Salesforce Commerce Cloud connector - Installation and setup (beta)

This is currently a closed beta program

Please contact your account manager if you'd like to be added to it.

Contents

Installing the Salesforce Commerce Cloud connector
Working with your Commerce Cloud store settings
Data synchronisation
   » Customers
   » Orders
   » Products
Data schema
   » Order Insight data schema
   » Product Insight data (AccountInsight) schema

Summary

dotmailer’s Commerce Flow now integrates with Salesforce Commerce Cloud. It doesn't require a cartridge and fully relies upon the built-in Open Commerce API (OCAPI) of Commerce Cloud.

This integration allows you to synchronise your store customers' information and purchase data as well as your product catalogue. You can choose which of your Commerce Cloud data fields get mapped to your dotmailer contact data fields, allowing you to utilise their order information for better campaign targeting. You can also enrol new customer accounts and first-time buyers into your programs.

Installing the Salesforce Commerce Cloud connector

Create a Demandware API client

  1. Log into your Demandware account management console, API Client section: https://account.demandware.com/dw/account/APIAdmin
  2. Click the button Add API Client
  3. Give your API client a display name and a password (leave JWT and OpenID scopes empty) and save them
  4. Once created, copy the generated API client ID and given password and go to the next step below

Connect your store in dotmailer

  1. Go to the page https://login.dotmailer.com/commerce-cloud
  2. Log into your dotmailer account (if you haven't done so already)
  3. Provide your store URL (i.e. https://xxxx-xx-dw.demandware.net), API client ID and password and authorize the connection

Before finally connecting to your store, you need to set the API permissions (at Shop and Data level) in your store's backend:

  1. Copy the JSON for the Shop permission and paste it into Demandware's backend: Administration > Site development > Open Commerce API settings, select type 'Shop' and set the context to 'Global'
  2. Copy the JSON for the Data permission and paste it into Demandware's backend: Administration > Site development > Open Commerce API settings, select type 'Data' and set the context to 'Global'
  3. Once you're all set, click the Authorise button

Working with your Commerce Cloud store settings

Once you've successfully installed the connector, you can start working with your general Commerce Cloud connector settings in dotmailer. They're accessed by clicking on Commerce Cloud in the settings menu.

This takes you to the 'Store' tab, where you can access data synchronisation, contact synchronisation and program enrolment settings. You can also remove your Commerce Cloud connection completely if you wish.

Remember to click Save after making any changes here.

Data synchronisation

Customers

New Commerce Cloud customers are synced every 5 minutes.

A full synchronisation is also done every 24 hours to pick up any customer’s data modifications.

Note: The first synchronisation will sync the entire customer list and might take a few hours to complete. New or modified customers will only be processed once the initial sync job has fully caught up with the old ones.

The customer fields we support for Commerce Cloud are (with data types in parentheses):

  • First name (text)
  • Last name (text)
  • Created date (date)
  • Phone (text)
  • Billing address 1 (text)
  • Billing address 2 (text)
  • Billing phone (text)
  • Billing fax (text)
  • Billing city (text)
  • Billing postcode (text)
  • Billing state (text)
  • Billing region (text)
  • Billing country (text)
  • Billing company (text)
  • Shipping address 1 (text)
  • Shipping address 2 (text)
  • Shipping phone (text)
  • Shipping fax (text)
  • Shipping city (text)
  • Shipping postcode (text)
  • Shipping state (text)
  • Shipping region (text)
  • Shipping country (text)
  • Shipping company (text)

Orders

New and modified orders are synced every 5 minutes.

Note: The first synchronisation will sync the order history and might take a few hours to complete. New or modified orders will only be processed once the initial sync job has fully caught up with the old ones.

Orders will be stored against dotmailer contacts as Insight data.

Products

New products in the product catalog of your site are synced every 5 minutes.

A full synchronisation is also done every 24 hours to pick up any products data modifications or stock updates.

Note: The first synchronisation will sync the entire site’s product catalog and might take a few hours to complete. New or modified products will only be processed once the initial sync job has fully caught up with the old ones.

Products are stored at the dotmailer account level (known as AccountInsight). These are accessible by clicking on the on the person-and-cog icon positioned in the bottom left corner of the screen, clicking on Insight data, and then selecting the collection called 'Catalog_Default'.

Data schema

Order Insight data schema

Attribute

   

Type

id

   

text

order_total

   

numerical

payment

   

text

delivery_method

   

text

delivery_total

   

numerical

currency

   

text

order_status

   

text

email

   

text

quote_id

   

text

purchase_date

   

date

billing_address

     
 

billing_address_1

 

text

 

billing_address_2

 

text

 

billing_city

 

text

 

billing_country

 

text

 

billing_postcode

 

text

delivery_address

     
 

delivery_address_1

 

text

 

delivery_address_2

 

text

 

delivery_city

 

text

 

delivery_country

 

text

 

delivery_postcode

 

text

products

   

array

 

Product #1

   
 

name

 

text

 

price

 

numerical

 

sku

 

text

 

qty

 

numerical

       
 

Product #2

   
 

...

   

order_subtotal

   

numerical

base_subtotal_incl_tax

   

numerical

discount_amount

   

numerical

Product Insight data (AccountInsight) schema

Attribute

Type

id

numerical

product_variant_id

numerical

name

string

price

numerical

url

string

sku

string

stock

numerical

status

string

image_path

string

Have more questions? Submit a request

Comments