Skip to main content

GET Get Showcase Products

Get Showcase Products Creator Required scope: creator.showcase.reador creator.video.write 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. Version 202405

GET/affiliate_creator/202405/showcases/products

Request

Header

PropertiesTypeDescription
content-type RequiredstringAllowed type: application/json
x-tts-access-token RequiredstringThe creator access_token value from Get Access Token, when user_type = 1. Follow this guide to get creator access_token.

Query

PropertiesTypeDescription
app_key RequiredstringEvery single app will have a unique key. Please use the specific key assigned to your app.
sign RequiredstringSignature generated by gen algorithm. When you send API requests to TTS, you must sign them so that TTS can identify the senders.
timestamp RequiredintUnix timestamp GMT (UTC+00:00). This timestamp is used across all API requests. Developers can use this convert to local time.
page_size RequiredintThe number of results to be returned per page. Valid range: [1-20].
page_tokenstringAn 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.
origin RequiredstringSet to LIVE to indicate the request originates from a Live room. Set to SHOWCASE to indicate that the request originates from the Showcase.

Example

CurlGoNode.jsJavaEnable word wrap

Response Parameters

PropertiesTypeDescription
codeintThe success or failure status code returned in API response.
messagestringThe success or failure messages returned in API response. Reasons of failure will be described in the message.
request_idstringRequest log
dataobjectSpecific return information

Example

JSONEnable word wrap

Error Code

View common error codes

| Code | Message | | --- | --- | | 18001405 | This creator account has no selection region. | | 36009003 | Internal error. Please try again. If the issue persists after multiple attempts, please contact platform support. |

Is this content helpful?Helpful

Not Helpful

PreviousNext