Drew Null
Feb 6, 2022
  2420
(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
Copy Optimizely SaaS CMS Settings to ENV Format Via Bookmarklet

Do you work with multiple Optimizely SaaS CMS instances? Use a bookmarklet to automatically copy them to your clipboard, ready to paste into your e...

Daniel Isaacs | Dec 22, 2024 | Syndicated blog

Increase timeout for long running SQL queries using SQL addon

Learn how to increase the timeout for long running SQL queries using the SQL addon.

Tomas Hensrud Gulla | Dec 20, 2024 | Syndicated blog

Overriding the help text for the Name property in Optimizely CMS

I recently received a question about how to override the Help text for the built-in Name property in Optimizely CMS, so I decided to document my...

Tomas Hensrud Gulla | Dec 20, 2024 | Syndicated blog

Resize Images on the Fly with Optimizely DXP's New CDN Feature

With the latest release, you can now resize images on demand using the Content Delivery Network (CDN). This means no more storing multiple versions...

Satata Satez | Dec 19, 2024