Loyalty Management Developer Guide
jNewer Version Available
Redeem Voucher
Redeem a voucher for a loyalty 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 - Examples
-
1https://yourInstance.salesforce.com/services/data/vXX.X 2/loyalty/programs/DemoProgram/members/M1234/vouchers/VC001/redeem -
1https://yourInstance.salesforce.com/services/data/vXX.X 2/loyalty/programs/DemoProgram/members/M1234/vouchers/VC001/redeem?voucherNumber=00000006 - Available version
- 51.0
- Requires Chatter
- No
- HTTP methods
- POST
- Parameters for POST
-
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 voucherNumber String The auto-generated voucher number. Optional 55.0 - Request body for POST
- The request body is available in version 53.0 and later.
-
- JSON example
-
1{ 2 "currencyIsoCode" : "Yen", 3 "redeemAmount" : 1.5 4} - Properties
-
Name Type Description Required or Optional Available Version currencyIsoCode String Three-letter ISO 4217 currency code of the monetary currency in which the voucher is redeemed. Optional 55.0 redeemAmount Double The value of the voucher to be redeemed. Specify a value when a member hasn't redeemed the full value of the voucher. This value is only applicable for vouchers issued using Fixed Value voucher definitions. A value isn't required when the member has redeemed the complete value of the voucher in a single transaction.
Optional 53.0
- Response body for POST
- Redeem Voucher Output (available in version 53.0 and later)
-
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 ALREADY_REDEEMED_VOUCHER The voucher is redeemed. Specify a voucher that hasn’t redeemed. 500 MULTIPLE_VOUCHERS 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.