Learn about the Issue Voucher process template and its components. Also, understand how you can use the template to create a loyalty program process and execute the process.
Required Editions
| Available in: Lightning Experience in Enterprise, Performance, Unlimited, and Developer Editions |
| Available in: Orgs that have the B2C - Loyalty, B2C - Loyalty Plus, B2B - Loyalty, Loyalty Management - Growth, or Loyalty Management - Advanced license enabled |
What Does the Template Contain?
The template contains a rule and set of parameters. The Issue Voucher rule has only one rule step to issue vouchers to loyalty program members or contacts based on the input parameters. The parameters stores parameter values that the rule uses to issue vouchers.
| Rule Step Name | What Does the Rule Step Do? | Parameters used in the Step | What Does the Parameter Do? |
|---|---|---|---|
| Issue Voucher | Issues vouchers to loyalty program members or contacts based on the input parameters. | VoucherDefinitionName | The input parameter stores the name of the voucher definition. |
| VoucherCode | The input parameter stores the code of the voucher. | ||
| VoucherEffectiveDate | The input parameter stores the date when the member can start redeeming the voucher. | ||
| VoucherExpirationDate | The input parameter stores the date on which the voucher expires. | ||
| VoucherFaceValue | The input parameter stores the value of a Fixed-Value type voucher. | ||
| VoucherDiscountPercentage | The input parameter stores the discount percentage of a Discount Percentage type voucher. | ||
| Notes | The input parameter stores the comments for issuing the voucher. |
How Can You Execute the Processes Created Using the Issue Voucher Process Template?
Loyalty Management provides a Business API to execute processes created by cloning loyalty program process templates. You can integrate the external system and Loyalty Management with the Issue Voucher API by executing it as per the input parameters.
- The API is executed when you want to issue vouchers to your loyalty members and contacts.
- The voucher definition, voucher code, and other details are provided in the API request.
In the API, you must specify these values to execute the API for your cloned process:
- In the API endpoint, specify the API name of your cloned process.
- In the API request, specify the values for the parameters that are used in the Issue Voucher
rule.
You must specify the voucher definition and voucher code and other details to issue vouchers.
When you execute the API, it runs the loyalty program process and the process issues voucher using the value provided in the API request.
Example of How You Can Use the Template
You can clone and extend the template based on your requirements. Here’s a way you can use the template:
| Use Case | How to Achieve the Use Case? |
|---|---|
|
You want to define and issue vouchers from different departments of an organization. When these vouchers are managed in external systems, each department can have a specific use of vouchers. For example:
These vouchers are issued from different systems. You may want to customize the issue of vouchers. |
To issue different vouchers from different systems, you can create a separate clone of the API for each department. For example:
|