Skip to main content
All CollectionsEcommerce IntegrationSFCC (Salesforce Commerce Cloud)
Getting Started with Salesforce Commerce Cloud
Getting Started with Salesforce Commerce Cloud
Danielle From BayEngage avatar
Written by Danielle From BayEngage
Updated over a week ago

You will learn

How to connect TargetBay’s BayEngage with Salesforce Commerce Cloud (SFCC). Stores using Salesforce Commerce Cloud (formerly Demandware) can easily connect and transfer both real-time and historical data to BayEngage via the cartridge(s) and API connectivity.

When BayEngage and Salesforce Commerce Cloud are integrated, BayEngage will begin tracking real-time user actions such as website navigation, search tracking, products, add-to carts, category views, checkouts, and orders.

There are some mains steps to integrate BayEngage into SFCC 😀

  • Create an API client

  • Enable OCAPI

  • Sign up or log in to BayEngage

  • Upload BayEngage cartridge in SFCC

  • Configure service.xml and metadata.xml files into SFCC

  • Enable the cartridge

Step 1:

Go to the URL: <>

Log in to your SFCC account and verify your identity.

Go to ‘administration’ in the main menu and click ‘Open commerce API settings.’

This is your OCAPI page, keep this tab open in your browser, and let’s call it tab ‘A’ for better understanding.

and now open a new tab ‘B’on your browser and go to this link and log in again using this link:

Here’s where you can create your API Client

Click ‘API client’ on the left section, create a new API client by clicking the ‘Add API client’ button.

Fill in the Display name, Description, and Passwords and enable ‘access control’.

Assign the organization you want by selecting from the options and ensure that the token endpoint auth method is in jwt format.

Now, click ‘Save.’

You should see the newly created API client ID in the API client section of the Account Manager profile.

Copy the newly created API client ID

Step 2:

As we have copied the new API client ID, go back to the tab ‘A’ i.e., the OCAPI page on your browser, and paste the copied client ID to the JSON displayed.

Ensure the type is ‘shop,’ and the context is ‘Global-organization wide’’ when you do this.

After this, change the type to ‘Data’ and copy, and paste the below JSON to it.

We have finished enabling the OCAPI

Step 3:

Log in to app.bayengage.com

Select Salesforce from the list of integrations should in BayEngage’s dashboard.

Fill in the required parameters

Note: don’t add a slash at the end of your website in the website address section. Example - https://yourstore.com

Type in the client ID and password you created earlier.

For the site ID, go back to your Salesforce account’s ‘Administration’ and go to ‘Manage sites’

You will be directed to a list of your Storefront sites, copy the ID next to the site you are trying to integrate with BayEngage.

Paste that in the Site ID section in BayEngage.

As for the version section, type v_19.10

To fill in the category ID field, return to your Salesforce account. Go to ‘Merchant Tools’ in the main menu, and choose ‘catalog’

It will direct you to a list of your brands’ catalogs and choose the right catalog ID against the site you want to integrate.

Copy the catalog ID and paste it into the BayEngage app where it’s required.

Now that’s done, below the catalog id field, you will see ‘click here to retrieve the list of sites.

It will take you to a list of categories and IDs mentioning the brand names against them. Select the category and ID that is relevant to your site.

Click ‘continue’

This ends your onboarding process, now we are going to upload BayEngage’s cartridge to the cartridge path.

Step 4:

Download the below zip file and add the cartridge to the cartridges path.

Once the cartridges are imported, they must be added to the list of cartridges used by your site using SFCC's Account Manager.

Navigate to Administration > Sites > Manage Sites.

Select your site.

Select the Settings tab.

At the beginning of the cartridge path input labeled Cartridges, add the names of the imported BayEngage cartridges with the core cartridge last (app_support_utility:int_bayengage_metrics).

Click Apply.

Once you've clicked Apply, you should see the two cartridges at the beginning of the field labeled Effective Cartridge Path.

Step 5:

Once the cartridges have been imported and added to the site's cartridge path,

Navigate to Administration > site development > site import & export > services

Upload the services .xml file

Then select the same .xml file once uploaded and then validate it

Click ‘next’

Then, you will be taken to Service Import - Import; always select the ‘Merge’ mode

Click ‘import’.

At the last of the Import & Export page, you will see a ‘refresh’ button; click it and see the status.

The status should say ‘success.’

Now, navigate to Administration > services

The status of bayengage.https.sendorderupdates and bayengage.tracking should show as ‘Live’

Step 6:

The next step is to import the attribute definition into the system we are using for BayEngage

Navigate to Administration > Site Development > Site Import & Export > Services.

Upload, then import the metadata.xml zip file

Refresh and validate the status.

The status should reflect ‘Success’

Then navigate to Merchant tools > Site Preferences > Custom Preferences > BayEngage

Click BayEngage, and you will be directed to BayEngage Configurations

The value for Enable BayEngage should be set to ‘yes’ if you want to enable the cartridge, or you can set it to ‘No’ if you wish to disable BayEngage.

Did this answer your question?