Skip Navigation

Newer Version Available

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

Issue Voucher

Issue a voucher for a member or contact.

This action is available in API version 51.0 and later for users with Loyalty Management license.

Supported REST HTTP Methods

URI: /services/data/vXX.X/actions/standard/issueVoucher
Formats: JSON, XML
HTTP Methods: POST
Authentication: Authorization: Bearer token

Inputs

Input	Details
BenefitId	Type ID Description The benefit associated with the voucher.
ContactId	Type ID Description The contact associated with the member.
DiscountPercent	Type percent Description The discount percentage provided by the voucher. Specify a value to override the discount percentage specified in the associated voucher definition. Specify this when the associated voucher definition is of the type Discount Percentage. This field is available in API version 53.0 and later.
FaceValue	Type double Description The amount of discount provided by the voucher. Specify a value to override the face value specified in the associated voucher definition. Specify this when the associated voucher definition is of the type Fixed Value. This field is available in API version 53.0 and later.
EffectiveDate	Type Date Description The date the voucher goes into effect.
ExpiryDate	Type Date Description The date the voucher expires.
JournalId	Type ID Description The transaction journal associated with the member voucher when the voucher results from accrual of points.
LoyaltyProgramMemberId	Type ID Description ID of the loyalty program member to issue the voucher.
PromotionId	Type ID Description The promotion associated with the voucher.
ProgramName	Type string Description The name of the loyalty program associated with this voucher.
Reason	Type string Description The reason why the voucher is issued.
VoucherCode	Type string Description Required. The voucher identifier generated by an external system.
VoucherDefinitionName	Type string Description Required. The name of the voucher definition associated with the voucher code.

Outputs

Output	Details
VoucherId	Type ID Description The ID of the voucher that’s generated after the request is successful.

Example

Sample Request

Sample Response