List locations

GET 
/openapi/2025-06/locations

List all locations for shipping, inventory, and order fulfillment.

Request

Query Parameters

cursor string

Cursor of the next page

page_size int32

Number of records per page

status enum

Default to 0; 0: All, 1: Search the warehouse that is enabled, 2: Search the warehouse that is not enabled

sort_by string

Sort field. Defaults to listing the default location first. Supports "priority"

Responses

200

OK

application/json

Schema

Schema

codestring

error code

messagestring

error message

data object

locations object[]

List of locations

Array [

iduint64

Location ID

activeboolean

Whether active

defaultboolean

Default

countrystring

Country name

country_codestring

Country code (e.g. CN)

provincestring

Province or state

province_codestring

Province code

citystring

City

areastring

Area or region

addressstring

Address

address1string

Primary address line

namestring

Name

phonestring

Phone number

zipstring

Postal or ZIP code

companystring

Company name

latitudestring

Latitude coordinate

longitudestring

Longitude coordinate

created_atstring

Creation timestamp, in ISO-8601 format

updated_atstring

Last update timestamp, in ISO-8601 format

]

totalint64

Total

cursorstring

The cursor for the next page of results

has_moreboolean

Whether there are more records

Example

{
  "code": "string",
  "message": "string",
  "data": {
    "locations": [
      {
        "id": 0,
        "active": true,
        "default": true,
        "country": "string",
        "country_code": "string",
        "province": "string",
        "province_code": "string",
        "city": "string",
        "area": "string",
        "address": "string",
        "address1": "string",
        "name": "string",
        "phone": "string",
        "zip": "string",
        "company": "string",
        "latitude": "string",
        "longitude": "string",
        "created_at": "string",
        "updated_at": "string"
      }
    ],
    "total": 0,
    "cursor": "string",
    "has_more": true
  }
}