Skip to main content

Onboarding with Salesforce Commerce Cloud

Below are written steps on how to onboard to Canal via Salesforce Commerce Cloud! 

 

Step 1: Create your account

The email and password created on this step will be used to login to Canal going forward.

 

Step 2: Select Salesforce Commerce Cloud as your Integration type

Screen Shot 2024-02-28 at 9.26.45 AM.png

 

Step 3: Complete brand profile

Screen Shot 2024-02-28 at 9.27.44 AM.png

 

 

Step 4: Set your desired partnership terms

Terms listed here will be displayed on your profile for potential partners to see. You will always have the chance to renegotiate or set new terms before a partnership is established.

 

Step 5: Salesforce Commerce Cloud setup

We will need 5 pieces of information from you to complete onboarding. Below are instructions of where to find each!

1. Organization ID & Short Code 

These are found in SFCC Business Manager. You must have the Business Manager Administrator role in Account Manager and know the Business Manager URL to access this information.

Go to Administration > Site Development > Salesforce Commerce API Settings.

2. Site ID 

This is also found in SFCC Business Manager.

Go to Administration > Sites > Manage Site and take note of the ID for the site you want to enable API access for.

3. API Client ID & Password

You need to create an API client and share these credentials with Canal to grant us API access for your shop. You can read more at the Salesforce Help Center.

  1. Log into SFCC Account Manager

  2. Go to API Client > Add API Client

  3. Enter a display name and create a password. Take note of this password to share with Canal (this is the API Client Password)`

  4. Go to the the Organizations section > click add > select the organization of the instance you want to enable access for.

  5. Go to the Roles section > click add > go to the Salesforce Commerce API category > select the Salesforce Commerce API.

  6. Click the filter button on the right, select the organization and the instances you want to enable access for.

  7. Go to the Open ID Connect section

  8. Paste the following scopes into the Default Scopes section

    mail
roles
tenantFilter
profile
openId

  9. Paste the following scopes into the Allowed Scopes section

    sfcc.catalogs
sfcc.catalogs.rw
sfcc.inventory.availability
sfcc.inventory.availability.rw
sfcc.inventory.impex-graphs
sfcc.inventory.impex-inventory
sfcc.inventory.impex-inventory.rw
sfcc.inventory.reservations
sfcc.inventory.reservations.rw
sfcc.orders
sfcc.orders.rw
sfcc.products
sfcc.products.rw

  10. Select client_secret_post for Token Endpoint Auth Method and ensure Access Token Format is set to JWT

  11. Click save

  12. Find your new API client in the table and take note of the value in the column API Client ID to share with Canal (This is the API Client ID)

4. Configuring Delta Exports

  1. Go to Administration > Site Development > Delta Exports

    • If Delta Exports is not visible, reach out to SFCC Support

  2. Click New > enter “Canal Catalog Export” (case sensitive) as the name for your export > click Create

  3. Enter “canal” (case sensitive) in the Consumers section > select Export Full Base Products.

  4. Expand the “Catalogs” section > select the catalog you are importing products for (the same selected for the initial data import).

  5. Click Apply

  6. Go to the Schedule section > select the checkbox marked Enabled > Set Catalog and Pricebook to “Every” and 1 hours > click Apply. For inventory set the “Every” to every 10 minutes.

  7. Repeat steps 3-7 for “Inventory” and “Pricebook”, using export titles “Canal Inventory Export” and “Canal Pricebook Export”

  8. Go to Administration → Organization → WebDAV Client Permissions

  9. Add the following information to your permissions. Ensure you replace “API_CLIENT_ID” with the api client id you generated during onboarding.

    {
"clients": [
    {
        "client_id": "{API_CLIENT_ID}",
        "permissions": [
            {
                "path": "/impex/src/platform/outbox/canal",
                "operations": [
                    "read"
                ]
            }
        ]
    }
]
}

  10. Click save.

5. Configuring SLAS

You must have SLAS Organization Administrator role to complete this step, this can be assigned in Account Manager. Read more in the Salesforce reference

  1. Go to this url, replace short code with your short code.
    https://{{short-code}}.api.commercecloud.salesforce.com/shopper/auth-admin/v1/ui/
  2. Click token in the top nav
  3. Click copy admin token to clipboard (it expires after 30 mins!)

6. Data Imports 

    1. Log into SFCC business Manager, go to Merchant Tools and select the site you are connecting to Canal.

    2. Go to Products and Catalog > Import and Export

    3. Click Export under the Catalog section

    4. Select the catalog that you wish to export, enter a name for the export file, and click either “Export entire catalog” or “Export specific products” (We recommend exporting the entire catalog!)

    5. Click on the catalog name you just entered, download the generated catalog XML file and upload this to Canal.

    6. Repeat steps 3-5 for the pricebook export.

    7. Repeat steps 3-5 for the inventory list export Note: Only select a single inventory list to import. This must be the inventory list that is assigned to the site you are integrating with Canal.

 

After Onboarding

Have a brand you want to partner with on Canal? Learn how to invite them here!

Was this article helpful?