Finalizes carton and shipping details for an inbound order that is ready to ship. For an order that has not already been shipped, a successful response means the details were saved and the order moved to the receiving stage. Repeating the request after the order has already been shipped returns success without applying the supplied details again.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Query Parameters
Section titled “Query Parameters”Identifies the shop. Obtain it from the Get Authorized Shops API.
Request Bodyrequired
Section titled “Request Bodyrequired”object
Identifier of the inbound order to ship.
Carton details. Required when the inbound plan was created or updated using goods_items instead of cartons and the order has not already been shipped. Not required when retrying an order that has already been shipped.
object
Indicates whether the carton is configured as single-SKU or multi-SKU.
Possible values:
SINGLE_SKU:itemsmust contain exactly one item.MULTI_SKU:itemsmust contain two or more items.
Goods item list of a carton.
object
The Fulfilled by TikTok goods identifier for this carton item. The goods must belong to the merchant associated with the authenticated seller, be approved for fulfillment, and be matched to an SKU.
Quantity of this goods item in each carton. Must be greater than 0.
Lot code for this goods item. Required when lot-code management is enabled for the goods. Every occurrence of the same goods_id in cartons must use the same lot_code and expiration_timestamp values.
The expiration date for this item, as a Unix timestamp in seconds. Required when expiration management is enabled for the goods. It must be no earlier than the current time plus the goods-specific inbound_cutoff_days. Obtain this value from data.goods[].lot_expiration_info.inbound_cutoff_days in Search Goods Info (POST /fbt/202607/goods/search).
Number of cartons that use this carton configuration.
Identifiers assigned to the cartons represented by this configuration. Either every carton configuration in the request must provide a non-empty carton_nums array, or no configuration may provide any carton identifiers. When provided, the number of identifiers must equal this configuration’s quantity; each identifier must use the format C followed by four digits and must be unique across the request. If none are provided, carton identifiers are generated automatically.
Carton measurement.
object
Carton weight.
The unit used for the carton’s weight value.
Possible values:
KILOGRAM(kg)GRAM(g)MILLIGRAM(mg)POUNDS(lbs)OUNCE(oz)
Carton width.
Carton height.
Carton length.
The unit used for the carton’s length, width, and height values.
Possible values:
METER(m)CENTIMETER(cm)MILLIMETER(mm)FOOT(ft)MICRON(μm)INCH(in)
Shipment option containing freight type and shipping method.
object
Shipping method. Possible values: SMALL_PARCEL (small parcel shipping); FREIGHT (freight shipping).
Freight load type. Required when shipping_method is FREIGHT for EU and UK shops. It is optional for US shops and is not required when shipping_method is SMALL_PARCEL.
Possible values:
FTLLTL
Example
{ "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" }}Responses
Section titled “Responses”Success
object
Status code; 0 means success.
Success or failure message.
Request log ID.
object
Identifier of the shipped inbound order.
Example
{ "code": 0, "data": { "inbound_order_id": "5766071177167344427" }, "message": "Success", "request_id": "202203070749000101890810281E8C70B7"}