Docs

Split Order

POST /Orders/{orderId}/split

POST/Orders/{orderId}/split

Moves part of the order's resource lines onto a new Draft order and returns the new order's id. Each entry names a line and a quantity to move (greater than zero, no more than the line holds); a fully moved line leaves the source, others are reduced, and some quantity must stay on the source. The new order is named "{name} (split)" unless a name is given and keeps the source's Internal or External source. Expense lines are not moved. Refused while the order is locked (declared Sent or Confirmed, or Ordered on an internal order, with no unsent revision); call Orders_MintOrderVersion first. Line ids come from Orders_GetOrder.

Path Parameters

FieldTypeRequiredDescription
orderIduuidRequired

Request Body

FieldTypeRequiredDescription
namestringOptional
linesSplitOrderRequestLineSplit[]Optional

SplitOrderRequestLineSplit

FieldTypeDescription
lineItemIduuid
quantitynumber

Response

Type: uuid