stable本次发布有变化全部展示
来自 TikTok Shop 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存，可追溯
- 官方原文可核对
资料正文
§1 Path: /affiliate_seller/202410/open_collaborations/sample_rules
#§2 Method: [POST]
#§3 Function Description
Use this API to manage sample rules in open collaborations, like valid time periods, or thresholds for creators to request samples. You can create, update, or deactivate rules.
§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 |
|---|---|---|---|---|
| product_id | string | Y | 123456 | The product ID to which the sample rule applies. You can only assign one sample rule for one product_id. Only the most recent API call will take effect. |
| sample_rule | object | N | Sample rule | |
| ^sample_quota | int | N | 100 | The total quantity of the samples provided by the seller that the creators can apply for. |
| ^is_sample_time_unlimited | bool | N | true | Whether the sample is always available for application: |
- If true, the sample can be requested at any time.
- If false, the sample can only be requested during specified time periods. You must set start_time and end_time. | ^start_time |int |N |1728552553 |The start time of the period during which a creator can apply for samples. You must specify
start_timeandend_timetogether. | ^end_time |int |N |1728552553 |The end time of the period during which a creator can apply for samples. You must specifystart_timeandend_timetogether. | ^thresholds |object |N | |The threshold criteria that a creator must meet to be eligible to apply for the sample. | ^^minimum_follower_count |int |N |2000 |The creator must have a follower count greater than this value to be eligible to request the sample. | ^^minimum_gmv |int |N |1000 |The creator must have the GMV in the past 30 days greater than this value to be eligible to request the sample. | ^^avg_ec_video_views |int |N |5 |The creator must have the average views of e-commerce videos in the past 30 days greater than this value to be eligible to request the sample. | ^^category_ids |[]string |N |["601152"] |A list of product first-level category IDs. Use this to limit participating creators: for each creator, sort their GMV over the past 30 days by first-level product category. If the GMV of one of the categories is among the top three, the creator is eligible to participate in the event. No restriction by default. For example, if a creator's top three categories are [{Cellphone_ID}, {Furniture_ID}, {Food_ID}], and the value of tehis parameter is[{Food_ID}], the creator is qualified for open collaboration. | ^^predicted_fulfillment_rank |string |N |LOW |The creators whose predicted rate of posting a shoppable video or LIVE after receiving a sample. - ALL. All creators regardless of the rate.
- LOW. The creators whose rate is above or equal to low.
- MEDIUM. The creators whose rate is above or equal to medium.
- HIGH. The creators whose rate is high. | ^activate_status |string |Y |ACTIVATE |To activate the sample rule, use
ACTIVATE; to deactivate the sample rule, useDEACTIVATE. When usingACTIVATE, you must specify the details of the rule; when usingDEACTIVATE, you just need to specifyproduct_id. |
§7 Request Sample
Query
https://open-api.tiktokglobalshop.com/affiliate_seller/202410/open_collaborations/sample_rules?app_key=123abc&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c×tamp=1625484268&shop_cipher=ROW_RHkDDABBAAB8tKAVoAqsMTjsQZFLyNfY
Body
{"product_id":"123456","sample_rule":{"sample_quota":100,"is_sample_time_unlimited":true,"start_time":1728552553,"end_time":1728552553,"thresholds":{"minimum_follower_count":2000,"minimum_gmv":1000,"avg_ec_video_views":5,"category_ids":["601152"],"predicted_fulfillment_rank":"LOW"},"activate_status":"ACTIVATE"}}
§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 |
§9 Response Sample
{"code":0,"data":{},"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 |
|---|