| page_type | languages | products | name | description | |||
|---|---|---|---|---|---|---|---|
sample |
|
|
Extend Headless Commerce APIs. |
This repo contains the sample code on how to extend the Dynamics 365 Headless Commerce engine - APIs, Commerce runtime and Database. |
This readme file explains how to run the Headless Commerce extension samples and consume the reference package from the public feed for Dynamics 365 Commerce extension development.
This repo contains code samples, templates, and tools that are required to extend or customize existing Commerce functionality, samples are published into different repos in GitHub based on the Commerce extension components. This topic applies to Dynamics 365 commerce application version 10.0.16 or greater. For earlier version refer this doc.
This repo contains the sample code for how to customize the Commerce runtime (CRT), Headless Commerce APIs and channel database.
The samples in the repo are organized by Dynamics 365 Commerce application release, each branch in the repo points to an application release of Dynamics 365 Commerce, use the right release branch based on your go-live version.
Note: The repo contains only samples, so its not required to clone this repo.
| Release branch name | version | Application release version |
|---|---|---|
| Release/9.44 | 9.44.* | 10.0.34 |
| Release/9.45 | 9.45.* | 10.0.35 |
| Release/9.46 | 9.46.* | 10.0.36 |
| Release/9.47 | 9.47.* | 10.0.37 |
| Release/9.48 | 9.48.* | 10.0.38 |
Extension repository:
Extension code or repository if required can download and consume the samples and templates from microsoft/Dynamics365Commerce.ScaleUnit, the sample scale unit repo contains nuget.config, repo.props, CustomizationPackage.props and build pipelines script which provide guidance on how extension can setup the repo metadata files.
| Folder | Project | Description |
|---|---|---|
| Channel Database | ChannelDatabase.csproj | This project contains samples on how to create Commerce Runtime database extensions. |
| CommerceRuntime | CommerceRuntime.csproj | Controller – Sample code for how to implement new RS APIs.Entities, Messages and RequestHandlers – Sample code for how to implement new CRT service. |
| ScaleUnit | ScaleUnit.csproj | Sample project on how to generate the CSU |
| ScaleUnit.Installer | ScaleUnit.csproj | Sample project on how to generate the CSU installer. |
| POS | POS.csproj | Contains samples on how to create POS extensions. |
| TypeScriptProxyGenerator | TypeScriptProxyGenerator.csproj | Contains a sample on how to generate typescript extension proxies for Commerce Applications. |
| CSharpProxyGenerator | CSharpProxyGenerator.csproj | Contains a sample on how to generate C# extension proxies for Commerce Applications. |
Samples for instore components like Modern POS, Cloud POS, Hardware station and Cloud scale unit – Self hosted are published in the Dynamics365Commerce.InStore repo.
Readme file inside the Commerce Runtime, ChannelDatabase and ScaleUnit contain more details on how to run the samples. Analyzers readme at the root of the repo describes all the Commerce and standard .NET code analysis rules enabled for extension projects.
If you don't need POS or other samples from the repo, exclude the corresponding projects from the solution.
Download reference packages for creating Commerce extension APIs and consuming messages, request, entities, and contracts:
Commerce contracts, messages, entities, and request packages are published in this public feedfor commerce extension code to consume and customize existing functionalities or build new functionalities for Dynamics 365 Commerce product.
Consume the commerce packages from this location, extension can add package source location in the nuget.config of their extension project file.
<packageSources>
<add key="dynamics365-commerce" value="https://pkgs.dev.azure.com/commerce-partner/Registry/_packaging/dynamics365-commerce/nuget/v3/index.json" />
<add key="nuget.org" value="https://api.nuget.org/v3/index.json" />
</packageSources>Commerce packages available in the public feed:
| Package name | Description |
|---|---|
| Microsoft.Dynamics.Commerce.Sdk.ChannelDatabase | This package is required to generate the DB packages with CSU. |
| Microsoft.Dynamics.Commerce.Sdk.Runtime | This package contains all commerce runtime libraries |
| Microsoft.Dynamics.Commerce.Sdk.ScaleUnit | This package is required to generate the CSU package for deployment. |
| Microsoft.Dynamics.Commerce.Sdk.Installers.ScaleUnit | This package is required to generate the ScaleUnit package for deployment |
| Microsoft.Dynamics.Commerce.Sdk.HardwareAndPeripherals | This package contains all commerce Hardware station and peripherals libraries |
| Microsoft.Dynamics.Commerce.Sdk.Installers | This package contains all the installers libraries |
| Microsoft.Dynamics.Commerce.Sdk.Installers.HardwareStation | This package is required to generate the Hardware station package for deployment |
| Microsoft.Dynamics.Commerce.Sdk.Pos | This package contains all POS libraries |
| Microsoft.Dynamics.Commerce.Sdk.Installers.ModernPos | This package is required to generate the POS extension installer for deployment |
| Microsoft.Dynamics.Commerce.Diagnostics | This package contains all the diagnostic libraries |
| Microsoft.Dynamics.Commerce.Runtime.Data | This package contains all data contract libraries |
| Microsoft.Dynamics.Commerce.Runtime.DataServices.Messages | This package contains all data services message libraries |
| Microsoft.Dynamics.Commerce.Runtime.Entities | This package contains all commerce entities definition |
| Microsoft.Dynamics.Commerce.Runtime.Framework | This package contains all commerce framework libraries |
| Microsoft.Dynamics.Commerce.Runtime.Hosting.Contracts | This package contains all commerce controller libraries |
| Microsoft.Dynamics.Commerce.Runtime.Messages | This package contains all commerce runtime messages libraries |
| Microsoft.Dynamics.Commerce.Runtime.RealtimeServices.Messages | This package contains all the commerce real runtime libraries |
| Microsoft.Dynamics.Commerce.Runtime.Services.Messages | This package contains all the commerce service messages libraries |
| Microsoft.Dynamics.Commerce.Runtime.Services.PricingEngine.Contracts | This package contains all the Commerce Pricing Engine contracts |
| Microsoft.Dynamics.Commerce.HardwareStation.Core | This package contains all the HWS libraries |
| Microsoft.Dynamics.Commerce.HardwareStation.PeripheralRequests | This package contains all the HWS peripherals request libraries |
| Microsoft.Dynamics.Commerce.HardwareStation.Peripherals.Contracts | This package contains all the HWS peripherals contracts libraries |
| Microsoft.Dynamics.Commerce.HardwareStation.Peripherals.Entities | This package contains all the HWS peripherals entities libraries |
| Microsoft.Dynamics.Commerce.Installers.Framework | This package contains all the installers framework libraries |
| Microsoft.Dynamics.Commerce.KeyVault.Contracts | This package contains all the key vault contract libraries |
| Microsoft.Dynamics.Commerce.PaymentSDK.Extensions.Portable | This package contains all the payment extension libraries |
| Microsoft.Dynamics.Commerce.PaymentSDK.Portable | This package contains all the payment libraries |
| Microsoft.Dynamics.Commerce.Runtime.FIF.Connector.Messages | This package contains all the FIF connector libraries |
| Microsoft.Dynamics.Commerce.Runtime.FIF.DocumentProvider.Messages | This package contains all the FIF document provider libraries |
| Microsoft.Dynamics.Commerce.Installers.Framework.DatabaseExtensions | This package contains all the database installer framework libraries |
| Microsoft.Dynamics.Commerce.Tools.DbUtilities | This package contains all the DB utilities libraries |
| Microsoft.Dynamics.Commerce.Tools.ExtensionsProxyGenerator.AspNetCore | This package contains all the extensions proxy generator utilities |
| Microsoft.Dynamics.Commerce.Proxy.ScaleUnit | This package contains all the proxies class for extension applications to consume the Headless Commerce APIs in online mode (connected to Headless Commerce). |
Package versioning:
| Package version | Application release |
|---|---|
| 9.44.x.x-preview | 10.0.34 PEAP release |
| 9.44.x.x | 10.0.34 Customer preview |
| 9.44.x.x | 10.0.34 GA |
| 9.45.x.x-preview | 10.0.35 PEAP release |
| 9.45.x.x | 10.0.35 Customer preview |
| 9.45.x.x | 10.0.35 GA |
| 9.46.x.x-preview | 10.0.36 PEAP release |
| 9.46.x.x | 10.0.36 Customer preview |
| 9.46.x.x | 10.0.36 GA |
| 9.47.x.x-preview | 10.0.37 PEAP release |
| 9.47.x.x | 10.0.37 Customer preview |
| 9.47.x.x | 10.0.37 GA |
| 9.48.x.x-preview | 10.0.38 PEAP release |
| 9.48.x.x | 10.0.38 Customer preview |
| 9.48.x.x | 10.0.38 GA |
Extension project can consume the correct version by adding the package reference to the project with full version number or use wild card to always get the latest version, recommend option is to use the full version number and update the version based on your go-live version.
<PackageReference Include="Microsoft.Dynamics.Commerce.Sdk.Runtime" Version="9.48.x.x" />Or
<PackageReference Include="Microsoft.Dynamics.Commerce.Sdk.Runtime" Version="9.48.*" />Or
// Available in Visual Studio version 16.6, NuGet version 5.6, .NET Core SDK version 3.1.300
<PackageReference Include="Microsoft.Dynamics.Commerce.Sdk.Runtime" Version="9.48.*-*" />With every hotfix and new application release, new version of the package will be published in the same public feed, consume the right package version based on the version required for your go-live. Consuming the higher version of the package than your go-live application version may result in runtime and deployment failures.
Setup Azure DevOps pipeline for build automation and package generation:
Set up a build pipeline for the independent-packaging SDK
Best practice and branching strategies:
Detailed information on git branching strategy refer Git branching strategy doc.
The following branching strategies are based on the way we use Git here at Microsoft. For more information, see How we use Git at Microsoft.
Keep your branch strategy simple. Build your strategy from these three concepts:
- Use feature branches for all new features and bug fixes.
- Merge feature branches into the main branch using pull requests.
- Keep a high quality, up-to-date main branch.
Create a new feature branch for development and bug fixes:
Create a new feature main branch for our extension, follow the proper naming convention (refer the Git branching doc for sample naming convention)
Create a new development branch:
Create a private branch for the development:
- git checkout -b private/{username}/{feature/description}
Add and commit new changes to the development branch using git -add . and git commit -m" commit message."
After the development is completed, tested, and validated push the changes to the main branch by doing git push <remote> <branch>
- git push origin {private branch name}
Create a release branch after development:
After the development changes pushed into the main branch, create a new release branch, and create the deployable packages from the release branch.
- git checkout -b release/x.x.x
Merge the changes from the release branch back to main branch if any changes done in the release branch.
- git checkout master git merge release/x.x.x
Extension hotfix branch:
Like release branch, create hotfix branch for extension from main branch and release the fix and later merge the changes back to the main branch.
Merge new release branch to main and development branch:
After a new version of the samples released, if required merge your development branch with the new branch. The repo contains only samples, so it's not required to always get the updated changes from the branch.
- git checkout master git merge release/x.x.x