Salesforce B2C Commerce 24.7 > Open Commerce API 23.2 > Data API documents 23.2

Locale document (Data API 23.2)

Document that describes a single locale.

Property Type Constraints Description
active Boolean   Flag that is true if the locale is currently active in the system.
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 the locale is the default one to use if an explicit 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   Returns the String representation of the localeID.

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.

Infocenter Retirement: On June 30, 2023, the Infocenter was retired, and documentation currently hosted on the Infocenter will be published to Salesforce Help, Commerce Cloud Developer Center, and Salesforce B2C Commerce Developer Documentation Resources. For more information, see the release note.

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.