Get FBT Warehouse List

GET

/fbt/202408/warehouses

This API is used to retrieve all Fulfilled by TikTok warehouse information including the warehouse name, warehouse address information, etc. The IDs of subscribed warehouses can be used to query inventory-related information.

Authorizations

• accessToken

Parameters

Query Parameters

shop_cipher

required

string

Identifies the shop. Obtain it from the Get Authorized Shops API.

Responses

200

Success

Media typeapplication/json

object

code

Status code; 0 means success.

integer format: int64

message

Success or failure message.

string

request_id

Request log ID.

string

data

object

warehouses

A list of Fulfilled by TikTok warehouses information.

Array<object>

object

fbt_warehouse_id

The identifier for warehouse generated by Fulfilled By TikTok system.

string

warehouse_ids

The warehouse IDs generated by TikTok Shop that are associated with this Fulfilled by TikTok warehouse (fbt_warehouse_id).

Array<string>

name

The Fulfilled by TikTok warehouse name, e.g.TikTok_Eastvale(CA).

string

type

The Fulfilled by TikTok warehouse type. Possible values:

• PLATFORM_WAREHOUSE: A warehouse operated by TikTok.
• OTHER_WAREHOUSE: A warehouse that is not classified as a platform warehouse.

string

Allowed values: PLATFORM_WAREHOUSE OTHER_WAREHOUSE

subscribed

A flag indicating whether the warehouse is subscribed. True: Subscribed. False: Not subscribed.

boolean

addresses

A list of addresses used to receive inbound shipments at the Fulfilled by TikTok warehouse.

Array<object>

object

postal_code

Warehouse address postal code (also known as zip code).

string

region_code

Warehouse country or region code in two-character ISO 3166-1 alpha-2 format.

string

state

Warehouse address state or province.

string

district

Warehouse address district or county.

string

city

Warehouse address city.

string

address_line_1

The detail address line 1.

string

address_line_2

The detail address line 2, additional address information(optional).

string

address_line_3

The detail address line 3, additional address information(optional).

string

logistics_services

A list of logistics service information related to the current warehouse.

Array<object>

object

id

The identifier for logistics service in TikTok Shop system.

string

name

The logistics service name.

string

subscribed

A flag indicating whether the logistic service is subscribed. True: Subscribed. False: Not subscribed.

boolean

Example

{
  "code": 0,
  "data": {
    "warehouses": [
      {
        "fbt_warehouse_id": "121219993203023",
        "warehouse_ids": [
          "161213293423029",
          "181213293423030"
        ],
        "name": "TikTok_Eastvale(CA)",
        "type": "PLATFORM_WAREHOUSE",
        "subscribed": true,
        "addresses": [
          {
            "postal_code": "92376",
            "region_code": "US",
            "state": "CA",
            "district": "San Bernardino",
            "city": "Rialto",
            "address_line_1": "1420 Tamarind Ave, Rialto, San Bernardino",
            "address_line_2": " ",
            "address_line_3": " "
          }
        ],
        "logistics_services": [
          {
            "id": "12123232323",
            "name": "Fulfilled by TikTok Shop-Standard",
            "subscribed": true
          }
        ]
      }
    ]
  },
  "message": "Success",
  "request_id": "202203070749000101890810281E8C70B7"
}