locations

query

Returns a list of active inventory locations.

LocationConnection arguments

•LocationConnection!

after

•

String

The elements that come after the specified cursor.

before

•

String

The elements that come before the specified cursor.

first

•

Int

The first n elements from the paginated list.

includeInactive

•

BooleanDefault:false

Whether to include the locations that are deactivated.

includeLegacy

•

BooleanDefault:false

Whether to include the legacy locations of fulfillment services.

last

•

Int

The last n elements from the paginated list.

query

•

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 name • string
Anchor to pickup_in_store • string
Anchor to province • string
Anchor to zip • string

reverse

•

BooleanDefault:false

Reverse the order of the underlying list.

sortKey

•

LocationSortKeysDefault: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?

Retrieve a list of locations

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

const response = await admin.graphql(

`#graphql

query {

locations(first: 5) {

edges {

node {

name

address {

formatted

}

}`,

);

const data = await response.json();

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

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2024-04/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 } } } } }"
}'

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

const response = await admin.graphql(
  `#graphql
  query {
    locations(first: 5) {
      edges {
        node {
          id
          name
          address {
            formatted
          }
        }
      }
    }
  }`,
);

const data = await response.json();

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

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)

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",