v5.1.0

API Versions

API Name	API Version
shopper-login	1.46.0
shopper-baskets	1.11.0
shopper-baskets	2.5.1
shopper-configurations	1.2.0
shopper-consents	1.1.4
shopper-context	1.1.3
shopper-customers	1.6.1
shopper-experience	1.2.1
shopper-gift-certificates	1.2.0
shopper-orders	1.12.1
shopper-payments	1.4.0
shopper-products	1.3.0
shopper-promotions	1.2.0
shopper-search	1.8.0
shopper-seo	1.0.17
shopper-stores	1.2.0

Enchancements

• Allow developers to pass in custom fetch implementation via clientConfig #272

v5.0.0

API Versions

API Name	API Version
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.0
shopper-payments	1.2.3
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

v4.2.0

API Versions

New APIs:

• Shopper Configurations

API Name	API Version
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

NOTE: This release does not implement any features in v4.1.0. These features are still experimental and will be released in a future major version and will be denoted in the release notes.

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

v4.1.0 (DEPRECATED)

Enhancements

• Allow developers to pass in custom fetch implementation via clientConfig #246
• Support subpath imports for individual APIs and named imports #219

Bug Fixes

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

Known Issues

• The new subpath import feature and updated fetch implementation may not work as expected in certain usage patterns, specifically for CommonJS environments. The team is actively investigating and will publish a fix in the next release. We recommend staying on version v4.0.1 until then.

v4.0.1

Bug Fixes

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

v3.5.0

Enhancements

• Make code_challenge an optional parameter on SLAS getTrustedAgentAuthorizationToken endpoint #229

v4.0.0

API Versions

API Name	API Version
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

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
• Path parameter special characters are encoded by default
• Allow custom properties on request bodies to be passed
• Remove API version from client config
  • Use ShopperBasketsV2 API class to use V2 of Shopper Baskets

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.

v3.4.0

API Changes

• Shopper Search API: Add includedCustomVariationProperties query parameter to the productSearch operation and expand/includedCustomProductProperties query parameters to the getSearchSuggestions operation

v3.3.0

Enhancements

• Allow custom params for 'loginGuestUser', 'authorizeIDP' and custom body for 'loginRegisteredUserB2C' functions #186
• Add helper to encode special SCAPI characters #189

Security fix

• Normalize URLs to remove the possibility of path traversal from fetch calls #192

v3.2.0

v3.2.0

Enhancements

• Add to README docs to explain error handling for the SDK #174
• Add SLAS passwordless login helpers #173
• Add SLAS social login helper #172
• Support Node 22 #178

API Changes

• The expand query parameter for Shopper Products calls now includes a new argument, page_meta_tags
• The expand query parameter for Shopper Search calls now includes a new argument, page_meta_tags
• X-Geolocation header was added to Shopper Context