Skip to main content

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: A list of locales available on a shop.

Was this section helpful?

Anchor to MutationsMutations

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 shopLocaleshopLocale •ShopLocale: ISO code of the locale that was enabled.
Anchor to userErrorsuserErrors •[UserError!]! non-null: The list of errors that occurred from executing the mutation.

shopLocaleUpdate

•mutation

Updates a locale for a shop.

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.

Anchor to shopLocaleshopLocale •ShopLocale: The locale that was updated.
Anchor to userErrorsuserErrors •[UserError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?