stable本次发布有变化全部展示
来自 TikTok Shop 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存，可追溯
- 官方原文可核对
资料正文
§1 Path: /affiliate_creator/202509/open_collaborations/products
#§2 Method: [POST]
#§3 Function Description
Get Product OpenCollaboration Product List By Product Ids
§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. |
| product_ids | []string | N | 123,456 | product id list |
§6 Request Sample
Query
https://open-api.tiktokglobalshop.com/affiliate_creator/202509/open_collaborations/products?app_key=123abc&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c×tamp=1625484268&product_ids=123,456
Body
{}
§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 | |
| ^products | []object | These are the searched products. | |
| ^^shop | object | The product's shop information. | |
| ^^^name | string | Test shop | The name of the shop to which the product belongs. |
| ^^id | string | 1729432087292775344 | Product's unique id. |
| ^^has_inventory | bool | false | Whether this product has inventory. |
| ^^units_sold | int | 12 | The total sales of this product. |
| ^^title | string | Blue t-shirt | Product's name. |
| ^^sale_region | string | ID | The region represents the areas where the product can be sold. |
| ^^main_image_url | string | https://p16-oec-va.ibyteimg.com/tos-maliva-i-o3syd03w52-us/fa0387fa5a204dcfa44d5be75877a163~tplv-o3syd03w52-origin-webp.webp?from=3478900499 | The product image url. |
| ^^detail_link | string | https://shop.tiktok.com/view/product/1729624807198591373?region=ID&local=en | Product's detail link which is used to get product details on mobile clients. |
| ^^original_price | object | The product's original price | |
| ^^^currency | string | USD | The currency in the sale region. |
| ^^^minimum_amount | string | 12.21 | The minimum original price of all skus of this product. |
| ^^^maximum_amount | string | 100.00 | The maximum original price of all skus of this product. |
| ^^category_chains | []object | The categories of this product. | |
| Return to the top three categories at most | |||
| ^^^id | string | 3435545 | The current category id of this product. |
| ^^^local_name | string | COMPUTER | The current level category name of this product. |
| ^^^is_leaf | bool | false | Indicate whether current node is leaf node |
| ^^^parent_id | string | 12345 | The category id of its parent category |
| ^^commission | object | The commission of this product. | |
| ^^^rate | int | 100 | - The commission rate for this product is set by merchants for creators public promotion. |
- The range of this value is [100, 8000].
- This value equals actual commission rate multi 10000. For example: 3000 means the actual commission rate is 30.00%, and 3555 means 35.55% | ^^^currency |string |USD |Currency symbol | ^^^amount |string |123 |The commission for this product is calculated by multiplying the promotional price with the commission rate for each promotional order. The currency symbol is same as the currency symbol in price | ^^sales_price |object | |Sales price information of the product | ^^^currency |string |USD |Currency symbol for sales area | ^^^minimum_amount |string |34.3 |The minimum promotion price of all skus of this product. | ^^^maximum_amount |string |55.7 |The maximum promotion price of all skus of this product. | ^^shop_ads_commission |object | |The ads commission rate applies only to orders generated from ads. If a creator’s video is used as an ad without this rate being set, the resulting orders will instead earn either:
- The Shop Ads commission you configured in open collaboration, or
- The standard commission defined in this invitation. | ^^^rate |int |100 |- The commission rate for this product is set by merchants for creators public promotion.
- The range of this value is [100, 8000].
- This value equals actual commission rate multi 10000. For example: 3000 means the actual commission rate is 30.00%, and 3555 means 35.55% |
§8 Response Sample
{"code":0,"data":{"products":[{"shop":{"name":"Test shop"},"id":"1729432087292775344","has_inventory":false,"units_sold":12,"title":"Blue t-shirt","sale_region":"ID","main_image_url":"https://p16-oec-va.ibyteimg.com/tos-maliva-i-o3syd03w52-us/fa0387fa5a204dcfa44d5be75877a163~tplv-o3syd03w52-origin-webp.webp?from=3478900499","detail_link":"https://shop.tiktok.com/view/product/1729624807198591373?region=ID\u0026local=en","original_price":{"currency":"USD","minimum_amount":"12.21","maximum_amount":"100.00"},"category_chains":[{"id":"3435545","local_name":"COMPUTER","is_leaf":false,"parent_id":"12345"}],"commission":{"rate":100,"currency":"USD","amount":"123"},"sales_price":{"currency":"USD","minimum_amount":"34.3","maximum_amount":"55.7"},"shop_ads_commission":{"rate":100}}]},"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 |
|---|