stable本次发布有变化全部展示
来自 TikTok Shop 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存,可追溯
- 官方原文可核对
资料正文
§1 Path: /affiliate_creator/202405/showcases/products
#§2 Method: [GET]
#§3 Function Description
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.
§4 Common Parameters
For common parameters, refer to How to call TikTok Shop APIs - Common Parameters
| Properties | Location | Type | Require | Sample | Properties description |
|---|---|---|---|---|---|
| content-type | header | string | Y | application/json | Allowed type: application/json |
§5 Request Query Parameters
| Properties | Type | Require | Sample | Properties description |
|---|---|---|---|---|
| app_key | string | Y | 38abcd | Every single app will have a unique key. Please use the specific key assigned to your app. |
| sign | string | Y | 5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c | Signature generated by gen algorithm. When you send API requests to TTS, you must sign them so that TTS can identify the senders. |
| timestamp | int | Y | 1623812664 | Unix timestamp GMT (UTC+00:00). This timestamp is used across all API requests. Developers can use this convert to local time. |
| page_size | int | Y | 10 | The number of results to be returned per page. Valid range: [1-20]. |
| page_token | string | N | V231as2V0PTAK | 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. |
| origin | string | Y | LIVE | Set to LIVE to indicate the request originates from a Live room. Set to SHOWCASE to indicate that the request originates from the Showcase. |
§6 Request Sample
Query
https://open-api.tiktokglobalshop.com/affiliate_creator/202405/showcases/products?app_key=123abc&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c×tamp=1625484268&page_size=10&page_token=V231as2V0PTAK&origin=LIVE
§7 Response Parameters
| Properties | Type | Sample | Properties description |
|---|---|---|---|
| code | int | 0 | The success or failure status code returned in API response. |
| message | string | Success | The success or failure messages returned in API response. Reasons of failure will be described in the message. |
| request_id | string | 202203070749000101890810281E8C70B7 | Request log |
| data | object | Specific return information | |
| ^products | []object | A list of products. | |
| ^^id | string | 53219092314 | The product's product ID |
| ^^shop | object | Data and metadata associated with the Seller's TikTok Shop. | |
| ^^^name | string | Gift store | The TikTok Shop name. |
| ^^addition | object | An object including data about product images. | |
| ^^^customized_main_images | []object | A list of product images. | |
| ^^^^width | int | 100 | The image width in pixels. |
| ^^^^heigth | int | 100 | The image height in pixels. |
| ^^^^url | string | https://p16-sign.tiktokcdn-us.com/tos-useast5-avt-0068-tx/d76b8cc1b598de90ad5048df46e672b3~c5_100x100.webp?x-expires=1691895600&x-signature=oAT9KOL7aCN3Did9U%2FoKEsbBDj0%3D | The product's TikTok Shop image URL. |
| ^^price | object | An object including data about the product price. | |
| ^^^original_price | object | The original price of the product. | |
| ^^^^minimum_amount | string | 12.21 | The lowest original price for the product. |
| ^^^^maximum_amount | string | 100.00 | The highest original price for the product. |
| ^^^^currency | string | USD | The currency code. |
| ^^^seller_discount_price | object | An object including data about the product discount price. | |
| ^^^^minimum_amount | string | 12.21 | The lowest discount price. |
| ^^^^maximum_amount | string | 100.00 | The highest discount price. |
| ^^^^currency | string | USD | The currency code. |
| ^^^platform_discount_price | object | An object including data about the product platform discount price. | |
| ^^^^minimum_amount | string | 12.21 | The lowest product platform discount price. |
| ^^^^maximum_amount | string | 100.00 | The highest product platform discount price. |
| ^^^^currency | string | USD | The currency code. |
| ^^title | string | Chirstmas Gift | The product's display title. |
| ^^main_images | []object | A list of product images. | |
| ^^^width | int | 100 | The image width in pixels. |
| ^^^heigth | int | 100 | The image height in pixels. |
| ^^^url | string | https://p16-sign.tiktokcdn-us.com/tos-useast5-avt-0068-tx/d76b8cc1b598de90ad5048df46e672b3~c5_100x100.webp?x-expires=1691895600&x-signature=oAT9KOL7aCN3Did9U%2FoKEsbBDj0%3D | The product's TikTok Shop image URL. |
| ^^status | object | An object including product status information. | |
| ^^^inventory_status | string | IN_STOCK | The product inventory status. This an enumerated type with values: |
- IN_STOCK
- SOLD_OUT | ^^^review_status |string |APPROVED |The product review status. This is an enumerated type with values:
- APPROVED
- CHANGES_UNDER_REVIEW
- UNAVAILABLE
- ZERO_COMMISSION | ^^^is_hidden |bool |false |Set to
falseif the product is visible in the showcase. Set totrueif the product is hidden from the showcase. | ^^^added_status |string |ADDED |The product showcase status. This is an enumerated type with values: - NOT_ADDED
- ADDED
- REJECTED | ^^source |string |AFFILIATE |The product source. This is an enumerated type with values:
- THIRD_PARTY
- AFFILIATE
- TIKTOK_STORE | ^^detail_link |string |https://shop.tiktok.com/view/product/248901892031?region=US&local=en |The product detail page URL. | ^^third_party_link |string |https://storename.myshopify.com/products/gold-bracelet-engraved-with-diamonds |The off-TikTok Shop product detail page URL. | ^^sale_regions |[]string |["US"] |A list of regions in which the product is offered for sale. | ^^commission |object | |An object including data about commissions associated with the product. | ^^^rate |int |3000 |The commission rate in hundredths of a percent. For example,
3587is a commission rate of35.87%. The range of this value is [100, 8000]. | ^^^reward_rate |int |500 |The reward commission rate in hundredths of a percent. For example,3587is a commission rate of35.87%. | ^^collaboration |object | |An object including data about open or target collaboration for the product. | ^^^id |string |7495383576027499219 |The open or target collaboration identifier. | ^^^type |string |OPEN |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 | ^^^partner |object | |The partner information. | ^^^^id |string |123456789 |The partner identifier. | ^^^^name |string |Partner Name |The partner name. | ^next_page_token |string |V231as2V0PTAK |An opaque token used to retrieve the next page of a paginated result set. | ^total_count |int |15 |Total count of products in the response. |
§8 Response Sample
{"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\u0026x-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\u0026x-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\u0026local=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":"OPEN","partner":{"id":"123456789","name":"Partner Name"}}}],"next_page_token":"V231as2V0PTAK","total_count":15},"message":"Success","request_id":"202203070749000101890810281E8C70B7"}
§9 Error Code
For common error codes, refer to How to call TikTok Shop APIs - Common Error Code
| 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. |
