Workflow Endpoints

The Workflow API allows you to progress orders through their lifecycle by updating statuses and triggering configured workflow steps. Workflow steps can automatically capture payments, send notifications, book shipments, reduce inventory, and more.

For configuring workflows and workflow steps, see Order Workflows and Workflow Steps.

Base URL

https://api.omnium.no/api/Orders

Full Swagger reference: Omnium Order Workflow API Documentation

Update order status

Update the status of an order or a specific shipment, and run the associated workflow.

Endpoint: POST /api/Orders/{orderId}/UpdateStatus

Authorization: Order Admin

Parameters:

Request body: UpdateStatusPatch

Update order status

Set a new status on the entire order and trigger the workflow.

{
  "status": "InProgress"
}

Update shipment status

Target a specific shipment by setting shipmentId on the shipmentInfo object. The workflow runs for that shipment only. If all shipments reach the same status, the order status is updated automatically.

{
  "status": "Completed",
  "shipmentInfo": {
    "shipmentId": "1",
    "trackingUrl": "https://tracking.bring.com/12345"
  }
}

Update status without running workflow

Set skipRunWorkflow to true to update the status without executing any workflow steps. Useful when syncing status from an external system.

{
  "status": "Completed",
  "skipRunWorkflow": true
}

Response: 200 OK with WorkflowExecutionResult

Error responses:

Update order lines and shipments

Create or update shipments and order lines, then run the workflow. This is the primary endpoint for handling partial deliveries, split shipments, and line-item-level status updates.

Endpoint: POST /api/Orders/{orderId}/OrderLinesUpdate

Authorization: Order Admin

Parameters:

Request body: UpdateLineItemStatusPatch

Deliver items from an existing shipment

Mark specific line items as delivered on an existing shipment and trigger the workflow.

{
  "status": "Completed",
  "lineItemUpdates": [
    {
      "lineItemId": "4",
      "deliveredQuantity": 4
    },
    {
      "lineItemId": "6",
      "deliveredQuantity": 6
    }
  ],
  "shipmentInfo": {
    "shipmentId": "1"
  }
}

Create a partial delivery (new shipment)

Deliver some items in a new shipment while keeping the remaining items in the original shipment. If the shipmentId does not exist, a new shipment is created. Shipping information is copied from the original shipment unless overridden.

{
  "status": "Completed",
  "lineItemUpdates": [
    {
      "lineItemId": "4",
      "deliveredQuantity": 4
    },
    {
      "lineItemId": "6",
      "deliveredQuantity": 6
    }
  ],
  "shipmentInfo": {
    "shipmentId": "2",
    "shipmentMethodName": "Bring"
  }
}

Split shipment without delivering

Move items to a new shipment without marking them as delivered. Use splitQuantity instead of deliveredQuantity. You can optionally specify a different warehouse or pickup point for the new shipment.

{
  "status": "InProgress",
  "lineItemUpdates": [
    {
      "lineItemId": "4",
      "splitQuantity": 2
    },
    {
      "lineItemId": "6",
      "splitQuantity": 1
    }
  ],
  "shipmentInfo": {
    "shipmentId": "2",
    "shipmentMethodName": "Bring",
    "warehouseCode": "warehouse4",
    "servicePointId": "12345",
    "pickUpPointInformation": {
      "servicePointId": "12345",
      "name": "Pickup Point Name",
      "address": {
        "street": "Main Street 1",
        "postalCode": "12345",
        "city": "City Name",
        "country": "Norway",
        "countryCode": "NO"
      }
    }
  }
}

Deliver and cancel items

Deliver some items and cancel others in the same request.

{
  "status": "Completed",
  "lineItemUpdates": [
    {
      "lineItemId": "4",
      "deliveredQuantity": 4
    },
    {
      "lineItemId": "5",
      "deliveredQuantity": 2,
      "canceledQuantity": 3
    },
    {
      "lineItemId": "6",
      "canceledQuantity": 6
    }
  ],
  "shipmentInfo": {
    "shipmentId": "1"
  }
}

Split a single order line

When an order line has a quantity greater than 1, you can split it into a new partial shipment.

{
  "status": "Completed",
  "lineItemUpdates": [
    {
      "lineItemId": "4",
      "splitQuantity": 1
    }
  ],
  "shipmentInfo": {
    "orderStatus": "Completed"
  }
}

Response: 200 OK with WorkflowExecutionResult

Error responses:

Workflow test (dry run)

Run a workflow in test mode against a cart. No changes are persisted to the order or shipment. Useful for previewing which workflow steps would execute before actually placing the order.

Endpoint: POST /api/Orders/{cartId}/processCartWorkflowTest/{status}

Authorization: Order Admin

Parameters:

Response: 200 OK with WorkflowExecutionResult

Models

Update status patch model

Update line item status patch model

Line item update model

Update shipment info model

Allows you to target a specific shipment and optionally update shipment metadata in the same request.

Pickup point model

Pickup point address model

Shipment package model

Dimensions model

Tracking model

Workflow execution result model

Returned by all workflow endpoints. Contains the execution result of each workflow step and the updated order.

Action result model

Example response:

{
  "order": {
    "id": "ORD-2024-000001",
    "status": "Completed",
    "orderForm": { }
  },
  "isAborted": false,
  "orderActionExecutionResults": [
    {
      "actionType": "CapturePayment",
      "actionStatus": "Success",
      "cancelWorkflow": false
    },
    {
      "actionType": "Notification",
      "actionStatus": "Success",
      "cancelWorkflow": false
    },
    {
      "actionType": "ReduceInventory",
      "actionStatus": "Success",
      "cancelWorkflow": false
    }
  ]
}