Skip to main content
POST
Allocate a sales order onto a purchase order

Authorizations

Authorization
string
header
required

Authenticate using a bearer token. To create a token, navigate to /settings/api-tokens and click Create API Token.

Path Parameters

purchaseOrderId
integer
required

ID of the purchase order to allocate onto

Body

application/json
sales_order_id
integer
required

ID of the sales order whose lines are being allocated

Example:

5001

lines
object[]
required

Sales-order lines to peg onto this purchase order

Minimum array length: 1
ship_complete
boolean

When true, attempt to release the whole sales order as a single ship-complete fulfillment once every held line is coverable. Omit to leave the order's existing ship-complete behavior unchanged.

Example:

false

Response

Sales order lines allocated

data
object