Skip to content

TLocale

The TLocale object represents a locale available in the shop with its configuration and metadata.

Properties

locale

Type: TLocaleIsoUnderscore

The locale code in ISO format with underscore separator (e.g., "en_US", "pl_PL").

name

Type: string

The display name of the locale in its native language.

region

Type: string

The region or country name associated with the locale.

url

Type: string

The URL path or identifier for the locale in the shop.

currencyCode

Type: TCurrencyIsoCode

The default currency code for this locale in ISO format.

Example

const locale: TLocale = {
    locale: 'pl_PL',
    name: 'Polski',
    region: 'Poland',
    url: '/pl/',
    currencyCode: 'PLN'
};