**Version: 202601**

# List locations

**GET** `/openapi/2026-01/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
- `page` int32

  Page number (1-based). Mutually exclusive with cursor
- `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 | Example**

**Schema**

- `code` string

  error code
- `message` string

  error message
- `data` object

  - `locations` object[]

    List of locations

    *   Array \[

    - `id` uint64

      Location ID
    - `active` boolean

      Whether active
    - `default` boolean

      Default
    - `country` string

      Country name
    - `country_code` string

      Country code (e.g. CN)
    - `province` string

      Province or state
    - `province_code` string

      Province code
    - `city` string

      City
    - `area` string

      Area or region
    - `address` string

      Address
    - `address1` string

      Primary address line
    - `name` string

      Name
    - `phone` string

      Phone number
    - `zip` string

      Postal or ZIP code
    - `company` string

      Company name
    - `latitude` string

      Latitude coordinate
    - `longitude` string

      Longitude coordinate
    - `created_at` string

      Creation timestamp, in ISO-8601 format
    - `updated_at` string

      Last update timestamp, in ISO-8601 format
    *   \]
  - `total` int64

    Total
  - `cursor` string

    The cursor for the next page of results
  - `has_more` boolean

    Whether there are more records

```json
{
  "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
  }
}
```