SaaS CMS has officially launched! Learn more now.

Drew Null
Feb 6, 2022
  2223
(0 votes)

Product and category URLs without the catalog slug in Commerce 14 (.NET 5)

This one stumped me the other day, and I couldn't find anything by doing a web or World search.

Problem: How do we exclude the catalog route segment from the URLs of categories and products?

Say you have the following catalog structure:

Catalog Root
    My Catalog // CatalogContent
        My Category // NodeContent
            My Product // ProductContent
                My Variant // VariationContent

By default, the URL to My Variant will look like this:

/my-catalog/my-category/my-variant

But /my-catalog won't resolve to an actual page, so we want to remove it from the URL. Which would render like this:

/my-category/my-variant

Much better. But how do we do this in Commerce 14?

Prior to Commerce 14, this could be done using System.Web.Mvc's RouteTable. But that was killed off in ASP.NET Core, so we need another way.

PartialRouteHandler to the rescue.

This is pretty simple: Create an initialization module and use PartialRouteHandler to register a PageData-to-CatalogContentBase partial router. No custom implementation needed.

Note that how you, say, resolve a catalog to a site, could vary based on the needs of your project. In the example below, we resolve all catalogs to all sites.

using EPiServer;
using EPiServer.Commerce.Catalog.ContentTypes;
using EPiServer.Core;
using EPiServer.Core.Routing;
using EPiServer.Framework;
using EPiServer.Framework.Initialization;
using EPiServer.ServiceLocation;
using Mediachase.Commerce.Catalog;

[InitializableModule]
[ModuleDependency(typeof(EPiServer.Web.InitializationModule))]
[ModuleDependency(typeof(EPiServer.Commerce.Initialization.InitializationModule))]
public class CustomHierarchicalCatalogPartialRouterInitialization : IInitializableModule
{
    public void Initialize(InitializationEngine context)
    {
        /* MapDefaultHierarchialRouter [sic] is no longer needed... */
        ////CatalogRouteHelper.MapDefaultHierarchialRouter(false);
        var referenceConverter = ServiceLocator.Current.GetInstance<ReferenceConverter>();
        var contentLoader = ServiceLocator.Current.GetInstance<IContentLoader>();
        var partialRouteHandler = ServiceLocator.Current.GetInstance<PartialRouteHandler>();
        var catalogs = contentLoader.GetChildren<CatalogContentBase>(referenceConverter.GetRootLink());
        foreach (var catalog in catalogs)
        {
            // This implementation will register all catalogs for all sites; if you want it to work differently, do so here--
            partialRouteHandler.RegisterPartialRouter(
                new PartialRouter<PageData, CatalogContentBase>(
                    new HierarchicalCatalogPartialRouter(() => ContentReference.StartPage, catalog, false)));
        }
    }

    public void Uninitialize(InitializationEngine context)
    {
    }
}

And that's it.

Your category, product, and variant pages (and bundles/packages) should resolve without including the catalog slug in the URL. And UrlResolver should now give you the catalog-less URL on the frontend and in the CMS backoffice.

Feb 06, 2022

Comments

Please login to comment.
Latest blogs
Optimizely SaaS CMS Concepts and Terminologies

Whether you're a new user of Optimizely CMS or a veteran who have been through the evolution of it, the SaaS CMS is bringing some new concepts and...

Patrick Lam | Jul 15, 2024

How to have a link plugin with extra link id attribute in TinyMce

Introduce Optimizely CMS Editing is using TinyMce for editing rich-text content. We need to use this control a lot in CMS site for kind of WYSWYG...

Binh Nguyen Thi | Jul 13, 2024

Create your first demo site with Optimizely SaaS/Visual Builder

Hello everyone, We are very excited about the launch of our SaaS CMS and the new Visual Builder that comes with it. Since it is the first time you'...

Patrick Lam | Jul 11, 2024

Integrate a CMP workflow step with CMS

As you might know Optimizely has an integration where you can create and edit pages in the CMS directly from the CMP. One of the benefits of this i...

Marcus Hoffmann | Jul 10, 2024