Skip to main content

SFCC Integration Setup

Updated

This guide walks you through the steps needed to connect your Salesforce Commerce Cloud (SFCC) store to Rep AI. By the end, you will have the 4 values required for the connection:

 
 
 

Field

 

Where to find it

 

clientId

SFCC Account Manager — API Client page

clientSecret

The password you set when creating the API Client

instanceHostname

Your SFCC instance URL (e.g. your-store.dx.commercecloud.salesforce.com)

siteId

Business Manager — your storefront site identifier (e.g. RefArch, SiteGenesis)

 
 
 

Time Required: ~30 minutes

Prerequisites

  • SFCC Account Manager access (admin level) — https://account.demandware.com

  • SFCC Business Manager access (admin level)

Step 1: Create an API Client

  1. Log in to Account Manager: https://account.demandware.com

  2. Navigate to Account Information → API Client

  3. Click Add API Client

  4. Fill in the following:

    • Display Name: Rep AI

    • Description: Rep AI shopping assistant integration

    • Password: Create a strong password — save it immediately, this is your clientSecret

  5. Make sure Enabled is checked

  6. Under Organizations, assign the organization that owns your SFCC instance

  7. Roles — leave empty. Do not assign any roles (such as Salesforce Commerce API or SLAS Organization Admin)

  8. Click Save

After saving, copy and store these two values:

  • Client ID → this is your clientId

  • Password (from step 4) → this is your clientSecret

Step 2: Configure OCAPI Permissions

In Business Manager, navigate to:

Administration → Site Development → Open Commerce API Settings

You need to configure two sets of permissions: Data API and Shop API. Both must use Global context.

2a: Data API Permissions

  • Type: Data

  • Context: Global

Paste the following JSON (replace YOUR_CLIENT_ID with the Client ID from Step 1):

{ "_v": "23.2", "clients": [ { "client_id": "YOUR_CLIENT_ID", "allowed_origins": [], "resources": [ { "resource_id": "/**", "methods": ["get", "post", "put", "patch", "delete"], "read_attributes": "(**)", "write_attributes": "(**)" }, { "resource_id": "/order_search", "methods": ["post"], "read_attributes": "(**)", "write_attributes": "(**)" } ] } ] }

Click Save, then wait 2–5 minutes for the configuration to propagate.

2b: Shop API Permissions

  • Type: Shop

  • Context: Global

Paste the following JSON (replace YOUR_CLIENT_ID with the Client ID from Step 1):

{ "_v": 23.2, "clients": [ { "client_id": "YOUR_CLIENT_ID", "resources": [ { "resource_id": "/products/*", "methods": ["get"], "read_attributes": "(**)" }, { "resource_id": "/order_search", "methods": ["post"], "read_attributes": "(**)", "write_attributes": "(**)" } ] } ] }

Click Save, then wait 2–5 minutes for the configuration to propagate.

Step 3: Find Your Instance Hostname and Site ID

Instance Hostname

Your instanceHostname is the domain of your SFCC instance. It typically looks like:

your-store.dx.commercecloud.salesforce.com

You can find it in Business Manager — it's the hostname in your browser's address bar when logged in (without any path).

Site ID

Your siteId is the identifier for your storefront site. To find it:

  1. In Business Manager, go to Administration → Sites → Manage Sites

  2. Your Site ID is listed in the ID column (e.g. RefArch, SiteGenesis, or a custom name)

Step 4: Provide Your Credentials to Rep AI

Once you have all 4 values, share them with your Rep AI contact:

{ "clientId": "your-client-id", "clientSecret": "your-client-secret", "instanceHostname": "your-store.dx.commercecloud.salesforce.com", "siteId": "your-site-id" }

Verification Checklist

Before sharing your credentials, confirm:

API Client is Enabled in Account Manager

The correct Organization is assigned to the API Client

No roles are assigned to the API Client

Data API permissions are saved with Global context

Shop API permissions are saved with Global context

Both OCAPI configs use the correct Client ID

You waited at least 2–5 minutes after saving OCAPI settings

Troubleshooting

Connection fails with 403 Forbidden

  • Verify the API Client is Enabled in Account Manager

  • Verify both Data and Shop OCAPI JSONs contain your correct Client ID

  • Ensure context is set to Global (not site-specific)

  • Ensure no Salesforce Commerce API role is assigned to the client

  • Wait a few more minutes — OCAPI config propagation can take up to 5 minutes

Missing product pricing data

  • Ensure Shop API permissions are configured (not just Data API)

  • Verify price books exist and are assigned to your site in Business Manager

Common mistakes

  • Setting OCAPI context to a specific site instead of Global

  • Assigning SCAPI roles to the OCAPI client

  • Forgetting to enable the API Client

  • Configuring only the Data API and missing the Shop API

  • Not waiting for OCAPI configuration to propagate

Widget Installation

After Rep AI confirms the connection is successful, you will receive a widget embed code to place on your storefront.

SFRA (Storefront Reference Architecture)

Add the provided snippet to:

app_storefront_base/cartridge/templates/default/common/htmlHead.isml

Paste it before </head>.

PWA Kit

Add the provided snippet at the app/root level in:

_app-config/index.jsx

After Installation

  • Deploy your storefront changes

  • Open your storefront and verify the widget loads

  • If the widget does not appear, ensure your Content Security Policy (CSP) allows the Rep AI loader domain

Powered by Zendesk