Discount an order line

Applies a percentage or fixed-amount discount to one line and recalculates the order. A discount above the outlet's cap needs an approval_token from POST /pos/auth/approve.

To charge a different price instead, use PUT /pos/orders/{order_id}/items/{item_id}/price. Requires a staff token.

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

Payload for a line-item level discount.

value is a percentage for percent or an absolute amount for
amount. A price override goes through
PUT /orders/{order_id}/items/{item_id}/price instead — a custom price is
a price, not a discount (migration 042). Percentages are bounded at 100 in
the validator below — the property's own settings schema bounds
max_percent the same way, and a 500% discount is an input error rather than
a comp.

string
required
length between 1 and 500
string
enum
required
Allowed:
required
≥ 0
Headers
Responses

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