stable本次发布有变化全部展示
来自 TikTok Shop 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存，可追溯
- 官方原文可核对
资料正文
§1 Path: /affiliate_creator/202509/shop_products
#§2 Method: [GET]
#§3 Function Description
Developer can utilize this API to search and retrieve products information of shop which is bound by a specific creator with specific keywords.
§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. |
| title_keyword | string | N | apple | The title keyword of the product you wish to search by. |
| sort_field | string | N | PRODUCT_ID | Sort fields include PRODUCT_ID, PRICE and SALE. If sort_field is empty or invalid, PRODUCT_ID will be set as default. |
| sort_order | string | N | DESC | Sort orders include DESC and ASC. If sort order is empty or invalid, DESC will be set as default. |
| page_size | int | Y | 20 | Pagination count determines how many products you'll get after sending the request. 20 is a recommended number. |
| Valid Range: [1-100] | ||||
| page_token | string | N | b2Zmc2V0PTAK | The pagination offset that determines where you begin your search. If you are making your first request, this will be empty. |
§6 Request Sample
Query
https://open-api.tiktokglobalshop.com/affiliate_creator/202509/shop_products?app_key=123abc&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c×tamp=1625484268&title_keyword=apple&sort_field=PRODUCT_ID&sort_order=DESC&page_size=20&page_token=b2Zmc2V0PTAK
§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 | The searched product list. It will be empty when there are no search results. | |
| ^^id | string | 1729592969712207012 | TikTok product ID. |
| ^^title | string | testcase autotest Live Product | Product name. |
| ^^price | object | Product price shown with two decimal places and currency. | |
| ^^^amount | string | 56.00 | Product price with two decimal places. |
| ^^^currency | string | USD | Product price currency, based on region where creators can sell. |
| ^^added_status | string | ADDABLE | |
| Showcase add status with possible values: |
- ADDABLE
- ADDED
- REJECTED | ^^brand_name |string |Apple |The brand name a seller has set for a product. | ^^images |[]object | |Images of a product. | ^^^url |string |https://p19-pu-sign-useast8.tiktokcdn-us.com/tos-useast5-avt-0068-tx/982dd6b4e46a6a24203b00611a474cca~c5_1080x1080.webp |The URL of the product image. | ^^^width |int |200 |The width of the product image. | ^^^height |int |200 |The height of the product image. | ^^sales_count |int |33 |The number of products that have been sold. | ^total_count |int |300 |The total number of products that meet the query conditions. | ^next_page_token |string |b2Zmc2V0PTAK |The pagination token is a cursor used for pagination. The token is returned in the previous pagination query to determine the current position. It will be empty when there aren't any products to search for. |
§8 Response Sample
{"code":0,"data":{"products":[{"id":"1729592969712207012","title":"testcase autotest Live Product","price":{"amount":"56.00","currency":"USD"},"added_status":"ADDABLE\n","brand_name":"Apple","images":[{"url":"https://p19-pu-sign-useast8.tiktokcdn-us.com/tos-useast5-avt-0068-tx/982dd6b4e46a6a24203b00611a474cca~c5_1080x1080.webp","width":200,"height":200}],"sales_count":33}],"total_count":300,"next_page_token":"b2Zmc2V0PTAK"},"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 |
|---|