POST /v1/customers/:id/coupons/:couponId/redeem marks the given coupon as redeemed and returns the updated coupon. All body fields are optional and carry opaque IDs (your external system identifiers) that are resolved to internal references on our side.
user is omitted the authenticated API user is recorded as the redeeming user; when branch is omitted the authenticated user’s branch is used.
Request headers
string
required
Your active Bearer token:
Bearer <accessToken>.string
required
Always
application/json.Path parameters
string
required
Customer id.
string
required
Coupon instance id (from GET /v1/customers/:id/coupons).
Request body
string
Cashier user opaque id.
string
Branch opaque id.
string[]
Product opaque ids included in the redemption.
Response fields (200 OK)
string
Coupon instance id.
object
Coupon summary (
name).object
The branch and user that performed the redeem.
string
When the coupon was redeemed (ISO 8601).
string
Now
redeemed.A coupon can also be redeemed as part of a basket by passing its id in
reward on POST /v1/transactions/process.