Create Purchase Orders

Creates one or more purchase orders from a list of supplier packages.

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

Packages from the same supplier are grouped into a single purchase order. If the request includes packages from multiple suppliers, one purchase order is created per supplier.

quantity and to_par

Each package entry must provide either quantity or to_par, but not both:

  • quantity — the number of units to order. Must be a non-negative number.
  • to_par — when true, the quantity is automatically calculated to bring stock up to the configured par level for that package.
Body Params
string
required

The ID of the outlet the purchase order belongs to.

packages
array of objects
required
length ≥ 1

List of supplier packages to include. Duplicate supplier package IDs are not allowed.

packages*
string
required

The ID of the supplier package.

number | null

The quantity to order. Mutually exclusive with to_par. One of quantity or to_par must be provided.

boolean
Defaults to false

If true, the quantity is automatically calculated to reach the par level. Mutually exclusive with quantity. One of quantity or to_par must be provided.

Responses

400

400

403

403

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