This API lists the products in the creator’s showcase, paginated by specified page size and iterated through pages by page token for up to 2000 products in the showcase. This API is generally used when a creator would like to view the products in the showcase. The platform will return the product details in the showcase, as well as the products in the livebag if the creator is live streaming.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Query Parameters
Section titled “Query Parameters”The number of results to be returned per page. Valid range: [1-20].
An opaque token used to retrieve the next page of a paginated result set. Retrieve this value from the result of the next_page_token from a previous response. It is not needed for the first page.
Set to LIVE to indicate the request originates from a Live room. Set to SHOWCASE to indicate that the request originates from the Showcase.
Responses
Section titled “Responses”Success
object
Status code; 0 means success.
Success or failure message.
Request log ID.
object
A list of products.
object
The product’s product ID
Data and metadata associated with the Seller’s TikTok Shop.
object
The name of the shop to which the product belongs.
An object including data about product images.
object
A list of product images.
object
The image width in pixels.
The image height in pixels.
The product’s TikTok Shop image URL.
An object including data about the product price.
object
The original price of the product.
object
The lowest original price for the product.
The highest original price for the product.
The ISO 4217 currency code.
An object including data about the product discount price.
object
The lowest discount price.
The highest discount price.
The ISO 4217 currency code.
An object including data about the product platform discount price.
object
The lowest product platform discount price.
The highest product platform discount price.
The ISO 4217 currency code.
The product’s display title.
A list of product images.
object
The image width in pixels.
The image height in pixels.
The product’s TikTok Shop image URL.
An object including product status information.
object
The product inventory status. This an enumerated type with values:
- IN_STOCK
- SOLD_OUT
The product review status. This is an enumerated type with values:
- APPROVED
- UNDER_REVIEW
- CHANGES_UNDER_REVIEW
- UNAVAILABLE
- REJECTED
- ZERO_COMMISSION
Set to false if the product is visible in the showcase. Set to true if the product is hidden from the showcase.
The product’s add status for the request origin. For SHOWCASE, ADDED indicates that the product is in the showcase, while REJECTED indicates that the product is rejected for use in the current context. For LIVE, ADDED means the product is already in the Live room’s product list (live bag), NOT_ADDED means the product can be added, and REJECTED means the product cannot be added.
The product source. This is an enumerated type with values:
- THIRD_PARTY
- AFFILIATE
- TIKTOK_STORE
The product detail page URL.
The off-TikTok Shop product detail page URL.
A list of regions in which the product is offered for sale.
An object including data about commissions associated with the product.
object
The commission rate in hundredths of a percent. For example, 3587 is a commission rate of 35.87%. The range of this value is [100, 8000].
The reward commission rate in hundredths of a percent. For example, 3587 is a commission rate of 35.87%.
An object containing collaboration data for the product.
object
The collaboration identifier.
The collaboration type. This an enumerated type with values: 1 - Open Collaboration 2 - Target Collaboration 5 - Partner Campaign 11 - Flat Fee 12 - Collaboration Plus 13 - Affiliate Promotion
The partner information.
object
The partner identifier.
The partner name.
An opaque token used to retrieve the next page of a paginated result set.
Total count of products in the response.
Example
{ "code": 0, "data": { "products": [ { "id": "53219092314", "shop": { "name": "Gift store" }, "addition": { "customized_main_images": [ { "width": 100, "heigth": 100, "url": "https://p16-sign.tiktokcdn-us.com/tos-useast5-avt-0068-tx/d76b8cc1b598de90ad5048df46e672b3~c5_100x100.webp?x-expires=1691895600&x-signature=oAT9KOL7aCN3Did9U%2FoKEsbBDj0%3D" } ] }, "price": { "original_price": { "minimum_amount": "12.21", "maximum_amount": "100.00", "currency": "USD" }, "seller_discount_price": { "minimum_amount": "12.21", "maximum_amount": "100.00", "currency": "USD" }, "platform_discount_price": { "minimum_amount": "12.21", "maximum_amount": "100.00", "currency": "USD" } }, "title": "Chirstmas Gift", "main_images": [ { "width": 100, "heigth": 100, "url": "https://p16-sign.tiktokcdn-us.com/tos-useast5-avt-0068-tx/d76b8cc1b598de90ad5048df46e672b3~c5_100x100.webp?x-expires=1691895600&x-signature=oAT9KOL7aCN3Did9U%2FoKEsbBDj0%3D" } ], "status": { "inventory_status": "IN_STOCK", "review_status": "APPROVED", "is_hidden": false, "added_status": "ADDED" }, "source": "AFFILIATE", "detail_link": "https://shop.tiktok.com/view/product/248901892031?region=US&local=en", "third_party_link": "https://storename.myshopify.com/products/gold-bracelet-engraved-with-diamonds", "sale_regions": [ "US" ], "commission": { "rate": 3000, "reward_rate": 500 }, "collaboration": { "id": "7495383576027499219", "type": "1", "partner": { "id": "123456789", "name": "Partner Name" } } } ], "next_page_token": "V231as2V0PTAK", "total_count": 15 }, "message": "Success", "request_id": "202203070749000101890810281E8C70B7"}