Try our conversational search powered by Generative AI!

Quan Mai
Feb 27, 2019
  3958
(6 votes)

New feature in Commerce 13: Extendable OrderStatus and OrderShipmentStatus

We have been asked for quite something on how to extend OrderStatus and OrderShipmentStatus. The problem is, we can't, because they are two enums, and C#/.NET does not allow you to extend enums in any way.

However, that is going to change in Commerce 13. OrderStatus and OrderShipmentStatus are now classes, and you add new instances to the system. For example, if you want to add a new status of "InDispute", you can do like this in one of your initialization modules:

            OrderStatus.RegisterStatus(new OrderStatus(128, "InDispute"));

It's important to have this code in both your CMS and Commerce Manager sites.

New statuses will be available for filter and search in Commerce Manager (of course, you can now set an order status to that new value)

You might notice that the new status is not "localized". If you want it to display nicer, just add a new translation to App_GlobalResources\SharedStrings.resx

  <data name="OrderStatus_InDispute" xml:space="preserve">
    <value>In Dispute</value>
  </data>

Note that, this is a breaking change. As OrderStatus and OrderShipmentStatus are no longer enums, they can no longer be used in bitwise operations. If you were using some bitwise operations for comparison, for example 

status & OrderStatus.InProgress == status 

You would have to change it to 

status == OrderStatus.InProgress

Commerce 13 is a few weeks away.

Feb 27, 2019

Comments

Vincent
Vincent Feb 27, 2019 09:29 PM

Very helpful feature. I always “complain” c# enum design when I moved from java to .net. :p

Menno Zeilstra
Menno Zeilstra Mar 10, 2022 04:32 PM

I added a Queued Status, and added the Localization to the sharedstrings, somehow the Status remains blank when opening the details  (clicking in the Id Column)

Please login to comment.
Latest blogs
Optimizely and the never-ending story of the missing globe!

I've worked with Optimizely CMS for 14 years, and there are two things I'm obsessed with: Link validation and the globe that keeps disappearing on...

Tomas Hensrud Gulla | Apr 18, 2024 | Syndicated blog

Visitor Groups Usage Report For Optimizely CMS 12

This add-on offers detailed information on how visitor groups are used and how effective they are within Optimizely CMS. Editors can monitor and...

Adnan Zameer | Apr 18, 2024 | Syndicated blog

Azure AI Language – Abstractive Summarisation in Optimizely CMS

In this article, I show how the abstraction summarisation feature provided by the Azure AI Language platform, can be used within Optimizely CMS to...

Anil Patel | Apr 18, 2024 | Syndicated blog

Fix your Search & Navigation (Find) indexing job, please

Once upon a time, a colleague asked me to look into a customer database with weird spikes in database log usage. (You might start to wonder why I a...

Quan Mai | Apr 17, 2024 | Syndicated blog