stable本次发布有变化全部展示
来自 TikTok Shop 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存，可追溯
- 官方原文可核对
资料正文
§1 Path: /affiliate_creator/202405/showcases/products/add
#§2 Method: [POST]
#§3 Function Description
This API adds the products to the creator's showcase. The platform will return the add status of the products, and error code and error message if the deletion 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 |
|---|---|---|---|---|
| add_type | string | Y | PRODUCT_ID | Specifies how products are added to the showcase. This an enumerated type with values: |
- PRODUCT_ID
- PRODUCT_LINK | product_ids |[]string |N |["12390753231","7102893481290"] |A list of product identifiers included if
add_typeis set toPRODUCT_ID. The products associated with the identifiers are added to the showcase. Maximum length of the list is 20 product identifiers. | product_link |string |N |https://www.example.com/api/v1/share/AImHx6DlXqP1 |A list of product URLs included ifadd_typeis set toPRODUCT_LINK. The products associated with the URLs are added to the showcase. Maximum length of the list is 20 product URLs. |
§7 Request Sample
Query
https://open-api.tiktokglobalshop.com/affiliate_creator/202405/showcases/products/add?app_key=123abc&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c×tamp=1625484268
Body
{"add_type":"PRODUCT_ID","product_ids":["12390753231","7102893481290"],"product_link":"https://www.example.com/api/v1/share/AImHx6DlXqP1"}
§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 | |
| ^errors | []object | A list of product showcase addition errors. | |
| ^^code | int | 16001001 | The error code. |
| ^^message | string | Encounter network error, please try again. | A human-readable error message. |
| ^^detail | object | Additional detail about the product showcase addition error. | |
| ^^^product_id | string | 12390753231 | The product identifier. |
§9 Response Sample
{"code":0,"data":{"errors":[{"code":16001001,"message":"Encounter network error, please try again.","detail":{"product_id":"12390753231"}}]},"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 |
|---|