About the B2C Commerce API

The B2C Commerce API (also known as the Salesforce Commerce API or SCAPI) is a collection of RESTful APIs for interacting with B2C Commerce instances.

The Commerce API is broken into two main groups: Shopper APIs and Admin APIs. And within each group, they are divided into 20+ smaller groups of endpoints focused on related functionality.

For detailed API reference material, choose one of the groups of endpoints (Assignments, Campaigns, and so on) listed in the navigation.

To learn more about using the Commerce API, see the Get Started page in the Guides section.

The Admin APIs and Shopper APIs each have their own mechanisms for setting up API clients and requesting access tokens. For details, see the Authorization guide.

You can use correlation IDs to match a particular request to a particular response, making it easier to troubleshoot unexpected issues, such as internal server errors.

If a correlation-id header is provided in a request to a SCAPI endpoint, the response contains an x-correlation-id header that contains the value of correlation-id. The API also generates its own correlation ID for each response. The string that is provided in the x-correlation-id header is a combination of the user-provided correlation ID and the SCAPI-generated correlation ID with a comma separating the two IDs.

Example headers:

The value of correlation-id must be a universally unique identifier (UUID) and follow version 4 of the UUID standard: 36 characters long, including 3 hyphens. For more details on formatting, see the Universally unique identifier article on Wikipedia.

The SCAPI-generated correlation ID is shorter and doesn’t follow the UUID standard.

For most Commerce API endpoints, the correlation-id can be automatically added to log messages with a hook. You can query these messages in Log Center with an LCQL (Log Center Query Language) expression that filters messages based on the externalID field. The externalID field contains the value of the x-correlation-id header, so you can query for the user-provided correlation ID, the SCAPI-generated correlation ID, or the combined string.

Some groups of Commerce API endpoints are not used exclusively with B2C Commerce and therefore can’t log requests and responses to Log Center. These API groups include CDN Zones, Inventory Availability, Inventory Impex, Inventory Reservation, Shopper Context, and Shopper Login.

Watch this space for details on API updates.

11/3/2022

  • Rate limit increase for GET /customers/*(Shopper-Customers), see Rate Limits.
  • Security update for SCAPI platform environment.
  • Maintenance and stability updates for SCAPI platform environment.

11/1/2022

  • Rate limit increase for GET /products-lists/{id}(Shopper-Customers), see Rate Limits.
  • Maintenance, stability, and capacity updates for SCAPI platform environment.

10/27/2022

  • Rate limit updates: API families have either a 5s tier or a 60s tier, see Rate Limits.
  • Rate limit increase for Order API, see Rate Limits.
  • Shopper-Products:
    • response compression has been introduced.
    • ‘expand’ query parameter has been added for getProducts.
  • Maintenance and stability updates for SCAPI platform environment.

10/26/2022

  • Maintenance and stability updates for SCAPI platform environment.

10/24/2022

  • Added support for correlation-id and x-correlation-id headers.

09/14/2022

The scheduled deactivation of /customers/actions/login, /trusted-system/actions/login, and other related endpoints has been extended from mid-2022 to mid-2023 for existing customers. These endpoints are still not available to new customers, and we still discourage existing customers from using them. Instead, we strongly recommend that you use the Shopper Login and API Access Service (SLAS) because it meets a higher standard for security and availability.

09/13/2022

All APIs

  • Increased performance and response times through caching on the edge layer.
  • Resources affected: /product, /category, and /product_search.
  • Updates to the personalization handling ensure that personalized content is cached correctly.
  • No action is required by developers to take advantage of this update.

08/24/2022

All APIs

  • Update common libraries for data types, security schemes, and examples to latest versions.

Shopper Context

  • Remove outdated example requests for creating and updating shopper context.

Shopper Login (SLAS)

  • Replace SlasJWT-BearerSecurityScheme.BearerToken security scheme with CommerceCloudStandards.ShopperToken.