Maintenance Response Codes

When your B2C Commerce instance is updated as part of a system deployment, or you set the associated site's Site Status to Maintenance, B2C Commerce API returns a maintenance HTTP response.

System Maintenance

This includes system-wide updates, such as a B2C Commerce release or database upgrade. This status is typically set by B2C Commerce. For additional information, refer to the B2C Commerce Deployment Schedule.

Additional HTTP response header:

sfdc_maintenance: system

Example of the error response body:

{
  "type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/system-under-maintenance",
  "title": "System Under Maintenance",
  "detail": "The request could not be processed as the system is currently under maintenance."
}

Site Maintenance

When the Site Status of a B2C Commerce Site is set to Maintenance in Business Manager's Manage Sites panel, an HTTP 503 response is returned with an additional HTTP response header:

sfdc_maintenance: site

Example of the error response body:

{
  "type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/site-under-maintenance",
  "title": "Site Under Maintenance",
  "detail": "The request could not be processed as the site is currently under maintenance."
}