Set a purchase order status
Header Parameters
Path Parameters
Company ID. Must be one of the IDs returned by GET /api/v2/companies/.
Body Parameters
The order's UUID (its uuid on read). The unambiguous identifier.
Your reference for the order. Use it when you do not hold the UUID.
O ordered, D delivered, I invoiced, CO completed, RE returned. Any other status is refused.
ODICOREISO-8601, e.g. 2026-07-27T10:00:00Z. Defaults to now.
Free text stored with the status event.
Scopes the update to one item, by its position in the order. Requires status, and cannot be combined with finalDelivered / finalInvoiced.
The supplier-side order number. Saved before dispatch, so it is used for the order sent when processOrder is true.
Releases an order that is on hold and sends it to the supplier. Ignored when the order is in any other status.
Order-level: mark the order fully delivered.
Order-level: mark the order fully invoiced.
Free-text order reference stored on the order.
Reports how your own sync of this order went.
doneerrorDetail for syncStatus, typically the error.
Response
The status row that was written, with the order's sync state.
Response Attributes
Status code: O Ordered, R Rejected, P Pending, I Invoiced, S Sent, RT Resent, PA Partial, RS Resolved, D Delivered, CO Completed, CA Canceled, ID In delivery, OH On hold, RE Returned. Only O, D, I, CO and RE can be set through set-status; the others are assigned by flows inside Hivebuy.
ORPISRTPARSDCO... 4 other enums
Show child attributes
Validation failed. Every problem in the payload is reported at once, one entry per field.
Response Attributes
validationErrorclientErrorserverError Show child attributes
Missing, invalid, or expired API key, or a session credential was used instead of an API key.
Response Attributes
validationErrorclientErrorserverError Show child attributes
Authenticated but not entitled: the key's user is not an active member of this company, the External API feature (or the resource's own feature) is not enabled for it, the key lacks the scope this verb needs, or a browser session was used.
Response Attributes
validationErrorclientErrorserverError Show child attributes
No order in this company matched the identifier you sent.
Response Attributes
validationErrorclientErrorserverError Show child attributes
Rate limit exceeded (60 requests per minute per API key). Retry after the number of seconds given in the message.
Response Attributes
validationErrorclientErrorserverError