commissions/search
Search for commissions.
POST /commissions/search.xml
// Code
commissions_search($options, $campaign_id, $month, $year, $page=1, $perpage=6)
// $options is a hash like
$options => { "search_name" => value(optional), "search_amount" => value(optional), "search_status" => value(optional), "search_transaction_id" => value(optional) }
Parameters:
- campaign_id. Optional. A Campaign ID.
- month. Optional. The month in which to search - from 01 to 12.
- year: Optional. The year in which to search - 20xx.
- search_name. Optional. Name of the Affiliate that registered the commission.
- search_amount. Optional. Commission value, numeric.
- search_status. Optional. Commission status (accepted, pending or rejected).
- search_transaction_id. Optional. A specific transaction ID.
- page. Optional. The desired page.
- perpage. Optional. How many items per page.
commissions/listformerchant
Merchants: Show merchant's commissions.
GET /commissions/listformerchant.xml
// Code
commissions_listformerchant($campaign_id, $month, $year
Parameters:
- campaign_id. Optional. A Campaign ID.
- month. Required. The month in which to search - from 01 to 12.
- year: Required. The year in which to search - 20xx.
commissions/listforaffiliate
Affiliate: Show affiliate's commissions.
GET /commissions/listforaffiliate.xml
// Code
commissions_listforaffiliate($campaign_id, $month, $year)
Parameters:
- campaign_id. Optional. A Campaign ID.
- month. Required. The month in which to search - from 01 to 12.
- year: Required. The year in which to search - 20xx.
commissions/show
Show details about a commission.
GET /commissions/#{commission_id}.xml
// Code
commission_show($commission_id)
Parameters:
- commission_id. Required. A Commission ID.
commissions/update
Merchants: Update a commission's status.
PUT /commissions/#{commission_id}.xml
// Code
commission_update($commission_id, $commission)
Parameters:
- commission_id. Required. A Commission ID.
- commission. Required. Modified commission.
- You can change: status, amount, current_reason.
- status can be either pending, accepted, or rejected.
- current_reason should be a string. It is added on top of the previous reasons.
- amount when changed automatically adds a new reason.
