Developer docs / Products and showcase
List showcase products
List products in a creator showcase. Use SHOWCASE as the product source when creating a post.
GET
/v1/creator/tiktokshop/product/listByShowcase- 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.
Query parameters
| Field | Type | Required | Description |
|---|---|---|---|
id | integer | Yes | Creator account id |
origin | LIVE | SHOWCASE | Yes | Product source: LIVE or SHOWCASE |
pageSize | integer | Yes | Items per page |
pageToken | string | No | Pagination token from the previous response |
This endpoint does not accept titleKeyword. Filter by title on the client when needed.
Success response
{
"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"
}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 | Fixed value: 0 |
message | string | No | — |
data | object | Yes | — |
data.products | object[] | Yes | — |
data.products[].id | string | Yes | — |
data.products[].title | string | Yes | — |
data.products[].price | union | No | — |
data.products[].images | object[] | No | — |
data.products[].images[].url | string | Yes | — |
data.products[].images[].width | integer | No | — |
data.products[].images[].height | integer | No | — |
data.products[].shop | object | No | — |
data.products[].shop.name | string | Yes | — |
data.products[].addition | null | No | — |
data.products[].mainImages | object[] | No | — |
data.products[].mainImages[].width | integer | null | Yes | — |
data.products[].mainImages[].height | integer | null | Yes | — |
data.products[].mainImages[].url | string | Yes | — |
data.products[].status | object | No | — |
data.products[].status.inventoryStatus | string | Yes | — |
data.products[].status.reviewStatus | string | Yes | — |
data.products[].status.isHidden | boolean | Yes | — |
data.products[].status.addedStatus | string | Yes | — |
data.products[].source | string | No | — |
data.products[].detailLink | null | No | — |
data.products[].thirdPartyLink | null | No | — |
data.products[].saleRegions | array | null | No | — |
data.products[].commission | object | No | — |
data.products[].commission.rate | integer | Yes | — |
data.products[].commission.rewardRate | null | Yes | — |
data.products[].collaboration | object | No | — |
data.products[].collaboration.id | string | Yes | — |
data.products[].collaboration.type | string | Yes | — |
data.products[].collaboration.partner | null | Yes | — |
data.nextPageToken | string | Yes | — |
data.totalCount | integer | Yes | — |
HTTP 400The request parameters or body are invalid. Fix them and retry.HTTP 401The API key is missing or invalid. Check x-api-key.HTTP 403The API key has no permission to call this endpoint.HTTP 429Too many requests. Retry with exponential backoff.HTTP 500The server failed. Retry transient failures with exponential backoff.
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