Skip to main content

List Inbound Orders

GET 
/api/tiktok-shop/:integrationInstance/fbt/inbound-orders

Paginated list of Fulfillment by TikTok (FBT) inbound orders for one integration instance.

Not yet available to API tokens

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

An inbound order is what TikTok physically receives against: it carries the destination fulfillment center, the shipped and received unit counts, the freight details, and the two compliance clocks (the delivery window and the 75-day auto-close).

Permission: none beyond a valid token.

Filters. Every filter key below also accepts an operator suffix, written as filter[column.operator].

  • Text columns (status, tiktok_inbound_order_id, order_id_string, fbt_warehouse_id, fbt_warehouse_name, fbt_warehouse_type, freight_type, carrier_name) accept: contains, does_not_contain, is, is_not, is_one_of, is_not_one_of, starts_with, does_not_start_with, ends_with, does_not_end_with, is_empty, is_not_empty.
  • Numeric columns (id, plan_id, shipment_units, received_units, carton_count) accept: is, is_not, is_one_of, is_not_one_of, greater_than, less_than, greater_than_or_equal, less_than_or_equal, between, is_empty, is_not_empty.
  • Date columns (shipped_at, expected_arrival_at, actual_arrival_at, delivery_window_expires_at, created_at) accept: is, is_not, before, after, on_or_before, on_or_after, between, is_empty, is_not_empty, today, yesterday, tomorrow, past_week, past_month, past_year, next_week, next_month, next_year, days_ago, days_from_now, past_days, next_days.
  • The bare key (filter[status]) is shorthand for the is operator.
  • filter[search] matches the TikTok inbound order id, the inbound order reference, the carrier name and the destination name.
  • filter_groups accepts a base64-encoded JSON tree for grouped AND/OR conditions.

Sorts. id, status, shipment_units, received_units, carton_count, shipped_at, expected_arrival_at, delivery_window_expires_at, created_at. Prefix with - for descending. Default sort is -id.

Pagination. per_page defaults to 10.

Response additions: sku_link is the full cross-link to the source document (link_id, link_type_label, link_reference, link_route) — the Warehouse Transfer or Purchase Order that materializes this inbound — and portal_url deep-links the IBR in the seller's FBT Portal. The nested plan is no longer column-constrained, so its status / can_cancel / source_confirmed flags are correct (a partial select previously reported every nested plan as locked and uncancellable).

Request​

Responses​

OK

Response Headers
    Content-Type