Pick Lists

A pick list groups shipments from one or more orders so they can be picked together at a single warehouse or store. Picking staff work through the list item by item, register what was actually found on the shelf, and complete the list — at which point Omnium pushes the result back onto the underlying orders.

Pick lists are the link between order management and physical fulfillment: an order tells you what was sold, a pick list tells you what was collected, by whom, and where. Warehouse picking, in-store picking for click and collect, and store-to-store transfers all run through the same pick list model.

For click and collect specifically, Omnium also has a dedicated, simplified view built around that flow. Pick lists work for click and collect orders too, but the dedicated view is the lighter option — see Click and Collect.

How pick lists are created

Pick lists are created by users, not by the order workflow. A user selects the shipments to pick — in the Omnium UI or in the Omnium In-Store App — and Omnium builds a pick list from them:

1. A new pick list gets an ID from the PickListNumberOptions number sequence and is created with status New.
2. The list is assigned to the user who created it, and to a warehouse. When no warehouse is given, the user's selected store is used.
3. Each selected shipment is added to the list, along with the products, quantities, and warehouse locations of its order lines.

Because creation is user-driven, the public API is a read-and-annotate surface: you can search pick lists, read them, and patch status and properties, but you cannot create a pick list or add shipments to one through the public API.

Pick list statuses

Queued is a guard, not a resting state. If a pick list is stuck in Queued, an update was started and did not finish — attempting another update on it is rejected rather than applied twice.

Completing a pick list

When a pick list is completed, Omnium walks through every picked item and updates the corresponding order line and shipment. Three quantities drive this:

When everything is picked, the shipment is fulfilled and the orders move on through their workflow. When something is missing, the line needs a deviation handling decision before the list can be completed.

Deviation handling

Each item with a shortfall carries a rest action that tells Omnium what to do with the quantity that was not picked:

AttentionRequired takes precedence: if any item on the list is flagged for attention, the order is flagged and none of the other rest actions are applied to it.

A default rest action can be configured per tenant, so partially picked lines get a sensible fallback instead of blocking the picker — see Configuration.

Transferring to another warehouse

A pick list can be handed over to a different warehouse instead of being picked where it is. For each shipment on the list, Omnium either merges it into an existing shipment for the target warehouse, or moves the shipment to that warehouse and detaches it from the pick list. The pick list itself ends up with status Transferred.

Pick List API

Base URL

https://api.omnium.no/api/PickList

Full Swagger reference: Omnium Pick List API Documentation.

Authentication

All endpoints require Bearer token authentication and the Order Read role (the Order Admin role also grants access). See Authentication for details on obtaining tokens.

Endpoints

Pick list model

Each entry in PickListOrderItems identifies one shipment:

Search pick lists

Endpoint: POST /api/PickList/Search

Example request:

{
  "take": 25,
  "page": 1,
  "createdFrom": "2026-08-01T00:00:00Z",
  "createdTo": "2026-08-31T23:59:59Z",
  "sortOrder": "CreatedDescending"
}

Example response:

{
  "totalHits": 2,
  "result": [
    {
      "id": "PL100241",
      "name": "Morning pick - Oslo",
      "created": "2026-08-28T06:12:44Z",
      "modified": "2026-08-28T07:41:02Z",
      "warehouseCode": "OSLO-01",
      "warehouseName": "Epic Enterprise Oslo",
      "status": "Completed",
      "pickListOrderItems": [
        {
          "orderId": "ORD-2026-004417",
          "shipmentId": "8f2b91c4-5d0e-42a7-9c31-6b4de2f70a15"
        }
      ],
      "properties": []
    },
    {
      "id": "PL100240",
      "name": "Click and collect - Oslo",
      "created": "2026-08-27T13:55:10Z",
      "modified": "2026-08-27T13:55:10Z",
      "warehouseCode": "OSLO-01",
      "warehouseName": "Epic Enterprise Oslo",
      "status": "New",
      "pickListOrderItems": [],
      "properties": []
    }
  ]
}

Results are limited to the warehouses the calling user has access to.

Get a pick list

Endpoint: GET /api/PickList/Get?id=PL100241

Returns the pick list, or 404 Not Found when no pick list has that ID.

Patch a pick list

Endpoint: PATCH /api/PickList/PatchPickList

Only the properties present in the request are changed. Id is required; sending it without an ID returns 400 Bad Request.

Example request:

{
  "id": "PL100241",
  "status": "Completed",
  "properties": [
    {
      "key": "ExternalPickTaskId",
      "value": "WMS-88213",
      "valueType": "String"
    }
  ]
}

The updated pick list is returned in the response.

Finding the orders on a pick list

Order search accepts a PicklistIds filter, so you can retrieve every order that has a shipment on a given pick list:

{
  "picklistIds": ["PL100241"],
  "take": 50
}

See the Order API Reference for the full order search request.

Tracking pick list activity

Pick list operations are recorded as events, and can be subscribed to like any other Omnium event. Creation, item changes, order updates driven by a pick list, transfers, and deletions each have their own operation ID in the 114x and 214x ranges. See Events for the full list and for how to subscribe.

Configuration

Pick list behavior is configured per tenant under PickListSettings.

Pick list IDs come from the PickListNumberOptions number sequence — see Number options for how to configure the format and starting number.

Related

• Order API Reference — searching orders and reading shipments
• Click and Collect — in-store picking of reserved orders
• Order configuration — order types, statuses, and order settings
• Events — subscribing to pick list operations