Apply a discount to an order
POST/v1/orders/:id/discounts
Applies a discount to an order and returns it with the totals recalculated.
Discounts applied here are manual: you decide the amount or the percentage. Coupon discounts are resolved by the storefront, which knows the coupon rules, and are not created through this endpoint.
An order can carry several discounts; they add up.
Only orders created through the API can be changed here. An order taken on the storefront, the POS or a food app belongs to that channel and answers 422 order_not_modifiable.
Required scope: orders:write
Request
Responses
- 201
- 401
- 403
- 404
- 422
The order with the discount applied.
Unauthenticated — the request is missing a credential, or the Bearer token / API key is invalid, expired, or revoked.
Insufficient scope — the credential is authenticated but lacks a scope the endpoint requires.
Not found — no resource matches the id in the path (or it belongs to a different company).
Validation failed — the request body failed schema validation. errors[] lists every offending field.