Salesforce Commerce Cloud Setup Guide

Prerequisites

A Salesforce Commerce Cloud account with 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
- sfcc.price-books
When using OCAPI: Two separate API client applications - one for Salesforce Commerce API (SCAPI) tables, and one for Open Commerce API (OCAPI) tables. A client ID created for SCAPI cannot be reused for OCAPI calls.

Setup Guide

Step 1: Create a Salesforce Commerce API client
1. Log in to your Salesforce Commerce Cloud account.
2. On the left navigation menu, click API Client.
3. Click Add API Client.
4. Enter a Display Name for the API Client.
5. Enter a Password and Confirm Password for the new client. Copy the password (client secret) — you'll need it to configure Matia.
6. Go to the Organizations section, click Add, select one or more organizations, then click Add again.
7. Go to the Roles section:
  1. Click Add.
  2. Find the Salesforce Commerce API category and select it.
  3. Click Add.
  4. Click the filter button and select an organization.
  5. Enter the name of each instance you want to access with the API client, select each one, and click Add.
8. In Allowed Scopes, enter the scopes listed in the Prerequisites section above. Enter each scope on its own line.
9. In Token Endpoint Auth Method, select client_secret_post.
10. In Access Token Format, select JWT.
11. Click Save.
12. Copy the new API Client ID — you'll need it to configure Matia.
Step 2: Find your organization ID and short code
1. Go to Administration > Site Development > Salesforce Commerce API Settings.
2. Copy the Organization ID and Short Code — you'll need both to configure Matia.
Step 3: Find your site ID
1. Go to Administration > Sites > Manage Sites.
2. Copy the Site ID — you'll need it to configure Matia.
Step 4: Find your customer list ID
1. Go to Administration > Sites > Customer Lists.
2. Copy the Customer List ID — you'll need it to configure Matia.
(Optional) Create an Open Commerce API client

Required only if you want to sync tables supported through OCAPI. This must be a separate client from the one created in Step 1.
1. On the left navigation menu, click API Client.
2. Click Add API Client.
3. Enter a Display Name for the API Client.
4. Enter a Password and Confirm Password for the new client. Copy the password (client secret) — you'll need it to configure Matia.
5. Go to the Organizations section, click Add, select one or more organizations, then click Add again.
6. Skip the Roles section.
7. In Token Endpoint Auth Method, select client_secret_post.
8. In Access Token Format, select JWT.
9. Click Save.
10. Copy the new API Client ID — you'll need it to configure Matia.
(Optional) Add permissions for OCAPI endpoints
1. Go to Administration > Site Development > Open Commerce API Settings.
2. In Select Type, select Data.
3. In Select Context, select Global.
4. In the editor, add the permissions code: you only need to add the resource_id, methods, and attributes for the tables that you want to sync.

{
  "_v": "23.0",
  "clients": [
    {
      "client_id": "<OCAPI Client ID>",
      "resources": [
        {
          "resource_id": "/sites/*/customer_group_search",
          "methods": [
            "post"
          ],
          "read_attributes": "(**)",
          "write_attributes": "(**)"
        },
        {
          "resource_id": "/custom_objects_search/*",
          "methods": [
            "post"
          ],
          "read_attributes": "(**)",
          "write_attributes": "(**)"
        },
        {
          "resource_id": "/custom_object_definitions/*/attribute_definition_search",
          "methods": [
            "post"
          ],
          "read_attributes": "(**)",
          "write_attributes": "(**)"
        },
        {
          "resource_id": "/custom_object_definitions/*/attribute_group_search",
          "methods": [
            "post"
          ],
          "read_attributes": "(**)",
          "write_attributes": "(**)"
        },
        {
          "resource_id": "/sites/*/stores",
          "methods": [
            "get"
          ],
          "read_attributes": "(**)"
        },
        {
          "resource_id": "/inventory_lists",
          "methods": [
            "get"
          ],
          "read_attributes": "(**)"
        },
        {
          "resource_id": "/inventory_lists/*/product_inventory_records",
          "methods": [
            "get"
          ],
          "read_attributes": "(**)"
        },
        {
          "resource_id": "/catalogs/*/shared_product_options",
          "methods": [
            "get"
          ],
          "read_attributes": "(**)"
        }
      ]
    }
  ]
}

(Optional) Find your OCAPI hostname
1. Go to Administration > Sites > Manage Sites.
2. Go to Manage Business Manager site.
3. Go to the Hostnames tab and copy the Hostname — you'll need it to configure Matia.
(Optional) Find your custom object types
1. Go to Administration > Site Development > Custom Object Types.
2. Make a note of the object types you want to sync through Matia.
Step 5: Connect Salesforce Commerce Cloud in Matia
1. Enter the Client ID and Client Secret you created in Step 1.
2. Enter the Organization ID and Short Code you found in Step 2.
3. Enter the Site ID you found in Step 3.
4. Enter the Customer List ID you found in Step 4.
5. (Optional) To sync Open Commerce API endpoints, toggle Sync OCAPI Endpoints on and enter:
  - The OCAPI Client ID and OCAPI Client Secret you created above.
  - The OCAPI Hostname you found above.
  - (Optional) A comma-separated List of Custom Object Types you found above.
6. Enter an Asset Name.
7. (Optional) Enter a Description.
8. (Optional) Assign Tags.
9. Select an Owner.
10. Verify that your Salesforce Commerce Cloud account is successfully connected by clicking Test Connection.
11. Click Connect.

Prerequisites

Setup Guide

ON THIS PAGE