Skip to main content

Order Fulfillment and Tracking via API

Track order items as they move through fulfillment, update quantities, mark items delivered, and update order status and tags.

This article picks up after an order is created. See Creating an Order via API first.


How Orders and Items Relate

An order (e.g. SO05adce00ef4b092b90f42f97b2ec3e36) contains one or more order items (e.g. UN05adce00ef4b39680ac425a3882b0190). Each item has its own fulfillment status, shipping details, and tracking number. The order itself has a separate order status.

Level

Field

Values

Order

Status

Hold, New, InProgress, ReadyToFulfill, Complete, Cancelled

Order item

Status

Pending, Requested, Accepted, Rejected, Acknowledge, AcknowledgeNotReceived, Reserved, Backordered, PartiallyShipped, Shipped, Delivered, Failed, Cancelled

Item statuses Unassigned, DeliveryScheduled, OutForDelivery, and MissedDelivery only appear when Routing is enabled in your environment.


Get the Items on an Order

GET /v1/orders/{orderId}/items
GET /v1/orders/SO05adce00ef4b092b90f42f97b2ec3e36/items
{
"Items": [
{
"Id": "UN05adce00ef4b39680ac425a3882b0190",
"Count": 1,
"Status": "Shipped",
"Uom": { "Id": "UMf659af00783b2b9b61e4ad120d15d60a", "Name": "each", "Abbreviation": "ea" },
"Product": {
"Id": "P31SM48ZK95CX72GA60R",
"Name": "Ensure Therapeutic Vanilla",
"Hcpcs": ["B4150"],
"PartNumber": "464646464646"
},
"Shipped": {
"ShippedDate": "2026-08-11T00:00:00",
"Carrier": "UPS",
"TrackingNumber": "1Z999AA10123456784",
"HasMultipleShipment": false
}
}
]
}

Depending on the item's status, the response includes a matching detail block, such as Shipped, Backordered, Accepted, Rejected, or Failed, with dates, carrier, tracking number, and notes. Serialized and lotted items also include SerialNumber or LotNumber.

Get a Single Item

GET /v1/orders/{orderId}/items/{itemId}

Search Items Across all Orders

GET /v1/orders/items

Use this to find items by status, tracking number, serial or lot number, or date, across every order. It's ideal for building a fulfillment dashboard or a nightly shipping sync.

Useful Filters

Filter

Example

item.statuses

Shipped, Backordered

item.trackingNumber

1Z999AA10123456784

item.serialNumbers / item.lotNumbers

Serial or lot numbers

item.shippedDate.from / .to

2026-11-01

item.deliveryDate.from / .to

2026-11-01

order.ids

One or more Order IDs

order.patientId

10000105

order.statuses

InProgress, ReadyToFulfill

order.types

Sales, Resupply, Retail

order.modified.from / .to

2026-11-10T00:00:00Z

pageIndex / pageSize

Paging

GET /v1/orders/items?item.statuses=Backordered&order.statuses=InProgress&pageSize=50

Update an Item's Quantity

PUT /v1/orders/{orderId}/items/{itemId}
PUT /v1/orders/SO05adce00ef4b092b90f42f97b2ec3e36/items/UN05adce00ef4b39680ac425a3882b0190
{ "Qty": 2 }

Qty must be greater than 0.

Response: 200 OK

Mark an Item Delivered

PUT /v1/orders/{orderId}/items/{itemId}/status

⚠️ Only the Delivered status is currently supported on this endpoint. DeliveryDate is required.

PUT /v1/orders/SO05adce00ef4b092b90f42f97b2ec3e36/items/UN05adce00ef4b39680ac425a3882b0190/status
{
"Status": "Delivered",
"DeliveryDate": "2026-11-10"
}

Response: 200 OK


Remove an Item from an Order

DELETE /v1/orders/{orderId}/items/{itemId}

Response: 200 OK


Update Order Status or Tags

PUT /v1/orders/{id}
PUT /v1/orders/SO05adce00ef4b092b90f42f97b2ec3e36
{
"Status": "Complete",
"TagIds": ["c7cc3360b8bd89d916af5a7c65fceb9344059b80"]
}

Both fields are optional. Get tag IDs from GET /v1/order-tags.

Response: 200 OK


Shipping Items

To ship items, use the Quick-Ship endpoints:

  • Drop ship through an integrated vendor: POST /v1/orders/{orderId}/drop-ship

  • Direct ship with your own carrier and tracking number: POST /v1/orders/{orderId}/direct-ship


Get Notified Instead of Polling

Subscribe to these webhook events to be notified when fulfillment changes:

Event

Fires when

order.item.updated

An order item is updated (status, shipping, tracking)

order.status.updated

An order's status changes

order.updated

An order is updated

order.tags.updated

An order's tags change


Deprecated Endpoints

The /tracking endpoints are deprecated. Use the /items equivalents:

Deprecated

Use instead

GET /v1/orders/{orderId}/tracking

GET /v1/orders/{orderId}/items

GET /v1/orders/{orderId}/tracking/{trackingId}

GET /v1/orders/{orderId}/items/{itemId}

PUT /v1/orders/{orderId}/tracking/{trackingId}

PUT /v1/orders/{orderId}/items/{itemId}

PUT /v1/orders/{orderId}/tracking/{trackingId}/status

PUT /v1/orders/{orderId}/items/{itemId}/status

DELETE /v1/orders/{orderId}/tracking/{trackingId}

DELETE /v1/orders/{orderId}/items/{itemId}


Common Errors

Code

Meaning

400

Invalid request, e.g. Qty of 0, a status other than Delivered, or a missing DeliveryDate

401

Token missing, expired, or invalid

403

You don't have permission to access this resource

404

Order or item not found

429

Too many requests


Related articles

Did this answer your question?