stable本次发布有变化全部展示
来自 TikTok Shop 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存，可追溯
- 官方原文可核对
资料正文
§1 Path: /order/202606/pod_details/search
#§2 Method: [POST]
#§3 Function Description
Description of [POST]/order/:version/pod_details/search
§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. |
§6 Request Body Parameters
| Properties | Type | Require | Sample | Properties description |
|---|---|---|---|---|
| main_order_id | string | Y | 577449529742299260 | TikTok Shop order ID. |
| query_order_lines | []object | Y | Order lines that need to query pod info. | |
| ^order_line_id | string | Y | 577449529742430332 | The unique identifier of the order line item. |
| ^product_id | string | Y | 1732453831920750867 | The unique identifier of the product. |
| ^sku_id | string | Y | 1732453830297817363 | The unique identifier of the sku. |
| ^pod_order_data_id | string | Y | 122343 | The unique identifier of the pod data. |
§7 Request Sample
Query
https://open-api.tiktokglobalshop.com/order/202606/pod_details/search?app_key=123abc&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c×tamp=1625484268&shop_cipher=ROW_RHkDDABBAAB8tKAVoAqsMTjsQZFLyNfY
Body
{"main_order_id":"577449529742299260","query_order_lines":[{"order_line_id":"577449529742430332","product_id":"1732453831920750867","sku_id":"1732453830297817363","pod_order_data_id":"122343"}]}
§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 | |
| ^pod_details | []object | Pod customization order information. | |
| ^^order_line_id | string | 577457287176491132 | The pod customization Json string. |
| ^^pod_detail | string | pod_info_json | The unique identifier of the order line item. |
| ^status_code | int | 0 | response status |
§9 Response Sample
{"code":0,"data":{"pod_details":[{"order_line_id":"577457287176491132","pod_detail":"pod_info_json"}],"status_code":0},"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 |
|---|