Get FBT Inbound Order Details

This API is used to retrieve the inbound order details including the planned inbound detail, actual inbound detail and inbound status, etc.

---

For common parameters, refer to How to call TikTok Shop APIs - Common Parameters

Query

https://open-api.tiktokglobalshop.com/fbt/202602/inbound_orders?app_key=123abc&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c&timestamp=1625484268&shop_cipher=ROW_RHkDDABBAAB8tKAVoAqsMTjsQZFLyNfY&order_ids=5766071177167344427,5766071177167344428&include_carton_details=true

Possible values:

• HUB
• FC (Fulfillment Center) | ^^status_logs |[]object | |A list of inbound order operation history. | ^^^operate_time |int |1715398048 |The time when the inbound order is processed by the merchant or warehouses, represented as a Unix timestamp in seconds. | ^^^new_status |string |RECEIVED |The order status in Fulfilled by TikTok (FBT) warehouse after this operation.

Possible values:

• WORKING
• READY_TO_SHIP
• TO_BE_RECEIVED
• ARRIVED_HUB
• INTERNAL_TRANSFER
• RECEIVING
• PARTIALLY_RECEIVED
• RECEIVED
• CANCELLED
• DELIVERED | ^^^previous_status |string |PARTIALLY_RECEIVED |The order status in Fulfilled by TikTok (FBT) warehouse before this operation.

Possible values:

• WORKING
• READY_TO_SHIP
• TO_BE_RECEIVED
• ARRIVED_HUB
• INTERNAL_TRANSFER
• RECEIVING
• PARTIALLY_RECEIVED
• RECEIVED
• CANCELLED
• DELIVERED | ^^^operator |string |Warehouse |The unique identifier or name of the user or system entity that performed the status change. | ^^logistic_info_list |[]object | |List of logistics information tied to the order. Only populated for small-parcel inbound orders. | ^^^provider_name |string |UPS |Name of the logistics service provider

Possible values:

• FEDEX (Federal Express)
• UPS (United Parcel Service)
• DHL (DHL Express)
• USPS (United States Postal Service)
• OTHER (All other logistics providers) | ^^^waybill_number |string |889042812410 |The tracking number for the current inbound shipment with the carrier. | ^^^related_number |string |C0001 |Carton number tied to the logistics information. | ^^carton_details |[]object | |Detailed carton information for the inbound order. Only populated if include_carton_details is passed as true in the request. | ^^^carton_no |string |C0001 |Carton number. | ^^^carton_type |string |SINGLE_SKU |Whether this carton is single-SKU or multi-SKU.

Possible values:

• SINGLE_SKU
• MULTI_SKU | ^^^box_measurements |object | |Carton measurement. | ^^^^weight |string |5 |Carton weight. | ^^^^weight_unit |string |KILOGRAM |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 |6 |Carton width. | ^^^^height |string |7 |Carton height. | ^^^^length |string |8 |Carton length. | ^^^^length_unit |string |METER |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) | ^^^items |[]object | |List of items in this carton. | ^^^^goods_id |string |Goods id. |Identifier for goods within the Fulfilled by TikTok system. | ^^^^quantity |int |10 |Quantity of this goods lot in th ecarton. | ^^inbound_goods_lot_receive_item_details |[]object | |A detailed breakdown of planned versus actual receiving information, segmented by item, lot number, and expiration date. | ^^^goods_id |string |7603596185 |The unique numeric identifier of the goods within Fulfilled by TikTok. | ^^^lot_code |string |LOT-2024-XP9 |The specific batch or lot number assigned by the manufacturer for this group of items. | ^^^expiration_time |int |1735689600 |The expiration date of the items in this lot, provided as a Unix timestamp in seconds. | ^^^planned_count |int |100 |The total quantity of this specific lot expected to be received as part of the inbound order. | ^^^normal_received_count |int |98 |The quantity of items received at fulfillment centers in sellable (good) condition for this lot. If the inbound order is sent to a hub, this value will only be updated when the goods are subsequently transferred to the fulfillment center. | ^^^defective_received_count |int |2 |The quantity of items received in a damaged or unsellable state. | ^^^total_received_count |int |100 |The sum of both normal_received_count and defective_received_count. |

{"code":0,"data":{"inbound_orders":[{"order_id":"5766071177167344427","order_id_string":"IBR5766071177167344427","order_plan_id":"5766071177167345050","merchant":{"id":"493493403043","name":"ExampleCompany"},"create_time":1773778751,"ship_time":1773778751,"expected_arrival_time":1773778751,"actual_arrival_time":1773778751,"warehouse":{"fbt_warehouse_id":"121219993203023","business_warehouse_ids":["121219993209983"],"name":"TikTok Warehouse","type":"FC"},"status_logs":[{"operate_time":1715398048,"new_status":"RECEIVED","previous_status":"PARTIALLY_RECEIVED","operator":"Warehouse"}],"logistic_info_list":[{"provider_name":"UPS","waybill_number":"889042812410","related_number":"C0001"}],"carton_details":[{"carton_no":"C0001","carton_type":"SINGLE_SKU","box_measurements":{"weight":"5","weight_unit":"KILOGRAM","width":"6","height":"7","length":"8","length_unit":"METER"},"items":[{"goods_id":"Goods id.","quantity":10}]}],"inbound_goods_lot_receive_item_details":[{"goods_id":"7603596185","lot_code":"LOT-2024-XP9","expiration_time":1735689600,"planned_count":100,"normal_received_count":98,"defective_received_count":2,"total_received_count":100}]}]},"message":"Success","request_id":"202203070749000101890810281E8C70B7"}

For common error codes, refer to How to call TikTok Shop APIs - Common Error Code