Loyalty Management Developer Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
Loyalty Management Standard Objects
Loyalty Management Fields on Standard Objects
Coupon Objects in Loyalty Management
Loyalty Management Associated Objects
Apex Reference
Loyalty Management Business APIs
REST Reference
Resources
Club Member Enrollment
Club Member Profile
Club Membership Renewal
Corporate Member Enrollments
Individual Member Enrollments
Member Benefits
Member Profile
Member Engagement Trail
Member Vouchers
Redeem Voucher
Transaction History
Transaction Ledger Summary
Transaction Journals Execution
Transaction Journals Simulation
Loyalty Program Process
Cancel a Voucher
Credit Points to Members
Debit Points from Members
Enroll for Promotions
Get Member Promotions
Issue a Voucher
Unenroll a Member
Opt Out from a Promotion
Update Member Details
Update Member Tier
Gamification
Promotion
Request Bodies
Response Bodies
Loyalty Management Connect API Interchangeable Request Fields
Loyalty Management Standard Invocable Actions
Loyalty Management Custom Invocable Actions
Loyalty Management Metadata API Types
Loyalty Management Tooling API Objects
Loyalty Management Mobile SDK
Gamification Mobile SDK
Data Processing Engine, Batch Management, and Monitor Workflow Services
PDF

Cancel a Voucher

Change the status of a voucher to canceled.

Example URL

https://yourInstance.salesforce.com/services/data/v64.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

{
   "processParameters":[
      {
         "MemberId":"0lMxx00000000BJEAY",
         "VoucherId":"0kdxx000000000B245"
      }
   ]
}

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

{
   "processParameters":[
      {
         "MembershipNumber":"003",
         "VoucherCode":"15OFF"
      }
   ]
}

Sample JSON Response

{
   "message":null,
   "outputParameters":{
      "outputParameters":{
         "results":[
            {
               "VoucherId":"0kDRM0000004Ct22AE"
            }
         ]
      }
   },
   "simulationDetails":{
      
   },
   "status":true
}