Search affiliate orders
Queries TikTok Shop creator affiliate orders through /affiliate_creator/202410/orders/search. This is a creator-scoped endpoint: id is the creator account ID because the creator access_token is used, not a shop ID. startTime and endTime use YYYY-MM-DD and are converted from the start of the first day to the start of the day after endTime. Omit pageToken on the first request, then reuse nextPageToken with the same date range; an empty token means the last page. Amounts are localized strings with a currency; commission rates are in hundredths of a percent, so 3000 means 30%.
/v1/creator/tiktokshop/affiliateOrders/search- Authentication:
- Request header x-api-key: <YOUR_API_KEY>; keep the key on the server and never expose it in client code, logs or shared files.
- Success criteria:
- HTTP 2xx with code=0; for asynchronous tasks, also query the final status.
Request body fields
| Field | Type | Required | Description |
|---|---|---|---|
id | integer | Yes | Creator account ID (not a shop ID) |
startTime | string | Yes | Start date in YYYY-MM-DD |
endTime | string | Yes | End date in YYYY-MM-DD, inclusive of the whole day |
pageToken | string | No | Pagination token; omit on the first request |
pageSize | integer | No | Items per page from 1 to 100; defaults to 20 and is validated before calling the platform |
{
"id": 12345,
"startTime": "2026-11-01",
"endTime": "2026-11-16",
"pageSize": 20
}{
"code": 0,
"message": "success",
"data": {
"orders": [
{
"id": "789078671231123124",
"createTime": 1685548800,
"deliveryTime": 1685548800,
"status": "SETTLED",
"skus": [
{
"id": "1729793769377925388",
"campaignId": "73661290629",
"productName": "black_suit",
"productId": "1729793769377859852",
"price": {
"amount": "Rp9.900",
"currency": "IDR"
},
"shopName": "TestCase idl2l",
"contentType": "VIDEO",
"contentId": "7493990579714164574",
"quantity": 2,
"commissionRate": 3000,
"commissionModel": "Fixed commission",
"estimatedCommission": {
"amount": "Rp1.980",
"currency": "IDR"
},
"actualCommission": {
"amount": "Rp1.900",
"currency": "IDR"
},
"returnedQuantity": 0,
"refundedQuantity": 0,
"traceInfo": {
"id": "15678763",
"type": "SPECIFIC"
},
"lastUpdateTime": 1685548800,
"isCarousel": false
}
]
}
],
"nextPageToken": "",
"totalCount": 1
},
"timestamp": 1794463889000
}Response and errors
Main response fields come from the published contract; see the JSON Schema. Required refers to the constraint in the containing object.
| Field | Type | Required | Description |
|---|---|---|---|
code | integer | Yes | 0 indicates success |
message | string | Yes | — |
data | object | Yes | — |
data.orders | object[] | No | Matched orders. |
data.orders[].id | string | No | Order identifier |
data.orders[].createTime | integer | No | Order creation time in Unix seconds |
data.orders[].deliveryTime | integer | No | Delivery time in Unix seconds |
data.orders[].status | string | No | Order status: UNSPECIFIED (undefined, may update later), AWAITING PAYMENT (unpaid, estimated commission only), To-SETTLE (waiting for settlement, estimated commission only), SETTLED (commission settled), REFUNDED (returned/refunded/cancelled, no commission settled), FROZEN (possible fraud, unfrozen after review) |
data.orders[].skus | object[] | No | SKUs in the order. |
data.orders[].skus[].id | string | No | SKU identifier |
data.orders[].skus[].campaignId | string | No | Campaign ID associated with the order |
data.orders[].skus[].openCollaborationId | string | No | Open collaboration ID |
data.orders[].skus[].targetCollaborationId | string | No | Target collaboration ID |
data.orders[].skus[].productName | string | No | TikTok Shop product name |
data.orders[].skus[].productId | string | No | Product ID |
data.orders[].skus[].price | object | No | Localized amount: amount is a formatted string with currency symbol and separators; never convert it to a number for calculations. |
data.orders[].skus[].shopName | string | No | Shop name of the product |
data.orders[].skus[].contentType | string | No | Content format that generated the order: SHOP, VIDEO, LIVE, PRE_LIVE, PROMOTION_PAGE or LINKSHARE |
data.orders[].skus[].contentId | string | No | Content ID that generated the order |
data.orders[].skus[].quantity | integer | No | SKU quantity, including refunded units |
data.orders[].skus[].commissionRate | integer | No | Total commission rate in hundredths of a percent: 3000 = 30%; the sum of standard, shop ads, bonus and reward rates |
data.orders[].skus[].commissionTierSetting | string | No | Tier rates configured by the seller under the tiered commission model, such as 3.0 OR 5.0 |
data.orders[].skus[].commissionModel | string | No | Commission model: Fixed commission or Tiered commission |
data.orders[].skus[].commissionBonusRate | integer | No | Bonus commission rate in hundredths of a percent |
data.orders[].skus[].estimatedCommissionBase | object | No | Localized amount: amount is a formatted string with currency symbol and separators; never convert it to a number for calculations. |
data.orders[].skus[].standardCommissionRate | integer | No | Standard affiliate commission rate in hundredths of a percent |
data.orders[].skus[].shopAdsCommissionRate | integer | No | Shop ads commission rate in hundredths of a percent |
data.orders[].skus[].estimatedBonusCommission | object | No | Localized amount: amount is a formatted string with currency symbol and separators; never convert it to a number for calculations. |
data.orders[].skus[].estimatedStandardCommission | object | No | Localized amount: amount is a formatted string with currency symbol and separators; never convert it to a number for calculations. |
data.orders[].skus[].estimatedShopAdsCommission | object | No | Localized amount: amount is a formatted string with currency symbol and separators; never convert it to a number for calculations. |
data.orders[].skus[].estimatedCommission | object | No | Localized amount: amount is a formatted string with currency symbol and separators; never convert it to a number for calculations. |
data.orders[].skus[].actualCommission | object | No | Localized amount: amount is a formatted string with currency symbol and separators; never convert it to a number for calculations. |
data.orders[].skus[].actualBonusCommission | object | No | Localized amount: amount is a formatted string with currency symbol and separators; never convert it to a number for calculations. |
data.orders[].skus[].actualCommissionBase | object | No | Localized amount: amount is a formatted string with currency symbol and separators; never convert it to a number for calculations. |
data.orders[].skus[].actualStandardCommission | object | No | Localized amount: amount is a formatted string with currency symbol and separators; never convert it to a number for calculations. |
data.orders[].skus[].actualShopAdsCommission | object | No | Localized amount: amount is a formatted string with currency symbol and separators; never convert it to a number for calculations. |
data.orders[].skus[].returnedQuantity | integer | No | Returned quantity for this SKU |
data.orders[].skus[].refundedQuantity | integer | No | Refunded quantity for this SKU |
data.orders[].skus[].tag | string | No | User-defined tag for caller-side tracking |
data.orders[].skus[].creatorCommissionRewardRate | integer | No | Commission reward rate the affiliate partner gives the creator, in hundredths of a percent: 1000 = 10% |
data.orders[].skus[].estimatedCreatorCommissionRewardFee | object | No | Localized amount: amount is a formatted string with currency symbol and separators; never convert it to a number for calculations. |
data.orders[].skus[].actualCreatorCommissionRewardFee | object | No | Localized amount: amount is a formatted string with currency symbol and separators; never convert it to a number for calculations. |
data.orders[].skus[].isr | object | No | Localized amount: amount is a formatted string with currency symbol and separators; never convert it to a number for calculations. |
data.orders[].skus[].iva | object | No | Localized amount: amount is a formatted string with currency symbol and separators; never convert it to a number for calculations. |
data.orders[].skus[].pit | object | No | Localized amount: amount is a formatted string with currency symbol and separators; never convert it to a number for calculations. |
data.orders[].skus[].sharedWithPartner | object | No | Localized amount: amount is a formatted string with currency symbol and separators; never convert it to a number for calculations. |
data.orders[].skus[].traceInfo | object | No | Attribution information. |
data.orders[].skus[].lastUpdateTime | integer | No | Last update time of the record, in Unix seconds |
data.orders[].skus[].isCarousel | boolean | No | Whether the order is attributed to carousel content, which may involve a commission rate discount |
data.nextPageToken | string | No | Token for the next page; an empty string means the last page |
data.totalCount | integer | No | Total matched SKU rows. One order can contain multiple SKUs, so the number of order objects may be smaller than pageSize |
timestamp | integer | No | — |
Fix parameter, permission or authorization errors before retrying. If task creation times out, query existing tasks first and do not submit duplicates after an interrupted poll.
Last updated · 2026-11-16