Get a purchase order
Header Parameters
Path Parameters
Company ID. Must be one of the IDs returned by GET /api/v2/companies/.
Row id. A row belonging to another company is 404 on every verb, never 403.
Response
The order.
Response Attributes
The order id. This is what {id} and purchaseOrder take.
The human order number, with the company prefix.
The order in the Hivebuy UI.
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
The reference sent outbound: external order number, client external id, or the plain order number.
Same value as externalId.
Set by you through set-status, or by an integrated supplier on dispatch.
Show child attributes
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 such row for this company, including a row that belongs to another company, and a soft-deleted row you tried to write to. The API does not confirm whether the id exists elsewhere.
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