List FBT Inventory
GET/api/tiktok-shop/:integrationInstance/fbt/inventory
The mirrored FBT stock for this integration instance, joined onto the goods catalog: one entry per goods record with the total, available and reserved quantities, broken down per fulfillment center.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
TikTok owns this stock, so these figures are a mirror written by the last refresh — last_synced_at says how current it is. Use Refresh FBT Inventory to pull fresh figures.
Permission: none beyond a valid token.
Paginated. Returns the standard pagination envelope (data[] plus current_page, last_page, per_page, total), not a bare array. Accepts page, per_page (default 10), the same filter[...] / filter_groups parameters as List FBT Goods, and sort over id, name, reference_code, tiktok_goods_id, synced_at, created_at, updated_at. A wholly numeric filter[search] term also matches the record id exactly. Each row carries the mirrored stock snapshot: total_quantity, available_quantity, reserved_quantity and the per-fulfillment-center breakdown.
Request
Responses
- 200
- 401
- 403
- 404
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.