🛎️Send orders
This page provides a full description of all the routes available for handling orders. Each route is explained with its parameters, required headers, possible responses and examples of use.
Last updated
This page provides a full description of all the routes available for handling orders. Each route is explained with its parameters, required headers, possible responses and examples of use.
Last updated
| Parameter | Type | Explanation | Mandatory |
|---|---|---|---|
| Parameter | Type | Explanation | Mandatory |
|---|---|---|---|
This route is dedicated to sending orders to Fyre. It enables your orders to be integrated easily and securely directly into our system. Using this route, you can transmit the details of your orders, which will then be processed by our API.
POST https://api.fyre.app/api/v1/locations/{fyre_id}/orders
Requires permission:
orders.create
To transmit large volumes of sales data, we use CSV files.
CSV files must comply with the RFC 4180 standard format:
Field Separation: Data fields should be separated by commas.
Value Escaping: Values containing reserved characters (such as commas, double quotes, etc.) must be enclosed in double-quotes.
To optimize performance and minimize data loss, the CSV file contents should be organized as follows:
Each row represents an individual order item.
Rows must be sorted by the private_ref column to determine the start and end of each order.
Files should generally not exceed 20MB but can be smaller, depending on how you can chunk the data (e.g., daily sales, weekly sales, etc.).
POST https://api.fyre.app/api/v1/locations/{fyre_id}/orders/import
Requires permission:
orders.import
Below is a sample CSV file that follows the specified standard.
| Parameter | Type | Explanation | Mandatory |
|---|---|---|---|
| Value | Explanation |
|---|---|
| Column | Type | Explanation | Mandatory |
|---|---|---|---|
total
number
Total including discounts and charges.
✅
currency
string
Currency code ISO 4217
✅
items
See OrderItem model below
✅
private_ref
string
The ID of the order in the partner system (Must be unique)
✅
created_at
Date
Date and time when the order was created format ISO 8601
✅
subtotal
number
Total without discounts and charges.
❌
table_ref
string
ID of the table in the partner system
❌
table_name
string
Name of the table in the partner system
❌
service_type
If not provided, default value "eat_in" will be used.
❌
guest_count
number
Number of guests for the order, if not provided default value "1" will be set.
❌
ref
string
ID of the item within the order
✅
product_ref
string
Item ID in the partner system
✅
product_name
string
Item name
✅
price
number
Price of the item
✅
subtotal
number
Sum of the price of the item and its options, multiplied by the quantity
✅
quantity
number
Item quantity
✅
options
Item options
❌
category_ref
string
Category ID of the item
❌
category_name
string
Category name of the item
❌
tax_rate
number
Tax rate in percent (0 - 100)
❌
tax_price
number
Tax price for the item
❌
ref
string
ID of the option in the partner system
✅
name
string
Name of the option
✅
price
number
Price of the option
✅
quantity
number
Quantity of the option
✅
view
Menu consultation only
eat_in
Eat directly at the restaurant
collection
Order pick-up at the restaurant
delivery
Order in delivery
checkout
Payment only after eating in the restaurant
location_ref
string
Location identifier in an external system
✅
private_ref
string
Order identifier in the external system
✅
product_ref
string
Product identifier in the external system
✅
product_name
string
Product name
✅
sku_ref
string
Product variation identifier in the external system. Fallbacks to product_ref if not provided
❌
sku_name
string
Product variation name. Fallbacks to product_name if not provided
❌
category_ref
string
Category identifier in an external system
❌
category_name
string
Category name
❌
table_ref
string
Table identifier in the external system
❌
table_name
string
Table name
❌
quantity
number
Quantity of ordered items
✅
price
number
Price of individual item
✅
options_price
number
Price of options (e.g., sauces, toppings, etc.)
❌
subtotal
number
Cost of an order item including options:
(price + options_price) * quantity
✅
tax_price
number
Total tax amount for the ordered item, rounded to two decimal places.
❌
tax_rate
number
The tax rate for an ordered item is a percentage between 0 and 100.
✅
guests_count
number
Number of guests. If not provided it will default to 1
❌
created_at
string
Order creation date in ISO 8601 format, expressed in UTC.
✅
timezone
string
Timezone name in ISO-8601 format
❌