Loyalty Management Developer Guide
jNote: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.
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 |