Before you start
It’s recommended that you first install the Salesforce Commerce Cloud cartridge to a sandbox instance that is an exact copy of your live store. After you have verified everything is working properly in your sandbox environment, you can safely install the cartridge in your live environment.
The Gr4vy Salesforce Commerce Cloud cartridge is available for free in the Salesforce AppExchange.
Install the cartridges
Upload the following cartridges to the Business Manager of your Salesforce Commerce Cloud instance.
Configure the cartridge path as shown in the below tables. Cartridges should be added to the
beginning of the cartridge path. The
int_gr4vy_test cartridge can be added for testing the back office,
however, it should be removed after testing the integration.
|Site Cartridge Path
|Business Manager Cartridge Path
All BM configurations related to the below components have been configured within
- System/Custom object definitions
- Payment Methods
- Payment Processors
Please follow the below steps to import the BM configurations for the above-mentioned components.
- Locate the folder metadata in the installation package.
- Review the contents within the
- Change the site ID under path
site-template\sitesto your site ID.
- Archive the folder to
site-template.zipand import the file via
Site Import & Export.
The integration includes a new service named
Gr4vyAPI which can be accessed from Administration -> Operations -> Services.
The URLs for the sandbox and production credentials need to be configured with the URL of your Gr4vy
instance. For example, if your Gr4vy instance ID was
example, the URL for your sandbox credentials
https://api.sandbox.example.gr4vy.app and the URL for your production credentials would be
Payment Processor and Payment Method
The cartridge includes a Processor called
GR4VY which should be mapped to the Gr4vy Payment Method
under Merchant Tools -> Ordering -> Payment Methods.
The integration includes a new job named
ProcessGr4vyNotifications available under Administration -> Operations -> Jobs.
ProcessGr4vyNotifications job processes webhook notifications received from Gr4vy at a scheduled interval.
To configure the job, navigate to Administration -> Operations -> Jobs and select
ProcessGr4vyNotifications. Then on the
Schedule and History tab, set the job to run with a recurring interval of 1 minute.
Then on the
Job Steps tab, select the
Specific Sites scope and select the sites where the job is required.