Outlet List Requirements
This page describes the required and recommended information for the outlet list shared during the preparation phase.
The outlet list is a foundational input used to configure anonymization, eligibility assessment, and data ingestion. Providing a complete and accurate list ensures faster onboarding and higher data quality once transactional data is enabled.
Initial outlet list submission
Before any transactional data is processed, a full outlet list must be shared with Fyre.
This initial list serves as the baseline for the integration. It defines which outlets exist, how they are identified, and which locations may appear in transactional data. For this reason, transactional data should only reference outlets that are included in this initial list.
The list should cover all outlets that are currently active, as well as recently onboarded locations that may start sending data shortly.
Required fields
Regardless of how the outlet list is delivered, certain information must always be available.
Each outlet must include: • A unique internal outlet ID used in your POS system • Establishment or business name • Full address details, including country, city, postal code, and street address
These elements are required to uniquely identify, map, and validate each outlet.
Recommended fields
Some additional fields are not mandatory but are strongly recommended, as they provide valuable context and improve data quality and eligibility assessment.
When available, this includes:
Latitude and longitude
Company registration number (for example NID in Spain, SIRET or SIREN in France, KVK in the Netherlands)
Venue type, such as bakery, bar, café, restaurant, or hotel
First order date
Last order date
These fields help assess how long each establishment has been active and improve coverage analysis.
Identifier rules
The internal outlet ID plays a central role in the integration.
It must uniquely identify a single outlet, remain stable over time, and be reused consistently in all transactional data.
Format and delivery options
Fyre is flexible when it comes to how the outlet list is shared.
You may provide the outlet list as a file or make it available through an API, depending on what best fits your existing setup.
File-based delivery
Most partners share the outlet list as a file export. This can be:
CSV
Excel
JSON or another structured format
You may use an export you already have in place. The file does not need to follow a predefined Fyre schema, as long as all mandatory information is present and fields can be clearly identified.
API-based access
If outlet information is already exposed via an API, Fyre can retrieve the outlet list directly, provided that all mandatory fields are available.
This approach works well when outlet data is maintained centrally and changes frequently. Fyre uses read-only access to fetch the outlet list and apply the same validation and eligibility assessment rules as with file-based delivery.
If the API does not yet expose all required fields, file-based delivery can be used initially and revisited later.
Optional standardized outlet format
To simplify onboarding, Fyre can propose a standardized outlet list format.
Using this format is optional. It is provided as a reference and can be reused for initial delivery and future updates.
Standardized outlet list (example)
ref
string
✅
A unique internal outlet ID used in your POS system
13949
name
string
✅
Official name of the venue
Le Onze
registration_number
string
❌
Company registration number (example, IRET or SIREN in France, KVK in the Netherlands)
420042376
country
string
✅
FR
city
string
✅
City where the location operates
Paris
postal_code
string
✅
Postal code of the area the location belongs to
75005
address
string
✅
Full street address of the location
11 Rue Xavier Privas
latitude
number
❌
Latitude value of the location
48.8526751
longitude
number
❌
Longitude value of the location
2.3453955
currency
string
❌
Currency used by the venue for transactions in ISO 4217 format
EUR
timezone
string
❌
Time zone in which the location operates in ISO-8601 format
Europe/Paris
first_order_date
string
❌
Date in ISO 8601 format
2022-08-01
last_order_date
string
❌
Date in ISO 8601 format
2026-01-28
Maintaining and updating the outlet list
The outlet list is not a one-time delivery.
After the initial onboarding, it should be kept up to date to reflect changes in the partner’s network. As a baseline, Fyre expects updates on a quarterly basis.
Updates can be shared using the same method as the initial list, either through updated files or via API access.
What happens after submission
Once the sample transactional data has been submitted, Fyre carries out a structured review to confirm that the data is ready to move forward.
During this review, the data is checked for structural completeness, correct use of identifiers and timestamps, and overall consistency with the previously shared outlet list. Fyre also performs initial quality checks and validates that the data can be reliably enriched and segmented.
If any adjustments are required, Fyre will share clear and actionable feedback with the partner, allowing issues to be resolved before production data is enabled.
After the sample data has been reviewed and approved, the final integration model is confirmed. Where applicable, API access is enabled, historical data delivery is scheduled, and daily production data flows are activated.
Last updated