Anchor to section titled 'undefined'

shopLocales
query

Requires read_locales access scope or read_markets_home access scope.

A list of locales available on a shop.

Anchor to section titled 'Arguments'

Arguments

Anchor to published
published
Boolean
default:false

Return only published locales.

Was this section helpful?
Anchor to section titled 'ShopLocale possible returns'

ShopLocale possible returns

Anchor to ShopLocale
ShopLocale
ShopLocale
Access requirements

A locale that's been enabled on a shop.

Was this section helpful?
Retrieve a shop's locales
Hide code
DescriptionCopy
query {
  shopLocales {
    locale
    primary
    published
  }
}
Hide code
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
    }
  ]
}