v6.0.0

API Versions

API Name	API Version
assignments	1.0.38
campaigns	1.0.40
catalogs	1.0.46
cdn-api-process-apis	1.0.41
cors-preferences	1.0.9
coupons	1.0.43
customers	1.1.3
gift-certificates	1.0.42
orders	1.4.15
preferences	1.1.6
products	1.1.5
promotions	1.0.36
shopper-baskets	1.9.4
shopper-baskets	2.3.3
shopper-configurations	1.0.2
shopper-consents	1.1.4
shopper-context	1.1.3
shopper-customers	1.3.2
shopper-experience	1.1.2
shopper-gift-certificates	1.0.29
shopper-login	1.42.2
shopper-orders	1.10.2
shopper-products	1.1.3
shopper-promotions	1.0.39
shopper-search	1.5.4
shopper-seo	1.0.17
shopper-stores	1.0.19
slas-admin	1.14.1
source-code-groups	1.0.40

v5.1.0

API Versions

API Name	API Version
assignments	1.0.36
campaigns	1.0.38
catalogs	1.0.43
cdn-api-process-apis	1.0.40
cors-preferences	1.0.7
coupons	1.0.40
customers	1.0.33
gift-certificates	1.0.40
orders	1.4.11
preferences	1.1.4
products	1.0.41
promotions	1.0.34
shopper-baskets	1.9.1
shopper-baskets	2.1.1
shopper-configurations	1.0.0
shopper-consents	1.1.2
shopper-context	1.1.2
shopper-customers	1.1.2
shopper-experience	1.0.9
shopper-gift-certificates	1.0.27
shopper-login	1.40.0
shopper-orders	1.5.1
shopper-products	1.0.39
shopper-promotions	1.0.37
shopper-search	1.5.1
shopper-seo	1.0.14
shopper-stores	1.0.18
slas-admin	1.12.31
source-code-groups	1.0.38

Bug Fixes

• Fix incorrect encoding of multi-segment endpoint paths in callCustomEndpoint #435

NOTE: The Shopper-Consents API is experimental.
DO NOT use Shopper-Consents API in production, this api might be subject to change.

v5.0.0

API Versions

API Name	API Version
assignments	1.0.35
campaigns	1.0.37
catalogs	1.0.42
cdn-api-process-apis	1.0.39
cors-preferences	1.0.5
coupons	1.0.39
customers	1.0.32
gift-certificates	1.0.39
orders	1.4.10
preferences	1.1.3
products	1.0.40
promotions	1.0.33
shopper-baskets	1.9.0
shopper-baskets	2.1.0
shopper-consents	1.1.0
shopper-context	1.1.1
shopper-customers	1.1.1
shopper-experience	1.0.7
shopper-gift-certificates	1.0.26
shopper-login	1.39.41
shopper-orders	1.5.0
shopper-products	1.0.37
shopper-promotions	1.0.36
shopper-search	1.3.0
shopper-seo	1.0.13
shopper-stores	1.0.17
slas-admin	1.12.30
source-code-groups	1.0.37

Enchancements

• Enum types have been added for certain operations and types
• Certain operations have had types updated for query parameters
• SLAS helpers have been refactored to accept a single options object argument, where the properties are the old arguments
  • loginGuestUserPrivate now passes usid under options.parameters
• Path parameter special characters are encoded by default
• API family layer and API namespace has been removed. To import API classes, please refer to the README
• Docs Site has been upgraded to reflect new directory structure #426

NOTE: The Shopper-Consents API is experimental and will not be available for consumption until October 21st, 2025.
DO NOT use Shopper-Consents API in production, this api might be subject to change.

v4.2.0

Enchancements

• Allow custom params for 'loginGuestUser' and custom body for 'loginRegisteredUserB2C' function #415
• Add helper to encode special SCAPI characters #416

v4.1.0

v4.1.0

Enchancements

• Support Node 22 #412

API Changes

Shopper Products

• The expand query parameter now includes a new argument, page_meta_tags

Shopper Search

• The expand query parameter now includes a new argument, page_meta_tags

Shopper Context

• X-Geolocation header was added to Shopper Context

CDN Zones API

• Endpoints added

  Endpoint Name	Description
  getCodeUploadCertificates	Returns all the mTLS certificates for the account
  createCodeUploadCertificate	Set up two-factor mTLS certificates for the account and associate the staging zone code upload hostname
  getCodeUploadCertificate	Returns the mTLS certificate for the given account's mTLS certificate ID
  deleteCodeUploadCertificate	Successfully deleted the mTLS certificate from the account

v4.0.0

v4.0.0

⚠️ Planned API Changes ⚠️

Shopper Context

Starting July 31st 2024, all endpoints in the Shopper context API will require the siteId parameter for new customers. This field is marked as optional for backward compatibility and will be changed to mandatory tentatively by January 2025. You can read more about the planned change here in the notes section.

Shopper Login (SLAS)

SLAS will soon require new tenants to pass channel_id as an argument for retrieving guest access tokens. You can read more about the planned change here.

Please be aware that existing tenants are on a temporary allow list and will see no immediate disruption to service. We do ask that all users seek to adhere to the channel_id requirement before the end of August to enhance your security posture before the holiday peak season.

In practice, we recommend that customers using the SLAS helper functions upgrade to v4.0.0 of the commerce-sdk.

Enchancements

• Update SLAS helper function loginGuestUserPrivate to require channel_id and loginGuestUser to pass in channel_id to SLAS through clientConfig.parameters.siteId #406

API Changes

CDN Zones API

• Endpoints added

  Endpoint Name	Description
  getOwaspWafPackage	Get a OWASP ModSecurity Core Rule Set.
  patchOwaspWafPackage	Patch a OWASP ModSecurity Core Rule Set.
  getWafManagedRulesInRuleset	Retrieves all rules in the specified WAFv2 managed ruleset.
  updateWafManagedRuleInRuleset	Updates a WAF managed rule in the specified WAFv2 managed ruleset.
  migrateZoneToWafV2	Migrates a zone to WAFv2. Only applicable for existing zones using WAFv1.
  upsertOriginHeaderModification	Upsert origin header modification.
  getOriginHeaderModification	Get origin header modification associated with a zone.
  deleteOriginHeaderModification	Delete the origin header modification associated with a zone.

• BREAKING: Removed deprecated endpoints

  • getFirewallRules
  • createFirewallRule
  • getFirewallRule
  • updateFirewallRule
  • deleteFirewallRule

  NOTE: As of February 6th, 2024, firewall rules are deprecated and customers can use eCDN custom rules moving forward.

v3.1.0

API Changes

Shopper Baskets

Endpoint Name	Description
updateItemsInBasket	Updates multiple items in a basket.

v3.0.0

v3.0.0

API Changes

Shopper Customers

• Removal of deprecated endpoints:
  • invalidateCustomerAuth
  • authorizeCustomer
  • authorizeTrustedSystem

Shopper Orders

Endpoint Name	Description
guestOrderLookup	Lookup a guest order

Customers

Endpoint Name	Description
searchCustomerGroup	Search for customer groups in a given Site Id

Coupons

Endpoint Name	Description
redeemCoupon	Redeems a coupon code for an existing coupon within the selected site. The coupon code must be redeemable.

Enchancements

• Add helper function customApiHelper.callCustomEndpoint to call Custom APIs - #402

Other Changes

• Removal of deprecated helper function getShopperToken

v2.15.0

v2.15.0

API Changes

• Update APIs for Shopper Search

• New Endpoints

  Endpoint Name	Description
  getWafManagedRulesets	Retrieves WAFv2 managed rulesets.
  updateWafManagedRuleset	Updates WAFv2 managed ruleset.

v2.14.0

v2.14.0

API Changes

• Shopper SEO API*

New Endpoints

Endpoint Name	Description
getUrlMapping	Gets URL mapping information for a URL that a shopper clicked or typed in. The mapping information is based on URL rules and redirects set up in Business Manager. For more information about prerequisites and sample usage, see URL Resolution. You can customize the behavior of this endpoint by using hooks. See the hooks for getUrlMapping in the Hook List.