List purchase orders
GET
/api/purchase-orders
const url = 'http://localhost:3000/api/purchase-orders';const options = {method: 'GET', headers: {cookie: 'session=<session>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url http://localhost:3000/api/purchase-orders \ --cookie session=<session>Not paginated. Rows include itemCount.
Authorizations
Section titled “Authorizations ”Responses
Section titled “ Responses ”Success
Media type application/json
object
data
Array<object>
object
id
required
string format: uuid
poNumber
required
string
supplierName
string
status
required
string
orderDate
string format: date-time
expectedDelivery
string format: date-time
receivedDate
string format: date-time
totalValue
Numeric(12,2) serialised as string — recalculated server-side from items
string
notes
string
createdBy
string format: uuid
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
categoryName
string
manufacturerId
string format: uuid
manufacturerName
string
quantityOrdered
required
integer
quantityReceived
required
integer
unitCost
Numeric(12,2) serialised as string
string
totalCost
Numeric(12,2) serialised as string
string
notes
string
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"}