List purchase orders
Header Parameters
Query Parameters
Page number, starting at 1.
Rows per page. Default 10, maximum 30.
Narrow by order status. Repeat the key or send a comma list for several. An unknown value is a 400 listing the valid ones. Codes: 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.
ORPISRTPARSDCO... 4 other enums
Order number. Non-digits are stripped, so the display form works; a value with no digits at all is a 400.
Email of the requester. Must be a valid address.
Orders updated at or after this ISO-8601 timestamp. See the section page: nested changes do not bump this field.
Orders updated at or before this timestamp.
Sort key, - for descending. Default -orderNumber. A stable id tiebreaker is always appended so paging cannot repeat or skip a row.
createdAt-createdAtupdatedAt-updatedAtorderNumber-orderNumberstatus-statusPath Parameters
Company ID. Must be one of the IDs returned by GET /api/v2/companies/.
Response
The standard paginated envelope.
Response Attributes
Total matching records across all pages.
Total pages. 0 when there are no results.
The page this response contains.
Show child attributes
A query parameter was invalid. attr names it.
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
Rate limit exceeded (60 requests per minute per API key). Retry after the number of seconds given in the message.
Response Attributes
validationErrorclientErrorserverError