Location - admin-graphql - OBJECT

Version: 2024-07

Description:

Represents the location where the physical good resides. You can stock inventory at active locations. Active locations that have `fulfills_online_orders: true` and are configured with a shipping rate, pickup enabled or local delivery will be able to sell from their storefront.

Access Scopes

the `read_locations` access scope.

Fields

• activatable: Boolean! - Whether the location can be reactivated. If `false`, then trying to activate the location with the [`LocationActivate`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/locationActivate) mutation will return an error that describes why the location can't be activated.
• address: LocationAddress! - The address of this location.
• addressVerified: Boolean! - Whether the location address has been verified.
• createdAt: DateTime! - The date and time ([ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) that the location was added to a shop.
• deactivatable: Boolean! - Whether this location can be deactivated. If `true`, then the location can be deactivated by calling the [`LocationDeactivate`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/locationDeactivate) mutation. If `false`, then calling the mutation to deactivate it will return an error that describes why the location can't be deactivated.
• deactivatedAt: String - The date and time ([ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) that the location was deactivated at. For example, 3:30 pm on September 7, 2019 in the time zone of UTC (Universal Time Coordinated) is represented as `"2019-09-07T15:50:00Z`".
• deletable: Boolean! - Whether this location can be deleted.
• fulfillmentService: FulfillmentService - Name of the service provider that fulfills from this location.
• fulfillsOnlineOrders: Boolean! - Whether this location can fulfill online orders.
• hasActiveInventory: Boolean! - Whether this location has active inventory.
• hasUnfulfilledOrders: Boolean! - Whether this location has orders that need to be fulfilled.
• id: ID! - A globally-unique ID.
• inventoryLevel: InventoryLevel - The quantities of an inventory item at this location.
• isActive: Boolean! - Whether the location is active. A deactivated location can be activated (change `isActive: true`) if it has `activatable` set to `true` by calling the [`locationActivate`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/locationActivate) mutation.
• isFulfillmentService: Boolean! - Whether this location is a fulfillment service.
• isPrimary: Boolean! - Whether the location is your primary location for shipping inventory.
• legacyResourceId: UnsignedInt64! - The ID of the corresponding resource in the REST Admin API.
• localPickupSettingsV2: DeliveryLocalPickupSettings - Local pickup settings for the location.
• metafield: Metafield - A [custom field](https://shopify.dev/docs/apps/build/custom-data), including its `namespace` and `key`, that's associated with a Shopify resource for the purposes of adding and storing additional information.
• name: String! - The name of the location.
• privateMetafield: PrivateMetafield - Returns a private metafield by namespace and key that belongs to the resource.
• shipsInventory: Boolean! - Whether this location is used for calculating shipping rates. In multi-origin shipping mode, this flag is ignored.
• suggestedAddresses: LocationSuggestedAddress! - List of suggested addresses for this location (empty if none).
• updatedAt: DateTime! - The date and time ([ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) when the location was last updated.

Connections

• inventoryLevels: InventoryLevelConnection!
• metafieldDefinitions: MetafieldDefinitionConnection!
• metafields: MetafieldConnection!
• privateMetafields: PrivateMetafieldConnection!

Related queries

• location Returns an inventory Location resource by ID.
• locationsAvailableForDeliveryProfiles Returns a list of all origin locations available for a delivery profile.
• locations Returns a list of active inventory locations.
• locationsAvailableForDeliveryProfilesConnection Returns a list of all origin locations available for a delivery profile.

Related mutations

• locationActivate Activates a location so that you can stock inventory at the location. Refer to the [`isActive`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Location#field-isactive) and [`activatable`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Location#field-activatable) fields on the `Location` object.
• locationAdd Adds a new location.
• locationDeactivate Deactivates a location and moves inventory, pending orders, and moving transfers to a destination location.
• locationEdit Edits an existing location. [As of the 2023-10 API version](https://shopify.dev/changelog/apps-can-now-change-the-name-and-address-of-their-fulfillment-service-locations), apps can change the name and address of their fulfillment service locations.

Related Unions

• MetafieldReferencer Types of resources that may use metafields to reference other resources.

Examples

• Get a metafield attached to a location

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-07/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"query LocationMetafield($namespace: String!, $key: String!, $ownerId: ID!) { location(id: $ownerId) { hours: metafield(namespace: $namespace, key: $key) { value } } }\",\n \"variables\": {\n    \"namespace\": \"my_fields\",\n    \"key\": \"hours\",\n    \"ownerId\": \"gid://shopify/Location/346779380\"\n  }\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `query LocationMetafield($namespace: String!, $key: String!, $ownerId: ID!) {\n      location(id: $ownerId) {\n        hours: metafield(namespace: $namespace, key: $key) {\n          value\n        }\n      }\n    }`,\n    \"variables\": {\n      \"namespace\": \"my_fields\",\n      \"key\": \"hours\",\n      \"ownerId\": \"gid://shopify/Location/346779380\"\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 LocationMetafield($namespace: String!, $key: String!, $ownerId: ID!) {\n    location(id: $ownerId) {\n      hours: metafield(namespace: $namespace, key: $key) {\n        value\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"namespace\": \"my_fields\",\n  \"key\": \"hours\",\n  \"ownerId\": \"gid://shopify/Location/346779380\"\n}\n\nresponse = client.query(query: query, variables: variables)\n"
          PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n  query LocationMetafield($namespace: String!, $key: String!, $ownerId: ID!) {\n    location(id: $ownerId) {\n      hours: metafield(namespace: $namespace, key: $key) {\n        value\n      }\n    }\n  }\nQUERY;\n\n$variables = [\n  \"namespace\" => \"my_fields\",\n  \"key\" => \"hours\",\n  \"ownerId\" => \"gid://shopify/Location/346779380\",\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
          Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  query LocationMetafield($namespace: String!, $key: String!, $ownerId: ID!) {\n    location(id: $ownerId) {\n      hours: metafield(namespace: $namespace, key: $key) {\n        value\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"namespace\": \"my_fields\",\n      \"key\": \"hours\",\n      \"ownerId\": \"gid://shopify/Location/346779380\"\n    },\n  },\n);\n\nconst data = await response.json();\n"
          Graphql query: "query LocationMetafield($namespace: String!, $key: String!, $ownerId: ID!) {\n  location(id: $ownerId) {\n    hours: metafield(namespace: $namespace, key: $key) {\n      value\n    }\n  }\n}"
        

  input: {
    "namespace": "my_fields",
    "key": "hours",
    "ownerId": "gid://shopify/Location/346779380"
  }

  response: {
    "data": {
      "location": {
        "hours": {
          "value": "Open daily 9AM-5PM"
        }
      }
    }
  }

  Get metafields attached to a location

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-07/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"query LocationMetafields($ownerId: ID!) { location(id: $ownerId) { metafields(first: 3) { edges { node { namespace key value } } } } }\",\n \"variables\": {\n    \"ownerId\": \"gid://shopify/Location/346779380\"\n  }\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `query LocationMetafields($ownerId: ID!) {\n      location(id: $ownerId) {\n        metafields(first: 3) {\n          edges {\n            node {\n              namespace\n              key\n              value\n            }\n          }\n        }\n      }\n    }`,\n    \"variables\": {\n      \"ownerId\": \"gid://shopify/Location/346779380\"\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 LocationMetafields($ownerId: ID!) {\n    location(id: $ownerId) {\n      metafields(first: 3) {\n        edges {\n          node {\n            namespace\n            key\n            value\n          }\n        }\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"ownerId\": \"gid://shopify/Location/346779380\"\n}\n\nresponse = client.query(query: query, variables: variables)\n"
          PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n  query LocationMetafields($ownerId: ID!) {\n    location(id: $ownerId) {\n      metafields(first: 3) {\n        edges {\n          node {\n            namespace\n            key\n            value\n          }\n        }\n      }\n    }\n  }\nQUERY;\n\n$variables = [\n  \"ownerId\" => \"gid://shopify/Location/346779380\",\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
          Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  query LocationMetafields($ownerId: ID!) {\n    location(id: $ownerId) {\n      metafields(first: 3) {\n        edges {\n          node {\n            namespace\n            key\n            value\n          }\n        }\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"ownerId\": \"gid://shopify/Location/346779380\"\n    },\n  },\n);\n\nconst data = await response.json();\n"
          Graphql query: "query LocationMetafields($ownerId: ID!) {\n  location(id: $ownerId) {\n    metafields(first: 3) {\n      edges {\n        node {\n          namespace\n          key\n          value\n        }\n      }\n    }\n  }\n}"
        

  input: {
    "ownerId": "gid://shopify/Location/346779380"
  }

  response: {
    "data": {
      "location": {
        "metafields": {
          "edges": [
            {
              "node": {
                "namespace": "my_fields",
                "key": "hours",
                "value": "Open daily 9AM-5PM"
              }
            }
          ]
        }
      }
    }
  }

  Get pinned metafield definitions associated with a location

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-07/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"query LocationMetafieldDefinitions($ownerId: ID!, $first: Int, $pinnedStatus: MetafieldDefinitionPinnedStatus, $sortKey: MetafieldDefinitionSortKeys) { location(id: $ownerId) { metafieldDefinitions(first: $first, pinnedStatus: $pinnedStatus, sortKey: $sortKey) { edges { node { name namespace key type { name } } } } } }\",\n \"variables\": {\n    \"pinnedStatus\": \"PINNED\",\n    \"ownerId\": \"gid://shopify/Location/346779380\",\n    \"first\": 10,\n    \"sortKey\": \"PINNED_POSITION\"\n  }\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `query LocationMetafieldDefinitions($ownerId: ID!, $first: Int, $pinnedStatus: MetafieldDefinitionPinnedStatus, $sortKey: MetafieldDefinitionSortKeys) {\n      location(id: $ownerId) {\n        metafieldDefinitions(first: $first, pinnedStatus: $pinnedStatus, sortKey: $sortKey) {\n          edges {\n            node {\n              name\n              namespace\n              key\n              type {\n                name\n              }\n            }\n          }\n        }\n      }\n    }`,\n    \"variables\": {\n      \"pinnedStatus\": \"PINNED\",\n      \"ownerId\": \"gid://shopify/Location/346779380\",\n      \"first\": 10,\n      \"sortKey\": \"PINNED_POSITION\"\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 LocationMetafieldDefinitions($ownerId: ID!, $first: Int, $pinnedStatus: MetafieldDefinitionPinnedStatus, $sortKey: MetafieldDefinitionSortKeys) {\n    location(id: $ownerId) {\n      metafieldDefinitions(first: $first, pinnedStatus: $pinnedStatus, sortKey: $sortKey) {\n        edges {\n          node {\n            name\n            namespace\n            key\n            type {\n              name\n            }\n          }\n        }\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"pinnedStatus\": \"PINNED\",\n  \"ownerId\": \"gid://shopify/Location/346779380\",\n  \"first\": 10,\n  \"sortKey\": \"PINNED_POSITION\"\n}\n\nresponse = client.query(query: query, variables: variables)\n"
          PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n  query LocationMetafieldDefinitions($ownerId: ID!, $first: Int, $pinnedStatus: MetafieldDefinitionPinnedStatus, $sortKey: MetafieldDefinitionSortKeys) {\n    location(id: $ownerId) {\n      metafieldDefinitions(first: $first, pinnedStatus: $pinnedStatus, sortKey: $sortKey) {\n        edges {\n          node {\n            name\n            namespace\n            key\n            type {\n              name\n            }\n          }\n        }\n      }\n    }\n  }\nQUERY;\n\n$variables = [\n  \"pinnedStatus\" => \"PINNED\",\n  \"ownerId\" => \"gid://shopify/Location/346779380\",\n  \"first\" => 10,\n  \"sortKey\" => \"PINNED_POSITION\",\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
          Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  query LocationMetafieldDefinitions($ownerId: ID!, $first: Int, $pinnedStatus: MetafieldDefinitionPinnedStatus, $sortKey: MetafieldDefinitionSortKeys) {\n    location(id: $ownerId) {\n      metafieldDefinitions(first: $first, pinnedStatus: $pinnedStatus, sortKey: $sortKey) {\n        edges {\n          node {\n            name\n            namespace\n            key\n            type {\n              name\n            }\n          }\n        }\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"pinnedStatus\": \"PINNED\",\n      \"ownerId\": \"gid://shopify/Location/346779380\",\n      \"first\": 10,\n      \"sortKey\": \"PINNED_POSITION\"\n    },\n  },\n);\n\nconst data = await response.json();\n"
          Graphql query: "query LocationMetafieldDefinitions($ownerId: ID!, $first: Int, $pinnedStatus: MetafieldDefinitionPinnedStatus, $sortKey: MetafieldDefinitionSortKeys) {\n  location(id: $ownerId) {\n    metafieldDefinitions(first: $first, pinnedStatus: $pinnedStatus, sortKey: $sortKey) {\n      edges {\n        node {\n          name\n          namespace\n          key\n          type {\n            name\n          }\n        }\n      }\n    }\n  }\n}"
        

  input: {
    "pinnedStatus": "PINNED",
    "ownerId": "gid://shopify/Location/346779380",
    "first": 10,
    "sortKey": "PINNED_POSITION"
  }

  response: {
    "data": {
      "location": {
        "metafieldDefinitions": {
          "edges": [
            {
              "node": {
                "name": "Additional Notes",
                "namespace": "my_fields",
                "key": "notes",
                "type": {
                  "name": "single_line_text_field"
                }
              }
            },
            {
              "node": {
                "name": "Operating Since",
                "namespace": "my_fields",
                "key": "operating_since",
                "type": {
                  "name": "date"
                }
              }
            }
          ]
        }
      }
    }
  }

  Retrieve a list of inventory levels for a location

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-07/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"query LocationInventoryLevelList($id: ID!) { location(id: $id) { inventoryLevels(first: 10) { nodes { item { id } location { id } quantities(names: [\\\"available\\\"]) { name quantity } } } } }\",\n \"variables\": {\n    \"id\": \"gid://shopify/Location/346779380\"\n  }\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `query LocationInventoryLevelList($id: ID!) {\n      location(id: $id) {\n        inventoryLevels(first: 10) {\n          nodes {\n            item {\n              id\n            }\n            location {\n              id\n            }\n            quantities(names: [\"available\"]) {\n              name\n              quantity\n            }\n          }\n        }\n      }\n    }`,\n    \"variables\": {\n      \"id\": \"gid://shopify/Location/346779380\"\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 LocationInventoryLevelList($id: ID!) {\n    location(id: $id) {\n      inventoryLevels(first: 10) {\n        nodes {\n          item {\n            id\n          }\n          location {\n            id\n          }\n          quantities(names: [\"available\"]) {\n            name\n            quantity\n          }\n        }\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"id\": \"gid://shopify/Location/346779380\"\n}\n\nresponse = client.query(query: query, variables: variables)\n"
          PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n  query LocationInventoryLevelList($id: ID!) {\n    location(id: $id) {\n      inventoryLevels(first: 10) {\n        nodes {\n          item {\n            id\n          }\n          location {\n            id\n          }\n          quantities(names: [\"available\"]) {\n            name\n            quantity\n          }\n        }\n      }\n    }\n  }\nQUERY;\n\n$variables = [\n  \"id\" => \"gid://shopify/Location/346779380\",\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
          Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  query LocationInventoryLevelList($id: ID!) {\n    location(id: $id) {\n      inventoryLevels(first: 10) {\n        nodes {\n          item {\n            id\n          }\n          location {\n            id\n          }\n          quantities(names: [\"available\"]) {\n            name\n            quantity\n          }\n        }\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"id\": \"gid://shopify/Location/346779380\"\n    },\n  },\n);\n\nconst data = await response.json();\n"
          Graphql query: "query LocationInventoryLevelList($id: ID!) {\n  location(id: $id) {\n    inventoryLevels(first: 10) {\n      nodes {\n        item {\n          id\n        }\n        location {\n          id\n        }\n        quantities(names: [\"available\"]) {\n          name\n          quantity\n        }\n      }\n    }\n  }\n}"
        

  input: {
    "id": "gid://shopify/Location/346779380"
  }

  response: {
    "data": {
      "location": {
        "inventoryLevels": {
          "nodes": [
            {
              "item": {
                "id": "gid://shopify/InventoryItem/113711323"
              },
              "location": {
                "id": "gid://shopify/Location/346779380"
              },
              "quantities": [
                {
                  "name": "available",
                  "quantity": 8
                }
              ]
            },
            {
              "item": {
                "id": "gid://shopify/InventoryItem/30322695"
              },
              "location": {
                "id": "gid://shopify/Location/346779380"
              },
              "quantities": [
                {
                  "name": "available",
                  "quantity": 2
                }
              ]
            }
          ]
        }
      }
    }
  }

  Retrieve a single location by its ID

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-07/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"query LocationShow($id: ID!) { location(id: $id) { id name fulfillmentService { handle } address { address1 address2 city country countryCode province provinceCode zip } fulfillsOnlineOrders hasActiveInventory isActive } }\",\n \"variables\": {\n    \"id\": \"gid://shopify/Location/346779380\"\n  }\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `query LocationShow($id: ID!) {\n      location(id: $id) {\n        id\n        name\n        fulfillmentService {\n          handle\n        }\n        address {\n          address1\n          address2\n          city\n          country\n          countryCode\n          province\n          provinceCode\n          zip\n        }\n        fulfillsOnlineOrders\n        hasActiveInventory\n        isActive\n      }\n    }`,\n    \"variables\": {\n      \"id\": \"gid://shopify/Location/346779380\"\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 LocationShow($id: ID!) {\n    location(id: $id) {\n      id\n      name\n      fulfillmentService {\n        handle\n      }\n      address {\n        address1\n        address2\n        city\n        country\n        countryCode\n        province\n        provinceCode\n        zip\n      }\n      fulfillsOnlineOrders\n      hasActiveInventory\n      isActive\n    }\n  }\nQUERY\n\nvariables = {\n  \"id\": \"gid://shopify/Location/346779380\"\n}\n\nresponse = client.query(query: query, variables: variables)\n"
          PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n  query LocationShow($id: ID!) {\n    location(id: $id) {\n      id\n      name\n      fulfillmentService {\n        handle\n      }\n      address {\n        address1\n        address2\n        city\n        country\n        countryCode\n        province\n        provinceCode\n        zip\n      }\n      fulfillsOnlineOrders\n      hasActiveInventory\n      isActive\n    }\n  }\nQUERY;\n\n$variables = [\n  \"id\" => \"gid://shopify/Location/346779380\",\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
          Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  query LocationShow($id: ID!) {\n    location(id: $id) {\n      id\n      name\n      fulfillmentService {\n        handle\n      }\n      address {\n        address1\n        address2\n        city\n        country\n        countryCode\n        province\n        provinceCode\n        zip\n      }\n      fulfillsOnlineOrders\n      hasActiveInventory\n      isActive\n    }\n  }`,\n  {\n    variables: {\n      \"id\": \"gid://shopify/Location/346779380\"\n    },\n  },\n);\n\nconst data = await response.json();\n"
          Graphql query: "query LocationShow($id: ID!) {\n  location(id: $id) {\n    id\n    name\n    fulfillmentService {\n      handle\n    }\n    address {\n      address1\n      address2\n      city\n      country\n      countryCode\n      province\n      provinceCode\n      zip\n    }\n    fulfillsOnlineOrders\n    hasActiveInventory\n    isActive\n  }\n}"
        

  input: {
    "id": "gid://shopify/Location/346779380"
  }

  response: {
    "data": {
      "location": {
        "id": "gid://shopify/Location/346779380",
        "name": "Ottawa Store",
        "fulfillmentService": null,
        "address": {
          "address1": "126 york street",
          "address2": "second and third floor",
          "city": "ottawa",
          "country": "Canada",
          "countryCode": "CA",
          "province": "Ontario",
          "provinceCode": "ON",
          "zip": "k1n5t5"
        },
        "fulfillsOnlineOrders": true,
        "hasActiveInventory": true,
        "isActive": true
      }
    }
  }

  Returns a Location resource by ID

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-07/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"query { location(id: \\\"gid://shopify/Location/346779380\\\") { id name address { formatted } deactivatable fulfillsOnlineOrders hasActiveInventory isActive shipsInventory } }\"\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: `query {\n    location(id: \"gid://shopify/Location/346779380\") {\n      id\n      name\n      address {\n        formatted\n      }\n      deactivatable\n      fulfillsOnlineOrders\n      hasActiveInventory\n      isActive\n      shipsInventory\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    location(id: \"gid://shopify/Location/346779380\") {\n      id\n      name\n      address {\n        formatted\n      }\n      deactivatable\n      fulfillsOnlineOrders\n      hasActiveInventory\n      isActive\n      shipsInventory\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\n  query {\n    location(id: \"gid://shopify/Location/346779380\") {\n      id\n      name\n      address {\n        formatted\n      }\n      deactivatable\n      fulfillsOnlineOrders\n      hasActiveInventory\n      isActive\n      shipsInventory\n    }\n  }\nQUERY;\n\n$response = $client->query([\"query\" => $query]);\n"
          Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  query {\n    location(id: \"gid://shopify/Location/346779380\") {\n      id\n      name\n      address {\n        formatted\n      }\n      deactivatable\n      fulfillsOnlineOrders\n      hasActiveInventory\n      isActive\n      shipsInventory\n    }\n  }`,\n);\n\nconst data = await response.json();\n"
          Graphql query: "query {\n  location(id: \"gid://shopify/Location/346779380\") {\n    id\n    name\n    address {\n      formatted\n    }\n    deactivatable\n    fulfillsOnlineOrders\n    hasActiveInventory\n    isActive\n    shipsInventory\n  }\n}"
        

  input: null

  response: {
    "data": {
      "location": {
        "id": "gid://shopify/Location/346779380",
        "name": "Ottawa Store",
        "address": {
          "formatted": [
            "126 york street",
            "second and third floor",
            "ottawa ON k1n5t5",
            "Canada"
          ]
        },
        "deactivatable": true,
        "fulfillsOnlineOrders": true,
        "hasActiveInventory": true,
        "isActive": true,
        "shipsInventory": false
      }
    }
  }