Cancel a Voucher

Change the status of a voucher to canceled.

Example URL

1https://yourInstance.salesforce.com/services/data/v68.0/connect/loyalty/programs/DemoProgram/program-processes/cancel Voucher

The request and response parameters vary depending on the input and output parameters configured for the CancelVoucher process type in a Salesforce org.

Sample JSON Requests

Some of the API request fields contain field names that are interchangeable. For information on the list of interchangeable field names, see Loyalty Management Connect API Interchangeable Request Fields.

Note

Here’s a sample request with a member ID and voucher ID

1{
2   "processParameters":[
3      {
4         "MemberId":"0lMxx00000000BJEAY",
5         "VoucherId":"0kdxx000000000B245"
6      }
7   ]
8}

Here’s a sample request with a membership number and voucher code

If the voucher code isn’t unique, provide either a voucher ID or a number.

Note

1{
2   "processParameters":[
3      {
4         "MembershipNumber":"003",
5         "VoucherCode":"15OFF"
6      }
7   ]
8}

Sample JSON Response

1{
2   "message":null,
3   "outputParameters":{
4      "outputParameters":{
5         "results":[
6            {
7               "VoucherId":"0kDRM0000004Ct22AE"
8            }
9         ]
10      }
11   },
12   "simulationDetails":{
13      
14   },
15   "status":true
16}

See Also

Loyalty Management Help: Create a Process Using Cancel Voucher Process Template