Orders | Workflow

Update status and run workflow for an order or shipment

If you need to update status on a shipment and not the order, set the corresponding "shipmentId" on the "shipmentInfo" object. The shipmentInfo object also allows you to update shipment information, such as tracking link or shipping method. <br /> If you do not wish to automatically run the workflow for the order or shipment, you can specify this using "skipRunWorkflow:true". <br /> Set "executeWorkFlowAsync:true" to process the status update and workflow asynchronously via a Service Bus queue. The API returns 202 Accepted immediately without waiting for the workflow to complete. Ignored when "skipRunWorkflow:true". <br /><br /> Basic example on how you would update status to "InProgress" for an existing order:

 POST /api/orders/{orderId}/UpdateStatus
 {
     "status": "InProgress"
 }
        

Example on how you would set status for an existing shipment (with shipmentId "1") to "Completed" and run workflow for the shipment while also updating tracking url:

 POST /api/orders/{orderId}/UpdateStatus
 {
     "status": "Completed",
     "shipmentInfo": { 
          "shipmentId": "1",
          "trackingUrl" : "https://omnium.no/not-an-actual-tracking-link"
     }
 }
post/api/Orders/{orderId}/UpdateStatus

Request

  • Base URL: https://api.omnium.no (the document declares no server; this is the origin it was published from)
  • URL: https://api.omnium.no/api/Orders/{orderId}/UpdateStatus
  • Auth: API key in header Authorization

Path parameters

orderIdstring nullable required

The ID of the order

Request body

statusstring required

New status to update to

userIdstring nullable

User ID

returnIdstring nullable

For return order workflows (ReturnOrderForm.Id)

skipRunWorkflowboolean

If set to true, order will only be saved, and no workflows will run

executeWorkFlowAsyncboolean

When true, the status update and workflow are processed asynchronously via a Service Bus queue. The API returns 202 Accepted immediately without waiting for the workflow to complete. Defaults to false (synchronous processing). Ignored when Omnium.Public.Orders.Models.OmniumUpdateStatusPatch.SkipRunWorkflow is true.

Response

Success

isAbortedboolean

True if workflow failed and is aborted

Changes

No recorded changes to this operation across all 1 revision of this API.