Skip to content

List purchase orders

GET
/api/purchase-orders
curl --request GET \
--url http://localhost:3000/api/purchase-orders \
--cookie session=<session>

Not paginated. Rows include itemCount.

Success

Media type application/json
object
data
Array<object>
object
id
required
string format: uuid
poNumber
required
string
supplierName
string
nullable
status
required
string
Allowed values: draft ordered partially_received received cancelled
orderDate
string format: date-time
nullable
expectedDelivery
string format: date-time
nullable
receivedDate
string format: date-time
nullable
totalValue

Numeric(12,2) serialised as string — recalculated server-side from items

string
nullable
notes
string
nullable
createdBy
string format: uuid
nullable
itemCount

List endpoint only

integer
items

Detail endpoint only

Array<object>
object
id
required
string format: uuid
poId
required
string format: uuid
description
required
string
categoryId
string format: uuid
nullable
categoryName
string
nullable
manufacturerId
string format: uuid
nullable
manufacturerName
string
nullable
quantityOrdered
required
integer
quantityReceived
required
integer
unitCost

Numeric(12,2) serialised as string

string
nullable
totalCost

Numeric(12,2) serialised as string

string
nullable
notes
string
nullable
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
Example
{
"data": [
{
"status": "draft"
}
]
}

Not authenticated

Media type application/json
object
error
required
string
Example
{
"error": "Not found"
}

Insufficient role

Media type application/json
object
error
required
string
Example
{
"error": "Not found"
}