stable本次发布有变化全部展示
来自 TikTok Shop 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存，可追溯
- 官方原文可核对
资料正文
§1 Path: /affiliate_seller/202409/open_collaboration_settings
#§2 Method: [GET]
#§3 Function Description
Get the open collaboration settings, including auto add settings.
§4 Common Parameters
For common parameters, refer to How to call TikTok Shop APIs - Common Parameters
| Properties | Location | Type | Require | Sample | Properties description |
|---|---|---|---|---|---|
| shop_cipher | query | string | Y | GCP_XF90igAAAABh00qsWgtvOiGFNqyubMt3 | Use this property to pass shop information in requesting the API. Failure in passing the correct value when requesting the API for cross-border shops will return incorrect response. |
| Get by API Get Authorization Shop | |||||
| 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 Sample
Query
https://open-api.tiktokglobalshop.com/affiliate_seller/202409/open_collaboration_settings?app_key=123abc&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c×tamp=1625484268&shop_cipher=ROW_RHkDDABBAAB8tKAVoAqsMTjsQZFLyNfY
§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 | |
| ^open_collaboration_settings | object | Settings detail | |
| ^^auto_add_product | object | Setting for auto add products to affiliate | |
| ^^^enable | bool | true | - true: The seller can add existing non-affiliate products to open collaboration at one time, and future products will also be added automatically. |
- false: Future products will not be added to open collaboration automatically, but existing products' open collaboration will not be reverted. | ^^^commission_rate |int |1000 |The default commission rate of open collaboration created for the auto-added products. The unit is 0.01%. For example, to set the default commission rate to 10%, set the value to
1000. If so, if the price of a product is $50 USD, the creator would receive $5 USD for every piece of product sold. The range is[100, 8000]. When enable=false, this field will not be returned. |
§8 Response Sample
{"code":0,"data":{"open_collaboration_settings":{"auto_add_product":{"enable":true,"commission_rate":1000}}},"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 |
|---|