v1

latestOpenAPI 3.1.02026-07-2689175245.8 KB

Locations

List Locations

Retrieve a list of locations. The list can be filtered, sorted, and paginated using the parameters below.

get/locations

Query parameters

external_idstring

An external_id used to filter the locations.

limitinteger

The maximum number of locations returned.

sort_order'asc' | 'desc'

The sort order for the results.

cursorstring

The cursor to return the next page of results.

Response

Success

next_page_urlstring nullable

previous_page_urlstring nullable

Example response

{
  "locations": [
    {
      "id": 9007199254740991,
      "external_id": "62291d16-9b61-4fbb-b868-21c2d32dc155",
      "sales_channel": "shopify",
      "name": "Main Warehouse",
      "address": {
        "name": "Main Warehouse",
        "company": "Universal Exports",
        "address1": "1234 Example Street",
        "address2": "Unit 19",
        "city": "Townsville",
        "region": "Louisiana",
        "country_code": "US"
      }
    }
  ]
}