Introduction

EagleEye is a service that validates and redeems digital promotions in real-time for the grocery, retail and hospitality industries. Aurora supports the application of discounts using the Basket Promotions and also the use of Gift Cards at the checkout (with specified payment providers).

This support article covers how EagleEye is integrated into Aurora, and what is necessary to create EagleEye promotions.

Basket Promotions

Integration Settings

EagleEye integration settings can be accessed in the Aurora Backend under the Store > Settings > Promotions > Eagle Eye Integration heading. It contains all the EagleEye Integration settings:

How to enable EagleEye Gift Cards for payment via Aurora

🚧

You should complete the set-up process described above before considering enabling the payment system in Aurora.

Once you have configure the EagleEye integration, you can tell Aurora to allow payment using the EagleEye Gift Card service via the Checkout (and New Order section in the Back-end). To do this, following the Payment Types Accepted at Checkout Support Article.

New E-gift Card Email/SMS notifications via EagleEye

With enabling of the EagleEye Integration in the Store > Settings > Promotions tab, there is a possibility to make use of the "New E-gift Card Email/SMS" notifications via EagleEye. In order to do that there are few things you need to set up.

There are two new EagleEye Integration Settings, see the table below for details:

🚧

The Email Template ID is only used when an Email notification is sent to the desired email, this template ID is not used when sending a SMS notification.

When the integration is enabled, the following Ordered Item Additional Fields will be added by Aurora automatically:

🚧

Either email address or phone number can be provided, both are not needed. If both are provided the email takes precedence.

These fields need to be added to the Front-end templates on the product detail page, in order to be able to add the data to the ordered item when adding it to the basket. Here is an example HTML to do that:

<fieldset>
    <input class="textfield" type="text" placeholder="EMAIL" name="additional_description[eagleeye_recipient_email_address]" value="">
    <input class="textfield" type="text" placeholder="PHONE" name="additional_description[eagleeye_recipient_phone_number]" value="">
    <input class="textfield" type="text" placeholder="MSG" name="additional_description[eagleeye_recipient_message]" value="">
    <input class="textfield" type="text" placeholder="TIMESTAMP" name="additional_description[eagleeye_recipient_delivery_timestamp]" value="">
</fieldset>

🚧

These fields should be added inside a <form> tag for the product addition, and the above html example of the additional fields are provided without formatting, prompts or validation, and are for demonstration purposes only.

After the product additional fields have been filled and added to the basket, these fields can't be edited. In order to change any of the values, the customer needs to remove the item from the basket and re-add it with the correct data.

EagleEye Discount Card Integration Settings

🚧

The "Enabled?", "Live?" and "Log Requests?" settings described above are shared for all of the EagleEye Integrations.

EagleEye Validation

The discount card provided by the user in the order process will be validated against EagleEye at checkout, but will NOT block the checkout process on failure, i.e. the order will proceed no matter if the provided discount card is valid or not.

The result of the call to the EagleEye redemption against a customer active EagleEye account will be stored in an order additional field as "Valid" or "Invalid" respectively. 

A successful redemption call against customers active EagleEye account, will then result with creating a transaction in the customers wallet. You can find below, a list of the information passed to EagleEye for the wallet transaction:

EagleEye Remember Discount Card Number

Whenever a logged in user provides a discount card on checkout or purchases a discount card, Aurora will remember that card number for future uses and will expose it through a smarty variable. The smarty variable will be set and ready for use the next time the user logs in. The name of the smarty variable is "loyalty_card_number" and it can be accessed through the smarty templates, as in the following example:

<p>User Discount Card: {$smarty.session.user.fields.loyalty_card_number} </p>

EagleEye Discount Card Touchpoints

📘

This section describes where and when Aurora makes contact with the EagleEye service for the purposes of managing Discount Cards, from checkout to card delivery.

Wallet ID AutoLink (at Login)

When EagleEye is enabled and a customer logs into your store Aurora will automatically link the account with any existing active EagleEye account for that email. Where customers are already linked this process will be skipped.

Discount Card retrieval (at Login)

During the customer login process the following calls may occur in an attempt to locate a Discount Card Number for the customer where Aurora does not already have one on record:

• /wallet/{walletId}/identities

Validating a Discount Card during purchase (at checkout)

During the checkout process the following calls may occur to check the validity of any discount card being provided at checkout:

• /wallet/accounts - For checking if the card number provided is attached to an active account
• /wallet/{walletId}/account/{accountId}/redeem - For registering the purchase value against the customer's active account.
• /wallet/{walletId}/transaction - For recording the successful redemption transaction on the customer's account.

Issuing a purchased Discount Card (at order fraud approval)

Once a discount card purchase is considered 'fraud approved' the following calls may occur to check the current status of a customer's accounts in EagleEye and create all the the necessary records for the purchase made:

• /wallet - For checking for existing customer wallets.
• /services/wallet - For creating wallets for customers that do not already have one.
• /wallet/{walletId}/consumer - For creating a consumer record for customers that do not already have one.
• /wallet/{walletId}/campaign/{campaignId}/account - For creating accounts for customers that do not already have one.
• /wallet/{walletId}/account/{accountId} - For updating existing accounts for customers in the event of a renewal.

EagleEye Promotions

Creating an EagleEye promotion

When the EagleEye integration is enabled, you are able to create an EagleEye Promotion in Aurora under Merchandising > Basket & Coupon Promotions > Add Promotion.

EagleEye promotions use the standard Aurora promotion framework - as such, the Creating Basket and Coupon Promotions support article can be used when creating an EagleEye promotion. The only difference is that you will need to select EagleEye Staff Rewards option as the Promotion Type when creating the promotion. Unavailable EagleEye promotion settings will then be hidden.

🚧

If the EagleEye integration is disabled, the EagleEye Staff Rewards option will not appear under the Promotion Type dropdown menu.

Pertinent settings:

🚧

It's not possible to provide a discount amount for EagleEye promotions. This is because the discount amount for EagleEye promotions comes direct from the EagleEye service, and it is controlled there.

EagleEye Promotion Flow

Basket

EagleEye promotions will be applied to the basket like any other standard Aurora promotion. This will depend on the promotion configuration:

• If a promotion has coupons configured, it will be applied when a user enters the promotion coupon
• If a promotion has no coupons configured, it will be applied automatically

When an EagleEye promotion is applied to a basket, Aurora will connect to the EagleEye service and validate the user, also checking the discounts applicable to them. If there is a discount configured for the user, the appropriate discount value and available balance will be retrieved. If the available balance covers the total cost of the order, the promotion will be applied.

If the EagleEye service cannot be connected to, the user cannot be verified by the EagleEye service, or if the user's EagleEye balance does not cover the total paid value of the order - an error message will be shown to the user.

Checkout

The standard checkout process registers the customers discounts with EagleEye as the order is placed. The process flow, on payment, is as follows:

1. The discount is redeemed with EagleEye
   1. If the discount is approved:
      1. Continue to step 2.
   2. If the discount is rejected or EagleEye cannot be contacted:
      1. Discount is removed from the basket.
      2. The basket page is shown to the user with an error message describing the issue.
      3. The error is logged to "Failed Orders" log.
2. Payment is taken:
   1. If payment succeeds:
      1. Order is stored with all discount details.
      2. Order completed page is shown.
   2. If payment fails or is rejected:
      1. EagleEye discount is refunded.
      2. The basket page is shown to the user with the usual error message pertaining to the failure of the payment.

Errors

Front-end errors

All EagleEye errors displayed to users benefit from central management with Multiple Language translations and Site Text, which allows you to customise error messages.

To customise these messages, navigate to the Content > Site text. Select Basket as the Search Page and type Error into the search field:

Available error messages will be displayed. From here, each entry can be edited.

Failed Orders

If an EagleEye error occurs during the checkout process, an error is logged in Orders > Failed Orders.

Order Refund Errors

If an EagleEye error occurs while refunding an order, the refund will not be prevented, but will continue. However a note regarding the error will be visible in the confirmation message that is subsequently shown.

Further details regarding the error will be visible under the Errors tab on the View Order page.

A manual EagleEye refund may then be necessary via the EagleEye platform.