stable本次发布有变化全部展示
来自 TikTok Shop 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存，可追溯
- 官方原文可核对
资料正文
§1 Path: /fbt/202602/inbound_method_detail
#§2 Method: [POST]
#§3 Function Description
Get detailed information regarding inbound plan placement options.
§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 |
|---|---|---|---|---|
| plan_id | string | Y | 5766071177167344427 | Inbound plan identifier |
| inbound_method | string | Y | D2FC | Possible values: |
D2FC(Direct to fulfillment center, may be split into multiple shipments)ONE_HUB(Single destination, includes fee) | estimate_arrival_time |object |Y | |Estimated arrival time. Value should be retrieved from theavailable_time_window_listfromListAvailableInboundMethodAPI response | ^start_timestamp |string |Y |1774162800 |Epoch seconds timestamp representing Sunday at midnight like 2026-03-22T07:00:00Z (PDT)
This value needs to exactly match the available start_timestamp retrieved from ListAvailableInboundMethod API | ^end_timestamp |string |Y |1774767600 |Epoch seconds timestamp representing Sunday at midnight like 2026-03-22T07:00:00Z (PDT) This value needs to exactly match the available end_timestamp retrieved from ListAvailableInboundMethod API |
§7 Request Sample
Query
https://open-api.tiktokglobalshop.com/fbt/202602/inbound_method_detail?app_key=123abc&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c×tamp=1625484268&shop_cipher=ROW_RHkDDABBAAB8tKAVoAqsMTjsQZFLyNfY
Body
{"plan_id":"5766071177167344427","inbound_method":"D2FC","estimate_arrival_time":{"start_timestamp":"1774162800","end_timestamp":"1774767600"}}
§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 | |
| ^info | []object | Inbound method details. | |
| ^^allocation_shipments | []object | List of shipments for this placement option. | |
| ^^^warehouse_id | string | 7542187927317874487 | Warehouse identifier. |
| ^^^goods_items | []object | Goods item list. | |
| ^^^^goods_id | string | 2134566 | Goods identifier. |
| ^^^^quantity | int | 400 | Quantity of this goods. |
| ^^^cartons | []object | Carton List. | |
| ^^^^carton_type | string | SINGLE_SKU | Indicates if this is a single SKU carton or multi SKU carton. |
| Possible values: |
SINGLE_SKUMULTI_SKU| ^^^^items |[]object | |Goods item list of a carton. | ^^^^^goods_id |string |12345 |Goods identifier. | ^^^^^quantity |int |20 |Quantity of this goods. | ^^^^^lot_code |string |sfsfnjkfvv |Lot code of this goods. | ^^^^^expiration_timestamp |string |1623812664 |The expiration date for this item, Unix timestamp in seconds. | ^^^^quantity |int |2 |Carton quantity. | ^^^^carton_nums |[]string |["C0001","C0002"] |Carton numbers. | ^^^^box_measurements |object | |Carton measurement. | ^^^^^weight |string |3.5 |Carton weight. | ^^^^^weight_unit |string |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 |1.2 |Carton width. | ^^^^^height |string |2 |Carton height. | ^^^^^length |string |5 |Carton length. | ^^^^^length_unit |string |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_options |[]object | |Shipment options. | ^^^^shipping_method |string |SMALL_PARCEL |Shipping method for this shipment option. Possible values: SMALL_PARCEL, a parcel shipment method; FREIGHT, a freight shipment method. | ^^placement_option_id |string |5766071177167344420 |Placement option id. A placement option represents the shipment splits and destinations. | ^^placement_fee_estimate |object | |Placement fee. | ^^^amount |string |13.50 |Placement fee amount. | ^^^currency |string |USD |The unit of currency used for the amount.
Possible values:
USDCNYEURGBP| ^placement_task_status |string |Executing |Possible values:ExecutingSucceedFailed| ^expiration_timestamp |string |1774767600 |Expiration time for placement option. Placement results expire in one day. After that, you must call this API again to generate a new placement task. |
§9 Response Sample
{"code":0,"data":{"info":[{"allocation_shipments":[{"warehouse_id":"7542187927317874487","goods_items":[{"goods_id":"2134566","quantity":400}],"cartons":[{"carton_type":"SINGLE_SKU","items":[{"goods_id":"12345","quantity":20,"lot_code":"sfsfnjkfvv","expiration_timestamp":"1623812664"}],"quantity":2,"carton_nums":["C0001","C0002"],"box_measurements":{"weight":"3.5","weight_unit":"POUNDS","width":"1.2","height":"2","length":"5","length_unit":"INCH"}}],"shipment_options":[{"shipping_method":"SMALL_PARCEL"}]}],"placement_option_id":"5766071177167344420","placement_fee_estimate":{"amount":"13.50","currency":"USD"}}],"placement_task_status":"Executing","expiration_timestamp":"1774767600"},"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. |