API concepts
This section lists the core concepts of the AiFi check-in APIs.
Customer
A customer is an entity representing a shopper registered in the AiFi system.
It represents any shopper, regardless of whether they made a purchase or just
visited a store. You must create a customer entity before the check-in. A
customer entity links different sessions and is identified by some
authentication method (a QR code in the app linked to their account or a credit
card).
or more people go together on the same trip, there is still a single customer
entity. Group shoppers all link to a single authentication method.
Session
A session or a shoppingSession is a single shopping journey, inside a
specific store, of a specific customer. A single session should always result
in a single order which is like a receipt. It's identified by a sessionId,
which is the most important identifier in all webhooks.
Entry code
An entry code, sometimes referred to as verificationCode or code, is a
globally unique identifier for a specific session. A code is just a property
of the session entity. The entry code is what you send to AiFi APIs or show to
AiFi QR readers. The entry code is non-secret, short-lived, and you can display
it if necessary.
Check-in device
A check-in device is a device inside a store that reads and transfers an entry
code into the AiFi system, matching it with a customer entity. It's typically a
QR reader or a payment terminal.