stable本次发布有变化全部展示
来自 TikTok Shop 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存，可追溯
- 官方原文可核对
资料正文
§1 Path: /fulfillment/202607/orders/customs_info/query
#§2 Method: [POST]
#§3 Function Description
This API is used to query whether an order requires extra customs clearance information, whether such information has been submitted, and the list of submitted customs clearance information. If extra customs clearance information is required but not yet provided, the merchant must complete and submit it before shipment can proceed.
§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. |
§6 Request Body Parameters
| Properties | Type | Require | Sample | Properties description |
|---|---|---|---|---|
| order_ids | []string | Y | ["584882846571464153","584881010662934016"] | Query list of TikTok Shop order IDs. |
§7 Request Sample
Query
https://open-api.tiktokglobalshop.com/fulfillment/202607/orders/customs_info/query?app_key=123abc&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c×tamp=1625484268
Body
{"order_ids":["584882846571464153","584881010662934016"]}
§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 | |
| ^order_clearance_list | []object | clearance info of this order | |
| ^^order_id | string | 584882846571463232 | TikTok Shop order ID |
| ^^need_fill_clearance | bool | true | Whether an order needs to fill customs infomation: |
- true: The order needs to fill in customs information.
- false: The order does not need to fill in custom information. | ^^already_filled_clearance |bool |false |Whether an order alreay filled customs infomation | ^^target_country |string |JP |Country Alpha-2 Code | ^^biz_type |int |1 |enum CustomsBusinessType { CustomsBusinessTypeFS = 1; CustomsBusinessTypePOP = 2; } | ^^shipment_type |int |1 |enum ShipmentType{ CROSS_BORDER = 1, LOCAL = 2, } | ^^item_list |[]object | |The number of packages | ^^^order_line_id |string |584882846571423334 |Sub order ID | ^^^product_id |string |1729476373250999503 |Product ID. | ^^^sku_id |string |1735885807280883357 |SKU ID. | ^^^is_virtual_unboxing |bool |true |Whether this sub order is virtual_unboxing | ^^^is_temporary_listing |bool |false |Whether this sub order is temporary_listing | ^^^related_item_detail |[]object | |item info releated to this sub order | ^^^^product_id |string |1729476373250999503 |Product ID. | ^^^^sku_id |string |1735885807280883357 |SKU ID. | ^^^^qty |int |2 |The amount of this sku | ^^^^price_percent |int |10 |unit: %, price_percent=10 means 10% |
§9 Response Sample
{"code":0,"data":{"order_clearance_list":[{"order_id":"584882846571463232","need_fill_clearance":true,"already_filled_clearance":false,"target_country":"JP","biz_type":1,"shipment_type":1,"item_list":[{"order_line_id":"584882846571423334","product_id":"1729476373250999503","sku_id":"1735885807280883357","is_virtual_unboxing":true,"is_temporary_listing":false,"related_item_detail":[{"product_id":"1729476373250999503","sku_id":"1735885807280883357","qty":2,"price_percent":10}]}]}]},"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 |
|---|---|
| 11001002 | invalid param. |
| 11036004 | system error, please retry |