February 2024

SCAPI Features

• Shopper Search
  • With B2C Commerce 23.3:
    • The select query parameter in the Product Search API endpoint filters the response payload by a specified field or set of fields. This allows you to focus on the data that's important to you and improve page loading speed.
    • Save time and improve product listing page (PLP) performance by using the enhanced Product Search API endpoint. Use the new optional expansion on the Product Search API endpoint to retrieve product metadata and avoid the use of additional API calls to Get Products. Use these features to provide the additional information needed to render your PLP:
      • Allowable value: promotions value in the expand query parameter
      • Query parameters: perPricebook, allImages, and allVariationProperties
      • Responses: productPromotions, imageGroups, priceRanges, tieredPrices, variants, and variationGroups
• Shopper SEO
  • With B2C Commerce 24.3:
    • Updated getUrlMapping to support URL redirects. For more information, see the URL Resolution guide.
    • Updated getUrlMapping to support the following hooks: dw.shop.seo.url_mapping.beforeGET and dw.shop.seo.url_mapping.modifyGETResponse.
  • With B2C Commerce 24.2:
    • Updated getUrlMapping's response to include the optional property resourceSubType, which indicates whether the resolved object is a Page Designer content asset or a Content Slot asset.

• Custom APIs
  • With B2C Commerce 24.2, Salesforce Commerce Cloud now provides a new framework that enables you to write custom B2C commerce script code, such as controllers, and expose this functionality as a custom REST API endpoint under the SCAPI framework. Those custom API endpoints accept the same AuthN/AuthZ model as our Shopper and Admin APIs.
  • With the transition from Beta to General Availability (GA), future changes to B2C Commerce Custom APIs will follow our change policy.
  • If you are new to Custom APIs, see Custom APIs as a starting point.
    • New features (non-breaking changes) not included in the Beta:
      • Added the RestResponseMgr Script API class to simplify writing custom APIs.
      • Added support for local references of shared objects in the API contract.
      • Added support for the AmOauth2 method for Admin APIs. For details, see Custom API Authentication and Authorization.
    • If you participated in the Custom APIs Beta, the transition to General Availability causes the following BREAKING changes. Review and update your code as needed:
      • Custom endpoints now require custom scopes. For details, see Scopes.
      • Storefront quota limits are now enforced. Review these limits and fix any errors. For details, see API Quotas. The quota limits relevant for Custom APIs are the ones marked as Storefront Limit.
      • We've added Circuit Breaker functionality that is similar to what exists for hooks to Custom APIs. This is a protective measure that blocks API requests when the error rate is too high. For details, see Circuit Breaker. B2C Commerce Custom APIs support HTTP GET requests as well as DELETE, HEAD, and OPTIONS. Future transaction support with POST, PUT, PATCH is being planned.

• Shopper BasketsWith B2C Commerce 24.1, Shopper Baskets V2 is available.
• Custom Request Headers
  • Developers can send custom request headers that are passed and made available in server-side custom implementations.
  • The required pattern is: c\_{yourHeader}.
• Update order now supports the ShopperTokenTsob security scheme.
• Introduced new load shedding functionality that:
  • If the system reaches a load threshold, an HTTP 503 response is returned for a subset of API families.
  • Covers APIs not covered by rate limits that are considered non-critical, for example: endpoints related to search, products, and authentication. Load shedding is not used for checkout-related endpoints, such as Shopper Baskets and Shopper Orders, to ensure that shoppers can complete an in-progress checkout.
  • Includes additional HTTP response headers that allow you to understand the current system load: sfdc_load, which represents a load percentage with higher percentages indicating higher loads, and sfdc_load_status, which is a enum WARN|THROTTLE that helps you understand the relative health of the system.
• Replace Firewall Rules with New Custom Rules. For additional details, see: eCDN Custom Rules.

SLAS

• SLAS Admin UI: Added client name to the client list and detail pages.
• SLAS API: Added support for the DoNotTrack (DNT) query parameter in token calls for headless customers. This is in preparation for a future SCAPI B2C Commerce rollout. Additional documentation will be provided.
• SLAS to B2C Commerce Data consistency: Addressed a limitation around customer records synchronization between B2C Commerce and SLAS.
• SLAS third-party IDP configuration is tolerant of missing idToken when refreshing third-party IDPs.

For more detailed information, seeB2C Commerce API Release Notes.