Offline treasure hunt
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.
The Offline treasure hunt module was introduced to equip you with a tool that encourages customers to spend time in your store and discover products they might overlook otherwise. In order to get a prize customers need to search for a code in the shop and scan it with their phone.
The configured prize is assigned to the customer when the offline_treasure_found
or the offline_treasure_code_found
API events is submitted to Antavo.
Find the configuration page of the module by searching for the ‘Offline treasure hunt’ item in the Modules menu. The page will open to the list of treasure hunts that you’ve already added with the following information:
Name of the treasure hunt
A text label below the unique ID specifies if the treasure is Active or Inactive.Points - the number of points awarded for finding the code
Number of finds - the number of times customers have found the code
Adding a new treasure hunt
Click the ‘Create new offline treasure’ button in the upper right corner of the module page
Basic information
Enter the name of the treasure hunt
Add the description of the treasure hunt
Add meta description
Provide further information if necessary.Upload an image*
Success Message
Enter the text that should be displayed on the customer’s device when they find the hidden treasure. The success message is returned in the response to theoffline_treasure_found
or theoffline_treasure_code_found
API event.
Mechanics
Select the prize
Reward - Select the reward previously added in the Rewards module.
Points - Specify the number of points you’d like to award customers for finding the treasure
Set the start and the end date
Customers can participate in the treasure hunt only in the time interval between the start and end dates.Restrict the treasure hunt to segments
By using the dropdown menu, the treasure hunt is available for specific customer segment(s) and/or list(s) only. When setting up a treasure hunt to multiple segments, only theor
operator is valid, which means that members of any of the selected segment(s) and list(s) can participate in the treasure hunt.Enter code details
You can add multiple codes by clicking the ‘Add new code +’ button.
When anoffline_treasure_code_found
API event is submitted, the prize is only added if the code provided in the event matches one of the codes added.
Points economy
Select the account to which the points awarded by the treasure hunt should be added
This configuration field is available if the Multi-accounts module is enabled in the loyalty program.
Saving and activating a new treasure hunt
After saving for the first time by clicking ‘Create’ at the bottom of the page, the status of the treasure hunt is ‘inactive’, which means it appears only in the list of treasure hunts on the module configuration page.
You can activate the treasure hunt right away using the ‘Set active’ button on the upper right-hand side of the setup page and confirm the activation in the dialog that subsequently appears.
Translate text
In case you use the Multilanguage module in your loyalty program, the ‘Translate’ buttons are available for you on the editor interface to translate texts to each language enabled. If you don’t specify custom texts, the base text will be applied to all languages.
Managing treasure hunts
Edit a treasure hunt
Navigate to the Treasures tab
Click the ‘Edit’ button of the treasure hunt that you would like to edit
Edit the treasure hunt
Save your changes by clicking on the ‘Update’ button
Deactivate a treasure hunt
Navigate to the Treasures tab
Click the ‘Edit’ button of the treasure hunt that you would like to inactivate
Click on the ‘Set inactive’ button on the upper right-hand side of the page
Confirm your choice in the dialog that appears
Archive a treasure hunt
You have the option to delete inactive treasure hunts from the Backoffice by archiving them.
Navigate to the Treasures tab
Click the ‘Edit’ button of the treasure hunt that you would like to archive
Click the ‘Archive’ button on the upper right-hand side of the page
Confirm your choice in the dialog that appears
Archiving is irreversible. Once a treasure hunt is archived, it cannot be restored anymore.
Filter treasure hunts
Filter your treasure hunts in the Backoffice by clicking the ‘Filters’ button at the top right corner of the module configuration page. Select the status(es) that you’d like to filter to and click ‘Apply’ to see the filtered list or ‘Reset’ to close the filter menu and see the entire list again.
Searching for a treasure hunt
Use the search bar to search for a specific treasure hunt name in the treasure list on the Offline treasure hunt module page.
© Copyright 2022 Antavo Ltd.