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.Salesforce AppExchange
Our 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.int_gr4vy_sfra
int_gr4vy
bm_gr4vy
int_gr4vy_test
cartridge can be added for testing the back office,
however, it should be removed after testing the integration.
Site Cartridge Path | int_gr4vy_sfra:int_gr4vy |
Business Manager Cartridge Path | bm_gr4vy |
Metadata
All BM configurations related to the below components have been configured withinmetadata/site-template
folder.
- System/Custom object definitions
- Payment Methods
- Payment Processors
- Services
- Jobs
- Locate the folder metadata in the installation package.
- Review the contents within the
site-template
folder. - Change the site ID under path
site-template\sites
to your site ID. - Archive the folder to
site-template.zip
and import the file viaSite Import & Export
.
Services
The integration includes a new service namedGr4vyAPI
which can be accessed from Administration -> Operations -> Services.

Service Details
Service ID | Service Profile | Service Credential |
---|---|---|
Gr4vyAPI | Gr4vyAPI.profile | Gr4vyAPI.sandbox.credentials |
Gr4vyAPI.production.credentials |
example
, the URL for your sandbox credentials
would be https://api.sandbox.example.gr4vy.app
and the URL for your production credentials would be
https://api.example.gr4vy.app
.
Payment Processor and Payment Method
The cartridge includes a Processor calledGR4VY
which should be mapped to the Gr4vy Payment Method
under Merchant Tools -> Ordering -> Payment Methods.

Jobs
The integration includes a new job namedProcessGr4vyNotifications
available under Administration -> Operations -> Jobs.
The ProcessGr4vyNotifications
job processes webhook notifications received from us 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.

Job Steps
tab, select the Specific Sites
scope and select the sites where the job is required.
