Get Fulfillment by TikTok Settings
GET/api/tiktok-shop/:integrationInstance/fbt/settings
Read the Fulfillment by TikTok configuration for one TikTok Shop integration instance.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
Returns the on/off state, the pre-selected ship-from warehouse for new inbound plans, the compliance warning lead time in days, the FBT regions the shop is onboarded in, the last known enrolment outcome, and the captive FBT warehouse that mirrors TikTok-owned stock.
authorization is one of:
ok— enrolled and authorizednot_enrolled— the shop is not enrolled in Fulfillment by TikTok yetmissing_fbt_scope— enrolled, but the connection was authorized before the FBT inbound permission existed and must be re-authorizederror— TikTok could not confirm enrolment on the last attempt
This read never calls TikTok; the enrolment check runs only when the setting is turned on.
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.