Skip to main content
GET
Purchase orders

Authorizations

Authorization
string
header
required

Authenticate using a bearer token. To create a token, navigate to /settings/api-tokens and click Create API Token.

Query Parameters

page
integer
default:1

Page number for pagination

per_page
integer
default:10

Number of items per page (max 100)

Required range: x <= 100
order_numbers
string

Filter by purchase order numbers (alternate IDs). Searches across all order numbers associated with the purchase order.

public_note
string

Filter by public note content

private_note
string

Filter by private note content

tag
string

Filter by tags

order_date
string<date>

Filter by order date (YYYY-MM-DD)

invoice_date
string<date>

Filter by invoice date (YYYY-MM-DD)

requested_ship_date
string<date>

Filter by requested ship date (YYYY-MM-DD)

arrival_due_date
string<date>

Filter by arrival due date (YYYY-MM-DD)

created_at
string<date-time>

Filter by creation date (YYYY-MM-DD HH:mm:ss)

updated_at
string<date-time>

Filter by last update date (YYYY-MM-DD HH:mm:ss)

order_quantity
number

Filter by total number of items ordered

total_qty_ordered
number

Filter by total quantity of line items ordered (sum of ordered_qty from all items)

total_qty_received
number

Filter by total quantity of line items received

total_qty_remaining
number

Filter by total quantity of line items remaining to be received (ordered - received)

order_cost
number

Filter by order cost

total_cost
number

Filter by total cost (including tax and shipping)

total_tax
number

Filter by tax amount

total_shipping_cost
number

Filter by shipping cost

total_paid
number

Filter by amount paid

starred
boolean

Filter by starred status

supplier_id
integer

Filter by supplier ID

warehouse_id
integer

Filter by warehouse ID

location_id
integer

Filter by location ID

order_status
enum<string>

Filter by order status

Available options:
active,
inactive,
deleted

Response

Successful response

data
object[]
meta
object