Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The User Manual has moved! For the most up-to-date information, please visit our new site at docs.antavo.com.
We're committed to providing you with the best resources, and our new site offers an enhanced experience with the latest documentation. Thank you for your understanding and continued support.

Table of Contents
minLevel1
maxLevel3

You can find the Coupons tab by clicking the hamburger button of a reward on the Reward management page, clicking ‘Statistics’ or 'Edit', and navigating to the Coupons tab. The page will open to the list of coupons that have been uploaded and/or assigned to customers with the following information:

...

  • Navigate to the Coupons tab on the left-hand side of the page
    Please note that the Coupons tab is available after saving the reward for the first time.

  • Click the ‘Upload’ button on the upper right-hand side of the Coupons tab
    You’ll be redirected to the coupon import page of the Imports module. You can learn more about how to use the module here.

  • Upload a CSV format file with one code in each row
    You can find the data fields that you can include in the CSV in the ‘Name’ column under the 'Fields’ section. Make sure you include the parent field with the ID of the reward that you can find at the end of the editor page URL (loyalty.{environment}.antavo.com/{brandid}/extensions/rewards˛/{rewardid}).

  • Click ‘Upload’ at the bottom of the page

  • Configure the file import as per your need and make sure the correct reward is selected in the ‘Reward' dropdown field

  • Click ‘Start import’

Right after the import is completed, coupons will appear in the list with a ‘Not claimed yet’ label.

...

Manual coupon actions

Invalidate coupons

Please note, that only coupons with ‘claimed’ and ‘unassigned’ statuses can be invalidated.

Invalidate one single coupon

...

Invalidate multiple coupons at the same time

This method is available only for coupons with ‘claimed’ status.

  • Tick the checkbox of each coupon code you’d like to invalidate

  • Click the blue ‘Invalidate selected’ button at the top of the page

  • Confirm the invalidation action in the dialog that appears

The manual invalidation action updates the status of the coupon to ‘invalid’ and if the coupon had been claimed and assigned to a customer, it triggers the registration of the Coupon invalidate event is registered on the event history of the assignee of the reward.

Transfer coupons

Please note, that only coupons with ‘claimed’ and ‘unassigned’ statuses status can be invalidatedtransferred.

Transfer coupons

  • Click the hamburger button of the coupon code

  • Click ‘Transfer’

  • Enter the ID of the customer who will receive the coupon in the ‘Target Customer ID’ field,
    and/or
    Enter the ID of the customer who will receive the coupon in the ‘Target Customer email’ field

  • Click ‘Transfer’

The manual transfer action triggers the registration of the Coupon transfer on the event history of the previous assignee and the Coupon receive event on the event history of the new assignee.

Redeem coupons

Please note, that only coupons with ‘claimed’ status can be transferredredeemed.

...

  • Tick the checkbox of each coupon code you’d like to invalidate

  • Click the blue ‘Redeem selected’ button at the top of the page

  • Confirm the invalidation action in the dialog that appears

The redemption action triggers the registration of the Coupon redeem event on the event history of the assignee and increments the number of coupon usages.

Unredeem coupons

Please note, that only coupons with ‘claimed’ ‘redeemed’ status can be redeemedunredeemed.

...

Unredeem one single coupon

...

The unredeeem action updates the status of the coupon to ‘claimed ’, triggers the registration of the Coupon unredeem event on the event history of the assignee, and reduces the number of coupon usages.Please note, that only coupons with ‘redeemed’ status can be unredeemed.