Get Warehouse List

GET

/logistics/202309/warehouses

Retrieves warehouses associated with the seller, including names, effective statuses, types, default designations, and available address 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

Warehouses returned for the seller. This field is omitted when the result contains no warehouse.

Array<object>

object

id

The warehouse ID, a unique and immutable primary key, used for all warehouse logistics.

string

entity_id

The warehouse entity ID, used to associate physical information of a warehouse, different warehouses may be associated with the same entity.

string

name

Warehouse name. This name is not unique across the TikTok Shop system.

string

effect_status

Indicates whether inventory at the warehouse is available for sale. Possible values:

• ENABLED: All products in stock are available for sale.
• DISABLED: All products in stock are unavailable for sale.
• RESTRICTED: The warehouse is in holiday mode or order limit mode, so all products in stock are unavailable for sale.

The seller can enable holiday mode in Seller Center when the seller cannot fulfill orders from the warehouse. Order limit mode is applied when TikTok Shop limits the order volume that can be fulfilled by the warehouse because of policy violations.

string

Allowed values: ENABLED DISABLED RESTRICTED

type

Possible values:

• SALES_WAREHOUSE: Warehouse for shipping products.
• RETURN_WAREHOUSE: Warehouse for receiving returned products. You can have the same warehouse for both shipping and receiving returns, but they will have different warehouse IDs with the same address.

string

Allowed values: SALES_WAREHOUSE RETURN_WAREHOUSE

sub_type

Possible values:

• DOMESTIC_WAREHOUSE: The warehouse is in the same country as the target market and the seller.
• CB_OVERSEA_WAREHOUSE: For cross-border sellers, a local warehouse in the target market.
• CB_DIRECT_SHIPPING_WAREHOUSE: For cross-border sellers, a warehouse in the seller’s base country, e.g., Mainland China or Hong Kong.

string

Allowed values: DOMESTIC_WAREHOUSE CB_OVERSEA_WAREHOUSE CB_DIRECT_SHIPPING_WAREHOUSE

is_default

The default warehouse. If a product is listed with no designated warehouse, the default warehouse will be used.

boolean

address

Warehouse address.

object

region

The country or region of the warehouse address.

string

state

Warehouse state or province.

string

city

Warehouse city.

string

distict

Warehouse district.

string

town

Warehouse town.

string

contact_person

Warehouse contact person name.

string

first_name

Kanji first name Applicable only for the JP market.

string

last_name

Kanji last name Applicable only for the JP market.

string

first_name_local_script

Hiragana or Katakana first name Applicable only for the JP market.

string

last_name_local_script

Hiragana or Katakana last name Applicable only for the JP market.

string

postal_code

Warehouse address postal code (also known as zip code)

string

full_address

The combined warehouse address, including the street address and other address information such as apartment number, building, floor..etc (optional)

string

region_code

The country or region code of the warehouse address.

string

phone_number

Warehouse phone number.

string

address_line1

The first line of the warehouse address, like street name and street number. Note:

• For Brazilian market, this represents the neighborhood or district.
• For the JP market, this represents the district (Chome), block (Banchi), building number (Go).

string

address_line2

The second line of the warehouse address, like flat, apartment, or suit. Note: For the Brazilian market, this represents the street name.

string

address_line3

The street number. The literal value s/n indicates that no street number is available. Available only in the Brazilian market.

string

address_line4

This represents supplement information, like flat, apartment, or suit (optional). Note: Available only in the Brazilian market.

string

geolocation

The geographical location of the address.

object

latitude

The latitude of the address.

string

longitude

The longitude of the address.

string

Example

{
  "code": 0,
  "data": {
    "warehouses": [
      {
        "id": "7000714532876273410",
        "entity_id": "7395366865142499073",
        "name": "Guangzhou",
        "effect_status": "ENABLED",
        "type": "SALES_WAREHOUSE",
        "sub_type": "DOMESTIC_WAREHOUSE",
        "is_default": true,
        "address": {
          "region": "China",
          "state": "GuangDong",
          "city": "GuanZhou",
          "distict": "HuaDu",
          "town": "town",
          "contact_person": "Lee",
          "first_name": "新一",
          "last_name": "工藤",
          "first_name_local_script": "しんいち",
          "last_name_local_script": "くどう",
          "postal_code": "510000",
          "full_address": "South Sea 11 floor",
          "region_code": "CN",
          "phone_number": "188****2234",
          "address_line1": "Bairro/Distrito",
          "address_line2": "Caminho Trinta e Três",
          "address_line3": "3",
          "address_line4": "11 floor",
          "geolocation": {
            "latitude": "45.41634",
            "longitude": "-75.6868"
          }
        }
      }
    ]
  },
  "message": "Success",
  "request_id": "202203070749000101890810281E8C70B7"
}