Search Tap Affiliate Orders

TAP can use this API to retrieve a list of affiliate orders and track the affiliate conversions.

---

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

Query

https://open-api.tiktokglobalshop.com/affiliate_partner/202603/orders/search?app_key=123abc&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c&timestamp=1625484268&category_asset_cipher=ROW_RHkDDABBAAB8tKAVoAqsMTjsQZFLyNfY&page_token=6AsPQsUMvH3RkchNUPPh22NROHkE0D8pmq/N5M1kHYcZmtRyv9aVrNv65W7Q6tFA+7D1ud64MPNz5OaT&page_size=20

Body

{"create_time_ge":1623812664,"create_time_lt":1623812664,"campaign_id":"7324371012170024705"}

1. "CUSTOMER UNPAID", customer hasn't paid for the orders.
2. "PENDING", customers can still return or get a refund for this order. The earnings shown are estimates and waiting for settlement.
3. "SETTLED", your earnings have already settled to your account
4. "INELIGIBLE", The order has been returned/refunded/canceled by the buyer, and no commission will be settled.
5. "FROZEN", Possible fraud has been detected regarding the order. The commission will be unfrozen after the fraud is resolved. | ^^sku_id |string |1729793769377925388 |sku ID | ^^campaign_id |string |7324371012170024705 |New seller campaign | ^^creator_username |string |liuyi_id_creator1jigo |Creator username | ^^product_name |string |Black Hoodie |Product name / description | ^^product_id |string |1729435310697057093 |Unique identifier for Product | ^^price |object | |Price | ^^^amount |string |99 |Price amount for product, such as USD 1000 | ^^^currency |string |USD |Type of currency use | ^^quantity |int |1 |Total sku quantity per order | ^^content_type |string |VIDEO |The content format of the creator content through which the order was created. Possible values:
6. SHOP
7. VIDEO
8. LIVE
9. PRE_LIVE
10. PROMOTION_PAGE
11. LINKSHARE | ^^content_id |string |7494337156519332665 |Unique identifier for content | ^^creator_standard_commission_rate |int |3000 |Between TAP & creator percentage commission | ^^partner_standard_commission_rate |int |4000 |Between seller & TAP percentage commission | ^^creator_shop_ads_commission_rate |int |3000 |Between TAP & creator percentage shop ads commission | ^^partner_shop_ads_commission_rate |int |4000 |Between TAP & seller percentage shop ads commission | ^^partner_tap_bonus_commission_rate |int |1000 |The additional commission rate TikTok Shop offers to affiliate partners for driving product sales in specific campaigns | ^^creator_tap_bonus_commission_rate |int |2000 |The commission reward rate affiliate partners allocate to creators | ^^estimated_commission_base |object | |The estimated commission base is the item price multiplied by the number of items ordered at the time the order is created. | ^^^amount |string |99 |Price amount for product, such as Rp 1000 | ^^^currency |string |USD |Type of currency use | ^^estimated_creator_standard_commission |object | |Estimated TAP commission x creator commission rate | ^^^amount |string |100 |Price amount for product, such as Rp 1000 | ^^^currency |string |USD |Type of currency use | ^^estimated_partner_standard_commission |object | |Estimated commission base x TAP commission rate | ^^^amount |string |100 |Price amount for product, such as Rp 1000 | ^^^currency |string |USD |Type of currency use | ^^estimated_creator_shop_ads_commission |object | |Estimated commission base x creator shop ads commission rate | ^^^amount |string |99 |Commission amount, such as Rp 1000 | ^^^currency |string |USD |Type of currency use | ^^estimated_partner_shop_ads_commission |object | |Estimated commission base x partner shop ads commission rate | ^^^amount |string |99 |Commission amount, such as Rp 1000 | ^^^currency |string |USD |Type of currency use | ^^estimated_partner_tap_bonus_commission |object | |Estimated partner commission reward fee | ^^^amount |string |100 |Price amount for product, such as Rp 1000 | ^^^currency |string |USD |Type of currency use | ^^estimated_creator_tap_bonus_commission |object | |Estimated creator commission reward fee | ^^^amount |string |100 |Price amount for product, such as Rp 1000 | ^^^currency |string |USD |Type of currency use | ^^estimated_partner_isr |object | |Estimated ISR tax amount for Mexico partner | ^^^amount |string |99 |Tax amount, such as Rp 1000 | ^^^currency |string |USD |Type of currency use | ^^estimated_partner_iva |object | |Estimated IVA tax amount for Mexico partner | ^^^amount |string |99 |Tax amount, such as Rp 1000 | ^^^currency |string |USD |Type of currency use | ^^actual_commission_base |object | |The actual commission base is the item price multiplied by the number of items ordered minus returns at the time the order is completed. | ^^^amount |string |200 |Price amount for product, such as Rp 1000 | ^^^currency |string |USD |Type of currency use | ^^actual_creator_standard_commission |object | |Actual TAP commission x creator commission rate | ^^^amount |string |100 |Price amount for product, such as Rp 1000 | ^^^currency |string |USD |Type of currency use | ^^actual_partner_standard_commission |object | |Actual commission base x TAP commission rate | ^^^amount |string |99 |Price amount for product, such as Rp 1000 | ^^^currency |string |USD |Type of currency use | ^^actual_creator_shop_ads_commission |object | |actual commission base x creator shop ads commission rate | ^^^amount |string |99 |Commission amount, such as Rp 1000 | ^^^currency |string |USD |Type of currency use | ^^actual_partner_shop_ads_commission |object | |actual commission base x partner shop ads commission rate | ^^^amount |string |99 |Commission amount, such as Rp 1000 | ^^^currency |string |USD |Type of currency use | ^^actual_partner_isr |object | |Actual ISR tax amount for Mexico partner | ^^^amount |string |99 |Tax amount, such as Rp 1000 | ^^^currency |string |USD |Type of currency use | ^^actual_partner_iva |object | |actual IVA tax amount for Mexico partner | ^^^amount |string |99 |Tax amount, such as Rp 1000 | ^^^currency |string |USD |Type of currency use | ^^actual_partner_tap_bonus_commission |object | |Actual partner commission reward fee | ^^^amount |string |200 |The actual fee affiliate partners earn from commission rewards | ^^^currency |string |USD |Type of currency use | ^^actual_creator_tap_bonus_commission |object | |Actual creator commission reward fee | ^^^amount |string |100 |The actual fee creators receive from affiliate partners through commission rewards | ^^^currency |string |USD |Type of currency use | ^^fully_return |string |Yes |Return “Yes” when this sku is fully returned/refunded. No commission given when full return/refund | ^^settlement_time |int |1685548800 |Time and date of order commission settled. UTC+0 Timing | ^^last_update_time |int |1685548800 |The time when the record was last updated. | ^^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 |6AsPQsUMvH3RkchNUPPh22NROHkE0D8pmq/N5M1kHYcZmtRyv9aVrNv65W7Q6tFA+7D1ud64MPNz5OaT |Cursor used for searching for more information | ^total_count |int |100 |The total number of sku orders |

{"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"}

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