Choose a version:

ShopLocale

object

Requires read_locales access scope or read_markets_home access scope.

A locale that's been enabled on a shop.

Anchor to FieldsFields

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?

Anchor to QueriesQueries

Anchor to shopLocales shopLocales

•query

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 publishedpublished •Boolean Default:false: Return only published locales.

Was this section helpful?

Anchor to MutationsMutations

Anchor to shopLocaleEnable shopLocaleEnable

•mutation

Adds a locale for a shop. The newly added locale is in the unpublished state.

Anchor to localelocale •String! required: ISO code of the locale to enable.
Anchor to marketWebPresenceIdsmarketWebPresenceIds •[ID!]: The list of markets web presences to add the locale to.

Anchor to shopLocaleUpdate shopLocaleUpdate

•mutation

Updates a locale for a shop.

Arguments

Anchor to localelocale

•String!

required

ISO code of the locale to update.

Anchor to shopLocaleshopLocale

•ShopLocaleInput!

required

Specifies the input fields for a shop locale.

Was this section helpful?