Choose a version:

shopLocales

query

Requires read_locales access scope or read_markets_home access scope.

Returns the locales enabled on a shop. Each locale represents a language for translations and determines how content displays to customers in different markets.

Use the optional published argument to filter for only the locales that are visible to customers. The response includes the ISO locale code, whether it's the shop's primary locale, and which MarketWebPresence objects use each locale.

Anchor to Arguments

Arguments

Anchor to publishedpublished •Boolean Default:false: Return only published locales.

Was this section helpful?

Anchor to Possible returnsPossible returns

Anchor to ShopLocaleShopLocale

•[ShopLocale!]!

A locale that's been enabled on a shop.

Anchor to localelocale •String! non-null: The locale ISO code.
Anchor to marketWebPresencesmarketWebPresences •[MarketWebPresence!]! non-null: The market web presences that use the locale.
Anchor to namename •String! non-null: The human-readable locale name.
Anchor to primaryprimary •Boolean! non-null: Whether the locale is the default locale for the shop.
Anchor to publishedpublished •Boolean! non-null: Whether the locale is visible to buyers.

Was this section helpful?

Examples

Retrieve a shop's locales

Description

The following query retrieves a list of the shop's enabled locales, including the locale tag, the published state, and whether the locale tag is the primary tag.

Query

query {
  shopLocales {
    locale
    primary
    published
  }
}

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 { shopLocales { locale primary published } }"
}'

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 {
    shopLocales {
      locale
      primary
      published
    }
  }`,
  );
  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 {
    shopLocales {
      locale
      primary
      published
    }
  }
QUERY

response = client.query(query: query)

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: `query {
    shopLocales {
      locale
      primary
      published
    }
  }`,
});

Shopify CLI

shopify app execute \
--query \
'query {
  shopLocales {
    locale
    primary
    published
  }
}'

Response

{
  "shopLocales": [
    {
      "locale": "en",
      "primary": true,
      "published": true
    },
    {
      "locale": "es",
      "primary": false,
      "published": true
    },
    {
      "locale": "fr",
      "primary": false,
      "published": true
    },
    {
      "locale": "ja",
      "primary": false,
      "published": true
    }
  ]
}

Retrieve a shop's locales

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 {

shopLocales {

locale

primary

published

}

}`,

);

const json = await response.json();

return json.data;

}

GQL

query {
  shopLocales {
    locale
    primary
    published
  }
}

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 { shopLocales { locale primary published } }"
}'

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 {
    shopLocales {
      locale
      primary
      published
    }
  }`,
  );
  const json = await response.json();
  return json.data;
}

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: `query {
    shopLocales {
      locale
      primary
      published
    }
  }`,
});

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 {
    shopLocales {
      locale
      primary
      published
    }
  }
QUERY

response = client.query(query: query)

Shopify CLI

shopify app execute \
--query \
'query {
  shopLocales {
    locale
    primary
    published
  }
}'

Response

JSON

{

"shopLocales": [

{

"locale": "en",

"primary": true,

"published": true

{

"locale": "es",

"primary": false,

"published": true

{

"locale": "fr",

"primary": false,

"published": true

{

"locale": "ja",

"primary": false,

"published": true

}

]

}