Quan Mai
Feb 27, 2019
  5206
(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
Catalog Traversal in Action. Part 2: Real-World Scheduled Job Patterns

In my previous post, I showed how to build a memory-efficient catalog traversal service for Optimizely Commerce. The service uses streaming to...

Stanisław Szołkowski | Feb 24, 2026 |

Resource Editor - A localization management tool for Optimizely CMS

If you have worked with Optimizely CMS for any amount of time you know that managing localization through XML files can be tedious. Content type...

Per Nergård (MVP) | Feb 23, 2026

Storing JSON in a property the efficient way

Here is a little-known trick to store and retrieve JSON property data more efficiently.

Stefan Holm Olsen | Feb 23, 2026 |

Development Agent V2: From Element Tweaks to Full Page Experiences

The Development Agent in Web Experimentation just got a major upgrade - moving from single-element edits to page-level changes with design system...

Hristo Bakalov | Feb 23, 2026 |