Get Inbound Order
GET/api/tiktok-shop/:integrationInstance/fbt/inbound-orders/:order
Returns one inbound order with its parent plan, its cartons and their contents, and any receipt discrepancies raised against it.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
Capability flags travel with the record: can_ship, can_cancel and is_departed each carry a matching *_reason sentence that is null exactly when the action is allowed.
Returns 404 when the inbound order does not belong to the given integration instance.
Permission: none beyond a valid token.
Response additions: sku_link (source-document cross-link: link_id, link_type_label, link_reference, link_route), portal_url, and cartons already scoped to THIS inbound order — clients should read those rather than fetching the whole plan's carton set and filtering.
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.