Outlet List Requirements

🏷️ 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

• ✅ Perform eligibility assessments

• ⚙️ Set up data ingestion pipelines

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.

The initial list:

• Defines which outlets exist

• Shows how they are identified

• Specifies which locations may appear in transactional data

⚠️ Transactional data should only reference outlets included in this initial list.

The list should cover:

• All currently active outlets

• Recently onboarded locations that may start sending data shortly

---

✅ Required Fields

Each outlet must include:

• 🆔 A unique internal outlet ID used in your POS system

• 🏢 Establishment or business name

• 📍 Full address details: country, city, postal code, and street address

These fields are essential to uniquely identify, map, and validate each outlet.

---

💡 Recommended Fields

Optional but strongly recommended fields:

• 🌐 Latitude & longitude

• 📝 Company registration number (e.g., NID in Spain, SIRET/SIREN in France, KVK in the Netherlands)

• 🏨 Venue type (bakery, bar, café, restaurant, hotel…)

• 📅 First order date

• 📅 Last order date

These help assess outlet activity and improve coverage analysis.

---

🔑 Identifier Rules

The internal outlet ID is central to the integration:

• Must uniquely identify a single outlet

• Must remain stable over time

• Must be reused consistently in all transactional data

---

📂 Format and Delivery Options

Fyre is flexible with how the outlet list is shared:

File-Based Delivery

Most partners provide the list as a file export:

• CSV

• Excel

• JSON or other structured formats

You can use your existing export. No predefined Fyre schema is required, as long as all mandatory fields are clearly identifiable.

API-Based Access

If outlet data is already available via API:

• Fyre can fetch the list directly using read-only access

• All mandatory fields must be included

• Works well for centrally maintained and frequently updated data

If the API does not yet expose all required fields, file-based delivery can be used initially.

Optional Standardized Format

Fyre provides a standardized outlet list format as a reference:

• Optional but recommended

• Can be used for initial delivery and future updates

• Standardized outlet list (example)

  Field name	Type	Required	Explanation	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.

• Updates should be made quarterly to reflect changes in the partner network

• Updates can use the same method as the initial list (file or API)

---

✅ What Happens After Submission

After sample transactional data is submitted:

1. Fyre performs a structured review to confirm readiness

2. Checks include:

   • Structural completeness

   • Correct use of identifiers & timestamps

   • Consistency with the outlet list

   • Initial quality checks

3. Fyre shares actionable feedback if adjustments are needed

Once approved:

• Final integration model is confirmed

• API access is enabled (if applicable)

• Historical data delivery is scheduled

• Daily production data flows are activated