Send Purchase Order

Sends a purchase order to the supplier.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

The purchase order must be in IN_PROGRESS status and owned by the requesting user.

supplier_email_input

Only required when the supplier has no configured email address and supports email orders. When the supplier already has one or more configured email addresses, this field is ignored and the order is sent to those addresses.

expected_delivery_date

Must not be in the past. If the outlet has an ordering schedule configured for this supplier, the date must also comply with that schedule — requests that fall outside the supplier's delivery days or past the order cutoff time will be rejected.

Order approval

A 200 does not always mean the order was sent. When the library has the Order Approval module and the order, added to what was already sent to this supplier for this outlet that day, goes over the daily threshold configured for them, the order is parked: the response carries status: AWAITING_APPROVAL, nothing reaches the supplier, and an order approval waits for a user with the Approve Orders permission. Branch on status: ORDERED means sent, AWAITING_APPROVAL means parked.

A parked order keeps the expected_delivery_date, remarks and customer_number sent here, and goes to the supplier with them when its order approval is approved, unless the approver sets a new delivery date. To find that order approval, see Get Order Approvals. To change the order instead, add packages to it, which takes it back to IN_PROGRESS.

Items whose lead time is too long for expected_delivery_date are moved to a new IN_PROGRESS order for the same outlet and supplier, and the rest of the order is parked without them, as it would be sent. The threshold is checked against the items that stay.

Path Params
string
required

A purchase order's ID.

Body Params
string
required

The expected delivery date and time. Must not be in the past and must comply with the supplier's ordering schedule if one is configured. Accepted formats: YYYY-MM-DDTHH:MM:SS and YYYY-MM-DDTHH:MM.

string | null

Optional order remarks visible to the supplier.

string | null

Optional supplier customer number to include on the order.

string | null

Required when the supplier has no configured email address and supports email orders. Ignored when the supplier already has one or more configured email addresses.

Responses

403

The token lacks the procurement scope, the library does not have the Ordering module, or the user lacks the Send Orders permission.

404

The purchase order does not exist or is not accessible to the caller.

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json