Skip to main content
POST
Auto Generate Purchase Orders

Headers

TENANT
string
required

The tenant you are making this request on behalf of

API-KEY
string
required

Your api key

Body

application/json
locationIds
string[]
required

List of location IDs to check stock levels for

Response

Successful Response

supplierId
string
required

ID of the supplier

id
string

Unique identifier for the purchase order

status
enum<string>
default:PENDING

Status of the purchase order

Available options:
PENDING,
PLACED,
COMPLETED,
CANCELLED
issueDate
string<date-time> | null

Date when the purchase order was sent to supplier

completedDate
string<date-time> | null

Date when all shipments are DELIVERED (purchase order completed)

supplier
Supplier · object | null

Optional supplier details

lineItems
PurchaseOrderLineItemWithDetails · object[] | null

Line items with details

notes
PurchaseOrderNote · object[] | null

Notes attached to this purchase order

createdDate
string<date-time> | null

Date and time the purchase order was created

updatedDate
string<date-time> | null

Date and time the purchase order was last updated

isArchived
boolean
default:false

Whether the purchase order is archived

leadTimeDays
integer | null

Maximum lead time in days across all line items (estimated delivery time from order placement)