Search Seller Affiliate Orders

This API allows the partner to retrieve a list of affiliate orders (orders which are affiliate-commission eligible) generated by a seller, returning the order ID and the product ID. Using this, the partner can track their affiliate-conversions on behalf of a seller, using the order ID.

---

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

Note: create_time_ge and create_time_lt together constitute the creation time filter condition.

• If create_time_ge is filled but create_time_lt is empty, create_time_lt will default to the current time.
• If create_time_lt is filled but create_time_ge is empty, create_time_ge will default to the earliest shop time. If both are not specified, data from the last three months will be queried by default. | program_id |string |N |73661290629 |Filter orders by the associated affiliate program which refer to your agency partner's campaign ID. |

Query

https://open-api.tiktokglobalshop.com/affiliate_seller/202410/orders/search?app_key=123abc&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c&timestamp=1625484268&shop_cipher=ROW_RHkDDABBAAB8tKAVoAqsMTjsQZFLyNfY&page_token=b2Zmc2V0PTAK&page_size=20

Body

{"create_time_lt":1722485856,"create_time_ge":1719807456,"program_id":"73661290629"}

• Unknown: The status of the order is undefined. It might be updated later.
• AWAITING PAYMENT：The order hasn't been paid by customer yet, only estimated commission is available
• To-SETTLE：The order is waiting for settlement, only estimated commission is available
• SETTLED: The commission of the order is already settled.
• INELIGIBLE: The order has been returned/refunded/canceled by the buyer, and no commission will be settled. | ^^^open_collaboration_id |string |73661290629 |The ID of the open collaboration in which the product is enrolled. | ^^^target_collaboration_id |string |73661290629 |The ID of the target collaboration in which the product is enrolled. | ^^^campaign_id |string |73661290629 |The ID of the TAP campaign in which the product is enrolled. | ^^^creator_username |string |exampleTikTokCreatorUsername |The username of the creator that's participating in the specified open collaboration. | ^^^price |object | |The SKU selling price information. | ^^^^amount |string |1000 |The price amount. | ^^^^currency |string |VND |The price currency. | ^^^quantity |int |1 |The SKU quantity for the order. | ^^^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. | ^^^product_id |string |1729503179457070324 |The product ID in TikTok Shop. | ^^^commission_model |string |Tiered commission |Determine order commission be calculated based on fixed commission model or tiering model | ^^^commission_tier_setting |string |3.0 OR 5.0 |Between Seller & Creator percentagecommission. When tiering commission model applied, will return each tier's commission rate seller set. | ^^^commission_rate |string |1000 |The commission rate established by the seller to be paid to creators involved in the collaboration, expressed in hundredths of a percent. For example, 1550 represents a commission rate of 15.50%. Please note that we only return the value when this order is directly generated from your creator. If you are working with partner, please refer to partner_commission_rate. | ^^^partner_commission_rate |string |1000 |The commission rate established by the seller to be paid to affiliate partner involved in the collaboration, expressed in hundredths of a percent. For example, 1550 represents a commission rate of 15.50%. | ^^^shop_ads_commission_rate |string |5000 |The commission rate for orders generated through Shop Ads. | ^^^estimated_commission_base |object | |The estimated total sales value before deducting any refunds, used as a base for calculating commission. Formula: selling price * order quantity | ^^^^amount |string |1000 |The commission base amount. | ^^^^currency |string |VND |The commission base currency. | ^^^estimated_paid_shop_ads_commission |object | |The estimated Shop Ads commission that a seller will pay on sales. Formula: estimated commission base * Shop Ads commission rate | ^^^^amount |string |1000 |The commission amount. | ^^^^currency |string |VND |The commission currency. | ^^^estimated_paid_commission |object | |The estimated commission that a seller will pay on sales. Formula: estimated commission base * commission rate. Please note that we only return the value when this order is directly generated from your creator. If you are working with partner, please refer to paid_partner_commission. | ^^^^amount |string |20000 |The commission amount. | ^^^^currency |string |VND |The commission currency. | ^^^estimated_paid_partner_commission |object | |The estimated commission that a seller will pay on sales to affiliate partner. Formula: estimated commission base * partner commission rate | ^^^^amount |string |100 |The commission amount. | ^^^^currency |string |USD |The commission currency. | ^^^actual_commission_base |object | |The actual total sales value after deducting any refunds, used as a base for calculating commission. Formula: selling price * (order quantity - return/refund quantity) | ^^^^amount |string |50000 |The commission base amount. | ^^^^currency |string |VND |The commission base currency. | ^^^actual_paid_commission |object | |The actual commission the seller will pay on sales. Formula: actual commission base * commission rate. Please note that we only return the value when this order is directly generated from your creator. If you are working with partner, please refer to actual_paid_partner_commission. | ^^^^amount |string |10000 |The commission amount. | ^^^^currency |string |VND |The commission currency. | ^^^actual_paid_partner_commission |object | |The actual commission that a seller will pay on sales to affiliate partner. Formula: actual commission base * partner commission rate | ^^^^amount |string |20000 |The commission amount. | ^^^^currency |string |VND |The commission currency. | ^^^actual_paid_shop_ads_commission |object | |The actual Shop Ads commission the seller will pay on sales. Formula: actual commission base * Shop Ads commission rate | ^^^^amount |string |20000 |The commission amount. | ^^^^currency |string |VND |The commission currency. | ^^^estimated_cofunded_creator_bonus_amount |object | |The portion of the estimated creator bonus that you co-fund in commission boost. | ^^^^amount |string |100 |The commission amount. | ^^^^currency |string |USD |The commission currency. | ^^^actual_cofunded_creator_bonus_amount |object | |The portion of the actual creator bonus that you co-fund in commission boost. | ^^^^amount |string |100 |The commission amount. | ^^^^currency |string |USD |The commission currency. | ^^^refunded_quantity |int |1 |Field depreciated, no value return.please refer to fully_return. | ^^^returned_quantity |int |1 |Field depreciated, no value return.please refer to fully_return. | ^^^fully_return |string |Yes |Return yes when this sku is fully returned/refunded. No commission given when full return/refund | ^^^is_carousel |bool |false |Carousel content may involve a commission rate discount. Return [True] when orders is attributed to carousel content | ^next_page_token |string |WzE2OTUxMTY2NTQ2OTMsNTc2NDczNDg5ODYxNDEyMDI1XQ== |An opaque token used to retrieve the next page of a paginated result set. Provide this value in the page_token parameter of your request if the current response does not return all the results. | ^total_count |int |10000 |The total number of sku orders that matches the query conditions. |

{"code":0,"data":{"orders":[{"id":"579125529499110202","delivery_time":1723748656,"create_time":1722420186,"status":"COMPLETED","skus":[{"sku_id":"1729791975232997145","settlement_status":"SETTLED","open_collaboration_id":"73661290629","target_collaboration_id":"73661290629","campaign_id":"73661290629","creator_username":"exampleTikTokCreatorUsername","price":{"amount":"1000","currency":"VND"},"quantity":1,"content_type":"LIVE","content_id":"7493990579714164574","product_id":"1729503179457070324","commission_model":"Tiered commission","commission_tier_setting":"3.0 OR 5.0","commission_rate":"1000","partner_commission_rate":"1000","shop_ads_commission_rate":"5000","estimated_commission_base":{"amount":"1000","currency":"VND"},"estimated_paid_shop_ads_commission":{"amount":"1000","currency":"VND"},"estimated_paid_commission":{"amount":"20000","currency":"VND"},"estimated_paid_partner_commission":{"amount":"100","currency":"USD"},"actual_commission_base":{"amount":"50000","currency":"VND"},"actual_paid_commission":{"amount":"10000","currency":"VND"},"actual_paid_partner_commission":{"amount":"20000","currency":"VND"},"actual_paid_shop_ads_commission":{"amount":"20000","currency":"VND"},"estimated_cofunded_creator_bonus_amount":{"amount":"100","currency":"USD"},"actual_cofunded_creator_bonus_amount":{"amount":"100","currency":"USD"},"refunded_quantity":1,"returned_quantity":1,"fully_return":"Yes","is_carousel":false}]}],"next_page_token":"WzE2OTUxMTY2NTQ2OTMsNTc2NDczNDg5ODYxNDEyMDI1XQ==","total_count":10000},"message":"Success","request_id":"202203070749000101890810281E8C70B7"}

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