Choose a version:

locationByIdentifier

query

Requires read_locations access scope.

Return a location by an identifier.

Arguments

Anchor to identifieridentifier •LocationIdentifierInput!required: The identifier of the location.

Was this section helpful?

Anchor to Possible returnsPossible returns

Anchor to LocationLocation •Location: 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.

Was this section helpful?

Find a location by custom id

Open in GraphiQL

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

const response = await admin.graphql(

`#graphql

query($identifier: LocationIdentifierInput!) {

location: locationByIdentifier(identifier: $identifier) {

name

}

}`,

{

variables: {

"identifier": {

"customId": {

"namespace": "custom",

"key": "id",

"value": "1001"

}

);

const data = await response.json();

query($identifier: LocationIdentifierInput!) {
  location: locationByIdentifier(identifier: $identifier) {
    id
    name
  }
}

curl -X POST \
https://your-development-store.myshopify.com/admin/api/unstable/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query($identifier: LocationIdentifierInput!) { location: locationByIdentifier(identifier: $identifier) { id name } }",
 "variables": {
    "identifier": {
      "customId": {
        "namespace": "custom",
        "key": "id",
        "value": "1001"
      }
    }
  }
}'

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

const response = await admin.graphql(
  `#graphql
  query($identifier: LocationIdentifierInput!) {
    location: locationByIdentifier(identifier: $identifier) {
      id
      name
    }
  }`,
  {
    variables: {
      "identifier": {
        "customId": {
          "namespace": "custom",
          "key": "id",
          "value": "1001"
        }
      }
    },
  },
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `query($identifier: LocationIdentifierInput!) {
      location: locationByIdentifier(identifier: $identifier) {
        id
        name
      }
    }`,
    "variables": {
      "identifier": {
        "customId": {
          "namespace": "custom",
          "key": "id",
          "value": "1001"
        }
      }
    },
  },
});

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($identifier: LocationIdentifierInput!) {
    location: locationByIdentifier(identifier: $identifier) {
      id
      name
    }
  }
QUERY

variables = {
  "identifier": {
    "customId": {
      "namespace": "custom",
      "key": "id",
      "value": "1001"
    }
  }
}

response = client.query(query: query, variables: variables)

Input variables

JSON

{

"identifier": {

"customId": {

"namespace": "custom",

"key": "id",

"value": "1001"

}

Response

JSON

{

"location": {

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

"name": "Ottawa Store"

}