Get Open Collaboration Sample Rules

Use this API to get the status and the details of the sample rules for products under an open collaboration. With this API, you can efficiently review the sample distribution criteria for products within the open collaboration context.

---

For common parameters, refer to How to call TikTok Shop APIs - Common Parameters

Query

https://open-api.tiktokglobalshop.com/affiliate_seller/202410/open_collaborations/sample_rules?app_key=123abc&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c&timestamp=1625484268&shop_cipher=ROW_RHkDDABBAAB8tKAVoAqsMTjsQZFLyNfY&product_ids=172979,848746

• If true, it means available all the time
• If false, it means sample only available from begin_time to end_time. | ^^status |string |ONGOING |Free sample rule status:
• NOT_STARTED. Not yet reached the specified begin_time.
• ONGOING. The sample rule is effective and the collaboration is ongoing.
• NO_LEFT_COUNT. sample_quantity_available is 0.
• PLAN_EXCEPTION. The product commission collaboration status is abnormal
• EXPIRED. Exceeded the end_time. | ^^available_quantity |int |50 |The quantity of remaining samples available for application. | ^^start_time |int |1728546888 |The start time of the period during which a creator can apply for samples. You must specify start_time and end_time together. | ^^end_time |int |1728546888 |The end time of the period during which a creator can apply for samples. | ^^thresholds |object | |The threshold criteria that a creator must meet to be eligible to apply for the sample. | ^^^minimum_follower_count |int |200 |The creator must have a follower count greater than this value to be eligible to request the sample. | ^^^minimum_gmv |int |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 |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 |["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 |ALL |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. |

{"code":0,"data":{"sample_rules":[{"product_id":"123456","sample_quota":100,"is_sample_time_unlimited":true,"status":"ONGOING","available_quantity":50,"start_time":1728546888,"end_time":1728546888,"thresholds":{"minimum_follower_count":200,"minimum_gmv":1000,"avg_ec_video_views":5,"category_ids":["601152"],"predicted_fulfillment_rank":"ALL"}}]},"message":"Success","request_id":"202203070749000101890810281E8C70B7"}

For common error codes, refer to How to call TikTok Shop APIs - Common Error Code