Choose a version:

shopLocales

query

Requires read_locales access scope or read_markets_home access scope.

A list of locales available on a shop.

Arguments

Anchor to publishedpublished • BooleanDefault:false: Return only published locales.

Was this section helpful?

Anchor to Possible returnsPossible returns

ShopLocale

•

[ShopLocale!]!

A locale that's been enabled on a shop.

locale• String! non-null: The locale ISO code.
marketWebPresences• [MarketWebPresence!]! non-null: The market web presences that use the locale.
name• String! non-null: The human-readable locale name.
primary• Boolean! non-null: Whether the locale is the default locale for the shop.
published• Boolean! non-null: Whether the locale is visible to buyers.

Was this section helpful?

Retrieve a shop's locales

Open in GraphiQL

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

const response = await admin.graphql(

`#graphql

query {

shopLocales {

locale

primary

published

}

}`,

);

const data = await response.json();

query {
  shopLocales {
    locale
    primary
    published
  }
}

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query { shopLocales { locale primary published } }"
}'

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

const response = await admin.graphql(
  `#graphql
  query {
    shopLocales {
      locale
      primary
      published
    }
  }`,
);

const data = await response.json();

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

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)

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

}

]

}