开发者文档 / 带货内容发布
查询橱窗商品
查询达人橱窗商品。创建发布任务时,商品来源 source 应传 SHOWCASE。
GET
/v1/creator/tiktokshop/product/listByShowcase- 鉴权:
- 请求头 x-api-key: <YOUR_API_KEY>;密钥仅保存在服务端。
- 成功判断:
- HTTP 2xx 且响应 code=0;异步任务还需查询最终状态。
Query 参数
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
id | integer | 是 | 达人账号表 id |
origin | LIVE | SHOWCASE | 是 | 来源类型:LIVE 或 SHOWCASE |
pageSize | integer | 是 | 每页数量 |
pageToken | string | 否 | 上一页返回的分页 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。必填指字段所在对象中的约束。
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
code | integer | 是 | 固定值:0 |
message | string | 否 | — |
data | object | 是 | — |
data.products | object[] | 是 | — |
data.products[].id | string | 是 | — |
data.products[].title | string | 是 | — |
data.products[].price | union | 否 | — |
data.products[].images | object[] | 否 | — |
data.products[].images[].url | string | 是 | — |
data.products[].images[].width | integer | 否 | — |
data.products[].images[].height | integer | 否 | — |
data.products[].shop | object | 否 | — |
data.products[].shop.name | string | 是 | — |
data.products[].addition | null | 否 | — |
data.products[].mainImages | object[] | 否 | — |
data.products[].mainImages[].width | integer | null | 是 | — |
data.products[].mainImages[].height | integer | null | 是 | — |
data.products[].mainImages[].url | string | 是 | — |
data.products[].status | object | 否 | — |
data.products[].status.inventoryStatus | string | 是 | — |
data.products[].status.reviewStatus | string | 是 | — |
data.products[].status.isHidden | boolean | 是 | — |
data.products[].status.addedStatus | string | 是 | — |
data.products[].source | string | 否 | — |
data.products[].detailLink | null | 否 | — |
data.products[].thirdPartyLink | null | 否 | — |
data.products[].saleRegions | array | null | 否 | — |
data.products[].commission | object | 否 | — |
data.products[].commission.rate | integer | 是 | — |
data.products[].commission.rewardRate | null | 是 | — |
data.products[].collaboration | object | 否 | — |
data.products[].collaboration.id | string | 是 | — |
data.products[].collaboration.type | string | 是 | — |
data.products[].collaboration.partner | null | 是 | — |
data.nextPageToken | string | 是 | — |
data.totalCount | integer | 是 | — |
HTTP 400请求参数或请求体无效,请修正后重试。HTTP 401API 密钥缺失或无效,请检查 x-api-key。HTTP 403API 密钥没有此接口的调用权限。HTTP 429请求过于频繁,请采用指数退避重试。HTTP 500服务端发生错误;对于暂时性故障采用指数退避重试。
参数、权限或授权错误需先修正。创建发布或生成任务超时后先查询已有任务,避免重复创建;不要因轮询中断而重复提交。
最后更新 · 2026-09-29