stable本次发布有变化全部展示
来自 TikTok Shop 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存，可追溯
- 官方原文可核对
资料正文
§1 Path: /affiliate_creator/202405/open_collaborations/products/search
#§2 Method: [POST]
#§3 Function Description
This API is used to search the information of products with open collaboration by category, commission rate, and keywords. It will return all products on the TikTok Shop Affiliate Product Marketplace that are in an open collaboration. Creators can only search for open collaboration within the regions they are registered in the affiliate.
§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. |
| page_token | string | N | b2Zmc2V0PTAK | Pagination offset determines where you begin to search for. It's empty when raise your first request. |
| page_size | int | Y | 20 | The value of "page_size" must be greater than 0 and less than or equal to 20. |
| sort_field | string | N | commission_rate | The returned results are sorted by the specified field. |
Possible values:
- commission_rate
- product_sales_price
- commission
- units_sold
Specify the sort order using the sort_order parameter.
|
sort_order |string |N |DESC |The sort order for the objects in the response. Default: ASC
Possible values:
- ASC: Ascending order
- DESC: Descending order |
§6 Request Body Parameters
| Properties | Type | Require | Sample | Properties description |
|---|---|---|---|---|
| title_keywords | []string | N | ["Men", "Fashion"," Sports Short"] | A list of product keywords for searching. Product titles, or names, are loosely matched. Keywords in the list form a query and the resulting set of matching product names is based on the conjunctive operator AND between each keyword. For example, the keyword list ["Men", "Fashion"] creates a query "Men" AND "Fashion" and the resulting set of matching product names contains the loosely matched conjuction of "Men" and "Fashion" such as "Male Fashionable". Maximum length of the list is 20 keywords. Maximum keyword string length is 255 characters. |
| sales_price_range | object | N | Restricts the products in the search results to those with prices greater than or equal to the expressed minimum price and less than the expressed maximum price. | |
| ^amount_ge | string | N | 12.44 | The product price must be greater than this value in order to be included in the search results. The value must be greater than 0. |
| ^amount_lt | string | N | 100 | The product price must be greater than this value in order to be included in the search results. The value must be greater than 0. No upper bound is set if this property is not included. |
| category | object | N | Restricts the products in the search results to those that are associated with the expressed product category. | |
| ^id | string | N | 341234 | The category identifier. Note that only first-level categories are supported. |
| commission_rate_range | object | N | The commission rate of the searched product needs to be limited within this range. | |
| ^rate_ge | int | N | 100 | The commission rate must be greater than this value in order to be included in the search results. The commission rate is expressed in hundredths of a percent. For example, 3587 is a commission rate of 35.87%. This value must a minimum of 1000. |
| ^rate_lt | int | N | 8000 | The commission rate must be less than this value in order to be included in the search results. The commission rate is expressed in hundredths of a percent. For example, 3587 is a commission rate of 35.87%. This value must a minimum of 1000. |
§7 Request Sample
Query
https://open-api.tiktokglobalshop.com/affiliate_creator/202405/open_collaborations/products/search?app_key=123abc&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c×tamp=1625484268&page_token=b2Zmc2V0PTAK&page_size=20&sort_field=commission_rate&sort_order=DESC
Body
{"title_keywords":["Men","Fashion"," Sports Short"],"sales_price_range":{"amount_ge":"12.44","amount_lt":"100"},"category":{"id":"341234"},"commission_rate_range":{"rate_ge":100,"rate_lt":8000}}
§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 | |
| ^products | []object | A list of products. | |
| ^^shop | object | Data and metadata associated with the Seller's TikTok Shop. | |
| ^^^name | string | Test shop | The TikTok Shop name. |
| ^^id | string | 1729432087292775344 | The product identifier. |
| ^^has_inventory | bool | false | Set to true if there are more than zero units of the product in inventory. Set to false if there are zero units in inventory. |
| ^^units_sold | int | 12123 | Total number of units sold. Units are indexed to SKU. Note that if the creator has not given permission for precise data sharing, this property will not be present. |
| ^^title | string | Blue t-shirt | The product name. |
| ^^sale_region | string | ID | The region where the product is offered for sale. |
| ^^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 | The URL for the product's detail page. |
| ^^original_price | object | The original price of the product. | |
| ^^^currency | string | USD | The currency code. |
| ^^^minimum_amount | string | 12.21 | The lowest original price of all SKUs of the product. |
| ^^^maximum_amount | string | 100.00 | The highest original price of all SKUs of the product. |
| ^^category_chains | []object | A list of categories associated with the product. Maximum length of the list is 3 categories. | |
| ^^^id | string | 343554 | The category identifier. |
| ^^^local_name | string | COMPUTER | The name of the product in the category. |
| ^^^is_leaf | bool | false | Set to true if this category is a leaf node. Set to false if not. |
| ^^^parent_id | string | 341182 | The category identifier of the parent category. |
| ^^commission | object | Metadata and data associated with the commission rates for the product. | |
| ^^^rate | int | 3000 | The commission rate in hundredths of a percent. For example, 3587 is a commission rate of 35.87%. This value must a minimum of 1000. The range of this value is [100, 8000]. |
| ^^^currency | string | USD | The currency code. |
| ^^^amount | string | 121.32 | The commission amount. |
| ^^sales_price | object | Metadata and data associated with the sale price of the product | |
| ^^^currency | string | USD | The currency code. |
| ^^^minimum_amount | string | 34.3 | The lowest promotion price of all SKUs of this product. |
| ^^^maximum_amount | string | 55.7 | The highest promotion price of all SKUs of this product. |
| ^next_page_token | string | b2Zmc2V0PTEw | An opaque token used to retrieve the next page of a paginated result set. |
| ^total_count | int | 10000 | Total count of products meeting the search criteria expressed in the request body. |
§9 Response Sample
{"code":0,"data":{"products":[{"shop":{"name":"Test shop"},"id":"1729432087292775344","has_inventory":false,"units_sold":12123,"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":"343554","local_name":"COMPUTER","is_leaf":false,"parent_id":"341182"}],"commission":{"rate":3000,"currency":"USD","amount":"121.32"},"sales_price":{"currency":"USD","minimum_amount":"34.3","maximum_amount":"55.7"}}],"next_page_token":"b2Zmc2V0PTEw","total_count":10000},"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 |
|---|