Cancel Inbound Plan
POST/api/tiktok-shop/:integrationInstance/fbt/inbound-plans/:plan/cancel
Cancel an inbound plan that has reached TikTok.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
Body
reason(string, required, 3–255 characters) — TikTok validates the cancellation reason itself, so it cannot be blank.
There is no plan-level cancel at TikTok: a plan's shipments are its inbound orders, so each live one is cancelled in turn. Only once they are all gone does the plan flip to CANCELLED and release any source reservations it still holds. A partial failure is reported as one — the response says how many inbound orders were cancelled before TikTok refused, and the plan is left unchanged so it can be retried.
A draft answers 409 and must be deleted instead. The plan must belong to the integration instance in the path; a plan owned by another instance answers 404.
Requires the integrations.update permission.
If TikTok does not answer (or answers with a server error or rate limit) while cancelling one of the inbound orders, that order is not treated as refused: its stock stays held, the plan is left unchanged, and the next sync reads whether TikTok cancelled it. The response is 422 saying so; refresh the plan before trying again.
Request
Responses
- 200
- 401
- 403
- 404
- 409
- 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.
Conflict
Response Headers
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.