Configuration

Learn how to configure order types, workflows, and return charges in Omnium. This guide covers order statuses, workflow steps, and key properties to customize order processing.

Order types

The order workflow is built around order types. An order type will be configured with order statuses, each with a set of workflow steps.

An order type could, for instance, be:

Online
Click And Collect
POS Order
Subscription order
Edge case order

The purpose of separating orders into different order types is to enable multiple workflows. An online order might have three statuses (New, In progress, Sent). Click and Collect orders could have four statuses (New, In progress, Ready for pickup, Picked up). A POS order might only have one status (Completed). There are no limits in Omnium regarding the number of order types, number of statuses, and number of workflow steps.

Order type model

Property	Type	Description
Name *	string	Order type name (E.g. Online, ClickAndCollect, Pos, etc)
OrderStatuses *	List<OrderStatus>	List of available order statuses
EnableEdit	bool	Is order editable in GUI
EnableCreateFromCart	bool	True if it is possible to create order type from cart
DisableWorkflow	bool	Temporarily disable workflow for order type
DefaultOrderType	bool	True if the order is the default. Autofilter by default types in the order list.
DefaultExternalIdProvider	string	External ID provider (Added to list of external IDs)

Order statuses

In the order processing, the order will go through the configured order statuses. Each status will trigger a workflow of each workflow step for the order status. The workflow execution will result in a list of execution results. Read more about order workflow.

Order status model

Property	Type	Description
Name *	string	Order status name
Order *	int	Status sort order index
WorkflowSteps *	List<WorkflowStep>	Workflow steps to run
DisplayName	string	Alternative order status name
IsMainFilter	bool	Is main filter
Condition	string	Condition for showing order status (if more statuses have the same sort order)
IsCanceledStatus	bool	True if orders with this status are canceled
IsDeliveredStatus	bool	True if orders with this status are delivered to the customer
IsInProgressStatus	bool	True if orders with this status are in progress
IsPicked	bool	True if orders with this status are picked. Used by picklist to set the correct status when the order is ready to ship/pick up
ShipmentStatusUpdate	string	If set, the shipments on order will get this status
AvailableSteps	List<string>	List of available next order statuses
TranslateKey	string	Translation key for order status
Properties	List<PropertyItem>	Custom properties

Workflow steps

Property	Type	Description
Name *	string	Workflow step name
Connector *	string	Connector to use for workflow step
Active	bool	True if step should be run
RunAfterOrderIsSaved	bool	True if step should run after order is saved
ContinueOnError	bool	If true, the workflow will continue if the current step fails to execute
TranslateKey	string	Translation key for workflow step name
IsInvisible	bool	True if result should not be shown in GUI
EnabledForMarkets	List<string>	List of markets where this workflow step should be enabled (all markets available if empty)
DisabledForMarkets	List<string>	List of market IDs where the workflow step should be disabled (overrides enabled property)

Samples

Simple order type: PoS-order

In the example below, a point of sale order can be added from physical stores. The status is completed upon registration, and no action is taken by Omnium.

"OrderTypes": [
  {
    "Name": "Pos",
    "EnableEdit": false,
    "EnableCreateFromCart": false,
    "OrderStatuses": [
      {
        "Name": "Completed",
        "DisplayName": "Completed",
        "TranslateKey": "PickedUp",
        "IsMainFilter": true,
        "Order": 1,
        "WorkflowSteps": []
      }
    ]
  }
]

Online order with workflow steps

In the example below, an order type with the name "Online" is defined. It has two order statuses, "New" and "Completed":

"OrderTypes": [
  {
    "Name": "Online",
    "EnableEdit": true,
    "EnableCreateFromCart": true,
    "OrderStatuses": [
      {
        "Name": "New",
        "DisplayName": "New",
        "IsMainFilter": true,
        "Order": 1,
        "WorkflowSteps": [
          {
            "Name": "Notification",
            "Active": true,
            "TranslateKey": "WorkflowStep_Notification"
          },
          {
            "Name": "GetOrCreateCustomerFromOrder",
            "Active": true
          }
        ]
      },
      {
        "Name": "Completed",
        "DisplayName": "Completed",
        "TranslateKey": "PickedUp",
        "IsMainFilter": true,
        "Order": 4,
        "Condition": "Pickup",
        "IsCanceledStatus": false,
        "WorkflowSteps": []
      }
    ]
  }
]

Return charges

Return charges are default values of what to charge the customer when creating a return.

Return charges sample

{
  "ReturnCost": 99,
  "NotPickedUpCost": 150
}

Configuration

On this page