Skip to main content

List Inbound Products

GET 

/api/tiktok-shop/:integrationInstance/fbt/inbound-products

Look up shop SKUs for the inbound builder, annotated with everything that decides whether they can actually be sent to Fulfillment by TikTok.

Not yet available to API tokens

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

Query parameters

  • query (string, optional, nullable, max 255) — partial match on seller SKU, product name or TikTok SKU id.
  • source_warehouse_id (integer, optional, nullable) — when given, each row reports source_available_quantity and source_on_hand_quantity at that warehouse. When omitted both are null rather than zero, because unknown and none are different answers.
  • matched_only (boolean, optional) — return only SKUs already bound to an FBT goods record.

match_status is matched or unmatched; an unmatched SKU has no goods record behind it and cannot be inbounded until it is bound. is_hazmat, is_lot_code, is_expiration_management and requires_lot_or_expiry come from the bound goods record and govern what carton contents must declare.

Returns at most 50 rows, ordered by seller SKU — this is a type-ahead lookup, not a report.

Requires an authenticated token. No extra permission is needed for this read.

Request

Responses

OK

Response Headers
    Content-Type