Get Placement Option Detail
POST/api/tiktok-shop/:integrationInstance/fbt/inbound-plans/:plan/placement/detail
Fetch TikTok's concrete allocation for one placement option — which destination warehouses the shipment splits into, and which goods and cartons go to each.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
Body
option_id(integer, required) — the placement option's SKU.io id, as returned by the options refresh. It must belong to the plan in the path, otherwise the request answers404. TikTok's own placement option id is only minted as part of this very call, so it cannot be used to address the option on the first fetch.
TikTok computes the allocation asynchronously, so ready: false with a null option is a normal answer, not an error — poll again in a few seconds. When ready is true, the option comes back with placement_option_id, allocation_shipments and destination_count filled in, and is_selectable true.
This is a mutation because it writes the resolved allocation back onto the option.
Requires the integrations.update permission.
Request
Responses
- 200
- 401
- 403
- 404
- 422
- 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.
Unprocessable Content
Response Headers
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.