Locale document (Shop API 21.9)

Document that describes a single locale.

Property Type Constraints Description
country String   The uppercase ISO 3166 2-letter country/region code for this Locale. If no country has been specified for this Locale, this value is an empty string.
default Boolean   Flag that is true if this locale is the default to use if a locale is not specified.
display_country String   The display name of this Locale's country, in this Locale's language, not in the session locale's language. If no country has been specified for this Locale, this value is an empty string.
display_language String   The display name of this Locale's language, in this Locale's language, not in the session locale's language. If no country has been specified for this Locale, this value is an empty string.
display_name String   The display name of this Locale, in this Locale's language, not in the session locale's language. If no display name has been specified for this Locale, this value is an empty string.
id String   The identifier of the Locale. Combines the language and the country key, concatenated with "-". For example: "en-US". This attribute is the primary key of the class.
iso3_country String   The uppercase ISO 3166 3-letter country/region code for this Locale. If no country has been specified for this Locale, this value is an empty string.
iso3_language String   The 3-letter ISO 639 language code for this Locale. If no language has been specified for this Locale, this value is an empty string.
language String   The lowercase ISO 639 language code for this Locale. If no language has been specified for this Locale, this value is an empty string.
name String   The display name of the Locale. Uses the current request locale to localize the value.
X OCAPI versions 15.x and 16.x will be retired on March 31, 2021. For dates and more information, see the OCAPI versioning and deprecation policy and this Knowledge Article.
X Privacy Update: We use cookies to make interactions with our websites and services easy and meaningful, to better understand how they are used. By continuing to use this site you are giving us your consent to do this. Privacy Policy.