Overview

The below high level integration flow illustrates the recommended approach for integrating POS with Eagle Eye (EE). Each sub-flow is further described in this document using a consumer's shopping examples, request and response API call examples and field by field mapping guidance.

This documentation describes the below consumer journeys at POS in detail. You will learn about detailed integration flow, sample use case with request and response payloads, data changes in AIR as well as minimum recommended fields for each request.

The following flows will be documented in the future:

Fulfil
Refund
Exchange

Terminology

Visit Glossary of Terms general Eagle Eye AIR terminology. The terms described below are relevant to POS Connect:

Terminology	Description
Synchronous API call	When an application makes an API call and then waits for a response before proceeding with the next action in the flow
Asynchronous API call	When an application makes an API call and then proceeds with the next action in the flow without waiting for a response
POS	Point of Sale (POS) is a system that accepts payments and processes a transaction. This can be in a physical store aka brick and mortar aka in-lane at a till or a cash register. POS can also be a digital system used at an online aka e-commerce store.
POS Connect	APIs for integrating POS systems with Eagle Eye AIR
Check out	When a consumer is ready to pay for the items in their basket
Basket	In Eagle Eye terms, a list of items or products is known as a basket. Clients may also call this a cart in business terms.
Adjudication	The process of determining and applying any valid and active promotions, rewards, or entitlements to a consumer's transaction in real-time
Reward	For participating in a loyalty program, a consumer can receive a reward. Refer to this page to learn more about the types of rewards supported in POS Connect.
Wallet Open	A POS Connect API call made during the Adjudication flow that uses information about a transaction and responds back with basket adjudication results
Wallet Settle	A POS Connect API call made to complete a transaction so that rewards can be given to a consumer and details of a transaction can be recorded
Spend	In Eagle Eye terms, spend means to use points towards a transaction as tender. In business terms, clients may also refer to this concept as "redeeming points". Spend is a POS Connect API used to commit a number of points to be spent. Spend is also an account transaction event to describe the action of points being spent.
Spend Calculate	A POS Connect API used to validated an amount of points or monetary that a consumer would like to spend.
Spend Void	A POS Connect API used to void or undo an Active spend transaction that is not yet settled.
Fulfil	A POS Connect API used to complete an E-commerce transaction as items are fulfilled
Exchange	A POS Connect API used to exchange items that were previous purchased
Refund	A POS Connect API to process a return against a purchase transaction

High-Level Integration Flow

Use Case - A Fabulous Retailer offers Fabulous Rewards

Consider this loyalty program example that will be referenced throughout this documentation to help you identify key areas of the request and response JSON payloads for integrating the desired POS Connect API.

A Fabulous Retailer offers a very attractive loyalty program called Fabulous Rewards that allows consumers to:

Earn 10 base points for every $1.00 spent
Spend points towards purchases where 10,000 points are worth $10 and can be spent at increments of 10,000 with a maximum spend of 500,000 per transaction
Receive personalized (targeted) and mass(open) loyalty rewards such as:
- Points
- Discounts
- Coupons for future use

A Fabulous Retailer does not reward consumers for buying alcohol.