Salesforce Commerce Cloud Integration

Configure the Salesforce Commerce Cloud Business Manager

Before a Salesforce Commerce Cloud connection can be established, the following two configuration processes must be performed in the Salesforce Commerce Cloud Business Manager.

In Salesforce Commerce Cloud, data are uploaded to Salesforce Commerce Cloud via WebDAV. The data are then imported with a job into the shop. There are two jobs, one for inventory import and one for data import.
Please note that these two jobs must be configured in your Salesforce Commerce Cloud account in the exact order and using the specified values as described below.

Create an inventory import job

Create a job to import inventory-related data.

Prerequisites

A Salesforce Commerce Cloud account has been created.
The user has the required rights.

Procedure

Salesforce Commerce Cloud Business Manager > Select a site

Welcome to Business Manager

Click the arrow in the Administration tab in the navigation bar at the top of the page.
The administration menu window is displayed.
Click the Jobs entry in the Operations section of the administration menu window.
The Jobs page is displayed.
Click the [New Job] button in the upper right corner to create the inventory import job.
The New Job window is displayed under the [New Job] button.
Enter a name for the inventory import job, for example InventoryImport, in the ID field and, if desired, a job description in the Description field, and click the [Create] button.
The new job has been created. The "Job ID name" page is displayed. By default, the General tab in the header of the "Job ID name" page is preselected.

Note the ID of the inventory import job, as it must be specified in the Omni-Channel module when establishing the connection to Salesforce Commerce Cloud.
Click the Job Steps tab in the header of the "Job ID name" page.
By default, an empty flow box has been preconfigured.
Click the [Configure a step] button in the flow box and select the ImportInventoryLists step.
The Select and Configure Step side bar is displayed on the right side of the page.
Enter a name for the step, for example ImportInventoryLists, in the ID field and, if desired, a step description in the Description field, and configure the following values in the corresponding fields of the Select and Configure Step side bar for the ImportInventoryLists step:

Field Value

WorkingFolder import/inventory

FileNamePattern ac_.*_inventory\.xml

NoFilesFoundHandling NO_FILES_FOUND

ImportMode Merge

ImportFailedHandling WARN

The values in the AfterImportFileHandling and the ArchiveFolder fields can be arbitrarily selected.
Click the [Assign] button in the bottom right corner of the Select and Configure Step side bar.
The step has been configured and is displayed in the flow box.

Field	Value
WorkingFolder	import/inventory
FileNamePattern	ac_.*_inventory\.xml
NoFilesFoundHandling	NO_FILES_FOUND
ImportMode	Merge
ImportFailedHandling	WARN

Create a data import job

Create a job to import product-related data.

Prerequisites

A Salesforce Commerce Cloud account has been created.
The user has the required rights.

Procedure

Salesforce Commerce Cloud Business Manager > Select a site

Welcome to Business Manager

Click the arrow in the Administration tab in the navigation bar at the top of the page.
The administration menu window is displayed.
Click the Jobs entry in the Operations section of the administration menu window.
The Jobs page is displayed.
Click the [New Job] button in the upper right corner to create the inventory import job.
The New Job window is displayed under the [New Job] button.
Enter a name for the data import job, for example SiteDataImport, in the ID field and, if desired, a job description in the Description field, and click the [Create] button.
The new job has been created. The "Job ID name" page is displayed. By default, the General tab in the header of the "Job ID name" page is preselected.

Note the ID of the data import job, as it must be specified in the Omni-Channel module when establishing the connection to Salesforce Commerce Cloud.
Click the Job Steps tab in the header of the "Job ID name" page.
By default, an empty flow box has been preconfigured.

The data import job must import different types of data and therefore contains sequential flows.
Click the [Configure a step] button in the flow box and select the StandardProductsImport step.
The Select and Configure Step side bar is displayed on the right side of the page.

Make sure that all folders specified within a step have been previously created in WebDAV. Otherwise, the data cannot be imported. For detailed information about WebDAV, see the Salesforce Commerce Cloud documentation, Using WebDAV.
Enter a name for the step, for example ImportInventoryLists, in the ID field and, if desired, a step description in the Description field, and configure the following values in the corresponding fields of the Select and Configure Step side bar for the StandardProductsImport step:

Field Value

WorkingFolder import/catalogs

FileNamePattern ac_.*catalog\.*\.xml

NoFilesFoundHandling NO_FILES_FOUND

ImportMode Merge

ImportFailedHandling WARN

The values in the AfterImportFileHandling and the ArchiveFolder fields can be arbitrarily selected.
Click the [Assign] button in the bottom right corner.
The step has been configured and is displayed in the flow box.
Click the (Add) button below the first flow box.
An empty flow box has been added below the first flow box.
Click the [Configure a step] button in the flow box and select the BundleProductsImport step. The Select and Configure Step side bar is displayed on the right side of the page.

Make sure that all folders specified within a step have been previously created in WebDAV. Otherwise, the data cannot be imported. For detailed information about WebDAV, see the Salesforce Commerce Cloud documentation, Using WebDAV.
Enter a name for the step, for example BundleProductsImport, in the ID field and, if desired, a step description in the Description field, and configure the following values in the corresponding fields of the Select and Configure Step side bar for the BundleProductsImport step:

Field Value

WorkingFolder import/catalogs

FileNamePattern ac_.*bundles\.*\.xml

NoFilesFoundHandling NO_FILES_FOUND

ImportMode Merge

ImportFailedHandling WARN

The values in the AfterImportFileHandling and the ArchiveFolder fields can be arbitrarily selected.
Click the [Assign] button in the bottom right corner.
The step has been configured and is displayed in the flow box.
Click the (Add) button below the second flow box. An empty flow box has been added below the second flow box.
Click the [Configure a step] button in the flow box and select the CategoryAssignmentImport step. The Select and Configure Step side bar is displayed on the right side of the page.

Make sure that all folders specified within a step have been previously created in WebDAV. Otherwise, the data cannot be imported. For detailed information about WebDAV, see the Salesforce Commerce Cloud documentation, Using WebDAV.
Enter a name for the step, for example CategoryAssignmentImport, in the ID field and, if desired, a step description in the Description field, and configure the following values in the corresponding fields of the Select and Configure Step side bar for the CategoryAssignmentImport step:

Field Value

WorkingFolder import/catalogs

FileNamePattern ac_.*assignments\.*\.xml

NoFilesFoundHandling NO_FILES_FOUND

ImportMode Merge

ImportFailedHandling WARN

The values in the AfterImportFileHandling and the ArchiveFolder fields can be arbitrarily selected.
Click the [Assign] button in the bottom right corner.
The step has been configured and is displayed in the flow box.
Click the (Add) button below the third flow box. An empty flow box has been added below the third flow box.
Click the [Configure a step] button in the flow box and select the PricebookImport step. The Select and Configure Step side bar is displayed on the right side of the page.

Make sure that all folders specified within a step have been previously created in WebDAV. Otherwise, the data cannot be imported. For detailed information about WebDAV, see the Salesforce Commerce Cloud documentation, Using WebDAV.
Enter a name for the step, for example PricebookImport, in the ID field and, if desired, a step description in the Description field, and configure the following values in the corresponding fields of the Select and Configure Step side bar for the PricebookImport step:

Field Value

WorkingFolder import/pricebooks

FileNamePattern ac_.*_price_book\.xml

NoFilesFoundHandling NO_FILES_FOUND

ImportMode Merge

ImportFailedHandling WARN

The values in the AfterImportFileHandling and the ArchiveFolder fields can be arbitrarily selected.
Click the [Assign] button in the bottom right corner.
The step has been configured and is displayed in the flow box.

Field	Value
WorkingFolder	import/catalogs
FileNamePattern	ac_.*catalog\.*\.xml
NoFilesFoundHandling	NO_FILES_FOUND
ImportMode	Merge
ImportFailedHandling	WARN

Field	Value
WorkingFolder	import/catalogs
FileNamePattern	ac_.*bundles\.*\.xml
NoFilesFoundHandling	NO_FILES_FOUND
ImportMode	Merge
ImportFailedHandling	WARN

Field	Value
WorkingFolder	import/catalogs
FileNamePattern	ac_.*assignments\.*\.xml
NoFilesFoundHandling	NO_FILES_FOUND
ImportMode	Merge
ImportFailedHandling	WARN

Field	Value
WorkingFolder	import/pricebooks
FileNamePattern	ac_.*_price_book\.xml
NoFilesFoundHandling	NO_FILES_FOUND
ImportMode	Merge
ImportFailedHandling	WARN

All required steps for the data import job has been configured.

Configure the Open Commerce API Settings

In Salesforce Commerce Cloud, there are two Open Commerce APIs (OCAPIs):

The shop API, which is used for the order data
The data API, which is used for the product data
The settings of the OCAPIs must be configured in Salesforce Commerce Cloud as described below.

Prerequisites

A Salesforce Commerce Cloud account has been created.
The user has the required rights.
The client ID has been generated in Salesforce Commerce Cloud, see the Salesforce Commerce Cloud documentation, Generate an API Client ID.

Procedure

Salesforce Commerce Cloud Business Manager > Select a site

Welcome to Business Manager

Click the arrow in the Administration tab in the navigation bar at the top of the page.
The administration menu window is displayed.
Click the Open Commerce API Settings entry in the Site Development section of the administration menu window.
The Open Commerce API Settings page is displayed.
Click the Select type drop-down list and select the Shop option. The available shop API is displayed in the text area.

Open Commerce API Settings Shop

Click the Select Context drop-down list and select the Global (organization-wide) option.

Check the text area for the following code. If it is not available, enter the following JSON code:

{
"client_id": "CLIENTID",
"resources": [
    {
        "resource_id": "/order_search",
        "methods": [
            "post"
        ],
        "read_attributes": "(**)",
        "write_attributes": "(**)"
    },
    {
        "resource_id": "/orders/*",
        "methods": [
            "get",
            "patch"
        ],
        "read_attributes": "(**)",
        "write_attributes": "(**)"
    }
]
}

Replace the CLIENTID description for the client_id property in the code with your client ID.
Click the [Save] button.
All changes to the shop API have been saved.
Click the Select type drop-down list and select the Data option.
The available data API is displayed in the text area.
Click the Select Context drop-down list and select the Global (organization-wide) option.

Check the text area for the following code. If it is not available, enter the following JSON code:

{
"client_id": "CLIENTID",
"resources": [
    {
        "resource_id": "/jobs/*/executions",
        "methods": [
            "post"
        ],
        "read_attributes": "(**)",
        "write_attributes": "(**)"
    },
    {
        "resource_id": "/jobs/*/executions/*",
        "methods": [
            "get"
        ],
        "read_attributes": "(**)",
        "write_attributes": "(**)"
    },
    {
        "resource_id": "/job_execution_search",
        "methods": [
            "post"
        ],
        "read_attributes": "(**)",
        "write_attributes": "(**)"
    },
    {
        "resource_id": "/locale_info/locales",
        "methods": [
            "get"
        ],
        "read_attributes": "(**)",
        "write_attributes": "(**)"
    },
    {
        "resource_id": "/system_object_definitions/Product/attribute_definitions/*",
        "methods": [
            "get"
        ],
        "read_attributes": "(**)",
        "write_attributes": "(**)"
    },
    {
        "resource_id": "/system_object_definitions/Product/attribute_groups/*",
        "methods": [
            "get"
        ],
        "read_attributes": "(**)",
        "write_attributes": "(**)"
    },
    {
        "resource_id": "/system_object_definitions/ProductInventoryRecord/attribute_definitions/*",
        "methods": [
            "get"
        ],
        "read_attributes": "(**)",
        "write_attributes": "(**)"
    },
    {
        "resource_id": "/system_object_definitions/ProductInventoryRecord/attribute_groups/*",
        "methods": [
            "get"
        ],
        "read_attributes": "(**)",
        "write_attributes": "(**)"
    },
    {
        "resource_id": "/system_object_definitions/ProductInventoryRecord/attribute_definitions",
        "methods": [
            "get"
        ],
        "read_attributes": "(**)",
        "write_attributes": "(**)"
    },
    {
        "resource_id": "/catalogs",
        "methods": [
            "get"
        ],
        "read_attributes": "(**)",
        "write_attributes": "(**)"
    },
    {
        "resource_id": "/catalogs/*/categories",
        "methods": [
            "get"
        ],
        "read_attributes": "(**)",
        "write_attributes": "(**)"
    },
    {
        "resource_id": "/inventory_lists",
        "methods": [
            "get"
        ],
        "read_attributes": "(**)",
        "write_attributes": "(**)"
    },
    {
        "resource_id": "/system_object_definitions/Product/attribute_groups",
        "methods": [
            "get"
        ],
        "read_attributes": "(**)",
        "write_attributes": "(**)"
    },
    {
        "resource_id": "/system_object_definitions/Product/attribute_definitions",
        "methods": [
            "get"
        ],
        "read_attributes": "(**)",
        "write_attributes": "(**)"
    },
    {
        "resource_id": "/sites",
        "methods": [
            "get"
        ],
        "read_attributes": "(**)",
        "write_attributes": "(**)"
    },
    {
        "resource_id": "/inventory_lists/*/product_inventory_records/*",
        "methods": [
            "put", "delete"
        ],
        "read_attributes": "(**)",
        "write_attributes": "(**)"
    },
    {
        "resource_id": "/sites/*/orders/*/export_status",
        "methods": [
            "put"
        ],
        "read_attributes": "(**)",
        "write_attributes": "(**)"
    }
]
}

Replace the CLIENTID description for the client_id property in the code with your client ID.
Click the [Save] button.
All changes to the data API have been saved.

For detailed information, see the Salesforce Commerce Cloud documentation, OCAPI Settings.

Generate an access key

To connect with Salesforce Commerce Cloud, an access token is required for named authentication in addition to the client ID and the client password. Therefore, an access key must be generated in Salesforce Commerce Cloud to establish the connection in the Omni-Channel module.
Unlike client id and password, the access key can only be used for one instance and not multiple times.

Prerequisites

A Salesforce Commerce Cloud account has been created.
The user has the required rights.

Procedure

Salesforce Commerce Cloud Business Manager > Select a site

Welcome to Business Manager

Click the (Profile) button on the right side of the header.
The My profile page is displayed.
Click the [Manage Access Keys] button.
The Manage Access Keys page is displayed.
Click the [Generate Access Key] button.
The Generate Access Key window is displayed.
Click the drop-down list and select the Agent User Login and OCAPI option as authentication scope.
Click the [Generate] button in the bottom right corner of the Generate Access Key window.
The access key has been generated and is displayed in the Generate Access Key window.

The access key is required to establish the connection with Salesforce Commerce Cloud in the Omni-Channel module.
Copy the key to your clipboard or click the [Download] button.
The access key has been copied or downloaded as a CSV file.

Once the Generate Access Key window is closed, the access key cannot be accessed anymore. It is therefore highly recommended to keep the access key safe for future use.
Click the [Close] button in the bottom right corner of the Generate Access Key window.
The Manage Access Keys page is displayed. The generated access key is displayed in the list of access keys.

As access keys expire after one year, they must be regenerated after this period.

Documentation

Hi, how can we help you?

Is this what you are looking for?

Sorry, we couldn't find what you were looking for...

Salesforce Commerce Cloud Integration

Configure the Salesforce Commerce Cloud Business Manager

Create an inventory import job

Prerequisites

Procedure

Create a data import job

Prerequisites

Procedure

Configure the Open Commerce API Settings

Prerequisites

Procedure

Generate an access key

Prerequisites

Procedure