TAP can use this API to retrieve a list of affiliate orders and track the affiliate conversions.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Query Parameters
Section titled “Query Parameters”The pagination token returned in next_page_token from the previous response. When paginating, provide create_time_ge and create_time_lt in the first request, then pass this token and reuse the same campaign_id (if specified), create_time_ge, and create_time_lt values in every subsequent request.
The default is 20, it must be positive integer, the range is 1-100
The partner identifier used in API requests. Retrieve this value by using the Get Authorized Category Assets API.
Request Body
Section titled “Request Body”object
Filter orders created at or after this time, specified as a Unix timestamp in seconds (UTC).
create_time_ge and create_time_lt must be provided together, and the interval must not exceed three months. If both fields are omitted, the API queries orders from the last three months.
Filter orders created before this time, specified as a Unix timestamp in seconds (UTC). See create_time_ge for the pairing, interval, and default behavior.
Filter orders by a TAP campaign using its identifier.
Example
{ "create_time_ge": 1623812664, "create_time_lt": 1623899064, "campaign_id": "7324371012170024705"}Responses
Section titled “Responses”Success
object
Status code; 0 means success.
Success or failure message.
Request log ID.
object
SKU-level affiliate order records. Estimated commission amount fields are populated when the corresponding estimated component is available. Actual commission amount fields are populated only for SETTLED or INELIGIBLE orders and are omitted before those states; an individual actual amount can still be omitted when its underlying component is unavailable.
object
Transaction main order ID
The order creation time as a Unix timestamp in seconds (UTC).
The order delivery time as a Unix timestamp in seconds (UTC).
Settlement Status of the order. Possible values:
- “CUSTOMER UNPAID”, customer hasn’t paid for the orders.
- “PENDING”, customers can still return or get a refund for this order. The earnings shown are estimates and waiting for settlement.
- “SETTLED”, your earnings have already settled to your account
- “INELIGIBLE”, The order has been returned/refunded/canceled by the buyer, and no commission will be settled.
- “FROZEN”, Possible fraud has been detected regarding the order. The commission will be unfrozen after the fraud is resolved.
Sku ID
The identifier of the TAP campaign associated with the order.
Creator username
The product name.
Unique identifier for Product
Price
object
The SKU price in major units of the currency specified by currency, represented as a decimal string.
The price currency code.
Number of SKU items in the order, including refunded items.
The content format of the creator content through which the order was created. Possible values:
- SHOP
- VIDEO
- LIVE
- PRE_LIVE
- PROMOTION_PAGE
- LINKSHARE
Unique identifier for content
The creator standard commission rate, scaled by 10,000. For example, 3000 represents 30%.
The affiliate partner’s standard commission rate, scaled by 10,000. For example, 4000 represents 40%.
The creator Shop Ads commission rate, scaled by 10,000. For example, 3000 represents 30%.
The affiliate partner’s Shop Ads commission rate, scaled by 10,000. For example, 4000 represents 40%.
The additional commission rate TikTok Shop offers to affiliate partners for driving product sales in specific campaigns, scaled by 10,000. For example, 1000 represents 10%.
The commission reward rate allocated by the affiliate partner to the creator, scaled by 10,000. For example, 2000 represents 20%.
The estimated commission base is the item price multiplied by the number of items ordered at the time the order is created.
object
The estimated commission base as a localized display string. It may include a currency symbol or code and region-specific decimal and grouping separators; see the sibling currency field for the currency code.
The currency code.
Estimated TAP commission x creator commission rate
object
The estimated creator standard commission amount without a currency symbol. Use currency to identify the currency.
Type of currency use
Estimated commission base x TAP commission rate
object
The estimated affiliate partner standard commission amount without a currency symbol. Use currency to identify the currency.
Type of currency use
Estimated commission base x creator shop ads commission rate
object
The estimated creator Shop Ads commission amount without a currency symbol. Use currency to identify the currency.
Type of currency use
Estimated commission base x partner shop ads commission rate
object
The estimated affiliate partner Shop Ads commission amount without a currency symbol. Use currency to identify the currency.
Type of currency use
Estimated partner commission reward fee
object
The estimated affiliate partner commission reward amount without a currency symbol. Use currency to identify the currency.
Type of currency use
Estimated creator commission reward fee
object
The estimated creator commission reward amount without a currency symbol. Use currency to identify the currency.
Type of currency use
Estimated ISR tax amount for Mexico partner
object
The estimated ISR tax amount without a currency symbol. Use currency to identify the currency.
Type of currency use
Estimated IVA tax amount for Mexico partner
object
The estimated IVA tax amount without a currency symbol. Use currency to identify the currency.
Type of currency use
The actual commission base is the item price multiplied by the number of items ordered minus returns at the time the order is completed.
object
The actual commission base as a localized display string. It may include a currency symbol or code and region-specific decimal and grouping separators; see the sibling currency field for the currency code. For SETTLED orders, this contains the actual base when available; for REFUNDED orders, it is a localized zero value; for other statuses, it is an empty string.
The currency code.
Actual TAP commission x creator commission rate
object
The actual creator standard commission amount without a currency symbol. Use currency to identify the currency.
Type of currency use
Actual commission base x TAP commission rate
object
The actual affiliate partner standard commission amount without a currency symbol. Use currency to identify the currency.
Type of currency use
Actual commission base x creator shop ads commission rate
object
The actual creator Shop Ads commission amount without a currency symbol. Use currency to identify the currency.
Type of currency use
Actual commission base x partner shop ads commission rate
object
The actual affiliate partner Shop Ads commission amount without a currency symbol. Use currency to identify the currency.
Type of currency use
Actual ISR tax amount for Mexico partner
object
The actual ISR tax amount without a currency symbol. Use currency to identify the currency.
Type of currency use
Actual IVA tax amount for Mexico partner
object
The actual IVA tax amount without a currency symbol. Use currency to identify the currency.
Type of currency use
Actual partner commission reward fee
object
The actual fee affiliate partners earn from commission rewards
Type of currency use
Actual creator commission reward fee
object
The actual fee creators receive from affiliate partners through commission rewards
Type of currency use
Whether the SKU was fully returned or refunded. Possible values:
Yes: The SKU was fully returned or refunded, and no commission is paid.No: The SKU was not fully returned or refunded.
The time when the order commission was settled, as a Unix timestamp in seconds (UTC).
The time when the record was last updated, as a Unix timestamp in seconds (UTC).
Carousel content may involve a commission rate discount. Returns true when the order is attributed to carousel content.
Pass this pagination token as page_token in the next request. Reuse the same campaign_id (if specified), create_time_ge, and create_time_lt values for every page; specify both time bounds in the first request to keep the search window fixed. Stop paginating when this field is omitted.
The total number of SKU orders matching the request filters across all pages.
Example
{ "code": 0, "data": { "sku_orders": [ { "id": "576962796354307765", "create_time": 1685548800, "delivery_time": 1685548800, "settle_status": "SETTLED", "sku_id": "1729793769377925388", "campaign_id": "7324371012170024705", "creator_username": "liuyi_id_creator1jigo", "product_name": "Black Hoodie", "product_id": "1729435310697057093", "price": { "amount": "99", "currency": "USD" }, "quantity": 1, "content_type": "VIDEO", "content_id": "7494337156519332665", "creator_standard_commission_rate": 3000, "partner_standard_commission_rate": 4000, "creator_shop_ads_commission_rate": 3000, "partner_shop_ads_commission_rate": 4000, "partner_tap_bonus_commission_rate": 1000, "creator_tap_bonus_commission_rate": 2000, "estimated_commission_base": { "amount": "99", "currency": "USD" }, "estimated_creator_standard_commission": { "amount": "100", "currency": "USD" }, "estimated_partner_standard_commission": { "amount": "100", "currency": "USD" }, "estimated_creator_shop_ads_commission": { "amount": "99", "currency": "USD" }, "estimated_partner_shop_ads_commission": { "amount": "99", "currency": "USD" }, "estimated_partner_tap_bonus_commission": { "amount": "100", "currency": "USD" }, "estimated_creator_tap_bonus_commission": { "amount": "100", "currency": "USD" }, "estimated_partner_isr": { "amount": "99", "currency": "USD" }, "estimated_partner_iva": { "amount": "99", "currency": "USD" }, "actual_commission_base": { "amount": "200", "currency": "USD" }, "actual_creator_standard_commission": { "amount": "100", "currency": "USD" }, "actual_partner_standard_commission": { "amount": "99", "currency": "USD" }, "actual_creator_shop_ads_commission": { "amount": "99", "currency": "USD" }, "actual_partner_shop_ads_commission": { "amount": "99", "currency": "USD" }, "actual_partner_isr": { "amount": "99", "currency": "USD" }, "actual_partner_iva": { "amount": "99", "currency": "USD" }, "actual_partner_tap_bonus_commission": { "amount": "200", "currency": "USD" }, "actual_creator_tap_bonus_commission": { "amount": "100", "currency": "USD" }, "fully_return": "Yes", "settlement_time": 1685548800, "last_update_time": 1685548800, "is_carousel": false } ], "next_page_token": "6AsPQsUMvH3RkchNUPPh22NROHkE0D8pmq/N5M1kHYcZmtRyv9aVrNv65W7Q6tFA+7D1ud64MPNz5OaT", "total_count": 100 }, "message": "Success", "request_id": "202203070749000101890810281E8C70B7"}