2.12.5 Commerce Release Guide - Enhanced Vouchers

To use enhanced voucher redemption the following actions need to be taken:

1. Install voucher plugin
   Installing the voucher plugin is required for the use of enhanced vouchers. When deploying, make sure the the json (plugins config with all the necessary files) is included. When configuring your vouchers make sure the plugin is enabled following the steps below. This will both allow the voucher banner to be displayed and show/enable the voucher widget on the product setup.

   1. Configuration > Local Plugins >

   2. Scroll to Group: “Aspenware Commerce” Plugin info: “Vouchers”

   3. Ensure the following plugin is installed and enabled
      
      

      Open

      

2. Add voucher banner plugin-html widget
   This plugin-html widget creates the voucher banner. Once installed and made visible admins can enable and disable the banner via the voucher banner settings in “All Settings”

   1. Nop-Templates > Plugins > Html Widgets > Manage

   2. Add New html widget

   3. Name: Voucher (this name is customizable)

   4. Select Tools dropdown and select “<> Source Code”

   5. Enter: <validate-code></validate-code>

   6. Save

   7. Select Edit (on newly added plugin)

   8. Select “Widget Zones” Tab

   9. Select Add New Record

   10. From dropdown select content_before

   11. Select “Update”

   12. Save

       1. Open

          

3. Review the voucher banner setting
   Once the plugin is installed, check that the voucher banner setting exists and use it to enable and disable the voucher banner across the site. The voucher banner will display on all pages on desktop but only on category pages (and not pdps) on mobile.

   1. Configuration > Settings > All Settings

   2. Scroll to bottom

   3. Find Setting: vouchersettings.showbanner

   4. Value: True (if you would like to show the banner)

   5. Value: False (if you would not like to show the banner)

4. Review voucher language strings

   1. Configuration > Languages > Edit

   2. Use the table below to view and modify the string resource and value by searching for the appropriate string and verifying/replacing values as desired

Set up product voucher product
To set up your voucher product set up the product as you would normally do. If you have successfully installed the voucher plugin, there will be a new widget at the bottom of your product setup page named “Vouchers” as well as a new (automatically injected) voucher attribute. To add vouchers, first retrieve the appropriate product voucher template (this should not be included on any other product). To add a voucher follow the instructions below:

a. Set up your voucher product

i. SAVE (In order to utilize the voucher widget, you must first save your product)

b. Navigate to Vouchers Dropdown

i. enter Voucher Template ID (from RTP)

ii. Select “Add Voucher Template”

1.Aspenware Commerce will validate that the voucher template is not being used on any other commerce product

iii. Save product

c. Verify that voucher attribute has been added to Attributes list
After the voucher template ID has been saved, you should find a new attribute called “Voucher ID” on your product. You should not have to alter this. However, if you would like it to appear in a different area or order you may adjust this e.g. adding [Dynamic] in the text prompt would place the voucher attribute into the dynamic component area on the pdp