您的浏览器不支持JavaScript,请启用JavaScript以获得最佳体验。
联盟订单查询
开发者文档 / 联盟订单

联盟订单查询

按创作者查询联盟带货订单,支持时间范围与游标分页。

POST/v1/creator/tiktokshop/affiliateOrders/search
鉴权:
请求头 x-api-key: <YOUR_API_KEY>;密钥仅保存在服务端。
成功判断:
HTTP 2xx 且响应 code=0;异步任务还需查询最终状态。

请求字段

字段类型必填说明
idinteger是创作者账号 ID(不是店铺 ID)
startTimestring是开始时间,格式 YYYY-MM-DD
endTimestring是结束时间,格式 YYYY-MM-DD,按当天 23:59:59 计
pageTokenstring否分页游标,首页不传
pageSizeinteger否每页条数 1-100,不传默认 20;越界由后端参数校验拦截,不会请求平台
这是创作者维度接口:`id` 传创作者账号 ID,服务端用该创作者的 access_token 调 TikTok Shop `/affiliate_creator/202410/orders/search`,不是店铺 ID。
时间范围:`startTime` / `endTime` 传 `YYYY-MM-DD`,后端按「起始日 00:00:00」到「结束日次日 00:00:00」换算成秒,结束日当天的订单也会返回。
分页:首页不传 `pageToken`;用返回的 `nextPageToken` 继续翻页,返回空字符串表示最后一页。翻页时须沿用同一组 `startTime` / `endTime`。`totalCount` 与 `pageSize` 都按 SKU 行计数,一个订单可能包含多个 SKU,所以返回的订单对象数量可能少于 `pageSize`。
金额字段都是「本地化字符串 + 币种」,不要直接转数字参与计算;佣金率以万分之一为单位,`3000` 表示 30%。
`isr`、`iva` 仅墨西哥创作者返回,`pit` 仅越南、泰国、菲律宾、印尼创作者返回,其他地区可能不出现这些字段。
请求体
{
  "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
}

响应与错误

主要响应字段来自接口规范;完整层级、联合类型和校验规则见 JSON Schema。必填指字段所在对象中的约束。

字段类型必填说明
codeinteger是0 表示成功
messagestring是—
dataobject是—
data.ordersobject[]否命中的订单列表。
data.orders[].idstring否订单标识
data.orders[].createTimeinteger否下单时间,Unix 秒
data.orders[].deliveryTimeinteger否送达时间,Unix 秒
data.orders[].statusstring否订单状态:UNSPECIFIED(尚未确定)、AWAITING PAYMENT(未支付,只有预估佣金)、To-SETTLE(待结算,只有预估佣金)、SETTLED(佣金已结算)、REFUNDED(已退货/退款/取消,不结算佣金)、FROZEN(疑似欺诈暂时冻结,处理完成后解冻)
data.orders[].skusobject[]否订单包含的 SKU 列表。
data.orders[].skus[].idstring否SKU 标识
data.orders[].skus[].campaignIdstring否该订单关联的活动 ID
data.orders[].skus[].openCollaborationIdstring否公开合作 ID
data.orders[].skus[].targetCollaborationIdstring否定向合作 ID
data.orders[].skus[].productNamestring否TikTok Shop 商品名称
data.orders[].skus[].productIdstring否商品 ID
data.orders[].skus[].priceobject否本地化金额:amount 是带符号和千分位的字符串,不要直接转数字参与计算。
data.orders[].skus[].shopNamestring否商品所属店铺名称
data.orders[].skus[].contentTypestring否成交内容形式:SHOP、VIDEO、LIVE、PRE_LIVE、PROMOTION_PAGE 或 LINKSHARE
data.orders[].skus[].contentIdstring否成交内容 ID
data.orders[].skus[].quantityinteger否该 SKU 数量,含退款数量
data.orders[].skus[].commissionRateinteger否总佣金率,万分之一为单位:3000 = 30%;等于标准、店铺广告、奖励与分成各项佣金率之和
data.orders[].skus[].commissionTierSettingstring否阶梯佣金模式下卖家设置的各档佣金率,例如 3.0 OR 5.0
data.orders[].skus[].commissionModelstring否佣金模式:Fixed commission 或 Tiered commission
data.orders[].skus[].commissionBonusRateinteger否奖励佣金率,万分之一为单位
data.orders[].skus[].estimatedCommissionBaseobject否本地化金额:amount 是带符号和千分位的字符串,不要直接转数字参与计算。
data.orders[].skus[].standardCommissionRateinteger否标准联盟佣金率,万分之一为单位
data.orders[].skus[].shopAdsCommissionRateinteger否店铺广告佣金率,万分之一为单位
data.orders[].skus[].estimatedBonusCommissionobject否本地化金额:amount 是带符号和千分位的字符串,不要直接转数字参与计算。
data.orders[].skus[].estimatedStandardCommissionobject否本地化金额:amount 是带符号和千分位的字符串,不要直接转数字参与计算。
data.orders[].skus[].estimatedShopAdsCommissionobject否本地化金额:amount 是带符号和千分位的字符串,不要直接转数字参与计算。
data.orders[].skus[].estimatedCommissionobject否本地化金额:amount 是带符号和千分位的字符串,不要直接转数字参与计算。
data.orders[].skus[].actualCommissionobject否本地化金额:amount 是带符号和千分位的字符串,不要直接转数字参与计算。
data.orders[].skus[].actualBonusCommissionobject否本地化金额:amount 是带符号和千分位的字符串,不要直接转数字参与计算。
data.orders[].skus[].actualCommissionBaseobject否本地化金额:amount 是带符号和千分位的字符串,不要直接转数字参与计算。
data.orders[].skus[].actualStandardCommissionobject否本地化金额:amount 是带符号和千分位的字符串,不要直接转数字参与计算。
data.orders[].skus[].actualShopAdsCommissionobject否本地化金额:amount 是带符号和千分位的字符串,不要直接转数字参与计算。
data.orders[].skus[].returnedQuantityinteger否该 SKU 退货数量
data.orders[].skus[].refundedQuantityinteger否该 SKU 退款数量
data.orders[].skus[].tagstring否自定义标记,供调用方跟踪用
data.orders[].skus[].creatorCommissionRewardRateinteger否联盟伙伴分配给达人的佣金奖励率,万分之一为单位:1000 = 10%
data.orders[].skus[].estimatedCreatorCommissionRewardFeeobject否本地化金额:amount 是带符号和千分位的字符串,不要直接转数字参与计算。
data.orders[].skus[].actualCreatorCommissionRewardFeeobject否本地化金额:amount 是带符号和千分位的字符串,不要直接转数字参与计算。
data.orders[].skus[].isrobject否本地化金额:amount 是带符号和千分位的字符串,不要直接转数字参与计算。
data.orders[].skus[].ivaobject否本地化金额:amount 是带符号和千分位的字符串,不要直接转数字参与计算。
data.orders[].skus[].pitobject否本地化金额:amount 是带符号和千分位的字符串,不要直接转数字参与计算。
data.orders[].skus[].sharedWithPartnerobject否本地化金额:amount 是带符号和千分位的字符串,不要直接转数字参与计算。
data.orders[].skus[].traceInfoobject否归因信息。
data.orders[].skus[].lastUpdateTimeinteger否该记录最后更新时间,Unix 秒
data.orders[].skus[].isCarouselboolean否订单是否归因于轮播内容;轮播内容可能涉及佣金率折扣
data.nextPageTokenstring否下一页游标,空字符串表示最后一页
data.totalCountinteger否命中的 SKU 订单总行数;一个订单可能包含多个 SKU,所以订单对象数量可能少于 pageSize
timestampinteger否—

参数、权限或授权错误需先修正。创建发布或生成任务超时后先查询已有任务,避免重复创建;不要因轮询中断而重复提交。

最后更新 · 2026-11-16