November Happy Hour will be moved to Thursday December 5th.

Quan Mai
Feb 27, 2019
  4291
(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 SaaS CMS DAM Picker (Interim)

Simplify your Optimizely SaaS CMS workflow with the Interim DAM Picker Chrome extension. Seamlessly integrate your DAM system, streamlining asset...

Andy Blyth | Nov 21, 2024 | Syndicated blog

Optimizely CMS Roadmap

Explore Optimizely CMS's latest roadmap, packed with developer-focused updates. From SaaS speed to Visual Builder enhancements, developer tooling...

Andy Blyth | Nov 21, 2024 | Syndicated blog

Set Default Culture in Optimizely CMS 12

Take control over culture-specific operations like date and time formatting.

Tomas Hensrud Gulla | Nov 15, 2024 | Syndicated blog

I'm running Optimizely CMS on .NET 9!

It works 🎉

Tomas Hensrud Gulla | Nov 12, 2024 | Syndicated blog