Add Packages to Purchase Order

Adds one or more supplier packages to an existing purchase order.

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

The request body is a flat array of package objects — not wrapped in a parent object. The purchase order must be in IN_PROGRESS status and owned by the requesting user.

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. Sending 0 removes the package from the order if it was already present.
  • to_par — when true, the quantity is automatically calculated as par − (current stock + outstanding orders), rounded up. If stock already meets or exceeds par, the calculated quantity is 0 and the package is removed from the order if it was already present.
Path Params
string
required

A purchase order's ID.

Body Params

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

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

404

404

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