Purchase orders
Get a paginated list of purchase orders with optional filtering.
For detailed information about the filtering system and available operators, refer to the Filter System Documentation.
Available Filters
String Filters
order_numbers: Purchase order numbers (alternate IDs) - searches across all order numberspublic_note: Public notes contentprivate_note: Private notes contenttag: Order tags
Date Filters
order_date: Date the order was placedinvoice_date: Date the order was invoicedrequested_ship_date: Requested shipping datearrival_due_date: Expected arrival date
DateTime Filters
created_at: When the order was createdupdated_at: When the order was last updated
Numeric Filters
order_quantity: Total number of items orderedorder_cost: Base cost before tax and shipping (calculated from line items)total_cost: Total cost including tax and shippingtotal_tax: Tax amounttotal_shipping_cost: Shipping costtotal_paid: Amount paidtotal_qty_ordered: Total quantity of line items ordered (sum ofordered_qtyfrom all items)total_qty_received: Total quantity of line items received (sum ofreceived_qtyfrom all items)total_qty_remaining: Total quantity of line items remaining to be received (ordered - received)
Boolean Filters
starred: Whether the order is starred
ID Filters
supplier_id: Filter by supplierwarehouse_id: Filter by warehouselocation_id: Filter by location
Enum Filters
order_status: Milestone status token or numeric id (active, production_started, production_completed, in_transit, completed, deleted;inactivedeprecated alias for completed)
Examples
# Find active orders with total cost over $1000
?order_status=active&total_cost[gt]=1000.00
# Find starred orders from a specific supplier
?starred=1&supplier_id=123
# Find orders by order number
?order_numbers=PO-2024-001
# Find orders with remaining quantity greater than 0
?total_qty_remaining[gt]=0
# Find recent orders with specific shipping costs
?total_shipping_cost=50.00&created_at[gte]=2024-10-25 00:00:00
Authorizations
Authenticate using a bearer token. To create a token, navigate to /settings/api-tokens and click Create API Token.
Query Parameters
Page number for pagination
Number of items per page (max 100)
x <= 100Filter by purchase order numbers (alternate IDs). Searches across all order numbers associated with the purchase order.
Filter by public note content
Filter by private note content
Filter by tags
Filter by order date (YYYY-MM-DD)
Filter by invoice date (YYYY-MM-DD)
Filter by requested ship date (YYYY-MM-DD)
Filter by arrival due date (YYYY-MM-DD)
Filter by creation date (YYYY-MM-DD HH:mm:ss)
Filter by last update date (YYYY-MM-DD HH:mm:ss)
Filter by total number of items ordered
Filter by total quantity of line items ordered (sum of ordered_qty from all items)
Filter by total quantity of line items received
Filter by total quantity of line items remaining to be received (ordered - received)
Filter by order cost
Filter by total cost (including tax and shipping)
Filter by tax amount
Filter by shipping cost
Filter by amount paid
Filter by starred status
Filter by supplier ID
Filter by warehouse ID
Filter by location ID
Filter by order status
active, inactive, deleted