Skip to main content
Welcome to the preview portal — This is an early release of the new Doc Hub experience, with more content coming soon.
Technology Partner

Install the Salesforce B2C Commerce Cartridge


Before beginning installation, ensure that you have:

  • Access to your Salesforce B2C Commerce instance.
  • Node.js installed on your development machine.
  • An appropriate IDE, such as VSCode with the Prophet Debugger extension.

Download the cartridge

Download the cartridge for Salesforce B2C Commerce from the ISV Integration Toolkits section on GitHub. The single download unpacks into the three cartridge folders referenced in the next step: int_cybs_sfra, int_cybs_sfra_base, and bm_cybs_sfra.

Set up your workspace

Create a folder named in your Salesforce workspace and copy the downloaded cartridges, int_cybs_sfra, int_cybs_sfra_base, and bm_cybs_sfra to the workspace.

If the project's base path is different from the one available in package.json, open the file /package.json and modify the paths.base value to point to your app_storefront_base cartridge. This path is used by the JS and SCSS build scripts.

Configure the IDE

If you use VSCode, install the Prophet Debugger extension and include these lines in dw.json:

{    "hostname": "your-sandbox-hostname.demandware.net",    "username": "yourlogin",    "password": "yourpwd",    "version": "version_to_upload_to",    "cartridge": [        "int_cybs_sfra",        "int_cybs_sfra_base",        "bm_cybs_sfra",        "app_storefront_base",        "modules"    ]}

If you are using a different IDE, refer to the respective guide to set up your workspace.

Install the Node.js dependencies

Install the Node.js dependencies in the folder.

npm install

Install the build dependencies

Install sgmf-scripts and copy-webpack-plugin with this command:

npm install sgmf-scripts && npm install copy-webpack-plugin

Compile JS and SCSS

Compile JS and SCSS with this command:

npm run compile:js && npm run compile:scss

Upload the code

Upload the code to the Salesforce B2C Commerce instance:

npm run uploadCartridge

Result: The cartridge is now installed and ready for configuration in your Salesforce B2C Commerce environment.

Last published: November 18, 2026