Loyalty Management Developer Guide

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
Request Bodies
Response Bodies
Additional Transaction Journal Attributes Output
Badge Output
Corporate Member Enrollment Output
Credit Points Action Output
Debit Points Action Output
Eligible Promotions List
Expression
Expression Value
Game Assignment Output
Game Details
Game Result
Game Reward Details
Game Rewards List
Games List
Issue Voucher Action Output
Individual Member Enrollment Output
Loyalty Account Output
Loyalty Engine Realtime Output
Loyalty Contact Output
Member Benefits Output
Member Benefit Output
Member Currency Output
Member Currency Change
Member Points Balance
Member Profile Output
Member Currency
Member Tier Output
Member Points Balance Change
Loyalty Process Output
Loyalty Program Process Rule
Loyalty Program Process Rule Step
Loyalty Program Process Rule Action
Loyalty Program Process Rule Action Parameter
Loyalty Program Process Rule Condition
Loyalty Program Process Rule Condition Filter Criteria
Loyalty Program Process Rule Condition Group
Loyalty View Transaction Journal History Output
Participant Game Rewards List
Process Result
Points Change Output
Points Summary
Promotion Details
Promotion Limit
Promotion Limit Output
Promotion Reward Details
Promotion Rules List
Redeem Voucher Output
Summary
Transaction Details Output
Transaction Journal Output
Transaction Journal Map Output
Transaction Journal Result
Transaction Journal Process Result
Transaction Ledgers Output
Update Cumulative Usage Action Output
Voucher
Vouchers List
Voucher Result
Voucher Output
Promotion Configuration Output
Clone Promotion Output
Promotion Coupon Availability
Promotion Coupon
Coupon Availablity Message
Coupon Usage Result
Member Engagement Trail Output
Member Engagement Attribute
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

Newer Version Available

This content describes an older version of this product. View Latest

Voucher

Output representation of the details of a voucher.
Property Name Type Description Filter Group and Version Available Version
currencyIsoCode String The currency ISO code in which the member has redeemed the voucher. Small, 58.0 58.0
description String The description of the voucher issued to the member. Small, 58.0 58.0
discountPercent Integer The discount percentage that's offered to the member by the voucher. Small, 58.0 58.0
effectiveDate String The date the member can redeem the voucher. Small, 58.0 58.0
effectiveDateTime DateTime The date and time from when the voucher is available for redemption. Small, 62.0 62.0
expirationDate String The date the voucher expires. Small, 58.0 58.0
expirationDateTime DateTime The date and time when the voucher expires and is no longer available for redemption. Small, 62.0 62.0
faceValue Double The value that the member can redeem using the voucher. Small, 58.0 58.0
isVoucherDefinitionActive Boolean Indicates whether the voucher definition associated with the voucher is active (true) or not (false). Small, 58.0 58.0
isVoucherPartiallyRedeemable Boolean Indicates whether the voucher can be redeemed across multiple transactions (true) or only one transaction (false). Small, 58.0 58.0
hasTimeBasedVoucher Boolean Indicates whether the voucher has an effective date and time (true) or not (false). Small, 62.0 62.0
partnerAccountName String The name of the partner associated with the voucher's voucher definition. Small, 58.0 58.0
productCategoryId String The ID of product category associated with the voucher's voucher definition. Small, 58.0 58.0
productCategoryName String The name of the product category associated with the voucher definition. Small, 58.0 58.0
productId String The ID of the product associated with the voucher definition. Small, 58.0 58.0
productName String The name of the product associated with the voucher definition. Small, 58.0 58.0
promotionId String The ID of the promotion for which the voucher is issued. Small, 58.0 58.0
promotionName String The name of the promotion for which the voucher is issued. Small, 58.0 58.0
redeemedValue Double The value that the member has already redeemed from a partially redeemable voucher. Small, 58.0 58.0
remainingValue Double The remaining value of the voucher after partial redemption. Small, 58.0 58.0
status String The status of the voucher. Small, 58.0 58.0
type String The type of voucher issued to the member. Small, 58.0 58.0
useDate String The date the voucher was redeemed. Small, 58.0 58.0
voucherCode String The code of the voucher. Small, 58.0 58.0
voucherDefinition String The name of the voucher definition used to issue the voucher to the member. Small, 58.0 58.0
voucherId String The ID of the voucher record. Small, 58.0 58.0
voucherImageUrl String The URL of the image associated with the voucher definition. Small, 58.0 58.0
voucherNumber String The unique number of the voucher. Small, 58.0 58.0