Before You Start: Lookups
What you need | Endpoint | Example |
Vendors |
|
|
Warehouses (inventory locations) |
|
|
Products |
|
|
Units of measure |
|
|
Purchase order statuses |
|
|
💡 Purchase order statuses can include custom statuses your organization has set up. Always get the list from GET /v1/purchase-orders/statuses rather than hard-coding it.
Purchase Orders
Create a Purchase Order
POST /v1/purchase-orders
Fields
Field | Required | Notes |
| ✅ |
|
| ✅ | The receiving warehouse |
| ✅ | One or more line items |
|
| A status |
|
| Your account number with the vendor |
|
| Requires |
|
|
|
Line items
Field | Required | Notes |
| ✅ |
|
| ✅ |
|
| ✅ | Purchase unit of measure |
| ✅ | Unit price |
|
|
|
|
| Vendor SKU |
|
|
|
|
|
|
Example
POST /v1/purchase-orders
{
"VendorId": "VR1b89c710acea37aa39249fcab4007a3f",
"LocationId": "LI133e5e00acea46095a34639c97805835",
"AccountNumber": "123456",
"Status": "New",
"Items": [
{
"ProductId": "A05MW34SX96ZF71QT28K",
"Qty": 10,
"UomId": "UMf659af00783b2b9b61e4ad120d15d60a",
"Price": 47.50,
"Sku": "CAH-12345",
"LineNumber": 1
}
]
}
Response: 201 Created
{ "Id": "POK35XW94MP10BG87QC6" }
Search Purchase Orders
GET /v1/purchase-orders
Filters: id, displayId, vendorId, vendorName, accountNumber, status, statuses, itemStatus, locationId, notes, createdBy, createdOn, customField.fieldId + customField.value, includeArchived, pageIndex, pageSize, selectCount.
{
"Items": [
{
"Id": "POK35XW94MP10BG87QC6",
"DisplayId": "PO-0BG87QC6",
"Status": { "Id": "Fulfilled", "Name": "Fulfilled" },
"Vendor": { "Id": "VR1b89c710acea37aa39249fcab4007a3f", "Name": "Cardinal Health" },
"TotalPrice": { "Amount": 475 },
"Archived": false
}
]
}
Get one: GET /v1/purchase-orders/{id}
Update a Purchase Order
PUT /v1/purchase-orders/{id}Same fields as creating one, except Status. Include each existing line's Id to update it.
Change Status
PUT /v1/purchase-orders/{id}/status
{ "Status": "InProgress" }
Update Line Item States
PUT /v1/purchase-orders/{id}/items/states
Use this to record where each line item stands with the vendor, for example from a vendor integration.
Status | Detail block (required for that status) |
|
|
|
|
|
|
|
|
|
|
Each detail block accepts an optional Date and Metadata (any JSON object).
{
"Items": [
{
"PurchaseOrderItemId": "string",
"Status": "Acknowledged",
"Acknowledged": { "Date": "2026-11-10" }
},
{
"PurchaseOrderItemId": "string",
"Status": "Failed",
"Failed": { "Date": "2026-11-10", "Messages": ["Item discontinued by vendor"] }
}
]
}
Delete a Purchase Order
DELETE /v1/purchase-orders/{id}
Audit History
GET /v1/purchase-orders/{purchaseOrderId}/audit: the change historyGET /v1/purchase-orders/{purchaseOrderId}/audit/{auditId}/details: received items and order-item link details for an audit entry
Inventory Items
Receive Inventory
POST /v1/inventory-items/receive
Field | Required | Notes |
| ✅ |
|
| ✅ | The warehouse receiving the stock |
| ✅ | In the selected unit of measure. Must be 1 for serialized products. |
| ✅ |
|
| For serialized products | Leave out for other product types |
| For lotted products | Leave out for other product types |
| For bundle products | One entry per component: |
|
| Link the receipt to a purchase order |
|
| Per unit of measure |
|
|
|
|
|
|
POST /v1/inventory-items/receive
{
"ProductId": "A05MW34SX96ZF71QT28K",
"LocationId": "LI133e5e00acea46095a34639c97805835",
"Count": 1,
"UomId": "UMf659af00783b2b9b61e4ad120d15d60a",
"SerialNumber": "SN-0012345",
"PurchaseOrderId": "POK35XW94MP10BG87QC6",
"PurchasePrice": 47.50
}
Batch receive: POST /v1/inventory-items/batch/receive with { "Items": [ ... ] }, same item fields. This runs as a background job: the response returns a job ID. Check its progress with GET /v1/jobs/{id}.
Search Inventory
GET /v1/inventory-items
Filters: name, productIds, partNumber, serialNumber, lotNumber, hcpcsCode, status, locationType, locationId, location, manufacturer, manufacturerIds, groupIds, categoryIds, refurbished, serviceRequired, pageIndex, pageSize, selectCount.
{
"Items": [
{
"Id": "UN0160e7001c4b1c4b88d4a85abd7e0954",
"Name": "AirFit F20 Frame - Small",
"PartNumber": "63463",
"PrimaryHcpcsCodes": ["A7030"],
"ProductType": { "Id": "NonSerialized", "Name": "NonSerialized" },
"Count": 1,
"Status": { "Id": "Active", "Name": "Active" },
"Location": { "Id": "10000370", "Name": "Jane Doe", "Type": { "Id": "Patient", "Name": "Patient" } },
"Refurbished": false,
"ServiceRequired": false
}
]
}
Get one: GET /v1/inventory-items/{id}
Move Inventory
PUT /v1/inventory-items/{id}/moveField | Required | Notes |
| ✅ |
|
| ✅ |
|
| ✅ |
|
| ✅ | Inventory location ID, team member ID ( |
|
|
|
PUT /v1/inventory-items/UN0160e7001c4b1c4b88d4a85abd7e0954/move
{
"Count": 1,
"UomId": "UMf659af00783b2b9b61e4ad120d15d60a",
"Destination": { "Type": "Warehouse", "Id": "LI016c7a00f12b857bbc342d5fdedd63cc" },
"Notes": "Returned from patient"
}
Batch move: PUT /v1/inventory-items/batch/move with { "Items": [ ... ] }. Each item includes its InventoryItemId. It also runs as a background job; check GET /v1/jobs/{id}.
Related Setup Endpoints
Area | Endpoints |
Vendors |
|
Products |
|
Units of measure |
|
Product categories, groups, manufacturers (V2) |
|
Get Notified of Changes
Subscribe to purchase-order.created, purchase-order.updated, purchase-order.deleted, purchase-order.status.updated, and management.inventory.product.created / .updated / .deleted.
See Webhooks API.
Common Errors
Code | Meaning |
| Invalid request, e.g. a missing serial number for a serialized product, a |
| Token missing, expired, or invalid |
| You don't have permission to access this resource |
| Purchase order, item, product, vendor, or location not found |
| Too many requests |
