Skip to content

Locale

The Locale object represents a specific locale of the storefront.

classDiagram
  direction LR
  Locale --> LocalesList
  class LocalesList{
  }
  class Locale{
    int id
    string locale
    string name
    string region
    Url url
    string currencyCode
  }

Properties

Attribute name Type Description
id int The unique identifier of the locale.
locale string System localization in ISO-8859-1 format.
name string Display name of the locale.
region string Display region of the locale.
url Url The Url object represents an external or internal url of locale.
currencyCode string Currency code of locale's default currency.

Examples

id property

{{ locale.id }}
1

locale property

{{ locale.locale }}
en_US

name property

{{ locale.name }}
english

region property

{{ locale.region }}
United States

url property

{{ locale.url }}
/en_US/index

currencyCode property

{{ locale.currencyCode }}
USD