To start using the Apparel21 and eyos integration, there are a few Apparel21-specific setup tasks that you must complete. These steps ensure that your store’s POS systems can properly communicate with eyos to deliver digitised receipts to your customers.
Prerequisites
Before beginning, please ensure:
-
You are running Apparel21 version 2025.1 or later.
-
You have contacted eyos to activate your merchant account and obtain your API keys for both test and live environments.
Step 1: Decide on a Layout Schema
All entities in the eyos system are structured hierarchically:
Account > Company > Store > Device
This hierarchy determines how transactions are traced and receipts are routed.
Mapping in Apparel21:
-
Account: Provided by eyos.
-
Company: Defined by you (typically a business unit or brand).
-
Store: Each individual physical store.
-
Device: Each POS till.
You can learn more about entity structure in Understanding Entities in the eyos System.
Hierarchical Reference Format
When sending transactions to eyos, Apparel21 generates a unique identifier based on this hierarchy:
<AccountRefFromeyos>_<CompanyRefCode>_<StoreRefName>_<TillName>
Example:
From Apparel21
- Account: AP21
-
Company: Apparel21
-
Store: Highpoint
-
Till: JhonaLenovo
To eyos:
AP21_Apparel21_Highpoint_JhonaLenovo
Step 2: Provide Your Company, Store, and Till List
During onboarding, you must provide eyos with a list of:
-
Store names, codes, and contact details
-
Associated till (device) names
How to Export the Data:
-
Export Store Details
-
Go to:
Report Query Builder > New -
Select:
Data View: Retail Transaction Reporting -
Apply filters and run
-
Use:
Utilities > Exportto download the list
-
-
Export Till Information
-
Go to:
POS Monitor > Utilities > Till License Check -
Use:
Utilities > Exportto download till data
-
Apparel21 consultants will assist in formatting and submitting this to eyos.
⚠️ After go-live, keep eyos updated when adding new stores or tills to avoid disruptions.
Step 3: Input Your eyos API Key
Enable System Access
-
Contact your CRM account manager for the new security file.
-
In Workgroup Security, activate the
Allow EYOS Receiptspermission.
Configure System Parameters
Navigate to: System Parameters > Retail POS > EYOS API Settings
-
Enable API: Set “Choice” to
Yes. -
API URL: Enter the endpoint provided by eyos (test/live).
-
Layout by Warehouse Reference: Select a warehouse reference group to segment stores (typically by Company or Brand). This must match what you provided to eyos.
Enter API Keys
In the grid of warehouse reference codes:
-
Match each reference to the appropriate eyos API key. Usually this is the same API key for each.
Logic:
-
If a store is linked to an API key → eyos receipt is sent.
-
If not → a standard POS email docket is generated.
Enabling Receipt Prompting at POS
Configure: System Parameters > Retail POS > Prompt for Digital Receipt
This setting ensures store staff are prompted to offer receipts via email or SMS during checkout.
Optional Configuration: Person Marketing Consent
To pass customer marketing preferences to eyos:
-
Use system parameters to define how Apparel21 interprets marketing consent.
-
Map Person References to “Email” or “SMS” and define “Yes/No” consent values.