Salesforce Commerce Cloud Setup Guide

Follow our setup guide to connect Salesforce Commerce Cloud to Fivetran.

Prerequisites

To connect Salesforce Commerce Cloud to Fivetran, you need:

• A Salesforce Commerce Cloud account

• Administrator permissions

• Access to the following authorization scopes for Salesforce Commerce Cloud's Admin API:

  • sfcc.products
  • sfcc.promotions
  • sfcc.customerlists
  • sfcc.catalogs
  • sfcc.gift-certificates
  • sfcc.source-codes
  • sfcc.orders

• Separate API client applications to sync tables supported through Salesforce Commerce Cloud API and Open Commerce API (OCAPI) respectively.

Setup instructions

Create Salesforce Commerce API client

1. Log in to your Salesforce Commerce Cloud account.

2. On the left navigation menu, click API Client.

3. In the API Clients page, do the following:

   i. Click Add API Client.

   

   ii. Enter a Display Name for the API Client.

   

   iii. Enter your Password and then Confirm Password for the new client. Make a note of the password (client secret). You will need it to configure Fivetran.

4. Go to the Organizations section and do the following:

   i. Click Add.

   ii. Select one or more organizations.

   iii. Click Add.

5. Go to the Roles section and do the following:

   i. Click Add.

   ii. Find the Salesforce Commerce API category and select the Salesforce Commerce API.

   iii. Click Add.

   iv. Click the filter button.

   v. Select an organization.

   vi. Enter the name for each instance you want to access with the API client.

   vii. Select each instance and click Add.

6. In the Allowed Scopes field, enter the authenticated access scopes provided in the Prerequisites section.

   NOTE: You must enter each scope in a separate line.

7. In the Token Endpoint Auth Method drop-down menu, select client_secret_post.

8. In the Access Token Format drop-down menu, select JWT.

9. Click Save.

10. Make a note of the new API Client ID. You will need it to configure Fivetran.

Find organization ID and short code

1. Go to Administration > Site Development > Salesforce Commerce API Settings.
2. Make a note of the Organization ID and Short Code. You will need them to configure Fivetran.

Find site ID

1. Go to Administration > Sites > Manage Sites.
2. Make a note of the Site ID. You will need it to configure Fivetran.

Find customer list ID

1. Go to Administration > Sites > Customer Lists.
2. Make a note of the Customer List ID. You will need it to configure Fivetran.

(Optional) Create Open Commerce API client

IMPORTANT: You must create a new API client to sync tables supported through Open Commerce API (OCAPI). A client ID used for Salesforce Commerce APIs (SCAPI) cannot be used for making OCAPI calls.

1. Log in to your Salesforce Commerce Cloud account.

2. On the left navigation menu, click API Client.

3. In the API Clients page, do the following:

   i. Click Add API Client.

   

   ii. Enter a Display Name for the API Client.

   iii. Enter your Password and then Confirm Password for the new client.

   iv. Make a note of the password (client secret). You will need it to configure Fivetran.

4. Go to the Organizations section and do the following:

   i. Click Add.

   ii. Select one or more organizations.

   iii. Click Add.

5. Skip the Roles section.

6. In the Token Endpoint Auth Method drop-down menu, select client_secret_post.

7. In the Access Token Format drop-down menu, select JWT.

8. Click Save.

9. Make a note of the new API Client ID. You will need it to configure Fivetran.

(Optional) Add permissions for OCAPI supported endpoints

1. Go to Administration > Site Development > Open Commerce API Settings.
2. In the Select Type drop-down menu, select Data.
3. In the Select Context drop-down menu, select Global.
4. In the editor, add the code to assign permissions to your API client to access to your required OCAPI endpoints.

(Optional) Find OCAPI hostname

1. Go to Administration > Sites > Manage Sites.

2. Go to Manage Business Manager site.

3. Go to Hostnames tab and Make a note of Hostname. You will need it to configure Fivetran.

   

(Optional) Find list of custom object types

1. Go to Administration > Site Development > Custom Object Types.

2. Make a note of the object types you need to sync through Fivetran.

   

Finish Fivetran configuration

1. In the connection setup form, enter the Destination schema name of your choice.

2. Enter the Client ID and Client Secret you created in Step 1.

3. Enter your Organization ID and the Short Code you found in Step 2.

4. Enter the Site ID you found in Step 3.

5. Enter the Customer List ID you found in Step 4.

6. (Optional) To sync Open commerce API endpoints, set the Sync OCAPI Endpoints toggle to ON, and specify the following:

   i. Enter the OCAPI Client ID and OCAPI Client Secret you created in Step 5.

   ii. Enter the OCAPI Hostname you found in Step 7.

   iii. (Optional) Enter a comma-separated List of Custom Object Types you found in Step 8.

7. Click Save & Test. Fivetran will take it from here and sync your Salesforce Commerce Cloud data.

Related articles

description Connector Overview

account_tree Schema Information

assignment Release Notes

settings API Connection Configuration

home Documentation Home