Transaction

Endpoint: https://app.partnerboost.com/api.php?mod=medium&op=transaction

Auth: Partner API authentication

Required parameters

Key	Description
token	Channel API token
begin_date	Transaction period. Format: YYYY-MM-DD. Either transaction period or validation period is mandatory.
end_date	Format: YYYY-MM-DD
validation_date_begin	Validation period. Format: YYYY-MM-DD. Either transaction period or validation period is mandatory.
validation_date_end	Format: YYYY-MM-DD

* Either transaction period (begin_date/end_date) or validation period is mandatory.

Optional parameters

Key	Description
type	Return format: json (default) or xml
order_id	Order ID
status	Commission status: Pending, Approved, Rejected, Normal, All
order_type	Filter by order type. Available values: amz_attribution (AMZ-Attribution Commission — Amazon attribution order), amz_creator_boost (AMZ-Creator Boost Commission — Amazon Creator Boost order), amz_cpc (Amazon CPC — Amazon CPC ad order), wmt_attribution (WMT-Attribution Commission — Walmart attribution order), wmt_affiliate_boost (WMT-Affiliate Boost Commission — Walmart Affiliate Boost order), dtc (DTC Commission — DTC direct order), tiktok (TikTok Commission — TikTok channel order), paid_placement (Paid Placement Fee — Paid placement order), merchant_bonus (Merchant Bonus — Merchant bonus order)
uid	uid, your custom tracking variable.
brand_id	Brand ID, a series of numbers, like 66303
mcid	Unique identifier for the brand, a series of characters, like ulike0
page	Current page index
limit	Number of transactions shown per page - max 2000 transactions per page

Return fields

Key	Description
channel_id	Channel ID
total_page	Total number of pages
total_trans	Total number of sales transactions
total_items	Total transactions broken down by items
partnerboost_id	PartnerBoost system unique ID
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
uid2	uid2, your custom tracking variable
uid3	uid3, your custom tracking variable
uid4	uid4, your custom tracking variable
uid5	uid5, your custom tracking variable
click_ref	Unique Click Id
prod_id	Product ID
order_unit	Order Unit Amount
comm_rate	Commission Rate
validation_date	Date the transaction validated
note	Reason for status change
customer_country	Customer country. If empty, it means the merchant does not provide
voucher_code	Code used at checkout
paid_status	Whether transaction has been paid to publishers. 1 = paid. 0 = not paid.
last_update_time	The latest time we update the transaction status from the advertiser.
payment_currency	The currency of the order and the currency used when paying the commission for the order to you.
order_type	The type of the order (e.g. AMZ-Attribution Commission,TikTok Commission etc.)

Request:

{
  "token": "YOUR_CHANNEL_TOKEN",
  "begin_date": "2024-01-01",
  "end_date": "2024-01-31",
  "status": "Approved",
  "order_type": "dtc"
}

Response:

{
  "status": { "code": 0, "msg": "Success" },
  "data": {
    "channel_id": "500107",
    "total_page": "1",
    "total_trans": "1",
    "total_items": "1",
    "list": [
      {
        "partnerboost_id": "pb-txid-001",
        "brand_id": "66303",
        "mcid": "example",
        "merchant_name": "Example Brand",
        "order_id": "ORD123456",
        "order_time": "1704067200",
        "sale_amount": "100.00",
        "sale_comm": "10.00",
        "status": "Approved",
        "uid": "tracking123",
        "uid2": "",
        "uid3": "",
        "uid4": "",
        "uid5": "",
        "paid_status": "1",
        "payment_currency": "USD",
        "order_type": "DTC Commission"
      }
    ]
  }
}