Member Vouchers

Get vouchers that have been issued to a loyalty program member.
Resource
/loyalty/programs/${programName}/members/${membershipNumber}/vouchers
Resource Examples
https://yourInstance.salesforce.com/services/data/v58.0
/connect/loyalty/programs/NTO/members/M1/vouchers
https://yourInstance.salesforce.com/services/data/v58.0
/connect/loyalty/programs/NTO/members/M1/vouchers?voucherStatus=Cancelled,Expired
https://yourInstance.salesforce.com/services/data/v58.0
/connect/loyalty/programs/NTO/members/M1/vouchers?pageNumber=2&voucherStatus=Issued&productName=Linea,Creta
Available version
58.0
Requires Chatter
No
HTTP methods
GET
Query parameters
Parameter Name Type Description Required or Optional Available Version
pageNumber Integer The page number to be returned. If you don’t specify a value, the first page is returned.

Each page contains 200 vouchers, sorted by their date of creation.

Note

Optional 58.0
productCategoryId String The ID of a product category associated with the member vouchers to be retrieved.

You can specify up to 20 product category IDs.

Note

Optional 58.0
productCategoryName String The product category name associated with the vouchers to be retrieved.

You can specify up to 20 product categories.

Note

Optional 58.0
productId String The product ID associated with the vouchers to be retrieved.

You can specify up to 20 product IDs.

Note

Optional 58.0
productName String The product name associated with the vouchers to be retrieved.

You can specify up to 20 product names.

Note

Optional 58.0
voucherStatus String The status of the member vouchers to filter the API response. Possible values are:
  • Cancelled
  • Expired
  • Issued
  • Redeemed
Optional 58.0
sortBy String The voucher field for sorting the API response. The default value is ExpirationDate.
Possible values are:
  • CreatedDate
  • EffectiveDate
  • ExpirationDate
Optional 58.0
sortOrder String The sort order of the API response. The default value is Ascending.
Possible values are:
  • Ascending
  • Descending
Optional 58.0
Response body for GET
Vouchers List