Coupons
Redeem a coupon
Marks a coupon as used. Redemption is final.
POST
/{locale}/shop/coupons/redeemMarks a coupon as used. Redemption is final.
Authorization
apiKey apiSecret X-API-Key<token>
Partner API key from the Partners Portal. Always sent together with X-API-Secret.
In: header
X-API-Secret<token>
Partner API secret. Always sent together with X-API-Key.
In: header
Path Parameters
locale*string
Locale code
Value in
- "lt"
- "en"
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X POST "https://example.com/lt/shop/coupons/redeem" \ -H "Content-Type: application/json" \ -d '{ "coupon_id": 77, "shop_id": 1 }'{ "success": true, "code": 200, "request_id": "550e8400-e29b-41d4-a716-446655440000", "message": "Success message", "data": {}}Hold a coupon during checkout POST
Marks a coupon as pending so it cannot be used elsewhere while the sale completes. Finish with coupons/redeem or undo with coupons/cancel-pending.
Verify a coupon code POST
Checks whether a coupon code is valid and redeemable at the given shop. Call this before applying a discount at the till.