Headless Development Using Commerce API

B2C Commerce: Salesforce Commerce API

Welcome to B2C Commerce: Salesforce Commerce API. In this course, you learn how to use the Salesforce Commerce API to get data from an instance. After completing this course, you'll be able to:

Access the Commerce Cloud Developer Center
Inspect shopper and admin APIs
Configure a ClientID and API roles in Business Manager
Use Postman to access the API

Get to Know Headless Commerce

Complete this Trailhead module to learn:

Define headless commerce.
Discuss the difference between a headless and a traditional approach.
List three advantages of using a headless approach.

API Basics

Learn the fundamentals and benefits of developing with APIs by completing this Trailhead module.

Commerce API Overview

This 5 minutes video explains:

Goal of Salesforce Commerce API
Navigation of Commerce Cloud Developer Center (CCDC)
Usage of a Shopper API

📝 Create an API Client for Use with Commerce API

To use the Commerce API, you need to be a B2C Commerce customer or partner (SI or LINK).

Login to Account Manager (AM). You need to be a B2C Commerce customer or partner (SI or LINK0 to have access to AM.
Make sure you have the Sandbox API User role. If not, request your AM account administrator to provide it for you.
Locate the API Client tab
1. Under Filter by Organization, make sure you select the one for which you are creating the API Client: the customer or the partner organization. It is possible that you belong to multiple organization in AM if you working for customers and they have added you to their AM organization.
2. Click Add API Client

Create the API Client following the steps in this document.
Remember the password! Save it somewhere safe (LastPass or equivalent). You will need it in future activities. If you forget it, you will have to create a new API Client (nice, eh?).
In the Roles section, make sure you select the specific On Demand Sandbox (ODS) that you have access to. While you are here, you should add any other ODS you want to be able to use the API on.
- Click the highlighted icon below to search and select the realm and sandbox to enable:
- Select the On Demand Sandboxes (ODSs) that you want to be able to access with this API Client
- Click Add
In the Allowed Scopes section, enter the following scopes which support future activities in this course (rather to do it now instead of coming back to AM several times to add a single scope):
1. sfcc.shopper-products
2. sfcc.shopper-product-search
3. sfcc.shopper-promotions
4. sfcc.shopper-customers.register
5. sfcc.shopper-customers.login
6. sfcc.shopper-baskets-orders.rw
7. sfcc.shopper-myaccount.baskets.rw
8. sfcc.catalogs
9. sfcc.customerlists.rw

For production, you will need more or less scopes depending on how much your headless application needs to support.

Use the Shopper API in Postman

Import a collection and environment into Postman:

If you don't have Postman installed, download and install it from official website. You can also use the Web Version, but the steps are only for the desktop version.
Start Postman
Download the zip file from the Commerce API Workshop.postman_collection.json gist, which contains two JSON files:
1. Postman collection for Commerce APIs
2. Postman environment variables for the collection
Click Import on the main menu and select Commerce API Workshop.postman_collection.json: this will import a collection into Postman:
Click on the Manage Environment icon on the upper right corner:
- Scroll to the bottom of the dialog and select Import
- Select the Commerce API Workshop.postman_environment.json
- This creates a new Commerce API Workshop environment that you can view and edit by clicking the icon "eye"

Edit your environment variables to point to your ODS

Postman uses environment variables to make it easier to enter and reuse API calls in your collection. This collection attempts to use the same variables that the CCDC uses in the API documentation.

Most environment variable values are placeholders, so you must use your own clientID and sandbox to fill them.

Any other values present assume SFRA RefArch site: products, promotions, catalog, customers lists, etc.

On the Commerce API Workshop environment screen (previous step), click Edit
clientId and clientIdPwd: login to AM, and get the clientId and password that you setup during Create an API Client for Use with Commerce API. If you forgot the password (really?), you will have to redo that activity.
Login to your ODS, navigate to Administration > Site Development > Salesforce Commerce API Settings, and populate the following from that screen:
1. organizationId: f_ecom_<realm>_<instance>
2. shortCode: unique to your instance
3. tenant: use the <realm>_<instance> combination. Don't forget to use underscore: “_”.
basketId, customerNo, itemId and all global variables: these are populated by collection calls, no need to enter a value
The rest of the variables are initialized to SFRA values. If you are using SiteGenesis site, modify accordingly.

Download Headless Commerce Course

B2C Commerce: Salesforce Commerce API
- Trailhead Unit: Get to Know Headless Commerce
- API Basics
- Commerce API Overview
- Activity: Create an API Client for Use with Commerce API
- Use the Shopper API in Postman
- Scope Considerations for Management API Calls
- Use the Management API in Postman
- Open Commerce API (OCAPI) Overview
- Study OCAPI Content
- Shopper Login and API Access Service (SLAS) Overview
- Set Up SLAS API to Enable Shopper Login to Open ID Compliant IDP
- Use SLAS API to Set up a tenant and a client
B2C Commerce: Sample Apps Using Commerce SDK Overview
- Welcome and Learning Objectives
- Explore Headless Architecture and Implementation Roles
- Goal and Architecture of Sample Apps
- Headless Developer Tools for Salesforce B2C Commerce
- Activity: Install and Run Sample Apps
- Backend for Frontend
- Commerce SDK
- Update SDK Version and Use the GraphQL Playground
- Additional Resource: Headless Commerce Concepts
B2C Commerce: Backend for Frontend Using Commerce SDK
- Backend for Frontend (BFF) Recap and Schema
- Modify the Product Details Type Definition
- Write Asynchronous JavaScript
- Code Walkthrough of Product Details Resolver
- Debug the Product Details Resolver
- Product Model Walkthrough
- Modify the Product Model
B2C Commerce: Frontend Architectural Options
- Frontend Considerations
- Modify the Sample Apps PDP using Lightning Web Components
- Lightning Web Components Basics Trailhead Module
B2C Commerce: Headless Commerce Implementation Considerations
- Sample Architecture for Headless Commerce
- Additional Resources: Sample Architecture for Headless Commerce
- Implement a Content Delivery Network and Caching
- Implement Scaling for Resilience, Middleware, and Networking
- Monitor and Test
- Rate limiting Diagram
- Circuit Breaking Diagram
- Load Testing for B2C Commerce
- Secure the Storefront
- Multi-Factor Authentication for B2C Commerce
- Operational Best Practices
- Additional Resources: Operational Best Practices
- B2C Commerce Headless Implementation

Content Locked. Get Full access in completing the form below

Enter your e-mail to get a free copy of Commerce API course.
Check your e-mail, you'll receive a copy in a few seconds. If not, take a look to the spam folder.