Creator Search Affiliate Trace Orders

This API allows the partner to retrieve a list of affiliate orders generated by a creator, returning the order ID and the product ID. Using this, the partner can track their affiliate-conversions on behalf of a creator, using the order ID.

---

For common parameters, refer to How to call TikTok Shop APIs - Common Parameters

• PAY_TIME: Filter based on the order payment time.
• DELIVERY_TIME: Filter based on the order delivery/shipment time.
• SETTLE_TIME: Filter based on the order settlement time.
• CREATE_TIME (default): Filter based on the order creation time. |

Query

https://open-api.tiktokglobalshop.com/affiliate_creator/202505/orders/trace/search?app_key=123abc&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c&timestamp=1625484268&page_token=asdasdaszz&page_size=50

Body

{"time_ge":1719807456000,"time_lt":1728443155000,"time_type":"PAY_TIME"}

• UNSPECIFIED: The status of the order is undefined. It might be updated later.
• ORDERED: The order has been placed, but the commission has not been settled. But an estimated commission is available.
• SETTLED: The commission of the order is already settled.
• REFUNDED: 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.
• DEDUCTED: Additional deduction from your balance account. | ^^skus |[]object | |A list of SKUs associated with the order. | ^^^id |string |1729793769377925388 |The SKU identifier. | ^^^product_id |string |1729793769377859852 |The product identifier. | ^^^price |object | |An object representing the localized price of the product. | ^^^^amount |string |Rp9.900 |The value of the price associated with the product. | ^^^^currency |string |IDR |The currency code of the price associated with the product. | ^^^quantity |int |2 |The total number of SKUs per order, calculated by aggregating the number of ordered product SKUs associated with the order. | ^^^commission_rate |int |1000 |The commission rate associated with the collaboration. Expressed in units of hundredths of a percent formatted as a string. The percent sign % is not included in the string. For example, 3000 represents a 30% commission. | ^^^estimated_commission_base |object | |An object representing the estimated base commission at the time of order creation. | ^^^^amount |string |Rp9.900 |The estimated commission base amount. | ^^^^currency |string |IDR |The currency code. | ^^^actual_commission |object | |An object representing the actual base commission, calculated by multiplying the actual commission base by the commission rate. | ^^^^amount |string |Rp1.900 |The actual commission amount. | ^^^^currency |string |IDR |The currency code. | ^^^shop_ads_commission_rate |int |5000 |The commission rate received by a creator for a sale associated with a specific piece of content. Expressed in units of hundredths of a percent formatted as a string. The percent sign % is not included in the string. For example, 3000 represents a 30% commission. | ^^^commission_bonus_rate |int |1000 |The commission bonus rate associated with the collaboration. Expressed in units of hundredths of a percent formatted as a string. The percent sign % is not included in the string. For example, 3000 represents a 30% commission. | ^^^product_name |string |black suit |The product name in the TikTok Shop. | ^^^shop_name |string |TestCase idl2l |The name of the TIkTok Shop in which the product is offered for sale. | ^^^returned_quantity |int |1 |The total number of returned SKUs associated with the order. | ^^^refunded_quantity |int |0 |The total number of refunded SKUs associated with the order. | ^^^campaign_id |string |73661290629 |The campaign identifier associated with the order. | ^^^actual_commission_base |object | |An object representing the actual commission base, calculated by multiplying the product sale price by the number of products sold, subtracting returned and refunded orders. | ^^^^amount |string |Rp9.900 |The value of the actual commission base. | ^^^^currency |string |IDR |The currency code. | ^^^actual_shop_ads_commission |object | |An object representing the actual shop ads commission, calculated by multiplying the commission base by the shop_ads_commission_rate. | ^^^^amount |string |Rp5.000 |The actual shop ads commission amount. | ^^^^currency |string |IDR |The currency code. | ^^^estimated_shop_ads_commission |object | |An object representing the estimated shop ads commission, calculated by multiplying the estimated commission base by the shop_ads_commission_rate | ^^^^amount |string |Rp8.000 |The estimated shop ads commission rate. | ^^^^currency |string |IDR |The currency code. | ^^^estimated_bonus_commission |object | |An object representing the estimated bonus commission, calculated by multiplying the estimated commission base by the commission bonus rate. | ^^^^amount |string |Rp1.00 |The estimated bonus commission amount. | ^^^^currency |string |IDR |The currency code. | ^^^delivery_time |int |1685548800 |Time and date order delivered, UTC+0 timing | ^^^creator_commission_reward_rate |int |1000 |The commission reward rate affiliate partners allocate to creators | ^^^estimated_creator_commission_reward_fee |object | |Estimated creator commission reward fee. | ^^^^amount |string |250 |The estimated fee creators receive from affiliate partners through commission rewards | ^^^^currency |string |IDR |The currency code. | ^^^actual_creator_commission_reward_fee |object | |Actual creator commission reward fee. | ^^^^amount |string |100 |The actual fee creators receive from affiliate partners through commission rewards | ^^^^currency |string |IDR |The currency code. | ^^^content_type |string |LIVE |The content format of the creator content through which the order was created. Possible values:
• SHOP
• VIDEO
• LIVE
• PRE_LIVE
• PROMOTION_PAGE
• LINKSHARE | ^^^content_id |string |7493990579714164574 |The content identifier for the creator content through which the order was created. | ^^^trace |object | |Extra information for tracing purposes. | ^^^^id |string |15678763 |When trace.type==GENERAL, the value is {eid} you provided in sharing_link; when trace.type==SPECIFIC, the value is the same as publisher_id. | ^^^^type |string |SPECIFIC |For the orders coming from the sharing links for specific publishers, the value is SPECIFIC; for the orders coming from the general sharing links, the value is GENERAL. | ^^^estimated_commission |object | |The estimated creator commission, calculated by multiplying the product sales price by the total number of products at the time of order creation. | ^^^^amount |string |1 |The estimated commission amount. | ^^^^currency |string |USD |The currency code. | ^^^actual_bonus_commission |object | |An object representing the actual bonus commission, calculated by multiplying the actual commission base by the commission bonus rate. | ^^^^amount |string |1 |The actual bonus commission amount. | ^^^^currency |string |USD |The currency code. | ^^create_time |int |1685548800 |Time and date of order created, UTC+0 timing | ^^delivery_time |int |1685548800 |Time and date order delivered, UTC+0 timing | ^next_page_token |string |b2Zmc2V0PTEw |An opaque token used to retrieve the next page of a paginated result set. | ^total_count |int |10 |Total count of orders in the response. |

{"code":0,"data":{"orders":[{"id":789078671231123124,"status":"SETTLED","skus":[{"id":"1729793769377925388","product_id":"1729793769377859852","price":{"amount":"Rp9.900","currency":"IDR"},"quantity":2,"commission_rate":1000,"estimated_commission_base":{"amount":"Rp9.900","currency":"IDR"},"actual_commission":{"amount":"Rp1.900","currency":"IDR"},"shop_ads_commission_rate":5000,"commission_bonus_rate":1000,"product_name":"black suit","shop_name":"TestCase idl2l","returned_quantity":1,"refunded_quantity":0,"campaign_id":"73661290629","actual_commission_base":{"amount":"Rp9.900","currency":"IDR"},"actual_shop_ads_commission":{"amount":"Rp5.000","currency":"IDR"},"estimated_shop_ads_commission":{"amount":"Rp8.000","currency":"IDR"},"estimated_bonus_commission":{"amount":"Rp1.00","currency":"IDR"},"delivery_time":1685548800,"creator_commission_reward_rate":1000,"estimated_creator_commission_reward_fee":{"amount":"250","currency":"IDR"},"actual_creator_commission_reward_fee":{"amount":"100","currency":"IDR"},"content_type":"LIVE","content_id":"7493990579714164574","trace":{"id":"15678763","type":"SPECIFIC"},"estimated_commission":{"amount":"1","currency":"USD"},"actual_bonus_commission":{"amount":"1","currency":"USD"}}],"create_time":1685548800,"delivery_time":1685548800}],"next_page_token":"b2Zmc2V0PTEw","total_count":10},"message":"Success","request_id":"202203070749000101890810281E8C70B7"}

For common error codes, refer to How to call TikTok Shop APIs - Common Error Code