Note: 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.

Vouchers List

Output representation of the list of vouchers associated with the loyalty program member.

JSON example

1{
2  "voucherCount": 6,
3  "vouchers": [
4    {
5      "effectiveDate": "2020-11-01",
6      "effectiveDateTime":"2020-11-01T07:47:44.000Z",
7      "expirationDate": "2021-11-01",
8      "expirationDateTime":"2021-11-01T07:33:00.000Z",
9      "faceValue": 100,
10      "isVoucherDefinitionActive": true,
11      "isVoucherPartiallyRedeemable": false,
12      "hasTimeBasedVoucherPeriod": true,
13      "redeemedValue": 0,
14      "remainingValue": 100,
15      "status": "Expired",
16      "type": "FixedValue",
17      "voucherCode": "J4XN26MT",
18      "voucherDefinition": "Ajio",
19      "voucherId": "0kDT1000000TUwsMAG",
20      "voucherNumber": "00005852"
21    },
22    {
23      "effectiveDate": "2020-11-01",
24      "expirationDate": "2021-11-01",
25      "faceValue": 100,
26      "isVoucherDefinitionActive": true,
27      "isVoucherPartiallyRedeemable": false,
28      "hasTimeBasedVoucherPeriod": false,
29      "redeemedValue": 0,
30      "remainingValue": 100,
31      "status": "Expired",
32      "type": "FixedValue",
33      "voucherCode": "6PM01LT8",
34      "voucherDefinition": "Ajio",
35      "voucherId": "0kDT1000000TUjEMAW",
36      "voucherNumber": "00005006"
37    },
38    {
39      "effectiveDate": "2020-11-01",
40      "expirationDate": "2021-11-01",
41      "faceValue": 100,
42      "isVoucherDefinitionActive": true,
43      "isVoucherPartiallyRedeemable": false,
44      "hasTimeBasedVoucherPeriod": false,
45      "redeemedValue": 0,
46      "remainingValue": 100,
47      "status": "Expired",
48      "type": "FixedValue",
49      "voucherCode": "LEEFAQGE",
50      "voucherDefinition": "Ajio",
51      "voucherId": "0kDT1000000TUQcMAO",
52      "voucherNumber": "00003852"
53    },
54    {
55      "effectiveDate": "2020-11-01",
56      "expirationDate": "2021-11-01",
57      "faceValue": 100,
58      "isVoucherDefinitionActive": true,
59      "isVoucherPartiallyRedeemable": false,
60      "hasTimeBasedVoucherPeriod": false,
61      "redeemedValue": 0,
62      "remainingValue": 100,
63      "status": "Expired",
64      "type": "FixedValue",
65      "voucherCode": "9WOYZK2G",
66      "voucherDefinition": "Ajio",
67      "voucherId": "0kDT1000000TUCyMAO",
68      "voucherNumber": "00003006"
69    },
70    {
71      "effectiveDate": "2020-11-01",
72      "expirationDate": "2021-11-01",
73      "faceValue": 100,
74      "isVoucherDefinitionActive": true,
75      "isVoucherPartiallyRedeemable": false,
76      "hasTimeBasedVoucherPeriod": false,
77      "redeemedValue": 0,
78      "remainingValue": 100,
79      "status": "Expired",
80      "type": "FixedValue",
81      "voucherCode": "6PLO64G1",
82      "voucherDefinition": "Ajio",
83      "voucherId": "0kDT1000000TU6yMAG",
84      "voucherNumber": "00002634"
85    },
86    {
87      "effectiveDate": "2020-11-01",
88      "expirationDate": "2021-11-01",
89      "faceValue": 100,
90      "isVoucherDefinitionActive": true,
91      "isVoucherPartiallyRedeemable": false,
92      "hasTimeBasedVoucherPeriod": false,
93      "redeemedValue": 0,
94      "remainingValue": 100,
95      "status": "Expired",
96      "type": "FixedValue",
97      "voucherCode": "K54Y02BK",
98      "voucherDefinition": "Ajio",
99      "voucherId": "0kDT1000000TTuKMAW",
100      "voucherNumber": "00001850"
101    }
102  ]
103}

Property Name	Type	Description	Filter Group and Version	Available Version
`voucherCount`	Integer	The number of vouchers returned by the API request.	Small, 58.0	58.0
`vouchers`	Voucher	The details of the vouchers.	Small, 58.0	58.0

Loyalty Management Developer Guide

Vouchers List