8.2.1 Release Notes

Cumulative release notes for Sitecore Commerce 8.2.1 Initial Release through Update-3.

Sitecore Commerce 8.2.1 Update-3 (May 2018)

1. What's New

A roll-up of fixes to previously reported customer issues.

Performance related improvements.

Compatibility with Sitecore 8.2 Update-7.

Extended the Sitecore 8.2 Update-7 technical guidance for General Data Protection Regulation (GDPR) to include guidance pertaining to Commerce shopper interaction data. See the Technical guidance for GDPR (including EXM and Sitecore Commerce topic (for Sitecore Platform 8.2) for more details.

Components in the Update-3 release package are updated as follows:
Area Component
Commerce Engine Sitecore.Commerce.SDK.1.3.153.zip
Commerce Server CommerceServer-11.4.153.exe
Connectors Sitecore Commerce Connect 10.3.27.zip
  Sitecore Commerce Server Connect.10.3.52.update
Business Tools Sitecore Commerce Business Tools Shared.1.3.13.update
  Sitecore Commerce Customer and Order Manager.1.3.11.update
  Sitecore Commerce Pricing and Promotion Manager.1.3.17.update
  Sitecore Commerce Merchandising Manager.11.1.48.update
Reference Storefront Sitecore.Reference.Storefront.Common.10.3.158.update

2. Compatibility

Sitecore Experience Platform 8.2 Update-7, available on dev.sitecore.net.

3. Resolved Issues
  • 5614: Commerce Server – cultures are not handled correctly when not set to English
  • 20092: Solr search – indexing strategies are not being implemented correctly, causing exception errors
  • 20484: Commerce Server - deadlocks are occurring causing processes to hang
  • 21400: CommerceUserEventHandler causes unneeded requests to Commerce Server
  • 22093: A large number of Sitecore.Commerce.Connect.CommerceServer.Events.CacheRefreshEvent events are written in an EventQueue table of a core database
  • 22149: Using MongoDB as a private session state store results in a SerializationException
  • 26463, 29946, 36399: CommerceServer.Core.Catalog.Internal.CatalogCache.ClearCache method clears HttpRuntime.Cache without filtering (see here for more details)
  • 26815, 31187: Customer and Order Manger – cannot sort orders by the date the order was submitted
  • 27689, 35330: Promotions – unable to set a promotion as an absolute value discount; only percent off discounts can be set
  • 28460: Attempting to fetch a price for a variant with same VariantId value as parent product's ProductId returns a Sitecore Commerce PricingServiceProvider error
  • 28466, 28646, 36345: Unable to switch the currency in a Cart (see here for more details)
  • 28557, 36397: Commerce plugins generate SQL commands in different ways depending on the set culture, which makes them incorrect
  • 28574, 36398: Merchandising Manager - adding an item to a cart and then deleting that item from the catalog causes the cart to no longer be openable
  • 30167: Merchandising Manager - property type 'Multiple Choice' set on Commerce server does not display multiple choice
  • 30773: Categories for a base catalog are not displayed if the language for the catalog is not set to "en-US"
  • 30831, 30919: A return that changes a price tier does not update the line item price to the new tier
  • 30963, 32774, 38535: Customer and Order Manager – does not show user profile's custom properties (see here for see here for more details)
  • 31520, 36402: Catalog Manager – crashes on Windows10 when rendering the language screen
  • 31822, 31995: Performance – slow checkout when multiple countries are configured
  • 32139: Reference Storefront - new categories and products do not display after publishing, unless a full re-index is implemented
  • 32143: Merchandising Manager - media prefixes for images are hard coded, causing them to not render correctly
  • 32313: Merchandising Manager – unable to set a price more than 999 via the Update List Price button
  • 32475: a backorderable product with the preorderable value set to Null throws an exception during order submission
  • 32552: Performance – adding an address to a customer in Customer Order Manager is slow
  • 32548, 35343: Customer and Order Manager – when placing an order on hold an unnecessary OrderHasNoOnHoldComponent warning message is displayed
  • 32799: Merchandising Manager – an issue occurs when creating a new relationship name that is set up as a two way relationship
  • 32806: Customer and Order Manager – dates are shown in different formats and UTC offsets across various UIs
  • 32873: Commerce Engine – defaults to language "en-US" whereas it should default more generically to language "en"
  • 32824: SellableItem.Component uses product.BaseCatalogName instead of product.CatalogName and therefore breaks virtual catalogs (see here for more details)
  • 33735: Customer and Order Manager - values of an order total (Grand, Payments, Sub, Adjustments) are incorrect when .Net globalization culture is set to a language other than English
  • 34491: Commerce Server - after installing in Windows 10 Update 1709, a ComException (0x80004005) occurs
  • 34576, 35345: IsShopNameCondition is unnecessarily case-sensitive
  • 34580: Reference Storefront - applying a promotion code to a cart that is empty returns an error message
  • 34589: ProfileKeyManager.exe throws a null reference exception when performing the command to roll profile key data
  • 34766: Merchandising Manager – does not display a Date Time property if its name contains a space e.g. “Valid From”
  • 35346: ValidateSitecoreConnectionBlock returns false when sitecore/content/home item is removed
  • 35439: Merchandising Manager – accessing a custom catalog results in error "Sequence contains more than one element"
  • 36087: IncludeInGrandTotal property of AwardedAdjustment class is not taken into account in CalculateCartTotalsBlock
  • 36133: MARS is hardcoded for all SQL connections
  • 36193: Performance - incorrect row locks used and possible invalid clustering of indexes are causing issues
  • 36266: Controller renderings fails when products are edited in Experience Editor
  • 36379: when Master Database is disabled, errors related to the cacheRefresh event are created in the Sitecore log on the CD server
  • 36405: Performance – Commerce Engine sends many authentication web API requests during startup
  • 36692: Pricing and Promotions Manager – only able to search items in language “en”
  • 36723: Sitecore.Commerce.Plugin.Rules plugin does not work cultures other than “en”
  • 37057: Performance – get SellableItems load slowly when there is a large number of price cards
  • 37065: Pricing and Promotions Manager – TaskCancelledException error is shown when price book has thousands of price cards
  • 37854: Merchandising Manager - price card picker can only search for the first ten price cards
  • 38147: Performance – degradation occurs when adding a product with multiple variants to a cart
  • 38558, 38600: Performance - asynchronous calls in SitecoreConnectionManager are causing call blocking
  • 117840, 219455: Commerce Connect - Commerce pipelines based on TriggerPageEvent throw NullReferenceException for robots

Release notes information update (Oct 2017)

The Microsoft Azure Cloud support feature is terminated for Commerce 8.2.1. The development work started in the Commerce 8.2.1 Update-1 timeframe was not completed, and the feature not released.

Compatibility with the Sitecore Experience Platform is kept up-to-date on dev.sitecore.net. The sections below in this document are not updated to reflect newer Platform versions.

Sitecore Commerce 8.2.1 Update-2 (July 2017)

1. What's New

Compatibility with Sitecore 8.2 Update-4.

Minor robustness, stability and performance improvements.

Preparatory software updates, enabling new Commerce features that are in development: Sitecore Experience Accelerator Storefront, Commerce deployment in a Microsoft Azure Cloud environment.

Components in the Update-2 release package are updated as follows:
Area Component
Commerce Engine Sitecore.Commerce.SDK.1.2.159.zip
Commerce Server CommerceServer-11.4.148.exe (unchanged)
Connectors Sitecore Commerce Connect 10.2.12.zip
  Sitecore Commerce Server Connect.10.2.42.update
Business Tools Sitecore Commerce Business Tools Shared.1.2.18.update
  Sitecore Commerce Customer and Order Manager.1.2.15.update
  Sitecore Commerce Pricing and Promotion Manager.1.2.6.update
  Sitecore Commerce Merchandising Manager.11.0.15.update
Reference Storefront Sitecore.Reference.Storefront.Common.10.2.65.update

2. Compatibility

Sitecore Experience Platform 8.2, Update-3 or Update-4, available on dev.sitecore.net.

3. Resolved Issues

  • 26440: Merchandising Mgr display label "List Price" is incorrect; should be "Default List Price".
  • 26913: High Memory consumption in CatalogItemHierarchyListControl.
  • 26947: GetCatalogs call to Commerce Server is not caching correctly causing perf impact.
  • 26953: Doc: Exclusive promotion applies across all cart lines, not just one cart line.
  • 26955: Sample Habitat promotion Mira Laptop 50% Off Time (Exclusive) is not exclusive.
  • 26965: Invalid column name exception is thrown when you try to add a product to cart.
  • 27046: Performance: SellableItems are not caching, even if the configuration says that it should.
  • 27047: Coupon is set to cache, but should not cache because a coupon is used once.
  • 27133: Performance: Cart calculations are performed unnecessarily often.
  • 27242: Paying as Paypal instead of a Credit Card in Braintree results in an obscure exception.
  • 27289: SellableItem list prices do not correctly apply independently across product variants.
  • 27342: SQL deadlock issues encountered while running high load checkout tests in parallel.
  • 27669: Adding a promotion to a promotion book causes a 405 error when WebDAV is enabled.
  • 27980: Ref Storefront takes too long to render the delivery option droplist.
  • 28012: Exception thrown when adding a property without a value to the User Profile search index.
  • 27961: Adding a PriceBook - part of the ServiceURL is omitted if it doesn't end with "/".
  • 28522: Running a high user load against Commerce Engine causes threads to deadlock.
  • 28580: Performance: negative caching is not working for entities. For example, SellableItems as designed.

4. Known Issues

Starting with Sitecore XP 8.2 Update-4, setting up Solr requires a new "user" field in the XML Schema for Commerce indexes. Follow the Commerce Setting up Solr documentation.

5. Breaking Changes

Not applicable.

Sitecore Commerce 8.2.1 Update-1 (April 2107)

1. What’s New

Update-1 adds robustness and performance improvements. Dependent software versions have also been updated.

Software Framework

  • Updated dependency on .NET Framework, from 4.5.2 to 4.6.1
  • Updated dependency on ASP.NET Core, from 1.0.0 to 1.0.3
  • Updated dependency on Sitecore Experience Platform, from 8.2 Update-1 to Update-3

Sitecore Commerce Engine

  • Robustness improvements.
  • Configurable logging levels.
  • Performance tuning.

Sitecore Commerce Engine Plugins

  • Improved the consistent use of asynchronous patterns, to avoid ASP. NET Core deadlocks and improve performance.
  • Improved item returns, including the calculation of refunds.
  • Moved the functionality related to digital items to a dedicated digital items plugin.
  • Added validation when initializing an environment to ensure connectivity to Sitecore XP and Commerce Server, with improved failure messaging.
  • Improved testing, including automated testing.
  • Removed unused properties, policies, etc.

Business Tools

  • Improved localizability of user interfaces.
  • Improved Private Coupon support.

Cloud Deployment Readiness

October 2017 update: This Cloud deployment feature development has been terminated. Commerce 8.2.1 does not support deployment in a Microsoft Azure (Platform as a Service) cloud.

Preparatory development to enable deployment in a Microsoft Azure Web Application (Platform as a Service). This provides product preparation for the Cloud deployment feature, but the feature is not yet available at the time of Update-1 release.

  • Converted Commerce Engine database scripts to DacPacs; no database structural changes were made.
  • Tested use of SQL Azure.
  • Eliminated the requirement for the (legacy) Commerce Server services in the Content Delivery environment.
  • Added support for logging to Application Insights.

Sitecore Commerce Release Package

Components in the Update-1 release package are updated as follows:

Area Component
Commerce Engine Sitecore.Commerce.SDK.1.1.819.zip
Commerce Server CommerceServer-11.4.148.exe (unchanged)
Connectors Sitecore Commerce Connect 10.1.11.zip
Sitecore Commerce Server Connect.10.1.22.update
Business Tools Sitecore Commerce Business Tools Shared.1.1.69.update
Sitecore Commerce Customer and Order Manager.1.1.76.update
Sitecore Commerce Pricing and Promotion Manager.1.1.65.update
Sitecore Commerce Merchandising Manager.10.1.110.update
Reference Storefront Sitecore.Reference.Storefront.Common.10.1.110.update

2. Compatibility

.NET Framework 4.6.1

ASP. NET Core 1.0.3

Sitecore Experience Platform 8.2 Update-3 software, available on dev.sitecore.net. Previous Sitecore XP 8.2 versions (Initial Release through Update-2) are not compatible.

3. Resolved issues

  • 25932: "View All" links appear in CUSTOMER & ORDER MANAGER\Price Books and cause an exception for IE.
  • 26019: Order.Payment.PartyID is null when you get an order via OrderServiceProvider.
  • 7986: A visitor cannot complete a checkout when the region and formats are set to regions other than Canada/US and English.

4. Known Issues

Sitecore Commerce 8.2.1 does not yet fully support deployment in a Microsoft Azure Web Application. This feature is still in development at the time of Update-1 release.

Solr 5.5 has a known issue that results in a blocking exception. To resolve, upgrade Solr to 5.5.1 or later. https://issues.apache.org/jira/browse/SOLR-8793

During Sitecore Commerce deployment, an unexpected Sitecore.Commerce.Assemblies.Common package version is fetched from the sitecore.myget.org feed and installed. The expected version is 11.4.148, which matches the Commerce Server version that is previously stated. The actual version that is installed is 11.4.150. There is no functional impact of this version mismatch. This package is fetched and installed when you run the dotnet restore command. For example, during Step 2 of the Install the Commerce Authoring Service procedure in the Sitecore Commerce 8.2.1 Deployment Guide.

5. Breaking Changes

Sitecore Commerce 8.2.1 Initial Release (January 2107)

1. What's New

The Sitecore Commerce 8.2.1 software includes a combination of new components and updated versions of components from the previous Sitecore Commerce 8.2 release.

Sitecore Commerce Engine

A completely new, extensible commerce core framework built as a thin ASP.NET Core application, which enables higher level functionality implemented through using NuGet based plugins. The new Commerce Engine provides a new framework for Cart, Order, and Pricing & Promotions services.

Commerce Server

Release 8.2.1 is the initial release towards completely replacing the legacy Sitecore Commerce Server technology. This release continues to include Commerce Server for a portion of its services. The new Commerce Engine replaces the following Commerce Server subsystems:

  • Orders
  • Marketing

Release 8.2.1 continues to use the following existing Commerce Server services, which will be replaced in a future release:

  • Catalog
  • Inventory
  • Profile


The Connect components serve together as an integration layer between the Commerce Engine and the Sitecore Experience Platform (Sitecore XP), and between the Commerce Engine and the Reference Storefront. A new Connect component has been introduced as an added thin layer that connects to the Commerce Engine:

  • Sitecore Commerce Engine Connect

The following existing components have evolved from the previous release:

  • Sitecore Commerce Connect
  • Sitecore Commerce Server Connect

Business Tools

Release 8.2.1 introduces a combination of new and evolved business tools used by merchandisers, marketers, procurement, and customer support personnel. These tools are tightly integrated with the new Commerce Engine. Two new business tools are introduced:

  • Customer and Order Manager. This replaces the previous Order Manager and Profile Manager.
  • Pricing and Promotions Manager. This replaces the previous Marketing Manager, and adds management of pricing.

The following existing tool has been evolved to function with the new Commerce Engine:

  • Merchandising Manager

Reference Storefront

Release 8.2.1 deploys with a new Reference Storefront sample site that integrates with the new Commerce Engine. This Storefront includes a new product catalog dataset populated with sample electronics data.

The following diagram shows a simplified logical view of these components, and the Sitecore Experience Platform.

Sitecore Commerce Release Package

Release 8.2.1 introduces a simplified software download from dev.sitecore.net. The required Sitecore Commerce components are included in a single zip file "release package": SitecoreCommerce8.2.1_1.0.xx.zip. When preparing for deployment of Sitecore Commerce, the 'dotnet restore' step will automatically retrieve the required nupkg files from the Sitecore Commerce NuGet repository.

The main components of the release package include:

Table 1.
Area Component
New Commerce Engine Sitecore.Commerce.SDK.1.0.2301.zip
Legacy Commerce CommerceServer-11.4.148.exe
Connectors Sitecore Commerce Connect 10.0.174.zip
  Sitecore Commerce Server Connect.10.0.70.update
Business Tools Sitecore Commerce Business Tools Shared.1.0.100.update
  Sitecore Commerce Customer and Order Manager.1.0.51.update
  Sitecore Commerce Pricing and Promotion Manager.1.0.75.update
  Sitecore Commerce Merchandising Manager.10.0.294.update
Reference Storefront Sitecore.Reference.Storefront.Common.10.0.853.update

Accordingly, this product release has three levels of versioning:

  • Product market version – Sitecore Commerce 8.2.1, signifying alignment with Sitecore XP 8.2 and not 8.3.
  • Release package version – SitecoreCommerce8.2.1_1.0.xx.zip, augmenting with each internal or external release package build, following semantic versioning.
  • Components' version – new components introduced in this release have a 1.0.x FileVersion; existing release components updated since release 8.2 have FileVersion equal to 10.0.x.

In addition to the Reference Storefront binaries in the release package, the Reference Storefront source code is available on GitHub.

2. Compatibility

Sitecore Commerce 8.2.1 represents a new product in the overall Sitecore Commerce product lineup. This release does not include updates to other Commerce products. Refer to dev.sitecore.net for the latest releases of the other Commerce products, The relationship between this release and other Commerce products includes:

  • Sitecore Commerce powered by Commerce Server (SCpbCS) – existing SCpbCS customers are entitled to deploy the new Sitecore Commerce 8.2.1 release, although there is no direct upgrade path to it.
  • Sitecore Commerce powered by Microsoft Dynamics – no upgrade path to Sitecore Commerce 8.2.1.
  • Sitecore Commerce Connect – a new version of this software is included as a Sitecore Commerce 8.2.1 component, but this new version is not released as a stand-alone module.
  • Commerce Server – version 11.4 is included as a Sitecore Commerce 8.2.1 component. It is the same version as in the Commerce 8.2 product lineup.

The dependent Sitecore Experience Platform 8.2 Update-1 software is not included in the Sitecore Commerce 8.2.1 release package. It can be retrieved from dev.sitecore.net.

Sitecore Commerce 8.2.1 components, including new and updated packages, will not work with Sitecore Commerce 8.2 products.

3. Resolved Issues

Not applicable for this initial release of the new Sitecore Commerce product.

4. Known Issues

Sitecore Commerce 8.2.1 does not yet fully support deployment in a Microsoft Azure Web Application.

5. Breaking Changes

None – not applicable for this initial release of the new Sitecore Commerce product.