stable本次发布有变化全部展示
来自 TikTok Shop 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存，可追溯
- 官方原文可核对
资料正文
§1 Path: /affiliate_creator/202409/showcases/products/top
#§2 Method: [POST]
#§3 Function Description
Use this API to move products to the top in a creator's showcase. The platform will return the error code and error message if the pinning operation fails.
§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. |
§6 Request Body Parameters
| Properties | Type | Require | Sample | Properties description |
|---|---|---|---|---|
| product_ids | []string | Y | ["12390753231","7102893481290"] | The product IDs to move to the top in a creator's showcase. If multiple products are provided, they will display according to the order passed in this parameter. |
§7 Request Sample
Query
https://open-api.tiktokglobalshop.com/affiliate_creator/202409/showcases/products/top?app_key=123abc&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c×tamp=1625484268
Body
{"product_ids":["12390753231","7102893481290"]}
§8 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 | |
| ^code | int | 0 | The success or failure status code returned in API response. |
| ^message | string | Success | The success or failure messages are returned in API response. Reasons of failure will be described in the message. |
| ^request_id | string | 202203070749000101890810281E8C70B7 | Every request generates a unique request_id for logging purposes. |
§9 Response Sample
{"code":0,"data":{"code":0,"message":"Success","request_id":"202203070749000101890810281E8C70B7"},"message":"Success","request_id":"202203070749000101890810281E8C70B7"}
§10 Error Code
For common error codes, refer to How to call TikTok Shop APIs - Common Error Code
| Code | Message |
|---|---|
| 16015001 | Invalid parameter, the product Ids are not correct. Please ensure the products are in the showcase right now. |
| 16015027 | System error |