Site document (Data API 23.1)

Document representing a site.

Property Type Constraints Description
cartridges String   The cartridge Path of the site
customer_list_link CustomerListLink   The link to the customer list.
description Localized<String>   The description of this site.
display_name Localized<String>   The display name entered by the user.
id String mandatory=true, minLength=1, nullable=false The id of this site.
in_deletion Boolean   The deletion status of this site, true if in deletion
link String   A link directly to the site
storefront_status Enum {online, maintenance, to_be_deleted, protected}    
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.