Search CAP Affiliate Orders

Search the list of affiliate orders of the specified date range from a MCN or known as CAP - Creator Agency partner

---

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

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. | create_time_ge |int |N |1623812664 |Filter orders to show only those that are created on or after the specified date and time. Unix timestamp. Please note that we only support 3 months' data at maximum for each single request. Note: create_time_ge and create_time_lt together constitute the creation time filter condition. create_time_ge and create_time_lt must be provided together. If both are not specified, data from the last three months will be queried by default. | create_time_lt |int |N |1623812664 |Unix timestamp representing the end of transactions time range one wants to request |

Query

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

Body

{"order_id":"576962796354307765","product_id":"1729435310697057093","settle_status":1,"create_time_ge":1623812664,"create_time_lt":1623812664}

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 |1729478689395213981 |The SKU identifier. | ^^open_collaboration_id |string |7324371012170024705 |The open collaboration identifier associated with the order. | ^^target_collaboration_id |string |7324371012170024705 |The target collaboration identifier associated with the order. | ^^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 | |The SKU selling price information | ^^^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 | ^^shop_name |string |xuyann aaaaa |Shop / Seller name | ^^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 | ^^attribution_type |string |Direct |Direct: Orders placed when customers click on links creators shared and buy from the shop. The commission rate is higher than indirect attribution. Indirect: Orders placed from the Recommendations page through links creators shared. The commission rate is lower than direct attribution. | ^^commission_model |string |Tiered commission |Determine order commission be calculated based on fixed commission model or tiering commission 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. | ^^standard_commission_rate |int |3000 |Between Seller & Creator percentage commission. 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 |3000 |TTS to creator percentage commission bonus. 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. | ^^shop_ads_commission_rate |int |3000 |Commission on sales that a creator will receive from seller/advertisers purchasing a specific creative. 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. | ^^tap_bonus_commission_rate |int |3000 |The commission reward rate affiliate partners allocate to creators | ^^revenue_sharing_portion_rate |int |3000 |The revenue splitting ratio between creator and agency. 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 | |The estimated commission base is the product sale price multiplied by the number of products sold when the order is created. | ^^^amount |string |99 |Price amount for product, such as Rp 1000 | ^^^currency |string |USD |Type of currency use | ^^estimated_standard_commission |object | |Estimated standard commission on sales that a creator will obtain. | ^^^amount |string |99 |Price amount for product, such as Rp 1000 | ^^^currency |string |USD |Type of currency use | ^^estimated_bonus_commission |object | |Estimated commission TTS pays well-performed creators | ^^^amount |string |99 |Price amount for product, such as Rp 1000 | ^^^currency |string |USD |Type of currency use | ^^estimated_shop_ads_commission |object | |Estimated commission on sales that a creator will receive from seller/advertisers purchasing a specific creative | ^^^amount |string |99 |Price amount for product, such as Rp 1000 | ^^^currency |string |USD |Type of currency use | ^^estimated_tap_bonus_commission |object | |Estimated commission bonus which TAP provided to creator | ^^^amount |string |99 |Price amount for product, such as Rp 1000 | ^^^currency |string |USD |Type of currency use | ^^estimated_creator_tax_isr |object | |Only for Mexico creator, the platform collected related revenue taxes on behalf of government based on regulation. | ^^^amount |string |99 |The estimated creator ISR amount. | ^^^currency |string |USD |Type of currency use | ^^estimated_creator_tax_iva |object | |Only for Mexico creator, the platform collected related revenue taxes on behalf of government based on regulation. | ^^^amount |string |99 |The estimated creator IVA amount. | ^^^currency |string |USD |Type of currency use | ^^estimated_creator_tax_pit |object | |Only for VN/TH/PH/ID creators, sellers collect related withholding taxes based on regulation. | ^^^amount |string |99 |The estimated creator PIT amount. | ^^^currency |string |USD |The currency code. | ^^estimated_creator_total_earnings_after_tax |object | |Total after-tax earnings for creator before splitting revenue with agency | ^^^amount |string |99 |The estimated creator earnings amount | ^^^currency |string |USD |The currency code. | ^^estimated_total_agency_earnings |object | |Total after-tax earnings for agency | ^^^amount |string |1 |The estimated agency earnings amount | ^^^currency |string |USD |The currency code. | ^^estimated_agency_isr |object | |Estimated ISR tax amount for Mexico agency | ^^^amount |string |99 |Tax amount, such as Rp 1000 | ^^^currency |string |USD |Type of currency use | ^^estimated_agency_iva |object | |Estimated IVA tax amount for Mexico agency | ^^^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 product sale price multiplied by the number of products sold, excluding returned and refunded orders. | ^^^amount |string |100 |Price amount for product, such as Rp 1000 | ^^^currency |string |USD |Type of currency use | ^^actual_standard_commission |object | |Actual commission on sales that a creator will obtain before revenue spliting | ^^^amount |string |100 |Price amount for product, such as Rp 1000 | ^^^currency |string |USD |Type of currency use | ^^actual_bonus_commission |object | |Actual commission on sales that a creator will receive from seller/advertisers purchasing a specific creative | ^^^amount |string |100 |Price amount for product, such as Rp 1000 | ^^^currency |string |USD |Type of currency use | ^^actual_shop_ads_commission |object | |actual commission on sales that a creator will receive from seller/advertisers purchasing a specific creative | ^^^amount |string |100 |Price amount for product, such as Rp 1000 | ^^^currency |string |USD |Type of currency use | ^^actual_tap_bonus_commission |object | |Actual commission bonus which TAP provided to creator | ^^^amount |string |100 |Actual TAP Bonus Commission amount | ^^^currency |string |USD |Type of currency use | ^^actual_creator_tax_isr |object | |Only for Mexico creator, the platform collected related revenue taxes on behalf of government based on regulation. | ^^^amount |string |1 |The actual creator ISR amount. | ^^^currency |string |USD |The currency code. | ^^actual_creator_tax_iva |object | |Only for Mexico creator, the platform collected related revenue taxes on behalf of government based on regulation. | ^^^amount |string |1 |The actual creator IVA amount. | ^^^currency |string |USD |The currency code. | ^^actual_creator_tax_pit |object | |Only for VN/TH/PH/ID creators, sellers collected related withholding taxes based on regulation. | ^^^amount |string |1 |The actual creator PIT amount. | ^^^currency |string |USD |The currency code. | ^^actual_creator_total_earnings_after_tax |object | |Total after-tax earnings for creator before splitting revenue with agency | ^^^amount |string |1 |The actual creator's earnings amount | ^^^currency |string |USD |The currency code. | ^^actual_total_agency_commission |object | |Total after-tax earnings for agency | ^^^amount |string |1 |The actual agency earnings amount | ^^^currency |string |USD |The currency code. | ^^actual_agency_isr |object | |The actual ISR tax amount for Mexico agency | ^^^amount |string |99 |Tax amount, such as Rp 1000 | ^^^currency |string |USD |Type of currency use | ^^actual_agency_iva |object | |The actual IVA tax amount for Mexico agency | ^^^amount |string |99 |Tax amount, such as Rp 1000 | ^^^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 |1775548800 |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","tags":"test-01","create_time":1685548800,"delivery_time":1685548800,"settle_status":"SETTLED","sku_id":"1729478689395213981","open_collaboration_id":"7324371012170024705","target_collaboration_id":"7324371012170024705","creator_username":"liuyi_id_creator1jigo","product_name":"Black Hoodie","product_id":"1729435310697057093","price":{"amount":"99","currency":"USD"},"quantity":1,"shop_name":"xuyann aaaaa","content_type":"VIDEO","content_id":"7494337156519332665","attribution_type":"Direct","commission_model":"Tiered commission","commission_tier_setting":"3.0 OR 5.0","standard_commission_rate":3000,"commission_bonus_rate":3000,"shop_ads_commission_rate":3000,"tap_bonus_commission_rate":3000,"revenue_sharing_portion_rate":3000,"estimated_commission_base":{"amount":"99","currency":"USD"},"estimated_standard_commission":{"amount":"99","currency":"USD"},"estimated_bonus_commission":{"amount":"99","currency":"USD"},"estimated_shop_ads_commission":{"amount":"99","currency":"USD"},"estimated_tap_bonus_commission":{"amount":"99","currency":"USD"},"estimated_creator_tax_isr":{"amount":"99","currency":"USD"},"estimated_creator_tax_iva":{"amount":"99","currency":"USD"},"estimated_creator_tax_pit":{"amount":"99","currency":"USD"},"estimated_creator_total_earnings_after_tax":{"amount":"99","currency":"USD"},"estimated_total_agency_earnings":{"amount":"1","currency":"USD"},"estimated_agency_isr":{"amount":"99","currency":"USD"},"estimated_agency_iva":{"amount":"99","currency":"USD"},"actual_commission_base":{"amount":"100","currency":"USD"},"actual_standard_commission":{"amount":"100","currency":"USD"},"actual_bonus_commission":{"amount":"100","currency":"USD"},"actual_shop_ads_commission":{"amount":"100","currency":"USD"},"actual_tap_bonus_commission":{"amount":"100","currency":"USD"},"actual_creator_tax_isr":{"amount":"1","currency":"USD"},"actual_creator_tax_iva":{"amount":"1","currency":"USD"},"actual_creator_tax_pit":{"amount":"1","currency":"USD"},"actual_creator_total_earnings_after_tax":{"amount":"1","currency":"USD"},"actual_total_agency_commission":{"amount":"1","currency":"USD"},"actual_agency_isr":{"amount":"99","currency":"USD"},"actual_agency_iva":{"amount":"99","currency":"USD"},"fully_return":"Yes","settlement_time":1775548800,"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