Commission

merchant_commission

Monthly approved commission totals by brand.

Endpoint: https://app.partnerboost.com/api.php?mod=settlement&op=merchant_commission

Key	Description
`type`	Return format: `json` (default) or `xml`
`payment_currency`	The currency used when paying the commission for the brand to you. Available filter: USD, EUR, GBP. Multiple currencies separated by commas.

Key	Description
`brand_id`	Brand ID, a series of numbers, like 66303
`mcid`	Unique identifier for the brand, a series of characters, like ulike0
`sale_comm`	Sale Commission
`settlement_date`	Date when commission is approved and ready for you to withdraw
`note`	This indicates the time period the amount is generated. It could be sales commission, bonus or paid placement.
`settlement_id`	A unique id indicates approved commission by merchant
`payment_currency`	The currency used when paying the commission for the brand to you. Available Filter: USD, EUR, GBP. Multiple currencies separated by commas.

Request:

{
  "token": "YOUR_CHANNEL_TOKEN",
  "begin_date": "2024-01-01",
  "end_date": "2024-01-31",
  "payment_currency": "USD"
}

Line-item breakdown for a settlement.

Endpoint: https://app.partnerboost.com/api.php?mod=settlement&op=commission_details

Key	Description
`token`	Channel API token
`settlement_id`	A unique id indicates approved commission by merchant

Key	Description
`type`	Return format: `json` (default) or `xml`

Key	Description
`brand_id`	Brand ID, a series of numbers, like 66303
`mcid`	Unique identifier for the brand, a series of characters, like ulike0
`merchant_name`	Brand Name
`order_id`	Order ID
`order_time`	Transaction Time
`sale_amount`	Sale Amount
`sale_comm`	Sale Commission
`status`	Commission Status
`uid`	uid, your custom tracking variable (tag)
`prod_id`	Product ID
`order_unit`	Order Unit Amount
`settlement_id`	A unique id indicates approved commission by merchant
`validation_date`	Date the transaction validated
`note`	Reason for status change
`payment_currency`	The currency used when paying the commission for the brand to you.

Request:

{
  "token": "YOUR_CHANNEL_TOKEN",
  "settlement_id": "810b2ce13d1a3b640423"
}

Workflow