Choose a version:

locations

query

A paginated list of inventory locations where merchants can stock Product items and fulfill Order items.

Returns only active locations by default. Use the includeInactive argument to retrieve deactivated locations that can no longer stock inventory or fulfill orders. Use the includeLegacy argument to include locations that FulfillmentService apps manage. Use the query argument to filter by location attributes like name, address, and whether local pickup is enabled.

Anchor to Arguments

LocationConnection arguments

•LocationConnection!

Anchor to afterafter

•String

The elements that come after the specified cursor.

Anchor to beforebefore

•String

The elements that come before the specified cursor.

Anchor to firstfirst

•Int

The first n elements from the paginated list.

Anchor to includeInactiveincludeInactive

•Boolean

Default:false

Whether to include the locations that are deactivated.

Anchor to includeLegacyincludeLegacy

•Boolean

Default:false

Whether to include the legacy locations of fulfillment services.

Anchor to lastlast

•Int

The last n elements from the paginated list.

Anchor to queryquery

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to default •string: Filter by a case-insensitive search of multiple fields in a document.
Anchor to active •string
Anchor to address1 •string
Anchor to address2 •string
Anchor to city •string
Anchor to country •string
Anchor to created_at •time
Anchor to geolocated •boolean
Anchor to id •id: Filter by id range.
Anchor to legacy •boolean
Anchor to location_id •id
Anchor to name •string
Anchor to pickup_in_store •string
Anchor to province •string
Anchor to zip •string

Anchor to reversereverse

•Boolean

Default:false

Reverse the order of the underlying list.

Anchor to sortKeysortKey

•LocationSortKeys

Default:NAME

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

Was this section helpful?

Anchor to Possible returnsPossible returns

Anchor to edgesedges •[LocationEdge!]! non-null: The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node.
Anchor to nodesnodes •[Location!]! non-null: A list of nodes that are contained in LocationEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve.
Anchor to pageInfopageInfo •PageInfo! non-null: An object that’s used to retrieve cursor information about the current page.

Was this section helpful?

Examples

Retrieve a list of locations

Description

Retrieves the first 5 locations.

Query

query {
  locations(first: 5) {
    edges {
      node {
        id
        name
        address {
          formatted
        }
      }
    }
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2026-01/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query { locations(first: 5) { edges { node { id name address { formatted } } } } }"
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  query {
    locations(first: 5) {
      edges {
        node {
          id
          name
          address {
            formatted
          }
        }
      }
    }
  }`,
  );
  const json = await response.json();
  return json.data;
}

Ruby

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~QUERY
  query {
    locations(first: 5) {
      edges {
        node {
          id
          name
          address {
            formatted
          }
        }
      }
    }
  }
QUERY

response = client.query(query: query)

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: `query {
    locations(first: 5) {
      edges {
        node {
          id
          name
          address {
            formatted
          }
        }
      }
    }
  }`,
});

Shopify CLI

shopify app execute \
--query \
'query {
  locations(first: 5) {
    edges {
      node {
        id
        name
        address {
          formatted
        }
      }
    }
  }
}'

Response

{
  "locations": {
    "edges": [
      {
        "node": {
          "id": "gid://shopify/Location/346779380",
          "name": "Ottawa Store",
          "address": {
            "formatted": [
              "126 york street",
              "second and third floor",
              "ottawa ON k1n5t5",
              "Canada"
            ]
          }
        }
      },
      {
        "node": {
          "id": "gid://shopify/Location/648019273",
          "name": "Ottawa Store geo located",
          "address": {
            "formatted": [
              "126 york street",
              "second and third floor",
              "ottawa ON k1n5t5",
              "Canada"
            ]
          }
        }
      },
      {
        "node": {
          "id": "gid://shopify/Location/884687543",
          "name": "Ottawa Warehouse",
          "address": {
            "formatted": [
              "Canada"
            ]
          }
        }
      },
      {
        "node": {
          "id": "gid://shopify/Location/124656943",
          "name": "Shipping Origin",
          "address": {
            "formatted": [
              "190 MacLaren Street",
              "Ottawa ON K2P 0L6",
              "Canada"
            ]
          }
        }
      },
      {
        "node": {
          "id": "gid://shopify/Location/750123840",
          "name": "Toronto Store",
          "address": {
            "formatted": [
              "620 King St. W",
              "toronto ON m5v1m5",
              "Canada"
            ]
          }
        }
      }
    ]
  }
}

Retrieve a list of locations

Open in GraphiQL

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(

`#graphql

query {

locations(first: 5) {

edges {

node {

name

address {

formatted

}

}`,

);

const json = await response.json();

return json.data;

}

GQL

query {
  locations(first: 5) {
    edges {
      node {
        id
        name
        address {
          formatted
        }
      }
    }
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2026-01/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query { locations(first: 5) { edges { node { id name address { formatted } } } } }"
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  query {
    locations(first: 5) {
      edges {
        node {
          id
          name
          address {
            formatted
          }
        }
      }
    }
  }`,
  );
  const json = await response.json();
  return json.data;
}

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: `query {
    locations(first: 5) {
      edges {
        node {
          id
          name
          address {
            formatted
          }
        }
      }
    }
  }`,
});

Ruby

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~QUERY
  query {
    locations(first: 5) {
      edges {
        node {
          id
          name
          address {
            formatted
          }
        }
      }
    }
  }
QUERY

response = client.query(query: query)

Shopify CLI

shopify app execute \
--query \
'query {
  locations(first: 5) {
    edges {
      node {
        id
        name
        address {
          formatted
        }
      }
    }
  }
}'

Response

JSON

{

"locations": {

"edges": [

{

"node": {

"id": "gid://shopify/Location/346779380",

"name": "Ottawa Store",

"address": {

"formatted": [

"126 york street",

"second and third floor",

"ottawa ON k1n5t5",

"Canada"

]

}

{

"node": {

"id": "gid://shopify/Location/648019273",

"name": "Ottawa Store geo located",

"address": {

"formatted": [

"126 york street",

"second and third floor",

"ottawa ON k1n5t5",

"Canada"

]

}

{

"node": {

"id": "gid://shopify/Location/884687543",

"name": "Ottawa Warehouse",

"address": {

"formatted": [

"Canada"

]

}

{

"node": {

"id": "gid://shopify/Location/124656943",

"name": "Shipping Origin",

"address": {

"formatted": [

"190 MacLaren Street",

"Ottawa ON K2P 0L6",

"Canada"

]

}

{

"node": {

"id": "gid://shopify/Location/750123840",

"name": "Toronto Store",

"address": {

"formatted": [

"620 King St. W",

"toronto ON m5v1m5",

"Canada"

]

}

]

}