List Inbound Plan Cartons
GET/api/tiktok-shop/:integrationInstance/fbt/inbound-plans/:plan/cartons
The plan's cartons and their contents.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
total_units is the sum of a carton's contents. label_voided_at / is_label_voided flag a carton whose printed label no longer matches what is inside it — a quantity change after printing voids the label and it must be reprinted before the box ships.
Returns the complete list — this endpoint is not paginated.
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.
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.