Skip to main content
GET
List Purchase Orders

Headers

TENANT
string
required

The tenant you are making this request on behalf of

API-KEY
string
required

Your api key

Query Parameters

page
integer | null
per_page
integer | null
sort_by
string | null
sort_direction
enum<string> | null
Available options:
asc,
desc
location_id
string | null
ids
string[] | null

Optional list of IDs of the purchase orders

supplier_id
string | null

Optional ID of the supplier

status
enum<string> | null

Optional status of the purchase order The status of a purchase order.

Available options:
PENDING,
PLACED,
COMPLETED,
CANCELLED
is_archived
boolean | null

Optional archived status of the purchase order

Response

Successful Response

data
PurchaseOrderResponse · object[]
required
total
integer
required