stable本次发布有变化全部展示
来自 TikTok Shop 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存，可追溯
- 官方原文可核对
资料正文
§1 Path: /fbt/202603/ship_inbound_order
#§2 Method: [POST]
#§3 Function Description
Finalizes the shipment details for a specific inbound order, including carton information and shipping methods.
§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 |
|---|---|---|---|---|
| inbound_order_id | string | Y | 5766071177167344427 | Identifier of the inbound order to ship. |
| cartons | []object | N | Carton list. | |
| ^carton_type | string | Y | SINGLE_SKU | Indicates if this is a single SKU carton or multi SKU carton. |
| Possible values: |
SINGLE_SKUMULTI_SKU| ^items |[]object |Y | |Goods item list of a carton. | ^^goods_id |string |Y |723456789012345678 |Identifier of the goods item in the carton. | ^^quantity |int |Y |100 |Quantity of this goods. | ^^lot_code |string |N |sfsfnjkfvv |Lot code of this goods. | ^^expiration_timestamp |string |N |1623812664 |The expiration date for this item, Unix timestamp in seconds. | ^quantity |int |Y |2 |Carton quantity. | ^carton_nums |[]string |N |["C0001","C0002"] |Carton numbers. | ^box_measurements |object |Y | |Carton measurement. | ^^weight |string |Y |10 |Carton weight. | ^^weight_unit |string |Y |POUNDS |The unit of measurement used for the weight of the items or cartons in this shipment.
Possible values:
KILOGRAM(kg)GRAM(g)MILLIGRAM(mg)POUNDS(lbs)OUNCE(oz) | ^^width |string |Y |20 |Carton width. | ^^height |string |Y |2 |Carton height. | ^^length |string |Y |3 |Carton length. | ^^length_unit |string |Y |INCH |The unit of measurement used for the dimensions (length, width, height) of the items or cartons in this shipment.
Possible values:
METER(m)CENTIMETER(cm)MILLIMETER(mm)FOOT(ft)MICRON(μm)INCH(in) | shipment_option |object |Y | |Shipment option containing freight type and shipping method. | ^shipping_method |string |Y |SMALL_PARCEL |Shipping method. Possible values: SMALL_PARCEL (small parcel shipping); FREIGHT (freight shipping). | ^freight_type |string |N |FTL |Possible values:FTLLTL|
§7 Request Sample
Query
https://open-api.tiktokglobalshop.com/fbt/202603/ship_inbound_order?app_key=123abc&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c×tamp=1625484268&shop_cipher=ROW_RHkDDABBAAB8tKAVoAqsMTjsQZFLyNfY
Body
{"inbound_order_id":"5766071177167344427","cartons":[{"carton_type":"SINGLE_SKU","items":[{"goods_id":"723456789012345678","quantity":100,"lot_code":"sfsfnjkfvv","expiration_timestamp":"1623812664"}],"quantity":2,"carton_nums":["C0001","C0002"],"box_measurements":{"weight":"10","weight_unit":"POUNDS","width":"20","height":"2","length":"3","length_unit":"INCH"}}],"shipment_option":{"shipping_method":"SMALL_PARCEL","freight_type":"FTL"}}
§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 | |
| ^inbound_order_id | string | 5766071177167344427 | Identifier of the shipped inbound order. |
§9 Response Sample
{"code":0,"data":{"inbound_order_id":"5766071177167344427"},"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 |
|---|---|
| 36009003 | Internal error. Please try again. If the issue persists after multiple attempts, please contact platform support. |
| 39001002 | Request or request parameters are empty. Please recheck the input parameters. |