您的浏览器不支持JavaScript,请启用JavaScript以获得最佳体验。
查询橱窗商品
开发者文档 / 带货内容发布

查询橱窗商品

查询达人橱窗商品。创建发布任务时,商品来源 source 应传 SHOWCASE。

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

Query 参数

字段 类型 必填 说明
idinteger是达人账号表 id
originLIVE | SHOWCASE是来源类型:LIVE 或 SHOWCASE
pageSizeinteger是每页数量
pageTokenstring否上一页返回的分页 Token
该接口不接收 titleKeyword;如需搜索,请在客户端按 title 过滤。
成功响应
{
  "code": 0,
  "data": {
    "products": [
      {
        "id": "1732280564607717841",
        "title": "Summer Vibes Cord",
        "price": {
          "amount": "19.99",
          "currency": "USD"
        },
        "images": [
          {
            "url": "https://cdn.example.com/product.jpg",
            "width": 800,
            "height": 800
          }
        ]
      }
    ],
    "nextPageToken": "",
    "totalCount": 1
  },
  "message": "success"
}

响应与错误

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

字段类型必填说明
codeinteger是固定值:0
messagestring否—
dataobject是—
data.productsobject[]是—
data.products[].idstring是—
data.products[].titlestring是—
data.products[].priceunion否—
data.products[].imagesobject[]否—
data.products[].images[].urlstring是—
data.products[].images[].widthinteger否—
data.products[].images[].heightinteger否—
data.products[].shopobject否—
data.products[].shop.namestring是—
data.products[].additionnull否—
data.products[].mainImagesobject[]否—
data.products[].mainImages[].widthinteger | null是—
data.products[].mainImages[].heightinteger | null是—
data.products[].mainImages[].urlstring是—
data.products[].statusobject否—
data.products[].status.inventoryStatusstring是—
data.products[].status.reviewStatusstring是—
data.products[].status.isHiddenboolean是—
data.products[].status.addedStatusstring是—
data.products[].sourcestring否—
data.products[].detailLinknull否—
data.products[].thirdPartyLinknull否—
data.products[].saleRegionsarray | null否—
data.products[].commissionobject否—
data.products[].commission.rateinteger是—
data.products[].commission.rewardRatenull是—
data.products[].collaborationobject否—
data.products[].collaboration.idstring是—
data.products[].collaboration.typestring是—
data.products[].collaboration.partnernull是—
data.nextPageTokenstring是—
data.totalCountinteger是—
  • HTTP 400请求参数或请求体无效,请修正后重试。
  • HTTP 401API 密钥缺失或无效,请检查 x-api-key。
  • HTTP 403API 密钥没有此接口的调用权限。
  • HTTP 429请求过于频繁,请采用指数退避重试。
  • HTTP 500服务端发生错误;对于暂时性故障采用指数退避重试。

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

最后更新 · 2026-09-29