您的浏览器不支持JavaScript,请启用JavaScript以获得最佳体验。
List showcase products
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

FieldTypeRequiredDescription
idintegerYesCreator account id
originLIVE | SHOWCASEYesProduct source: LIVE or SHOWCASE
pageSizeintegerYesItems per page
pageTokenstringNoPagination 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.

FieldTypeRequiredDescription
codeintegerYesFixed value: 0
messagestringNo—
dataobjectYes—
data.productsobject[]Yes—
data.products[].idstringYes—
data.products[].titlestringYes—
data.products[].priceunionNo—
data.products[].imagesobject[]No—
data.products[].images[].urlstringYes—
data.products[].images[].widthintegerNo—
data.products[].images[].heightintegerNo—
data.products[].shopobjectNo—
data.products[].shop.namestringYes—
data.products[].additionnullNo—
data.products[].mainImagesobject[]No—
data.products[].mainImages[].widthinteger | nullYes—
data.products[].mainImages[].heightinteger | nullYes—
data.products[].mainImages[].urlstringYes—
data.products[].statusobjectNo—
data.products[].status.inventoryStatusstringYes—
data.products[].status.reviewStatusstringYes—
data.products[].status.isHiddenbooleanYes—
data.products[].status.addedStatusstringYes—
data.products[].sourcestringNo—
data.products[].detailLinknullNo—
data.products[].thirdPartyLinknullNo—
data.products[].saleRegionsarray | nullNo—
data.products[].commissionobjectNo—
data.products[].commission.rateintegerYes—
data.products[].commission.rewardRatenullYes—
data.products[].collaborationobjectNo—
data.products[].collaboration.idstringYes—
data.products[].collaboration.typestringYes—
data.products[].collaboration.partnernullYes—
data.nextPageTokenstringYes—
data.totalCountintegerYes—
  • 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