Member Vouchers

Get vouchers that have been issued to a loyalty program member.

Resource

1/loyalty/programs/${programName}/members/${membershipNumber}/vouchers

Resource Examples

1https://YOUR_INSTANCE.salesforce.com/services/data/v58.0
2/loyalty/programs/NTO/members/M1/vouchers

1https://YOUR_INSTANCE.salesforce.com/services/data/v58.0
2/loyalty/programs/NTO/members/M1/vouchers?voucherStatus=Cancelled,Expired

1https://YOUR_INSTANCE.salesforce.com/services/data/v58.0
2/loyalty/programs/NTO/members/M1/vouchers?pageNumber=2&voucherStatus=Issued&productName=Linea,Creta

Available Version

58.0

Requires Chatter

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.	Optional	58.0
`productCategoryId`	String	The ID of a product category associated with the member vouchers to be retrieved.	Optional	58.0
`productCategoryName`	String	The product category name associated with the vouchers to be retrieved.	Optional	58.0
`productId`	String	The product ID associated with the vouchers to be retrieved.	Optional	58.0
`productName`	String	The product name associated with the vouchers to be retrieved.	Optional	58.0
`voucherStatus`	String	The status of the member vouchers to filter the API response. Possible values are `Cancelled`, `Expired`, `Issued`, or `Redeemed`.	Optional	58.0
`sortBy`	String	The voucher field for sorting the API response. The default value is `ExpirationDate`. Possible values are `CreatedDate`, `EffectiveDate`, or `ExpirationDate`.	Optional	58.0
`sortOrder`	String	The sort order of the API response. The default value is `Ascending`. Possible values are Ascending or Descending.	Optional	58.0

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

Note: You can specify up to 20 product category IDs.

Note: You can specify up to 20 product categories.

Note: You can specify up to 20 product IDs.

Note: You can specify up to 20 product names.

Response Body for GET

Vouchers List