ShopLocale - admin-graphql - OBJECT

Version: 2025-01

Description:

A locale that's been enabled on a shop.

Access Scopes

`read_locales` access scope or `read_markets_home` access scope.

Fields

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

Connections

Related queries

  • shopLocales A list of locales available on a shop.

Related mutations

  • shopLocaleEnable Adds a locale for a shop. The newly added locale is in the unpublished state.
  • shopLocaleUpdate Updates a locale for a shop.

Related Unions

Examples