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

Site document (Shop API 23.2)

Document representing a site.

Property Type Constraints Description
allowed_currencies [String]   The list of allowed currencies.
allowed_locales [Locale]   A list of all allowed site locales.
default_currency String   The currency mnemonic of the site.
default_locale String   The default locale of the site.
http_dis_base_url String   The HTTP DIS base URL.
http_hostname String   The configured HTTP host name. If no host name is configured the instance host name is returned.
http_library_content_url String   The HTTP URL to the library content location of the site.
http_site_content_url String   The HTTP URL to the site content location.
https_dis_base_url String   The HTTPS DIS base URL.
https_hostname String   The configured HTTPS host name. If no host name is configured the instance host name is returned.
https_library_content_url String   The HTTPS URL to the library content location of the site.
https_site_content_url String   The HTTPS URL to the site content location.
id String   The id of the site.
name String   The descriptive name for the site.
status Enum {online, offline}   The site status online/offline.
timezone String   The time zone of the site (for example, USA/Eastern).
timezone_offset Integer   The time zone offset from UTC for the current time in milliseconds (for example, -14400000).

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.