You are here:
Install the Shopper Agent Cartridge for SFRA Storefronts
If you use SFRA (Storefront Reference Architecture) to develop your storefront, install the required SFRA cartridge to run the agent.
- Confirm that you can access the Salesforce Commerce repository on GitHub.
- Clone the plugin_shopper_agent repository.
-
From the plugin_shopper_agent directory, install Node
Package Manager (NPM) dependencies with the command npm
install.
SFRA depends on modules managed by npm.
- Return to the plugin_shopper_agent directory, and open the dw.json configuration file.
-
In the dw.json configuration file, edit the hostname,
username, password, and code version. If the file doesn't exist, create it.
The dw.json file establishes the server connection and the code version to upload the cartridge. The code version must match the SFRA deployment in Business Manager. To locate it, click App Launcher
, and then select
"hostname": "HOST.salesforce.com", "username": "USERNAME", "password": "WEBDAV_ACCESS_KEY", "code-version": "CODE_VERSION" - Upload the cartridge with the command npm run uploadCartridge.
-
In the Business Manager, set up the cartridge path.
- Install the app_storefront_base cartridge.
-
Click App Launcher
, and then select , and select your site.
- On the Settings tab, update the cartridge path. For example, plugin_shopper_agent:app_storefront_base.
- Save your changes.

