Skip to Content

Locale

Language and regional settings, including ISO code, name, endonym, and root URL.

Type Definition

type Locale { endonymName: String isoCode: String name: String primary: Boolean rootUrl: String }

Fields

FieldTypeDescription
endonymNameStringReturns the endonym name for this locale.
isoCodeStringReturns the iso code for this locale.
nameStringReturns the name.
primaryBooleanReturns true if this locale is the shops primary locale.
rootUrlStringReturns the root URL for this locale.

Relationships

The Locale type is used to provide language and regional settings information within the API. It is referenced by the Customer type through the language field, allowing customer objects to specify their preferred locale and regional settings.

Example

query { endonymName isoCode name primary rootUrl }

Implements

This type does not implement any interfaces.

  • Customer