stable本次发布有变化全部展示
来自 TikTok Shop 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存，可追溯
- 官方原文可核对
资料正文
§1 Path: /affiliate_seller/202608/target_collaborations/creator_promotion_details/query
#§2 Method: [POST]
#§3 Function Description
Query the creator commission rate, number of promotional video contents and number of live‑stream promotions for specified creator, specified invitation and specified product.
§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 Body Parameters
| Properties | Type | Require | Sample | Properties description |
|---|---|---|---|---|
| creator_user_open_id | string | Y | abc | Creator open id |
| invitation_group_id | string | Y | 1234 | Invitation Group Id |
| query | string | N | abc | Query value |
| query_type | string | N | PRODUCT_ID | Query type, e.g. |
- PRODUCT_ID: query by product id -PRODUCT_NAME: query by product name | invitation_id |string |N |1234 |Creator Invitation Id | product_filter |object |N | |Product Fitler | ^added_types |[]string |N |["ALL"] |Product added type list, support status: -ALL: all status -ADDED: creator added product NOT_ADDED: creator not added product |
§7 Request Sample
Query
https://open-api.tiktokglobalshop.com/affiliate_seller/202608/target_collaborations/creator_promotion_details/query?app_key=123abc&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c×tamp=1625484268&shop_cipher=ROW_RHkDDABBAAB8tKAVoAqsMTjsQZFLyNfY
Body
{"creator_user_open_id":"abc","invitation_group_id":"1234","query":"abc","query_type":"PRODUCT_ID","invitation_id":"1234","product_filter":{"added_types":["ALL"]}}
§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 | |
| ^data | object | Response data | |
| ^^product_details | []object | Product detail infomation | |
| ^^^product_base_info | object | Product basic infomation | |
| ^^^^product_id | string | 1234 | Product ID |
| ^^^^title | string | product title | Product titile |
| ^^^^image | object | Product Image | |
| ^^^^^url | string | https://p16-oec-va.ibyteimg.com/tos-maliva-i-o3syd03w52-us/2ca53c34ad8443e6b39f4e0153d3aed4~tplv-o3syd03w52-origin-image.image?from=1320446476 | Product Image URL |
| ^^^^price | object | Product Price | |
| ^^^^^min_price | object | Product min price | |
| ^^^^^^amount | string | 1 | Price amout |
| ^^^^^^currency | string | GBP | Price currency |
| ^^^^^max_price | object | Product max price | |
| ^^^^^^amount | string | 1 | Product amount |
| ^^^^^^currency | string | GBP | Product currency |
| ^^^^promotion_price | object | Product promotion price | |
| ^^^^^min_price | object | Product promotion min price | |
| ^^^^^^amount | string | 1 | Price amount |
| ^^^^^^currency | string | GBP | Price currency |
| ^^^^^max_price | object | Product promotion max price | |
| ^^^^^^amount | string | 1 | Price amount |
| ^^^^^^currency | string | GBP | Price currency |
| ^^^^target_commission | int | 2200 | Product target collaboration commission. e.g. 2200 mean 22% commission rate |
| ^^^^open_commission | int | 2200 | Product open collaboration commission. e.g. 2200 mean 22% commission rate |
| ^^^^target_ads_commission | int | 2200 | Product target ads collaboration commission |
| ^^^^old_target_commission | int | 2200 | Product old target collaboration commission |
| ^^^^old_target_ads_commission | int | 2200 | Product old target ads collaboration commission |
| ^^^^commission_effective_time | int | 1786592565735 | Commission effective time(millisecond) |
| ^^^^ads_commission_effective_time | int | 1786592565735 | Ads commission effective time(millisecond) |
| ^^^^product_status | string | 1 | Product status |
| 1: Active | |||
| 2; Sold out | |||
| 3: product deactivated by seller; | |||
| 4: product deactivated by platform | |||
| 5: product reject | |||
| 6: product deleted | |||
| ^^^product_add_status | bool | false | Product added or not |
| ^^^video_count | int | 1 | Creator post video count in collaboration |
| ^^^live_count | int | 1 | Creator LIVE count in collaboration |
| ^^^is_commission_effective | bool | false | Collaboration effective or not |
§9 Response Sample
{"code":0,"data":{"data":{"product_details":[{"product_base_info":{"product_id":"1234","title":"product title","image":{"url":"https://p16-oec-va.ibyteimg.com/tos-maliva-i-o3syd03w52-us/2ca53c34ad8443e6b39f4e0153d3aed4~tplv-o3syd03w52-origin-image.image?from=1320446476"},"price":{"min_price":{"amount":"1","currency":"GBP"},"max_price":{"amount":"1","currency":"GBP"}},"promotion_price":{"min_price":{"amount":"1","currency":"GBP"},"max_price":{"amount":"1","currency":"GBP"}},"target_commission":2200,"open_commission":2200,"target_ads_commission":2200,"old_target_commission":2200,"old_target_ads_commission":2200,"commission_effective_time":1786592565735,"ads_commission_effective_time":1786592565735,"product_status":"1"},"product_add_status":false,"video_count":1,"live_count":1,"is_commission_effective":false}]}},"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 |
|---|