Skip to main content

List Purchase Orders (DataTable)

GET 
/api/purchase-orders

Paginated purchase orders list using the DataTable 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

Request​

Responses​

Successful response