Skip to main content

GET Get FBT Merchant Onboarded Regions

Get FBT Merchant Onboarded Regions Shop Required scope: seller.fbt.info This API verifies whether a seller is registered as a Fulfillment by TikTok (FBT) merchant. If the seller is onboarded, the API returns the regions where the merchant is authorized to operate under the FBT system. Version 202409

GET/fbt/202409/merchants/onboarded_regions

Request

Header

PropertiesTypeDescription
content-type RequiredstringAllowed type: application/json
x-tts-access-token RequiredstringThe seller access_token value from Get Access Token, when user_type = 0. Follow this guide to get seller access_token.

Query

PropertiesTypeDescription
app_key RequiredstringEvery single app will have a unique key. Please use the specific key assigned to your app.
sign RequiredstringSignature generated by gen algorithm. When you send API requests to TTS, you must sign them so that TTS can identify the senders.
timestamp RequiredintUnix timestamp GMT (UTC+00:00). This timestamp is used across all API requests. Developers can use this convert to local time.
shop_cipher RequiredstringUse this property to pass shop information in requesting the API. Failure in passing the correct value when requesting the API for cross-border shops will return incorrect response. Get by API Get Authorization Shop

Example

CurlGoNode.jsJavaEnable word wrap

1234curl-XGET 'https://open-api.tiktokglobalshop.com/fbt/202409/merchants/onboarded_regions?app_key=38abcd&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c&timestamp=1623812664&shop_cipher=GCP_XF90igAAAABh00qsWgtvOiGFNqyubMt3' -H 'x-tts-access-token: TTP_pwSm2AAAAABmmtFz1xlyKMnwg74T2GJ5s0uQbS8jPjb_GkdFVCxPqzQXSyuyfXdQa0AqyDsea2tYFNVf4XeqgZHFfPyv0Vs659QqyLYfsGzanZ5XZAin3_ZkcIxxS0_In6u6XDeU96k' -H 'content-type: application/json'

Response Parameters

PropertiesTypeDescription
codeintThe success or failure status code returned in API response.
messagestringThe success or failure messages returned in API response. Reasons of failure will be described in the message.
request_idstringRequest log
dataobjectSpecific return information

Example

JSONEnable word wrap

{"code":0,"data":{"onboarded_regions":[{"region_code":"GB"}]},"message":"Success","request_id":"202203070749000101890810281E8C70B7"}

Error Code

View common error codes

| Code | Message | | --- | --- | | Empty. No business logic error codes. |

Is this content helpful?Helpful

Not Helpful

PreviousNext