Skip to main content

Voucher Definitions

note

This feature may not appear in the Console depending on configuration.

A voucher definition establishes the template for a specific type of voucher that can be issued to members.

For example, a Free Coffee voucher versus a 20% Off Next Purchase voucher. The voucher definition must be created and configured before any vouchers of that type can be issued, specifying details such as the voucher's value, expiry rules, and redemption conditions.

Voucher definitions use a unique identifier following the same formatting as OFFER_ID: 3 to 128 alphanumeric characters and underscores only (a-z, A-Z, 0-9, _).

View or edit an existing voucher definition​

  1. Navigate to Data > Voucher Definitions. If there are multiple business units, select one.
  2. In the list on the Voucher Definitions landing page, click the voucher's definition name to view its details. You can also use the search bar to look up a voucher's name. Matching vouchers appear in the list. If no results are found, a message indicates that the voucher doesn't exist.
  3. To edit the voucher, click the ellipsis menu (⋯) and select Edit for that voucher definition.
  4. If editing, click Publish Changes to save any changes made, then Publish Changes in the confirmation window.

Create a voucher definition​

  1. Navigate to Data > Voucher Definitions, then select a business unit if applicable.

  2. On the Voucher Definitions page, click + Create Definition.

  3. On the Create Voucher Definition page, enter the Voucher Definition ID. This is a required field.

  4. Select a Business Unit — the name of the organization issuing the voucher. All available business units are shown in the dropdown list.

    note

    If you selected a business unit in step 1, it is shown (and can't be edited) in the Business Unit(s) field. If not, select the business unit in the first field if applicable. If your company doesn't use business units, this option isn't shown. If All is selected, the redemption ID applies to all available business units.

  5. Enter a Definition Name — a descriptive name that helps users understand the purpose of the voucher. Allowed characters are 3 to 128 characters: a-z, A-Z, 0-9, space, _@+-$&, and French characters. This field is required.

  6. Select a reward type. This describes the type of reward you want the voucher to apply. Options include the following:

    • Dollar Off: A dollar amount that is applied to the member's purchase when the voucher is redeemed.
    • Percent Off: A percentage reduction of the member's purchased item applied when the voucher is redeemed.
    • Fuel Discount: A discount applied to fuel purchases made by the member when they redeem the voucher.
    • Car Wash: A discount which can be used when a member visits a car wash.

  7. Enable the Item toggle in the Voucher Scope. This is enabled by default.

  8. Enter the dollar amount that will be applied to the Dollar Off reward type when the voucher is used.

  9. Enter the maximum number of items that the Percent Off reward type will apply to when the voucher is used. This option defaults to 1 item at most.

  10. In the Product Selection section, select + Add Condition to specify the attributes of the item(s) that you want to apply this voucher to. You can select as many conditions as possible.

  11. In the Expiry & Limits section, select your preferred expiry rule for the voucher. Options include the following:

    • Rolling (days from issuance): Select to expire the voucher a specific number of days after issuance. Selecting this requires you to configure the number of days from issuance until the voucher expires.
    • Fixed (specific date): Select to expire the voucher on a date you choose. Selecting this requires you to configure a fixed expiry date.
    • End of tier period: Select to expire the voucher when the member's program tier expires. Selecting this requires to to configure the voucher's value expressed in points.

  12. In the Point Value input, enter the voucher's reward value in points.

  13. In the Redemption Tier dropdown menu, Select a redemption tier for the voucher. The tier controls which vouchers appear on the CUX redemption page for members at that tier. Untagged vouchers aren't featured but remain redeemable if their point value is set.

  14. In the Sort Order field, enter the order in which the voucher appears on the CUX redemption page. If you leave this field blank, vouchers appear in order of expiry date.

  15. In the Redeemable Value field, Enter the amount of points that can be redeemed for this voucher. Leaving this field blank implies that the voucher is not available for points exchange.

  16. In the Channels section, check the boxes for the usage channels you want the vouchers to be redeemed through. Options include Point of Sale (POS) and Consumer Experience (CUX).

  17. In the Creative section, Enter the following fields for the default language which is Canadian English:

    • Short description for voucher: This is a summarized description of what the voucher is.
    • Detailed voucher description: This is a more detailed description of how the voucher works.
    • Terms and Conditions: This describes the terms and conditions of how the voucher should be used.
    • Small voucher image URL: This is a URL of a small image representing the voucher.
    • Large voucher image URL: This is a URL of a large image representing the voucher.
    • Small HD voucher image URL: This is a URL of a small image in HD representing the voucher.
    • Large HD voucher image URL: This is a URL of a large image in HD representing the voucher.

  18. In the Add Language subsection, optionally select Canadian French as a second language. If selected, complete the same fields as for Canadian English.

  19. Click Save Draft to save the voucher definition without completing all its details.

  20. Click Publish. Select Publish again when the confirmation window pops up.

Enable or disable a voucher definition​

To disable a voucher definition:

  1. Navigate to Data > Voucher Definitions, then select a business unit if applicable.
  2. In the list of voucher definitions on the Voucher Definitions page:
    • Either click the voucher definition's name, scroll down and select ... More > Disable
    • Or click the ellipsis menu (⋯) in the Actions column and select Disable.
  3. In the confirmation window that pops up, select Disable. The page loads, the voucher's status is updated to Disabled, and a confirmation message appears saying that the voucher has been disabled successfully.

To enable a voucher definition:

  1. Navigate to Data > Voucher Definitions, then select a business unit if applicable.
  2. In the list of voucher definitions on the Voucher Definitions page:
    • Either click the voucher definition's name, scroll down and select ... More > Enable
    • Or click the ellipsis menu (⋯) in the Actions column and select Enable.
  3. In the confirmation window that pops up, select Enable. The page loads, the voucher's status is updated to Published, and a confirmation message appears saying that the voucher has been enabled successfully.

Delete a voucher​

  1. Navigate to Data > Voucher Definitions, then select a business unit if applicable.
  2. In the list of voucher definitions on the Voucher Definitions page:
    • Either click the voucher definition's name, scroll down and select ... More > Delete
    • Or click the ellipsis menu (⋯) in the Actions column and select Delete.
  3. In the confirmation window that pops up, select Delete. The page loads, the voucher is deleted and a confirmation message appears saying that the voucher has been deleted successfully.
Last updated on