Split an order

Splits an order into separate checks. Each entry in splits is one new order, listing order item ids, or {order_item_id, quantity} to split a line's units across checks (two waters, one each). Every unit must be assigned exactly once.

The original order ends as split, and each new order records it as parent_order_id. Discounts, taxes and fees are divided so the checks add up to the original. To split a bill evenly without splitting items, take several payments with POST /pos/orders/{order_id}/payments/ instead. Requires a staff token.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required
Body Params

Instructions for splitting an order into two or more sub-orders.

A group entry is either a bare order-item id (the whole line — the original
wire shape, kept so offline mutations queued by older clients still replay)
or a SplitItemRef claiming part of a line's quantity. uuid.UUID
leads the union deliberately: a string only coerces to a UUID and a mapping
only validates as a ref, so the two shapes cannot shadow each other.

splits
array of arrays
required
length ≥ 2

Each inner list is one sub-order: bare order-item IDs take the whole line, {order_item_id, quantity} entries take that many units

Splits*
Headers
Responses

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