Loyalty Management Developer Guide
jNewer Version Available
Redeem Voucher
Redeem a voucher for a program member. The status of the voucher gets
updated to redeemed and the use date gets updated to the current date.
- Resource
-
1/services/data/vXX.X/loyalty/programs/${programName}/members/${membershipNumber}/vouchers/${voucherCode}/redeem - Resource example
-
1/services/data/v51.0/loyalty/programs/DemoProgram/members/M1234/vouchers/VC001/redeem - Available version
- 51.0
- Requires Chatter
- No
- HTTP methods
- POST
- Query parameters
-
Parameter Name Type Description Required or Optional Available Version membershipNumber String The loyalty program membership number. Required 51.0 programName String The loyalty program name. Required 51.0 voucherCode String The voucher code to be redeemed. Required 51.0 - Response body for POST
- Returns HTTP 201 on success.
-
This table lists HTTP response code descriptions that are unique to this resource.
HTTP Response Code Error Code Description 400 INVALID_API_INPUT The voucher is expired. Specify a voucher that hasn’t expired. 400 INVALID_API_INPUT The voucher is canceled. Specify a voucher that hasn’t canceled. 400 INVALID_API_INPUT Specify a valid voucher code and try again. 400 INVALID_API_INPUT Specify a valid loyalty program name and try again. 400 INVALID_API_INPUT Specify a valid loyalty program membership number and try again. 400 INVALID_API_INPUT The voucher definition is inactive. Specify a voucher that’s associated with an active voucher definition. 409 INVALID_API_INPUT The voucher is redeemed. Specify a voucher that hasn’t redeemed. 500 INTERNAL_SERVER_ERROR Duplicate vouchers for this voucher code. Either specify a different voucher code or ask your Salesforce admin for help. 500 UNKOWN_EXCEPTION The voucher redemption failed. Try again or ask your Salesforce admin for help.