Retrieve Redeem Options
GET {{api-url}}/reward-points/public/customer/redeemOptions
Retrieves all available redemption options configured for customers to use.
Note: This public API endpoint is accessible to all customers.
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
[{"type":"\u003cstring\u003e","name":"\u003cstring\u003e","points":"\u003cinteger\u003e","id":"\u003cstring\u003e","description":"\u003cstring\u003e","coupon":{"name":"\u003cstring\u003e","discountType":"FREE_SHIPPING","code":"\u003cstring\u003e","description":"\u003cstring\u003e","discountPercentage":"\u003cnumber\u003e","discountAbsolute":{"amount":0,"currency":"USD"},"allowAnonymous":false,"maxRedemptions":-1,"maxRedemptionsPerCustomer":-1,"restrictions":{"validFrom":"\u003cdateTime\u003e","validUntil":"\u003cdateTime\u003e","minOrderValue":{"amount":0,"currency":"USD"}},"issuedTo":"\u003cstring\u003e","redemptionCount":"\u003cnumber\u003e","status":"EXPIRED","links":[{"rel":"\u003cstring\u003e","title":"\u003cstring\u003e","href":"\u003cstring\u003e","type":"\u003cstring\u003e"},{"rel":"\u003cstring\u003e","title":"\u003cstring\u003e","href":"\u003cstring\u003e","type":"\u003cstring\u003e"}],"deleted":"\u003cboolean\u003e"}},{"type":"\u003cstring\u003e","name":"\u003cstring\u003e","points":"\u003cinteger\u003e","id":"\u003cstring\u003e","description":"\u003cstring\u003e","coupon":{"name":"\u003cstring\u003e","discountType":"ABSOLUTE","code":"\u003cstring\u003e","description":"\u003cstring\u003e","discountPercentage":"\u003cnumber\u003e","discountAbsolute":{"amount":0,"currency":"USD"},"allowAnonymous":false,"maxRedemptions":-1,"maxRedemptionsPerCustomer":-1,"restrictions":{"validFrom":"\u003cdateTime\u003e","validUntil":"\u003cdateTime\u003e","minOrderValue":{"amount":0,"currency":"USD"}},"issuedTo":"\u003cstring\u003e","redemptionCount":"\u003cnumber\u003e","status":"VALID","links":[{"rel":"\u003cstring\u003e","title":"\u003cstring\u003e","href":"\u003cstring\u003e","type":"\u003cstring\u003e"},{"rel":"\u003cstring\u003e","title":"\u003cstring\u003e","href":"\u003cstring\u003e","type":"\u003cstring\u003e"}],"deleted":"\u003cboolean\u003e"}}]