Setup Guide

Get SFCC Copilot running in your Business Manager in under 5 minutes.

Requirements

Google Chrome or Microsoft Edge browser
Access to your SFCC Business Manager (any sandbox or production)
Ability to edit OCAPI Settings in Business Manager
Access to account.demandware.com to create an API client
SFCC Data API version v24_1 or higher

1. Install the Chrome Extension

Download the extension Go to the GitHub repository and download the latest release ZIP.

Open Chrome Extensions Navigate to chrome://extensions in your browser.

Enable Developer Mode Toggle Developer mode in the top-right corner.

Load the extension Click Load unpacked and select the extension/ folder from the downloaded ZIP.

✓ The Copilot button will appear in the bottom-right corner of any Business Manager page.

2. Configure OCAPI Settings

SFCC Copilot uses the OCAPI Data API to create promotions, campaigns, and coupons. You need to grant your API client access to the required resources.

Open OCAPI Settings in Business Manager Go to Administration → Site Development → Open Commerce API Settings

Select Type: Data — Context: your site Select Data from the Type dropdown, then select your site (e.g. RefArch) from the Context dropdown.

Add the required resources Add the JSON below for your API client ID. If other clients already exist, append this as a new object in the clients array.

The required OCAPI resources for SFCC Copilot:

Resource	Methods	Purpose
`/sites//campaigns/`	GET PUT	Create & read campaigns
`/sites//campaigns//promotions/*`	PUT	Link promotions to campaigns
`/sites//campaigns//customer_groups/*`	PUT DELETE	Assign & remove customer groups
`/sites//campaigns//coupons/*`	PUT	Link coupons to campaigns
`/sites//promotions/`	GET PUT	Create & read promotions
`/sites//coupons/`	GET PUT	Create coupons

3. Create an API Client in Account Manager

If you don't have an API client yet, create one at account.demandware.com.

Go to API Client section Login → API Client → Add API Client

Add required roles Under Roles, add Sandbox API User and Salesforce Commerce API for your tenant (e.g. bjjp_004).

Copy your Client ID and Client Secret You'll need these in the next step.

⚠ The Client Secret is only shown once. Save it securely before leaving the page.

4. Enter Credentials in the Extension

Open the Copilot in Business Manager Click the Copilot button in the bottom-right corner of any BM page.

Open Settings Click the ⚙ icon in the Copilot header.

Fill in your credentials Enter your Base URL (e.g. https://xxxx-001.dx.commercecloud.salesforce.com), Client ID, Client Secret, and API Version (v24_1).

Click Save & Connect Credentials are stored locally in your browser — never sent to any third-party server.

✓ You're ready! Type a promotion description in the chat and SFCC Copilot will handle the rest.

Full OCAPI JSON Reference

Replace YOUR_CLIENT_ID with your actual API client ID. Add this to the Data API → your site context in OCAPI Settings.

{
  "_v": "24.1",
  "clients": [
    {
      "client_id": "YOUR_CLIENT_ID",
      "resources": [
        {
          "resource_id": "/sites/*/campaigns/*",
          "methods": ["get", "put", "patch", "delete"],
          "read_attributes": "(**)",
          "write_attributes": "(**)"
        },
        {
          "resource_id": "/sites/*/campaigns/*/promotions/*",
          "methods": ["put", "patch", "delete"],
          "read_attributes": "(**)",
          "write_attributes": "(**)"
        },
        {
          "resource_id": "/sites/*/campaigns/*/customer_groups/*",
          "methods": ["put", "delete"],
          "read_attributes": "(**)",
          "write_attributes": "(**)"
        },
        {
          "resource_id": "/sites/*/campaigns/*/coupons/*",
          "methods": ["put", "delete"],
          "read_attributes": "(**)",
          "write_attributes": "(**)"
        },
        {
          "resource_id": "/sites/*/promotions/*",
          "methods": ["get", "put", "patch", "delete"],
          "read_attributes": "(**)",
          "write_attributes": "(**)"
        },
        {
          "resource_id": "/sites/*/coupons/*",
          "methods": ["get", "put", "patch", "delete"],
          "read_attributes": "(**)",
          "write_attributes": "(**)"
        }
      ]
    }
  ]
}

ℹ If you already have other clients in your OCAPI Settings, add this as an additional object inside the existing "clients": [...] array — do not replace the entire JSON.

Troubleshooting

Error: ClientAccessForbiddenException

Your API client doesn't have permission for the requested resource. Check that:

The OCAPI resources were added to the correct site context (not Global)
The correct roles were added in Account Manager for your tenant
You waited ~3 minutes after saving OCAPI settings for changes to propagate

Error: OCAPI auth failed

Authentication with the Salesforce Account Manager failed. Check that:

Your Client ID and Client Secret are correct
The API client is enabled in Account Manager
The tenant roles include Sandbox API User for your environment

Copilot button not appearing

The extension only injects on Business Manager URLs matching *.commercecloud.salesforce.com or *.demandware.net. Make sure you're on a BM page and the extension is enabled in chrome://extensions.