Retrieves affiliate orders attributed to the creator represented by the current access token. Results can provide order status and timestamps, together with SKU-level product, shop, content, trace, quantity, price, and estimated or actual commission details.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Query Parameters
Section titled “Query Parameters”An opaque token used to retrieve the next page of a paginated result set. Retrieve this value from the result of the next_page_token from a previous response. It is not needed for the first page.
The number of results to return per page. Valid range: 1 to 100.
Request Bodyrequired
Section titled “Request Bodyrequired”object
The inclusive start of the time range for the selected time_type, as a Unix timestamp in milliseconds. Orders with timestamps greater than or equal to time_ge and less than time_lt are included.
The exclusive end of the time range for the selected time_type, as a Unix timestamp in milliseconds. Orders with timestamps greater than or equal to time_ge and less than time_lt are included.
Specifies the type of timestamp to filter the orders by. The query time range (time_ge and time_lt) will be applied to the selected time type. Possible values:
- 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.
Example
{ "time_ge": 1719807456000, "time_lt": 1728443155000, "time_type": "PAY_TIME"}Responses
Section titled “Responses”Success
object
Status code; 0 means success.
Success or failure message.
Request log ID.
object
The order resource.
object
The order identifier.
The current status of the order. Possible values:
- UNSPECIFIED: The status is undefined and may be updated later.
- ORDERED: The order has been placed, but commission has not been settled. The estimated commission is available.
- SETTLED: The commission has been settled. Actual commission values are populated when the corresponding settled amounts are available.
- REFUNDED: The order was returned, refunded, or canceled by the buyer; actual commission and actual commission base amounts are returned as localized zero values.
- FROZEN: Possible fraud was detected. Commission remains frozen until the issue is resolved.
- DEDUCTED: An additional deduction was made from the balance account.
For statuses other than SETTLED or REFUNDED, actual commission values can be empty. Bonus, shop ads, and creator commission reward amounts are populated only when the corresponding commission data exists; their availability is not determined by order status alone.
A list of SKUs associated with the order.
object
The SKU identifier.
The product identifier.
An object representing the localized price of the product.
object
The SKU price in major units of the currency specified by currency, represented as a decimal string.
The price currency code.
The quantity of this SKU in the order.
The commission rate associated with the collaboration, in hundredths of a percent. The value does not include a percent sign. For example, 3000 represents 30%.
An object representing the estimated base commission at the time of order creation.
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.
An object representing the actual creator commission. Its amount includes the components also reported in actual_bonus_commission and actual_creator_commission_reward_fee. The actual_shop_ads_commission amount is separate and is not included.
object
The actual 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. An empty string means that no actual commission value is available.
The currency code.
The commission rate received by a creator for a sale associated with a specific piece of content, in hundredths of a percent. The value does not include a percent sign. For example, 3000 represents 30%.
The commission bonus rate associated with the collaboration, in hundredths of a percent. The value does not include a percent sign. For example, 3000 represents 30%.
The product name in the TikTok Shop.
The name of the TIkTok Shop in which the product is offered for sale.
The returned quantity of this SKU in the order.
The refunded quantity of this SKU in the order.
The campaign identifier associated with the order.
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.
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.
An object representing the actual shop ads commission, calculated by multiplying the commission base by the shop_ads_commission_rate.
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.
An object representing the estimated shop ads commission, calculated by multiplying the estimated commission base by the shop_ads_commission_rate
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.
An object representing the estimated bonus commission, calculated by multiplying the estimated commission base by the commission bonus rate.
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.
Time and date order delivered, UTC+0 timing
The commission reward rate that affiliate partners allocate to creators, in hundredths of a percent. The value does not include a percent sign. For example, 1000 represents 10%.
Estimated creator commission reward fee.
object
When available, the estimated creator commission reward fee 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 creator commission reward fee.
object
When available, the actual creator commission reward fee 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.
The content format of the creator content through which the order was created. Possible values:
- SHOP
- VIDEO
- LIVE
- PRE_LIVE
- PROMOTION_PAGE
- LINKSHARE
The content identifier for the creator content through which the order was created.
Extra information for tracing purposes.
object
When trace.type is GENERAL, this is the event_id embedded in the general sharing link. When trace.type is SPECIFIC, this is the publisher_id supplied when generating the specific-publisher sharing link.
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.
An object representing the estimated creator commission. Its amount includes the components also reported in estimated_bonus_commission and estimated_creator_commission_reward_fee. The estimated_shop_ads_commission amount is separate and is not included.
object
The estimated 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.
An object representing the actual bonus commission, calculated by multiplying the actual commission base by the commission bonus rate.
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.
Time and date of order created, UTC+0 timing
Time and date order delivered, UTC+0 timing
An opaque token used to retrieve the next page of a paginated result set.
Total count of orders in the response.
Example
{ "code": 0, "data": { "orders": [ { "id": 789078671231123100, "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"}