GraphQL Storefront API
Locations settings

Get Locations

You can query location information using the GraphQL Storefront API. The information accessible by any storefront API is controlled by the location settings for the store.

For example queries, see Query Locations with the GraphQL Storefront API.

To work with locations, the API account that generates Storefront tokens must include one of the following OAuth scopes:

UI NamePermissionParameter
Information & Settingsmodifystore_v2_information
Information & Settingsread-onlystore_v2_information_read_only

Use these scopes to read and change the following information:

  • The storefront details for a location
  • General store information
  • Location addresses
  • Contact details

The Buy Online, Pick up in Store pattern is designed to center a single online storefront. Buy Online, Pick up in Store is not compatible with multi-storefront channels (MSF).

Location settings

A location must be enabled and visible in order for the GraphQL Storefront API to storefront details for the location.

If a location is not enabled or visible, send a request to the Update Locations endpoint.

Example request: Update location
X-Auth-Token: {{access_token}}
Content-Type: application/json
Accept: application/json
    "id": 2,
    "enabled": true,
    "storefront_visibility": true


Did you find what you were looking for?