HowTo - Display custom names for order item states on the Storefront

Edit on GitHub

For the order items states on the Storefront, it is not always appropriate to display the states as they are in the state machine, as they do not make much sense for Buyers. For example, for the OMS confirmed state, you might want to display this sate as, for example, waiting for shipment for the Storefront users.

To display custom order states on the Storefront, do the following:

  1. In your project, go to /config/Zed/oms and open the .XML file of the payment method or sub-process you want to change the order states on the Storefront for. For example, let’s take the default Spryker DummyPayment01.xml.

  2. Specify the display value of the necessary state, as you want it on the Storefront. In the example below, we have set the display value of the confirmed OMS sate to waiting for shipment:


?xml version="1.0"?>

    <process name="DummyPayment01" main="true">

        <state name="confirmed" reserved="true" display="waiting for shipment">

It is possible to have the same display values for different OMS states.

  1. Go to Back Office > Glossary.

  2. In the List of translations table, the Name column, find the state name as you specified it for the display parameter. For our example, it is waiting for shipment.

  3. Provide the new glossary keys, that is, translations of the state:

    1. Click Edit in the Actions column. You are taken to the Edit translation page.
    2. Enter translations for the available locales and click Save. You are taken to the Overview of Translation page where you can see the translations of the order state for the Storefront.

That’s it! Now, on the Order Overview and Order History pages on the Storefront, customers see the states that correspond to the values of the display parameter you set in .XML files of the respective payment methods and sub-processes.


If you delete the display parameter with its value, the OMS state, that is, the one specified in the state name parameter, is displayed on the Storefront.