Sitecore Commerce Engine SDK

The Sitecore Experience Commerce release package (for on-premise solutions) includes the Sitecore.Commerce.Engine.SDK, the Sitecore Commerce Engine software development kit (SDK). The SDK contains artifacts that play a key role during the initial deployment of the Sitecore XC solution. The Sitecore.Commerce.Engine.SDK also contains sample source code, libraries and sample projects to help you get started with your Commerce customization or integration projects.

You use the Sitecore.Commerce.Engine.SDK to:

The Sitecore.Commerce.Engine.SDK contains the following folders and files:

Folder or file name

Description

copyrights

A folder that contains third-party copyright information.

packages

A folder that contains packages used for solution deployment.

postman

A folder that contains API samples collection to use with Postman.

scripts

A folder that contains various scripts used during solution deployment.

src

A source folder that contains the solution projects (detail of content is described in the next table.

Yeoman Generator

A folder that contains Yeoman scaffolding for web application project generation.

Customer.Sample.Solution.sln

A Visual Studio solution file that allows you to load all sample Commerce Engine plugins provided with the SDK.

nuget.config

An .XML file that contains settings to control NuGet behavior.

Sitecore.Commerce.Engine.DB.dacpac

A file that contains Commerce database models.

Sitecore.Commerce.Plugin.vsix

Visual Studio extensions for the Commerce Engine SDK.

Sitecore.Commerce.Sample.Console.sln

A solution file for a console application that provides fully functional Commerce scenario examples.

Sitecore.Experience.Commerce.SDK.Documentation.chm

A compiled HTML help file that contains a reflection of the Commerce Engine objects (based on the Customer.Sample.Solution).

The source code folder (src) contains the following Visual Studio projects and sample plugins, to help you get started with your Commerce development and customization initiatives:

Folder name

Description

Engine.Configs.Cloud

Configuration files for deploying to the cloud.

Engine.Configs.OnPrem

Configuration files for deploying on-premise.

Plugin.Sample.AdventureWorks

Project to generate default data for the Adventure Works catalog during the environment initialization.

Plugin.Sample.Habitat

Project to generate default data for the Habitat catalog during the environment initialization.

Plugin.Sample.Payments.Braintree

Project to build an integration with Braintree payment provider for payment processing.

Sitecore.Commerce.Engine

Reference project for the Commerce Engine.

Sitecore.Commerce.Sample.Console

Project to run the Commerce sample console application.

Sitecore.Commerce.ServiceProxy

The service proxy is a .NET class that defines methods for accessing the Engine OData service endpoints. The proxy translates method calls into HTTP requests.

WebDeployUpdates

Contains configuration and extensibility points for creating custom Web Deploy Packages.

Shared

Sitecore branding and versioning information.