Search affiliate orders for an MCN (Creator Agency Partner) within the specified or default creation-time range. When multiple request-body filters are provided, order_id, product_id, settle_status, and the creation-time range are combined using AND semantics, so an order must match every supplied filter.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Query Parameters
Section titled “Query Parameters”Pagination token returned in next_page_token from the previous response. The token contains only the search-after sort position; it does not preserve the search filters or page_size. Omit this parameter for the first page. For each subsequent page, pass the returned token, provide a valid page_size, and resend the same partner authorization context and request-body filters used for the first page. The page_size value can be set independently for each page. For stable pagination, explicitly provide the same fixed create_time_ge and create_time_lt values on every request instead of relying on the rolling default time range.
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
Transaction main order ID
Unique identifier for Product
Filter orders by settlement status. Send one of the following integer values; the response settle_status field uses the corresponding label:
1→CUSTOMER UNPAID: The customer has not paid for the order.2→PENDING: The customer can still return the order or request a refund, so earnings are estimated and awaiting settlement.3→SETTLED: Earnings have been settled to your account.4→INELIGIBLE: The order was returned, refunded, or canceled, so no commission will be settled.5→FROZEN: Possible fraud was detected; the commission will be unfrozen after the fraud is resolved.
Filter orders created at or after this time. Unix timestamp in seconds. create_time_ge and create_time_lt must be provided together. An explicitly supplied range can span at most 92 days. If neither field is provided, the API searches from three calendar months before the request time through the request time.
Filter orders created before this time. Unix timestamp in seconds. create_time_ge and create_time_lt must be provided together.
Example
{ "order_id": "576962796354307765", "product_id": "1729435310697057093", "settle_status": 1, "create_time_ge": 1791222188, "create_time_lt": 1791229388}Responses
Section titled “Responses”Success
object
Status code; 0 means success.
Success or failure message.
Request log ID.
object
SKU orders returned for the current page.
For monetary fields whose names start with actual_, the nested amount can be present only when settle_status is SETTLED or INELIGIBLE. For all other statuses, the amount property is omitted. Even for SETTLED or INELIGIBLE orders, an individual actual_* field can still omit amount.
object
Transaction main order ID
The customizable ID for each order, used for tracking performance at difference front end modules.
Unix timestamp in seconds when the order was created (UTC).
Unix timestamp in seconds when the order was delivered (UTC). This field is omitted when no delivery timestamp is available.
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.
The SKU identifier.
The open collaboration identifier associated with the order.
The target collaboration identifier associated with the order.
Creator username
The product name.
Unique identifier for Product
The SKU selling price information
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.
Shop / Seller name
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
Attribution type for LINKSHARE content.
Possible values:
Direct: same-shop attribution.Indirect: non-same-shop attribution. The settlement commission rate is usually lower than the rate agreed in the Marketplace or target collaboration.
For other content types, this field is an empty string.
Commission calculation model. Possible values:
Fixed commissionTiered commission
Seller-configured commission rates for a tiered commission model, expressed as percentages and separated by OR. Returns - for the fixed commission model.
Seller-to-creator standard commission rate. Returned as an integer in hundredths of a percent without a percent sign; for example, 3000 represents 30%.
TTS-to-creator commission bonus rate. Returned as an integer in hundredths of a percent without a percent sign; for example, 3000 represents 30%.
Shop Ads commission rate paid to the creator. Returned as an integer in hundredths of a percent without a percent sign; for example, 3000 represents 30%.
Commission bonus rate that the affiliate partner allocates to the creator. Returned as an integer in hundredths of a percent without a percent sign; for example, 3000 represents 30%.
Revenue-sharing portion between the creator and agency. Returned as an integer in hundredths of a percent without a percent sign; for example, 3000 represents 30%.
The estimated commission base is the product sale price multiplied by the number of products sold when 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 standard commission on sales that a creator will obtain.
object
Commission amount without a currency symbol. Use the sibling currency field to identify the currency.
Type of currency use
Estimated commission TTS pays well-performed creators
object
When available, the estimated bonus commission amount 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 commission on sales that a creator will receive from seller/advertisers purchasing a specific creative
object
The estimated shop ads commission amount 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 commission bonus which TAP provided to creator
object
Commission amount without a currency symbol. Use the sibling currency field to identify the currency.
Type of currency use
Only for Mexico creator, the platform collected related revenue taxes on behalf of government based on regulation.
object
The estimated creator ISR amount.
Type of currency use
Only for Mexico creator, the platform collected related revenue taxes on behalf of government based on regulation.
object
The estimated creator IVA amount.
Type of currency use
Only for VN/TH/PH/ID creators, sellers collect related withholding taxes based on regulation.
object
The estimated creator PIT amount.
The currency code.
Total after-tax earnings for creator before splitting revenue with agency
object
The estimated creator earnings amount
The currency code.
Total after-tax earnings for agency
object
The estimated agency earnings amount
The currency code.
Estimated ISR tax amount for Mexico agency
object
Tax amount without a currency symbol. Use the sibling currency field to identify the currency.
Type of currency use
Estimated IVA tax amount for Mexico agency
object
Tax amount without a currency symbol. Use the sibling currency field to identify the currency.
Type of currency use
The actual commission base is the product sale price multiplied by the number of products sold, excluding returned and refunded orders.
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 commission on sales that a creator will obtain before revenue spliting
object
Commission amount without a currency symbol. Use the sibling currency field to identify the currency.
Type of currency use
The creator’s actual TikTok Shop bonus commission.
object
The actual bonus commission amount 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.
Actual commission on sales that a creator will receive from seller/advertisers purchasing a specific creative
object
When available, the actual shop ads commission amount 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.
Actual commission bonus which TAP provided to creator
object
Actual TAP Bonus Commission amount
Type of currency use
Only for Mexico creator, the platform collected related revenue taxes on behalf of government based on regulation.
object
The actual creator ISR amount.
The currency code.
Only for Mexico creator, the platform collected related revenue taxes on behalf of government based on regulation.
object
The actual creator IVA amount.
The currency code.
Only for VN/TH/PH/ID creators, sellers collected related withholding taxes based on regulation.
object
The actual creator PIT amount.
The currency code.
Total after-tax earnings for creator before splitting revenue with agency
object
The actual creator’s earnings amount
The currency code.
Total after-tax earnings for agency
object
The actual agency earnings amount
The currency code.
The actual ISR tax amount for Mexico agency
object
Tax amount without a currency symbol. Use the sibling currency field to identify the currency.
Type of currency use
The actual IVA tax amount for Mexico agency
object
Tax amount without a currency symbol. Use the sibling currency field to identify the currency.
Type of currency use
Whether this SKU order was fully returned or refunded. Possible values:
Yes: this SKU order was fully returned or refunded, and no commission is paid.No: this SKU order was not fully returned or refunded.
Unix timestamp in seconds when the order commission was settled (UTC). This field is omitted when no settlement timestamp is available.
Unix timestamp in seconds when the record was last updated (UTC).
Carousel content may involve a commission rate discount. Returns true when the SKU order is attributed to carousel content.
Pagination token for the next page. The token contains only the search-after sort position; it does not preserve the search filters or page_size. If this field is returned, pass it as page_token in the next request, provide a valid page_size, and resend the same partner authorization context and request-body filters used for the first page. The page_size value can be set independently for each page. For stable pagination, explicitly provide the same fixed create_time_ge and create_time_lt values on every request instead of relying on the rolling default time range. Stop paginating when this field is omitted. The field is omitted when the returned page contains fewer records than page_size.
Total number of SKU orders matching the current search criteria across all pages.
Example
{ "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 OR 5", "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"}