Skip to Content

Locale

Describes a locale with information about language, region, and localization settings.

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 by the Customer type to specify the customer’s preferred language locale. It provides localization information that can be referenced when personalizing content or communications for specific regions and languages.

Example

{ endonymName isoCode name primary rootUrl }

Implements

This type does not implement any interfaces.