K Khan
May 15, 2015
  3780
(0 votes)

Hook into commerce catalog events

"The possibilities for integrating EPiServer with other systems are virtually unlimited". A customer requires all the changes of EPiServer Commerce Products done by CMS Editors in Online Centre’s catalog UI, back into their fulfilment system. EPiServer provides a number of features to facilitate Integration with outer systems.  I will use .NET API’s catalog events to react changes to catalog items. This can be achieved by adding handlers for IContentEvents, CatalogEventHandler, CatalogEventBroadcaster or can create own implementation of CatalogEventListenerBase and hook the events such as EntryUpdating or EntryUpdated. 


IContentEvents: Events will not be raised when a catalog item is updated through Commerce Manager or in Integration Application using ICatalogSystem.
CatalogEventHandler: Events will not be raised when changes done directly through ICatalogSystem only.
CatalogEventBroadcaster: Events will be raised when changes are done through ICatalogSystem, including changes made through the Content API's.
(IContentEvents are in my scope)

We can register events in our Commerce Initialization module, e.g.

[InitializableModule, ModuleDependency(typeof(EPiServer.Commerce.Initialization.InitializationModule))]
    public class CommerceInitialization : IConfigurableModule
    {
///
        public void Initialize(InitializationEngine context)
        {
              var contenEventHandler = EPiServer.ServiceLocation.ServiceLocator.Current.GetInstance<EPiServer.Core.IContentEvents>();
            contenEventHandler.PublishedContent += this.ContenEventPublishedContent;
        }

///
    }

I am using ValueInjector (convention based mapper) to map Product meta class with OdooProduct.

private void ContenEventPublishedContent(object sender, ContentEventArgs e)
        {
            var product = e.Content as XYZ.BusinessModel.Models.MetaData.FashionProduct;
            if (product != null)
            {
                log4net.LogManager.GetLogger("EntryUpdate").Error(product.AgeFromInYears);
                //used value injector
                var odooProduct = 
                Mapper.AddMap<XYZ.BusinessModel.Models.MetaData.FashionProduct, OdooProduct>(src =>
                {
                    var res = new OdooProduct();
                    res.InjectFrom(src); // maps properties with same name and type
                    res.Name = src.DisplayName;
                    res.AgeFrom = src.AgeFromInYears;
                    return res;
                });
                // Update product details on fulfillment center
                fulfilmentService.UpdateProduct(odooProduct);
            }            
        }

and That's It.

May 15, 2015

Comments

valdis
valdis May 16, 2015 10:21 AM

I'm considering to expose Commerce events down to client-side through SignalR. Is that something useful? Would client be interested in catalog changes happening on the server?

May 17, 2015 07:10 PM

Bundle of thanks Champ for pointing out this extension point, I confess, I haven’t consider SignalR while writing this Blog. Anyway it isn’t in scope of work as they are not exposing their catalog/events to any client and these weren’t high frequency changes. We need to inform changes of few fields to an already working web service on a third party system only.

K Khan
K Khan May 17, 2015 07:13 PM

I have just noticed comments can be added as guest also :) , I own above comments.

Please login to comment.
Latest blogs
Announcing new library: SettingsManager

When you run .net app, there have been a few ways to store settings. Those can be set via appSettings.json, or via Azure Portal AppService...

Quan Mai | Apr 30, 2026

From Prompting to Production: Optimizely Opal University Cohort and the Future of Agentic MarTech

Most organizations today are still playing with AI. They experiment with prompts, test ideas in isolated chats, and occasionally automate a task or...

Augusto Davalos | Apr 28, 2026

Six Compelling Reasons for Upgrading to CMS 13

Most software updates ask you to keep up. Optimizely CMS 13 asks something different — it asks whether your digital strategy is built for a world...

Muhammad Talha | Apr 28, 2026

Optimizely CMS 13 breaking changes: GetContentTypePropertyDisplayName

When upgrading from CMS 12 to 13, resolving property display names may not work as before. Here’s what changed.

Tomas Hensrud Gulla | Apr 27, 2026 |

Accelerate Optimizely DAM Adoption: Unlocking Business Value with Metadata Bulk Import

Accelerating Optimizely DAM Adoption How a Metadata-Driven Bulk Import Utility Unlocks Real Business Value Executive Summary For enterprises runnin...

Vaibhav | Apr 27, 2026

Optimizely CMS 13 breaking changes: IValidate<T>

Custom IValidate validators in Optimizely CMS 13 are no longer auto-discovered. They must be registered explicitly when upgrading from CMS 12.

Tomas Hensrud Gulla | Apr 27, 2026 |