Get Inbound Plan
GET/api/tiktok-shop/:integrationInstance/fbt/inbound-plans/:plan
Read one inbound plan with everything needed to render it: its lines (each with packed_quantity and is_fully_packed), its cartons and their contents, every placement option TikTok has offered, and the inbound orders minted from it.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
The plan must belong to the integration instance in the path; a plan owned by another instance answers 404.
Requires an authenticated token. No extra permission is needed for this read.
Each line carries send_plan_line_id (and from_send_planner) when it was handed off from the send planner; the planner's stock hold stays attached to that line until the plan's own reservation replaces it.
available_quantity on each line is the source warehouse's free stock plus any Send Planner hold already placed for that line, so stock the planner held for this draft never reads as "more than available".
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.