您的浏览器不支持JavaScript,请启用JavaScript以获得最佳体验。
Search affiliate orders
Developer docs / Affiliate orders

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%.

POST/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

FieldTypeRequiredDescription
idintegerYesCreator account ID (not a shop ID)
startTimestringYesStart date in YYYY-MM-DD
endTimestringYesEnd date in YYYY-MM-DD, inclusive of the whole day
pageTokenstringNoPagination token; omit on the first request
pageSizeintegerNoItems per page from 1 to 100; defaults to 20 and is validated before calling the platform
Creator-scoped: id is the creator account ID, and the server calls TikTok Shop /affiliate_creator/202410/orders/search with that creator's access_token. It is 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. totalCount and pageSize count SKU rows, so an order with several SKUs can make the returned order objects fewer than pageSize.
Amounts are localized strings with a currency and must not be converted to numbers for calculations; commission rates are in hundredths of a percent, so 3000 means 30%.
isr and iva are returned for Mexico creators only, and pit for VN/TH/PH/ID creators only; other regions may omit them.
Request body
{
  "id": 12345,
  "startTime": "2026-11-01",
  "endTime": "2026-11-16",
  "pageSize": 20
}
Success response
{
  "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.

FieldTypeRequiredDescription
codeintegerYes0 indicates success
messagestringYes—
dataobjectYes—
data.ordersobject[]NoMatched orders.
data.orders[].idstringNoOrder identifier
data.orders[].createTimeintegerNoOrder creation time in Unix seconds
data.orders[].deliveryTimeintegerNoDelivery time in Unix seconds
data.orders[].statusstringNoOrder 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[].skusobject[]NoSKUs in the order.
data.orders[].skus[].idstringNoSKU identifier
data.orders[].skus[].campaignIdstringNoCampaign ID associated with the order
data.orders[].skus[].openCollaborationIdstringNoOpen collaboration ID
data.orders[].skus[].targetCollaborationIdstringNoTarget collaboration ID
data.orders[].skus[].productNamestringNoTikTok Shop product name
data.orders[].skus[].productIdstringNoProduct ID
data.orders[].skus[].priceobjectNoLocalized amount: amount is a formatted string with currency symbol and separators; never convert it to a number for calculations.
data.orders[].skus[].shopNamestringNoShop name of the product
data.orders[].skus[].contentTypestringNoContent format that generated the order: SHOP, VIDEO, LIVE, PRE_LIVE, PROMOTION_PAGE or LINKSHARE
data.orders[].skus[].contentIdstringNoContent ID that generated the order
data.orders[].skus[].quantityintegerNoSKU quantity, including refunded units
data.orders[].skus[].commissionRateintegerNoTotal commission rate in hundredths of a percent: 3000 = 30%; the sum of standard, shop ads, bonus and reward rates
data.orders[].skus[].commissionTierSettingstringNoTier rates configured by the seller under the tiered commission model, such as 3.0 OR 5.0
data.orders[].skus[].commissionModelstringNoCommission model: Fixed commission or Tiered commission
data.orders[].skus[].commissionBonusRateintegerNoBonus commission rate in hundredths of a percent
data.orders[].skus[].estimatedCommissionBaseobjectNoLocalized amount: amount is a formatted string with currency symbol and separators; never convert it to a number for calculations.
data.orders[].skus[].standardCommissionRateintegerNoStandard affiliate commission rate in hundredths of a percent
data.orders[].skus[].shopAdsCommissionRateintegerNoShop ads commission rate in hundredths of a percent
data.orders[].skus[].estimatedBonusCommissionobjectNoLocalized amount: amount is a formatted string with currency symbol and separators; never convert it to a number for calculations.
data.orders[].skus[].estimatedStandardCommissionobjectNoLocalized amount: amount is a formatted string with currency symbol and separators; never convert it to a number for calculations.
data.orders[].skus[].estimatedShopAdsCommissionobjectNoLocalized amount: amount is a formatted string with currency symbol and separators; never convert it to a number for calculations.
data.orders[].skus[].estimatedCommissionobjectNoLocalized amount: amount is a formatted string with currency symbol and separators; never convert it to a number for calculations.
data.orders[].skus[].actualCommissionobjectNoLocalized amount: amount is a formatted string with currency symbol and separators; never convert it to a number for calculations.
data.orders[].skus[].actualBonusCommissionobjectNoLocalized amount: amount is a formatted string with currency symbol and separators; never convert it to a number for calculations.
data.orders[].skus[].actualCommissionBaseobjectNoLocalized amount: amount is a formatted string with currency symbol and separators; never convert it to a number for calculations.
data.orders[].skus[].actualStandardCommissionobjectNoLocalized amount: amount is a formatted string with currency symbol and separators; never convert it to a number for calculations.
data.orders[].skus[].actualShopAdsCommissionobjectNoLocalized amount: amount is a formatted string with currency symbol and separators; never convert it to a number for calculations.
data.orders[].skus[].returnedQuantityintegerNoReturned quantity for this SKU
data.orders[].skus[].refundedQuantityintegerNoRefunded quantity for this SKU
data.orders[].skus[].tagstringNoUser-defined tag for caller-side tracking
data.orders[].skus[].creatorCommissionRewardRateintegerNoCommission reward rate the affiliate partner gives the creator, in hundredths of a percent: 1000 = 10%
data.orders[].skus[].estimatedCreatorCommissionRewardFeeobjectNoLocalized amount: amount is a formatted string with currency symbol and separators; never convert it to a number for calculations.
data.orders[].skus[].actualCreatorCommissionRewardFeeobjectNoLocalized amount: amount is a formatted string with currency symbol and separators; never convert it to a number for calculations.
data.orders[].skus[].isrobjectNoLocalized amount: amount is a formatted string with currency symbol and separators; never convert it to a number for calculations.
data.orders[].skus[].ivaobjectNoLocalized amount: amount is a formatted string with currency symbol and separators; never convert it to a number for calculations.
data.orders[].skus[].pitobjectNoLocalized amount: amount is a formatted string with currency symbol and separators; never convert it to a number for calculations.
data.orders[].skus[].sharedWithPartnerobjectNoLocalized amount: amount is a formatted string with currency symbol and separators; never convert it to a number for calculations.
data.orders[].skus[].traceInfoobjectNoAttribution information.
data.orders[].skus[].lastUpdateTimeintegerNoLast update time of the record, in Unix seconds
data.orders[].skus[].isCarouselbooleanNoWhether the order is attributed to carousel content, which may involve a commission rate discount
data.nextPageTokenstringNoToken for the next page; an empty string means the last page
data.totalCountintegerNoTotal matched SKU rows. One order can contain multiple SKUs, so the number of order objects may be smaller than pageSize
timestampintegerNo—

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