Skip to main content

Ship Inbound Order

POST 
/api/tiktok-shop/:integrationInstance/fbt/inbound-orders/:order/ship

Marks the inbound order as shipped at TikTok and, only once TikTok accepts it, posts the matching stock decrement at the source and the in-transit valuation.

Not yet available to API tokens

This endpoint currently requires session authentication; Personal Access Token scope support is in progress.

Cartons are supplied here only when the plan left carton packing until shipment. When they are supplied, the packed quantities must account for every unit on every plan line exactly once — an under-packed or over-packed payload is rejected with 422.

Permission: integrations.update.

Body

  • freight_type — required string. SMALL_PARCEL, LTL or FTL.
  • shipping_method — required string, max 64 characters.
  • carrier_name — optional, nullable string, max 255 characters.
  • pro_number — optional, nullable string, max 64 characters.
  • cartons — optional array, max 500 entries.
  • cartons[].carton_type — optional string. SINGLE_SKU or MIXED_SKU.
  • cartons[].quantity — optional integer, min 1. The number of identical cartons this entry stands for; it multiplies the item quantities inside it.
  • cartons[].carton_numbers — optional array of strings, each max 32 characters.
  • cartons[].length_cm, cartons[].width_cm, cartons[].height_cm, cartons[].weight_kg — optional, nullable numbers, min 0.
  • cartons[].items — required when cartons is supplied. Array, at least one entry.
  • cartons[].items[].goods_id — required when cartons is supplied. String, max 64 characters.
  • cartons[].items[].quantity — required when cartons is supplied. Integer, min 1.
  • cartons[].items[].lot_code — optional, nullable string, max 64 characters.
  • cartons[].items[].expiration_at — optional, nullable date.

Request​

Responses​

OK

Response Headers
    Content-Type