stable本次发布有变化全部展示
来自 TikTok Shop 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存，可追溯
- 官方原文可核对
资料正文
§1 Path: /product/202602/packages/recommend
#§2 Method: [POST]
#§3 Function Description
Retrieve a list of product recommended packages. (Only available in BR and MX)
§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. |
| page_size | int | Y | 100 | The number of results to be returned per page. |
| Valid range: [1-100] | ||||
| page_token | string | N | b2Zmc2V0PTAK | An opaque token used to retrieve the next page of a paginated result set. Retrieve this value from the result of the next_page_token from a previous response. It is not needed for the first page. |
§6 Request Body Parameters
| Properties | Type | Require | Sample | Properties description |
|---|---|---|---|---|
| product_ids | []string | N | ["12345678", "12345679"] | The product IDs for which you want to recommended product packages. |
§7 Request Sample
Query
https://open-api.tiktokglobalshop.com/product/202602/packages/recommend?app_key=123abc&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c×tamp=1625484268&shop_cipher=ROW_RHkDDABBAAB8tKAVoAqsMTjsQZFLyNfY&page_size=100&page_token=b2Zmc2V0PTAK
Body
{"product_ids":["12345678","12345679"]}
§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 | |
| ^next_page_token | string | b2Zmc2V0PTAK | An opaque token used to retrieve the next page of a paginated result set. Provide this value in the page_token parameter of your request if the current response does not return all the results. |
| ^total_count | int | 200 | The list of products that meet the query conditions. |
| ^products | []object | The list of product recommended packages | |
| ^^product_id | string | 23423 | The product ID generated by TikTok Shop. |
| ^^abnormality_types | []string | ["Dimension","Weight"] | List of detected anomaly types. |
| ^^weight_recommendation | object | Weight correction recommendation (Returned only when the weight of product has been recommended ). | |
| ^^^unit | string | GRAM | Unit of weight, fixed as GRAM. |
| ^^^weight | object | Recommended values for weight. | |
| ^^^^min_value | string | 550 | Recommended range minimum; unit: g |
| ^^^^max_value | string | 650 | Recommended range maximum; unit: g |
| ^^dimension_recommendation | object | Dimension correction recommendation (Returned only when the dimensions of product has been recommended). | |
| ^^^unit | string | CENTIMETER | Unit of dimension, fixed as centimeter. |
| ^^^length | object | Recommended values for length. | |
| ^^^^min_value | string | 19 | Recommended range minimum; unit: cm |
| ^^^^max_value | string | 22 | Recommended range maximum; unit: cm |
| ^^^height | object | Recommended values for height (structure same as length). | |
| ^^^^min_value | string | 19 | Recommended range minimum; unit: cm |
| ^^^^max_value | string | 22 | Recommended range maximum; unit: cm |
| ^^^width | object | Recommended values for width (structure same as length). | |
| ^^^^min_value | string | 19 | Recommended range minimum; unit: cm |
| ^^^^max_value | string | 22 | Recommended range maximum; unit: cm |
§9 Response Sample
{"code":0,"data":{"next_page_token":"b2Zmc2V0PTAK","total_count":200,"products":[{"product_id":"23423","abnormality_types":["Dimension","Weight"],"weight_recommendation":{"unit":"GRAM","weight":{"min_value":"550","max_value":"650"}},"dimension_recommendation":{"unit":"CENTIMETER","length":{"min_value":"19","max_value":"22"},"height":{"min_value":"19","max_value":"22"},"width":{"min_value":"19","max_value":"22"}}}]},"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 |
|---|