Each site is represented in Commerce Cloud by an object whose properties store configuration data for the site. To set up a new site, you create a site object and set the values of the properties. You can also update an existing site by modifying the values of the site object properties, or delete a site by deleting its site object. Note that you must log into the Admin API on the administration server using a profile that has the Administrator role in order to create, modify, or delete sites.
To simplify site creation, Commerce Cloud designates one site as the default site. When you create a new site, the values for properties that you do not explicitly supply are copied to the new site from the default site, with the following exceptions:
productionURLandadditionalProductionURLsare left null if you do not supply values.priceListGroupListdefaults to a single JSON object containing the value ofdefaultPriceListGroup.idandnamevalues are supplied automatically by Commerce Cloud.
In addition to serving as a template for site creation, the default site is used as the destination for requests to your Commerce Cloud instance when the site cannot be otherwise resolved (for example, a request whose URL does not match any of the URLs specified in the productionURL or additionalProductionURLs properties described below).
There is always a single default site in an individual instance of Commerce Cloud. Initially, this is the site whose id is siteUS (the site included with each Commerce Cloud instance). Once you have created other sites, you can change which site is the default. However, there are several restrictions you should be aware of when setting the default site:
The
enabledproperty of the default site must betrue. If you want to make a currently disabled site the default, first setenabledtotrue.You cannot set the
enabledproperty tofalseon the default site. If you want to disable the site that is currently the default, first make a different site the default.If you set the
defaultSiteproperty totrueon a site that is not currently the default, thedefaultSiteproperty is automatically set tofalseon the site that was previously the default.If you attempt to set the
defaultSiteproperty tofalseon the site that is currently the default, the call is ignored. To set thedefaultSiteproperty tofalseon a site, you must set it totrueon a different site.You cannot delete the default site. If you want to delete the site that is currently the default, first make a different site the default.
Most of the properties of site objects are site-specific – their values can be different for each site. A few properties are global – their values must be identical for all sites. When you set a site-specific property on a site object, the value you supply is applied only to that site object. When you set a global property on a site object, the value you supply is applied to all of the site objects in your Commerce Cloud instance.
The following site properties are global:
Property | Description |
|---|---|
| The hostname of the server for product recommendations. For example, |
| The port number for accessing the server for product recommendations. |
The remaining site properties are site-specific, including the following:
Property | Description |
|---|---|
| The primary URL for accessing the site, without the protocol or any subdirectories. For example, |
| Alternate URLs that can be used to access the site. These URLs must be specified in the same format as |
| An array that specifies external domains that are allowed to use CORS to make requests to the site. See CORS support for more information. |
| An array of JSON objects that specify all of the price list groups associated with the site. Must include the price list group specified in |
| A JSON object that specifies the default price list group associated with the site. |
| Name of the site (maximum 254 characters). |
| Text describing the site. |
| Text describing the site in greater detail. |
| The product catalog used for the site. Each site is associated with a single catalog. |
| The country code of the default billing country for the site. |
| The country code of the default shipping country for the site. |
| A string containing an integer that identifies the default locale for the site. You can view the mapping of IDs to locales using the |
| An array of IDs that specify other locales the site supports. |
| A boolean specifying whether the site is currently enabled. |
| A boolean specifying whether the site is currently the default site. |
| An array listing the site types this site supports. For sites running consumer-based commerce, set this property to |
| Amount of time (in milliseconds) that an approved order or a partially paid order can remain available before payment is completed. If payment is not completed after this amount of time, the order is marked for cancellation. |
| For sites that support loyalty points, the monetary currency that points can be converted to for calculating taxes and shipping costs. See Work with Loyalty Programs for more information. |
