For the complete documentation index, see llms.txt. This page is also available as Markdown.

Salesforce Commerce Cloud

Overview of Violet's Salesforce Commerce Cloud (SFCC) integration for channel developers

Salesforce Commerce Cloud (SFCC), formerly known as Demandware, is an enterprise ecommerce platform. SFCC uses the Open Commerce API (OCAPI) for backend integrations. This is one of the more involved platform setups due to SFCC's access control model.

Connection

SFCC credentials are passed as a JSON blob containing the following fields:

Field
Description

ocapi_client_id

OCAPI client ID configured in Business Manager

ocapi_client_password

OCAPI client password

access_key

Business Manager access key for the connecting user

username

Business Manager username (email)

site_id

The SFCC site ID to connect (e.g. RefArch)

The store URL is also required.

Required OCAPI Permissions

Violet validates OCAPI permissions during authentication. Both Shop API and Data API resource access must be configured in Business Manager for the provided client ID. Violet checks for a defined set of required resources across both API types and returns a detailed error listing any missing scopes if they are not present.

To simplify setup, merchants can grant wildcard (/**) access to the client ID rather than configuring individual resource paths.

Merchant Setup Requirements

  • Customer Group: The SFCC site must have a customer group named VIOLET_API. Violet-submitted orders are placed under this customer group.

  • Payment Method: A payment method must be configured on the site that Violet can reference when submitting orders.

Webhooks

SFCC does not support traditional real-time webhooks for the OCAPI integration. Product and order data is synchronized via scheduled sync jobs rather than push notifications.

Notable Behavior

  • Order management: SFCC order management is handled separately from the core OCAPI integration. If merchants use a standalone Order Management System (OMS) alongside SFCC, additional configuration may be required.

  • Locales and sites: SFCC supports complex multi-locale and multi-site configurations. Violet connects to the site specified in the site_id credential field.

Last updated

Was this helpful?