Skip to content

Create purchase order

POST
/api/purchase-orders
 
curl --request POST \
  --url http://localhost:3000/api/purchase-orders \
  --header 'Content-Type: application/json' \
  --cookie session=<session> \
  --data '{ "poNumber": "example", "supplierName": "example", "status": "draft", "orderDate": "2026-04-15T12:00:00Z", "expectedDelivery": "2026-04-15T12:00:00Z", "notes": "example", "items": [ { "description": "example", "categoryId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "manufacturerId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "quantityOrdered": 1, "unitCost": 1, "notes": "example" } ] }'

Authorizations

Section titled “Authorizations ”

Request Body required

Section titled “Request Body required ”
Media type application/json
object
poNumber
required

Unique

string
supplierName
string
status
string
default: draft
Allowed values: draft ordered partially_received received cancelled
orderDate
string format: date-time
expectedDelivery
string format: date-time
notes
string
items
required
Array<object>
object
description
required
string
categoryId
string format: uuid
manufacturerId
string format: uuid
quantityOrdered
integer
default: 1
unitCost
number
notes
string

Responses

Section titled “ Responses ”

201

Section titled “201 ”

Purchase order created (with items)

Media type application/json
object
data
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"
  }
}

400

Section titled “400 ”

PoNumber and at least one item are required

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

401

Section titled “401 ”

Not authenticated

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

403

Section titled “403 ”

Insufficient role

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