K Khan
May 15, 2015
visibility 3876
star star star star star
(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.

error Please login to comment.
Latest blogs
Fixing index_not_found_exception After Purging External Data in Optimizely Graph

The Scenario: Indexing External Data When working with Optimizely Content Graph, indexing external data is a straightforward process. Synchronize...

Akash Borkar | Jul 16, 2026

Finding Thomas Part 4 - The Intelligence Layer

I've been finding Thomas for a couple weeks now. Bear with me — we're almost at the full picture. Quick catch-up : Thomas is the returning visitor...

Ritu Madan | Jul 14, 2026

The Silent Success: When Your Optimizely SaaS CMS Config Push Succeeds with "0" Changes

  Picture this frustratingly common scenario in headless, code-first development with Optimizely SaaS CMS: You’ve defined a brilliant new element,...

Vipin Banka | Jul 13, 2026

Architecting an Enterprise-Grade Development Pipeline in Optimizely SaaS CMS

Most enterprise teams show up to Optimizely SaaS CMS with a clear roadmap for their release pipeline: DEV → QA → Stage → Prod. Four logical...

Vipin Banka | Jul 12, 2026