Adding custom order statuses to the filter criteria
You can add a custom status to the list of order statuses that are listed as part of the filter criteria in the Order list page.
About this task
Procedure
Example
A sample JSON specification that shows various properties for an order status list is given.
You can the override the status by changing the statusKey
and the status
values.
For translating, you must update the module’s en.json file. For information about adding new
translation literals, see Defining a bundle entry for an existing component or module.
Important: Either
statusValue
or fromStatus
and toStatus
attributes
are required to display a custom status under the filter orders criteria. If these values are not
provided, filtering of orders based on custom status does not work.Attribute | Description |
---|---|
statusCode (Required) |
Unique key to distinguish order statuses in the list and also shown as query parameter in the URL. |
statusKey (Required) |
Description bundle key for status. |
statusValue (Optional) |
Value for the status. Used for absolute status values and is required if
fromStatus and toStatus are not provided. |
fromStatus (Optional) |
Starting value of the status. Used for a range of status values and is required if
statusValue is not provided. |
toStatus (Optional) |
Ending value of the status. Used for a range of status values and is required if
statusValue is not provided. |