Discount an order

Applies a percentage or fixed-amount discount to the whole order. It is shared across the order's lines in proportion to their value, so taxes stay correct per line.

A discount above the outlet's cap needs an approval_token from POST /pos/auth/approve (action discount_above_cap). 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

Payload for an order-level discount. Percentages are bounded at 100.

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