Upgrading Umbraco Commerce

This article shows how to manually upgrade Umbraco Commerce to run the latest version. When upgrading Umbraco Commerce, be sure to also consult the version specific upgrade notes to learn about potential breaking changes and common pitfalls.

Before upgrading, it is always advisable to take a complete backup of your site and database.

Get the latest version of Umbraco Commerce

To get the latest version of Umbraco Commerce you can upgrade using:

  • NuGet

  • Visual Studio

NuGet

  • NuGet installs the latest version of the package when you use the dotnet add package Umbraco.Commerce command unless you specify a package version: dotnet add package Umbraco.Commerce --version <VERSION>

  • After you have added a package reference to your project by executing the dotnet add package Umbraco.Commerce command in the directory that contains your project file, run dotnet restore to install the package.

Visual Studio

  1. Go to Tools -> NuGet Package Manager -> Manage NuGet Packages for Solution... in Visual Studio, to upgrade Umbraco Commerce:

  2. Select Umbraco.Commerce.

  3. Select the latest version from the Version drop-down and click Install.

  4. When the command completes, open the .csproj file to make sure the package reference is updated:

<ItemGroup>
  <PackageReference Include="Umbraco.Commerce" Version="xx.x.x" />
</ItemGroup>

If you are using one or more of the below sub-packages, they also need to be upgraded as well:

Sub-package
Description

Umbraco.Commerce.Common

A shared project of common, non-Commerce-specific patterns and helpers.

Umbraco.Commerce.Core

Core Commerce functionality that doesn't require any infrastructure-specific dependencies.

Umbraco.Commerce.Infrastructure

Infrastructure-specific project containing implementations of core Commerce functionality.

Umbraco.Commerce.Persistence.SqlServer

Persistence-specific project containing implementations of core Commerce persistence functionality for SQL Server.

Umbraco.Commerce.Persistence.Sqllite

Persistence-specific project containing implementations of core Commerce persistence functionality for SQLite.

Umbraco.Commerce.Web

Core Commerce functionality that requires a web context.

Umbraco.Commerce.Cms

Core Commerce functionality that requires an Umbraco dependency.

Umbraco.Commerce.Cms.Web

The Commerce functionality for the Umbraco presentation layer.

Umbraco.Commerce.Cms.Web.Api

A shared project of common API specific functionality.

Umbraco.Commerce.Cms.Web.Api.Management

The backoffice Management API layer.

Umbraco.Commerce.Cms.Web.Api.Payment

The Payment handling API layer.

Umbraco.Commerce.Cms.Web.Api.Storefront

The frontend Storefront API layer.

Umbraco.Commerce.Cms.Web.UI

The static Commerce assets for the Umbraco presentation layer.

Umbraco.Commerce.Cms.Startup

The Commerce functionality for registering Commerce with Umbraco.

Umbraco.Commerce

The main Commerce package entry point package.

Last updated