A Simple Plugin Example

The latest version of Sitecore Commerce was released back in January, with version 8.2.1. An update to that release is expected soon, but I thought I’d discuss some of the new capability around the plugin architecture.

We wanted to make the process of adding your own custom business logic as easy as possible. Obviously, this is something that a developer is often required to do in an implementation. No solution is perfect out of the box.

Actually, the entire Commerce engine is based on plugins so a customer can chose which modules they require for their implementation. It’s called opt-in complexity and provides quite a bit more deployment flexibility.

If you download the Release Package, an SDK is also provided which contains a customer sample solution. The solution contains a couple of existing plugins, and a Visual Studio project template for building your own.

Shared Cart Plugin

I wanted to create a simple plugin, just to show how it’s done. The requirement is to be able to share a shopping cart across multiple sites, but the CSR and fulfillment process needs to know what store the product was purchased from. Here’s what I did:

When the product is added to the basket, I check the current context and add the current shop name to the new component:

//Get shopname from context
var shopname = context.CommerceContext.GetObjects<Shop>().FirstOrDefault().Name;

//Add component to CartlineComponent
arg.GetComponent<SharedCartLineComponent>().ShopName = shopname;

Now I need to display this value in the Customer & Orders Manager when a CSR looks at the line item details

if (line.HasComponent<SharedCartLineComponent>())
var sharedCartLineComponent = line.GetComponent<SharedCartLineComponent>();
//Add shop name property to the line item view
lineEntityView.Properties.Add(new ViewProperty { Name = "ShopName", DisplayName = "Store", IsReadOnly = true, RawValue = sharedCartLineComponent.ShopName });

Be sure to check out the full code example on GitHub, specifically ConfigureSitecore.cs. This is where your plugin functionality gets injected into the Commerce Engine.

Documentation on plugins is a work in progres, but in the meantime, the samples in the SDK (and this one) will definitely give you an idea of how it’s done.

Cross posted on my Sitecore Blog, The Commerce Experience