List Locations

GET

https://api.bigcommerce.com/stores/:store_hash/v3/inventory/locations

GET

/stores/:store_hash/v3/inventory/locations

curl https://api.bigcommerce.com/stores/store_hash/v3/inventory/locations \
     -H "Accept: application/json" \
     -H "X-Auth-Token: <apiKey>"

200Retrieved

{
  "data": [
    {
      "id": 2,
      "code": "BIGC-1",
      "label": "Central store",
      "description": "Central shop of the world",
      "managed_by_external_source": false,
      "type_id": "PHYSICAL",
      "enabled": true,
      "operating_hours": {
        "sunday": {
          "open": false,
          "opening": "08:00",
          "closing": "16:00"
        },
        "monday": {
          "open": false,
          "opening": "08:00",
          "closing": "16:00"
        },
        "tuesday": {
          "open": false,
          "opening": "08:00",
          "closing": "16:00"
        },
        "wednesday": {
          "open": false,
          "opening": "08:00",
          "closing": "16:00"
        },
        "thursday": {
          "open": false,
          "opening": "08:00",
          "closing": "16:00"
        },
        "friday": {
          "open": false,
          "opening": "08:00",
          "closing": "16:00"
        },
        "saturday": {
          "open": false,
          "opening": "08:00",
          "closing": "16:00"
        }
      },
      "time_zone": "Etc/GMT+12",
      "created_at": "2022-05-30T12:18:02Z",
      "updated_at": "2022-05-30T12:18:02Z",
      "address": {
        "address1": "Central Park",
        "address2": "string",
        "city": "New York City",
        "state": "NY",
        "zip": "11111",
        "email": "test@example.com",
        "phone": "800-555-0198",
        "geo_coordinates": {
          "latitude": 11,
          "longitude": 8
        },
        "country_code": "US"
      },
      "storefront_visibility": true,
      "special_hours": [
        {
          "label": "Thanksgiving",
          "date": "2022-09-29",
          "open": true,
          "opening": "09:00",
          "closing": "09:00",
          "all_day": false,
          "annual": false
        }
      ]
    }
  ],
  "meta": {
    "pagination": {
      "total": 2,
      "count": 2,
      "per_page": 100,
      "current_page": 1,
      "total_pages": 1,
      "links": {
        "previous": "?limit=100&page=1",
        "current": "?limit=100&page=1",
        "next": "?limit=100&page=1"
      }
    }
  }
}

List locations. You can use optional filter parameters.

Limits

Limit of 50 concurrent requests.
Limit of 1000 items for payload length.

Authentication

X-Auth-Tokenstring

OAuth scopes

UI Name	Permission	Parameter
Store Inventory	read-only	`store_inventory_read_only`
Store Inventory	modify	`store_inventory`

Authentication header

Header	Argument	Description
`X-Auth-Token`	`access_token`	For more about API accounts that generate `access_token`s, see API Accounts and OAuth Scopes.

Path parameters

store_hashstringRequired

Permanent ID of the BigCommerce store.

Query parameters

location_id:inintegerOptional

Comma separated list of location_id.

location_code:instringOptional

Comma separated list of location_code.

type_id:instringOptional

Comma separated list of locations type codes.

managed_by_external_sourcebooleanOptional

Filter whether an external source manages location inventory levels.

is_activebooleanOptional

Filter by active locations flag; return both if not specified.

storefront_visibilitybooleanOptional

Filter by storefront_visibility flag; return both if not specified.

pageintegerOptional

Specifies the page number in a limited (paginated) list of products.

limitintegerOptional

Controls the number of items per page in a limited (paginated) list of products.

Response

The request has been successfully processed.

datalist of objectsOptional

metaobjectOptional