Changelog

Salesforce Commerce App Installation Guide

Salesforce Commerce is a seamless cloud-based eCommerce platform that can help deliver a personalized and cohesive commerce experience. With its robust online store management features, you can set up an online store, create AI-powered shopping experiences and grow your online businesses.

Contentstack Marketplace allows you to easily install the Salesforce Commerce application and use it within your stack to add products and categories from the Salesforce Commerce store within your entries.

Prerequisites

Salesforce Commerce account
Contentstack account
Access to the Contentstack Organization/Stack as the Owner/Admin

This step-by-step guide explains how to install and configure the Salesforce Commerce app within your stack.

Steps for Execution

Retrieve your client credentials from Salesforce Commerce
Install and Configure Salesforce Commerce in Contentstack Marketplace
Use Salesforce Commerce within your Stack

Retrieve your client credentials from Salesforce Commerce

Follow the steps given below to retrieve the API client ID:
1. Log in to Commerce Cloud Account Manager.
2. Click API Client from the menu.
3. Click the Add API Client button.
4. Provide the following details for the new API client:
  1. Enter a Display Name and set a Password.
  2. Add an organization.
    1. Click the Add button for Organizations.
    2. Select your organization and click the Add button.
  3. Add roles.
    1. Click the Add button for Roles.
    2. Select the required roles and click the Add button.
  4. Add scopes under OpenID Connect.
    Enter the following scopes in Default Scopes:
    mail roles tenantFilter profile openId
    Enter the following scopes in Allowed Scopes:
    sfcc.shopper-baskets-orders.rw sfcc.shopper-promotions sfcc.shopper-gift-certificates sfcc.shopper-categories sfcc.shopper-product-search sfcc.shopper.stores sfcc.shopper-customers.register sfcc.shopper-customers.login sfcc.shopper-myaccount.rw sfcc.shopper-myaccount.addresses.rw sfcc.shopper-myaccount.baskets sfcc.shopper-myaccount.orders sfcc.shopper-myaccount.paymentinstruments.rw sfcc.shopper-myaccount.productlists.rw sfcc.products.rw sfcc.catalogs.rw sfcc.shopper-products sfcc.shopper-productlists
  5. Select client_secret_post as the Token Endpoint Auth Method.
  6. Click the Save button to get the API client ID.
    Now you can see your API client ID in the Account Manager screen.
  7. Copy the API client ID for future reference.
Follow the steps given below to retrieve the Short code, Site Id, and Organization Id:
1. Log in to Business Manager using the Account Manager credentials.
2. Go to Administration and click Site Development.
3. Click Salesforce Commerce API Settings on the following screen.
4. Click the Request Short Code button to retrieve the Short Code.
5. Click the Copy to Clipboard buttons next to Short Code and Organization Id and store these values for future purposes.
6. Go to Administration and click Sites.
7. Click Manage Sites on the following screen.
8. Note down the required Site Id from the list or create a new one.
Note: Before retrieving the Client Secret, go to the Authorization for Shopper APIs guide and follow the steps listed in the Set Up User Roles and Filters section to set the SLAS Organization Administrator roles.

Follow the steps given below to retrieve the Client Secret:
1. Use the following URL to open the SLAS User Login page.
  https://{{short-code}}.api.commercecloud.salesforce.com/shopper/auth-admin/v1/ui/
  Note: Replace the {{short-code}} in the URL with the Short Code retrieved in the previous steps.
2. Log in to SLAS Admin UI using the Account Manager credentials.
3. From the menu on top, click Clients.
4. Click the Add Client button.
5. On the next screen that appears, provide the following details:
  1. In the What tenant will be used? dropdown, select your tenant ID.
    Note: The tenant ID will be the same as the last portion of your organization ID. For example, if the organization ID is abc_zybz_001, the tenant ID will be zybz_001.
  2. In the What site will be used? dropdown, enter the site name if the site is not already populated.
  3. Enter the API client ID retrieved in the previous steps in the Client ID field.
6. Click the Submit button.
  You can view the Client Secret generated at the top.
7. Copy and save the Client Secret.
8. Follow the steps below if you want to make your app Private:
  1. From the menu on top, click Clients.
  2. Click the Edit option under Actions against your Client ID.
  3. Mark the checkbox next to Private?.
  4. Click the Submit button.
Install and Configure Salesforce Commerce in Contentstack Marketplace

Follow the steps given below to install the application in Contentstack.
1. Log in to your Contentstack account.
2. In the left-hand side primary navigation, click the Marketplace icon to go to the Marketplace.
3. Click Apps from the left panel.
4. Within the Marketplace, you will be able to see all the available apps. Hover over the Salesforce Commerce app and click Install App.
5. In the popup window, select the stack where you want to install the Salesforce Commerce app and click the Install button.
6. On the Configuration screen, enter the following details:
  1. Enter the Client Id (API client ID), Client Secret, Organization Id, Site Id, and Short Code retrieved from your Salesforce Commerce account in step 1.
  2. Save in Entry: Choose how you want to save your data in the entry.
    1. If you select the All Fields option, the entire object returned from Salesforce Commerce will be saved. Also, you can choose only a limited number of products or categories.
    2. If you select Custom Fields, you need to search and add specific Salesforce Commerce Keys you want to fetch. The default selections are productId and productName.
7. On the UI Locations tab, you can see the predefined app locations. You can use the toggle button corresponding to each UI location to enable or disable it based on your requirements.
8. If the webhook is enabled for your app, you can view the webhook logs under the Webhook tab.
9. After adding the configuration details, click the Save button.
10. Click Open Stack to start using the Salesforce Commerce application.
Use Salesforce Commerce within your Stack

To use the Salesforce Commerce application within an entry of your stack, follow the steps given below:
1. Go to your stack, click the Content Models icon in the left navigation panel, and click the + New Content Type button.
2. Create a content type by entering relevant details as given below:
3. In the Content Type Builder page, add a Custom field for product in your content type by clicking the Insert a field link represented by a + sign.
4. Under Select Extension/App, select Salesforce Commerce - Product and click the Proceed button.
  
  This adds Salesforce Commerce - Product in the custom field.
5. Add another Custom field for category in your content type by clicking the Insert a field link represented by a + sign.
6. Under Select Extension/App, select Salesforce Commerce - Category and click the Proceed button.
  
  This adds Salesforce Commerce - Category in the custom field.
7. After adding the app, click Save or Save and Close to save your changes.
8. To use the Salesforce Commerce app, create an entry for this content type. In the left navigation panel, navigate to the Entries page, click + New Entry to create a new entry for the above content type, and then click Proceed.
  You can see the Salesforce Commerce app’s custom fields on your entry page as shown below:
9. Click the Add Product(s) button to choose the product(s).
10. Select the products from your Salesforce Commerce store and click the + Add Product(s) button to add them to your entry.
  
  The products you selected are referenced within your entry in the thumbnail view.
  
  Select the list view option from the dropdown to view the products in the list view.
  
  The products you selected are referenced within your entry in the list view.
11. To reorder, open in Salesforce CC, or delete the selected product, hover over the product to get the options available, then perform the following:
  1. Click the Drag icon to drag and reorder the product.
  2. Click the Open in Salesforce CC icon to open the product in the Salesforce Commerce app.
  3. Click the Delete icon to delete the product.
12. Click the Save button to save your entry.
13. You can view more product details in the Sidebar Widget.
14. Click the Add Category(s) button to choose the product(s).
15. Select the products from your Salesforce Commerce store and click the + Add Category(s) button to add them to your entry.
  
  The category(s) you selected are referenced within your entry in the thumbnail view.
  
  Select the list view option from the dropdown to view the category(s) in the list view.
  
  The category(s) you selected are referenced within your entry in the list view.
16. To reorder, open in Salesforce CC, or delete the selected category, hover over the category to get the options available, then perform the following:
  1. Click the Drag icon to drag and reorder the category.
  2. Click the Open in Salesforce CC icon to open the category in the Salesforce Commerce app.
  3. Click the Delete icon to delete the category.
17. Click the Save button to save your entry.