List Purchase Orders (list view)
GET/api/purchase-orders
Paginated purchase orders list using the list view trait. Supports full-text search, filters, sorting, and archival state.
Authentication: Requires Bearer token.
Filter scopes available:
- filter[order_status]: draft, open, closed
- filter[arriving_this_week]: 1
- filter[overdue]: 1
- filter[submission_status]: pending, sent
- filter[receipt_status]: unreceived, partial, received, dropship
- filter[shipment_status]: pending, shipped
- filter[invoice_status]: uninvoiced, partial, invoiced
Allowed sorts: id, purchase_order_number, purchase_order_date, estimated_delivery_date, order_status, submission_status, receipt_status, shipment_status, invoice_status, total, total_quantity, supplier_id, created_at, updated_at
The response also includes unfiltered_total, the count of rows in the base scope before any user filters are applied — used by the frontend to show export totals.
Request
Responses
- 200
- 401
- 403
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.