locations - admin-graphql - QUERY

Version: 2024-10

Description:

Returns a list of active inventory locations.

Access Scopes

Arguments

• after: String - The elements that come after the specified [cursor](https://shopify.dev/api/usage/pagination-graphql).
• before: String - The elements that come before the specified [cursor](https://shopify.dev/api/usage/pagination-graphql).
• first: Int - The first `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql).
• includeInactive: Boolean - Whether to include the locations that are deactivated.
• includeLegacy: Boolean - Whether to include the legacy locations of fulfillment services.
• last: Int - The last `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql).
• query: String - A filter made up of terms, connectives, modifiers, and comparators. | name | type | description | acceptable_values | default_value | example_use | | ---- | ---- | ---- | ---- | ---- | ---- | | default | string | Filter by a case-insensitive search of multiple fields in a document. | | | - `query=Bob Norman`
  - `query=title:green hoodie` | | active | string | | address1 | string | | address2 | string | | city | string | | country | string | | created_at | time | | geolocated | boolean | | id | id | Filter by `id` range. | | | - `id:1234`
  - `id:>=1234`
  - `id:<=1234` | | legacy | boolean | | name | string | | pickup_in_store | string | | - `enabled`
  - `disabled` | | province | string | | zip | string | You can apply one or more filters to a query. Learn more about [Shopify API search syntax](https://shopify.dev/api/usage/search-syntax).
• reverse: Boolean - Reverse the order of the underlying list.
• sortKey: LocationSortKeys - 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](https://shopify.dev/api/usage/pagination-graphql#search-performance-considerations).

Returns

• edges: LocationEdge! The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node.
• nodes: Location! 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.
• pageInfo: PageInfo! An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page.

Examples

• Retrieve a list of locations

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"query { locations(first: 5) { edges { node { id name address { formatted } } } } }\"\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: `query {\n    locations(first: 5) {\n      edges {\n        node {\n          id\n          name\n          address {\n            formatted\n          }\n        }\n      }\n    }\n  }`,\n});\n"
          Ruby example: "session = ShopifyAPI::Auth::Session.new(\n  shop: \"your-development-store.myshopify.com\",\n  access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n  session: session\n)\n\nquery = <<~QUERY\n  query {\n    locations(first: 5) {\n      edges {\n        node {\n          id\n          name\n          address {\n            formatted\n          }\n        }\n      }\n    }\n  }\nQUERY\n\nresponse = client.query(query: query)\n"
          PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<query([\"query\" => $query]);\n"
          Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  query {\n    locations(first: 5) {\n      edges {\n        node {\n          id\n          name\n          address {\n            formatted\n          }\n        }\n      }\n    }\n  }`,\n);\n\nconst data = await response.json();\n"
          Graphql query: "query {\n  locations(first: 5) {\n    edges {\n      node {\n        id\n        name\n        address {\n          formatted\n        }\n      }\n    }\n  }\n}"
        

  input: null

  response: {
    "data": {
      "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"
                ]
              }
            }
          }
        ]
      }
    }
  }