Developer docs / Products and showcase
Creator TTS - Add showcase products
Add TikTok Shop products to an authorized creator showcase by product IDs or a product link.
POST
/v1/creator/tiktokshop/product/addToShowcase- 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
| Field | Type | Required | Description |
|---|---|---|---|
id | integer | Yes | Creator account id |
addType | PRODUCT_ID | PRODUCT_LINK | Yes | How products are identified |
productIds | string[] | Conditional | Required for PRODUCT_ID; 1–20 product IDs |
productLink | string(uri) | Conditional | Required for PRODUCT_LINK |
Required scopes: creator.showcase.write and creator.video.write.
A request can contain at most 20 product IDs.
Check data.errors even when code is 0; entries identify products that failed.
An expired creator authorization returns the business error “授权过期,请重新授权” (authorization expired, reauthorize).
Request example · Add by product ID
{
"id": 12345,
"addType": "PRODUCT_ID",
"productIds": [
"1732280564607717841",
"1732280564607717842"
]
}Request example · Add by product link
{
"id": 12345,
"addType": "PRODUCT_LINK",
"productLink": "https://shop.tiktok.com/view/product/1732280564607717841"
}Response example · All products added
{
"code": 0,
"data": {},
"message": "success",
"timestamp": 1786406400000
}Response example · Some products failed
{
"code": 0,
"data": {
"errors": [
{
"code": 16001001,
"message": "Product is unavailable for this creator",
"detail": {
"productId": "1732280564607717842"
}
}
]
},
"message": "success",
"timestamp": 1786406400000
}Response example · Creator authorization expired
{
"code": 40101,
"data": {},
"message": "授权过期,请重新授权",
"timestamp": 1786406400000
}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 | Business status code. 0 means the request was processed; still check the per-product results. |
data | object | Yes | — |
data.errors | object[] | No | Per-product failures; empty or omitted when every product was added. |
data.errors[].code | integer | No | — |
data.errors[].message | string | No | — |
data.errors[].detail | object | No | — |
data.errors[].detail.productId | string | No | Product ID that failed to be added. |
message | string | Yes | — |
timestamp | integer | Yes | Unix timestamp in milliseconds. |
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