🧾Get 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.

➡️ Get an order

➡️ Add a payment to an order

💡 Models

AddOrderPaymentRequest

Parameter	Type	Explanation	Mandatory
payment_intent_id	string	Id for the payment intent: identify the payment process even if still processing.	✅
amount	string	A number with 2 decimal digits, followed by a space and the ISO 4217 currency name. Can be preceded by a - sign for negative amounts. ex: 8.90 EUR | -0.05 GBP.	✅
payment_type	PaymentType	Payment provider type used.	✅
name	string	The name of the payment method.	❌
ref	string	Identifies the payment method.	❌
amount_type	PaymentAmounType	How the amount was entered by the user.	❌
items_to_pay	Array<OrderItemToPay>	Items paid.	❌
manual_additional_amount	string	For items amount type, additional amount added to all items amount.	❌
tip_charge_amount	string	Amount of the tips.	❌
transaction_id	string	Id for the payment transaction: filled once paid.	❌
updated_at	string	Updated at in ISO 8601 format.	❌

PaymentType Enum

Value	Explanation
table	Payment made using a table-based system (e.g., in a restaurant).
stripe	Payment processed through the Stripe payment gateway.
stripe_connect	Payment using Stripe Connect, often for marketplace platforms.
lyra	Payment processed through the Lyra payment gateway.
lyra_marketplace	Payment using Lyra Marketplace, for multi-vendor platforms.
lyf_cb	Payment through Lyf, using a credit card.
lyf_web	Payment through Lyf's web platform.
lyf_in_app	Payment through Lyf's in-app system.
edenred	Payment using Edenred, often for meal vouchers or employee benefits.
swile	Payment using Swile, another provider of meal vouchers and employee benefits.
adyen	Payment processed through the Adyen payment gateway.
pos	Payment made on a physical point of sale (POS) system.
none	No payment method specified.
other_cb	Payment using a credit card other than those specified (CB = Carte Bancaire, used in France).
connector_wallet	Payment made using a wallet system.
worldline	Payment processed through the Worldline payment gateway.
worldline_smart_pos	Payment made through a Worldline smart POS system.

PaymentAmountType Enum

Value	Explanation
manual	The payment amount is manually entered by the user.
items	The payment amount is based on the total of selected items.
split	The payment is split between multiple parties or methods.
full	The full amount of the transaction is paid.
none	No payment amount is specified or no payment is made.

OrderItemToPay

Parameter	Type	Explanation	Mandatory
index	number		✅
quantity	number		✅

🛒 Get an order

This route returns an order by its given id, using it you can get a detailed order and all the informations related to it.

GET https://api.fyre.app/api/v1/orders/{orderId}

HTTP headers: X-API-KEY: <your token>

Route Params⬇️

{
    orderId: string; // Order Id.
}

📤 Responses

200 - Success

Retrieved order.

Example:

{
  "channel": "printer_receipt",
  "deals": {},
  "status": "completed",
  "receipt_ref": "5B149459-C1754EFB-8C097708-D8D0C25F",
  "table_ref": "107",
  "created_at": "2022-07-21T15:44:00.000Z",
  "table_name": "107",
  "table_id": "O9HNbz92uLNNVdPzTV1r",
  "total": "61.40 EUR",
  "items": [
    {
      "sku_name": "Coca-cola 25cl",
      "sku_ref": "Coca-cola 25cl",
      "quantity": 1,
      "subtotal": "2.00 EUR",
      "price": "2.00 EUR",
      "product_name": "Coca-cola 25cl",
      "product_ref": "Coca-cola 25cl",
      "update_id": "8WjdwzvN7P2Yq3TnK7r6",
      "options": []
    },
    {
      "update_id": "8WjdwzvN7P2Yq3TnK7r6",
      "product_ref": "Orangina 25cl",
      "price": "2.00 EUR",
      "product_name": "Orangina 25cl",
      "options": [],
      "subtotal": "2.00 EUR",
      "sku_ref": "Orangina 25cl",
      "sku_name": "Orangina 25cl",
      "quantity": 1
    },
    {
      "update_id": "8WjdwzvN7P2Yq3TnK7r6",
      "options": [],
      "sku_name": "San Pellégrino 1L",
      "sku_ref": "San Pellégrino 1L",
      "product_ref": "San Pellégrino 1L",
      "product_name": "San Pellégrino 1L",
      "quantity": 1,
      "price": "2.00 EUR",
      "subtotal": "2.00 EUR"
    },
    {
      "update_id": "8WjdwzvN7P2Yq3TnK7r6",
      "quantity": 1,
      "subtotal": "6.90 EUR",
      "sku_name": "Soupe de tomates",
      "sku_ref": "Soupe de tomates",
      "price": "6.90 EUR",
      "product_name": "Soupe de tomates",
      "product_ref": "Soupe de tomates",
      "options": []
    },
    {
      "update_id": "8WjdwzvN7P2Yq3TnK7r6",
      "options": [],
      "product_name": "Millefeuille de crevett",
      "product_ref": "Millefeuille de crevett",
      "subtotal": "7.90 EUR",
      "sku_name": "Millefeuille de crevett",
      "quantity": 1,
      "sku_ref": "Millefeuille de crevett",
      "price": "7.90 EUR"
    },
    {
      "sku_name": "Poêlée de la mer",
      "update_id": "8WjdwzvN7P2Yq3TnK7r6",
      "price": "7.90 EUR",
      "sku_ref": "Poêlée de la mer",
      "options": [],
      "quantity": 1,
      "subtotal": "7.90 EUR",
      "product_ref": "Poêlée de la mer",
      "product_name": "Poêlée de la mer"
    },
    {
      "product_name": "L'assiette de Serrano",
      "product_ref": "L'assiette de Serrano",
      "sku_ref": "L'assiette de Serrano",
      "sku_name": "L'assiette de Serrano",
      "quantity": 1,
      "options": [],
      "price": "7.90 EUR",
      "update_id": "8WjdwzvN7P2Yq3TnK7r6",
      "subtotal": "7.90 EUR"
    },
    {
      "sku_name": "Huîtres n°3 par 6",
      "subtotal": "8.90 EUR",
      "sku_ref": "Huîtres n°3 par 6",
      "product_name": "Huîtres n°3 par 6",
      "quantity": 1,
      "options": [],
      "price": "8.90 EUR",
      "product_ref": "Huîtres n°3 par 6",
      "update_id": "8WjdwzvN7P2Yq3TnK7r6"
    },
    {
      "product_ref": "Tartare de saumon",
      "quantity": 1,
      "sku_name": "Tartare de saumon",
      "price": "9.90 EUR",
      "options": [],
      "update_id": "8WjdwzvN7P2Yq3TnK7r6",
      "product_name": "Tartare de saumon",
      "sku_ref": "Tartare de saumon",
      "subtotal": "9.90 EUR"
    },
    {
      "sku_name": "Café",
      "sku_ref": "Café",
      "quantity": 3,
      "subtotal": "6.00 EUR",
      "options": [],
      "product_ref": "Café",
      "product_name": "Café",
      "update_id": "8WjdwzvN7P2Yq3TnK7r6",
      "price": "6.00 EUR"
    }
  ],
  "service_type": "eat_in",
  "catalog_id": "",
  "collection_code": "8WJD",
  "display_id": "8WJD",
  "update_id": "8WjdwzvN7P2Yq3TnK7r6",
  "waiter": "Vincent V.",
  "account_id": "gigi-de-su-crjgAxJ71",
  "timezone_name": "Europe/Paris",
  "id": "8WjdwzvN7P2Yq3TnK7r6",
  "expected_time": "2022-07-21T15:44:00.000Z",
  "end_preparation_time": "2022-07-21T15:44:00.000Z",
  "location_id": "gigi-de-su-dJEkOrj0K",
  "private_ref": "5B149459-C1754EFB-8C097708-D8D0C25F"
}

401 - Unauthorized

Unauthorized.

{
  "status": 401,
  "message": "Request Authorization not found",
  "code": "AUTHORIZATION_NOT_FOUND",
  "value": ""
}

404 - Not found

Order not found.

{
  "status": 404,
  "message": "Not found",
  "code": "NOT_FOUND",
  "value": ""
}

422 - Unprocessable entity

Unprocessable entity, missing parameters.

{
  "status": 422,
  "message": "AccountId required",
  "code": "ACCOUNT_REQUIRED",
  "value": ""
}

500 - Server error

Server error.

{
  "status": 500,
  "message": "Error retrieving receipt",
  "code": "ERROR",
  "value": ""
}

📖 Route Params Example

{
    orderId: "8WjdwzvN7P2Yq3TnK7r6"
}

💳 Add a payment to an order

This route is used to add a payment to an order or to trigger a payment receipt print if there is a printer.

PUT https://api.fyre.app/api/v1/orders/{orderId}/manual-payment

HTTP headers: X-API-KEY: <your token>

Route Params⬇️

{
    orderId: string; // Order Id.
}

Payload ⬇️

{
    orderPaymentRequest: 
}

📤 Responses

200 - Success

Updated order.

{
  "channel": "printer_receipt",
  "deals": {},
  "status": "completed",
  "receipt_ref": "5B149459-C1754EFB-8C097708-D8D0C25F",
  "table_ref": "107",
  "created_at": "2022-07-21T15:44:00.000Z",
  "table_name": "107",
  "table_id": "O9HNbz92uLNNVdPzTV1r",
  "total": "61.40 EUR",
  "items": [
    {
      "sku_name": "Coca-cola 25cl",
      "sku_ref": "Coca-cola 25cl",
      "quantity": 1,
      "subtotal": "2.00 EUR",
      "price": "2.00 EUR",
      "product_name": "Coca-cola 25cl",
      "product_ref": "Coca-cola 25cl",
      "update_id": "8WjdwzvN7P2Yq3TnK7r6",
      "options": []
    },
    {
      "update_id": "8WjdwzvN7P2Yq3TnK7r6",
      "product_ref": "Orangina 25cl",
      "price": "2.00 EUR",
      "product_name": "Orangina 25cl",
      "options": [],
      "subtotal": "2.00 EUR",
      "sku_ref": "Orangina 25cl",
      "sku_name": "Orangina 25cl",
      "quantity": 1
    },
    {
      "update_id": "8WjdwzvN7P2Yq3TnK7r6",
      "options": [],
      "sku_name": "San Pellégrino 1L",
      "sku_ref": "San Pellégrino 1L",
      "product_ref": "San Pellégrino 1L",
      "product_name": "San Pellégrino 1L",
      "quantity": 1,
      "price": "2.00 EUR",
      "subtotal": "2.00 EUR"
    },
    {
      "update_id": "8WjdwzvN7P2Yq3TnK7r6",
      "quantity": 1,
      "subtotal": "6.90 EUR",
      "sku_name": "Soupe de tomates",
      "sku_ref": "Soupe de tomates",
      "price": "6.90 EUR",
      "product_name": "Soupe de tomates",
      "product_ref": "Soupe de tomates",
      "options": []
    },
    {
      "update_id": "8WjdwzvN7P2Yq3TnK7r6",
      "options": [],
      "product_name": "Millefeuille de crevett",
      "product_ref": "Millefeuille de crevett",
      "subtotal": "7.90 EUR",
      "sku_name": "Millefeuille de crevett",
      "quantity": 1,
      "sku_ref": "Millefeuille de crevett",
      "price": "7.90 EUR"
    },
    {
      "sku_name": "Poêlée de la mer",
      "update_id": "8WjdwzvN7P2Yq3TnK7r6",
      "price": "7.90 EUR",
      "sku_ref": "Poêlée de la mer",
      "options": [],
      "quantity": 1,
      "subtotal": "7.90 EUR",
      "product_ref": "Poêlée de la mer",
      "product_name": "Poêlée de la mer"
    },
    {
      "product_name": "L'assiette de Serrano",
      "product_ref": "L'assiette de Serrano",
      "sku_ref": "L'assiette de Serrano",
      "sku_name": "L'assiette de Serrano",
      "quantity": 1,
      "options": [],
      "price": "7.90 EUR",
      "update_id": "8WjdwzvN7P2Yq3TnK7r6",
      "subtotal": "7.90 EUR"
    },
    {
      "sku_name": "Huîtres n°3 par 6",
      "subtotal": "8.90 EUR",
      "sku_ref": "Huîtres n°3 par 6",
      "product_name": "Huîtres n°3 par 6",
      "quantity": 1,
      "options": [],
      "price": "8.90 EUR",
      "product_ref": "Huîtres n°3 par 6",
      "update_id": "8WjdwzvN7P2Yq3TnK7r6"
    },
    {
      "product_ref": "Tartare de saumon",
      "quantity": 1,
      "sku_name": "Tartare de saumon",
      "price": "9.90 EUR",
      "options": [],
      "update_id": "8WjdwzvN7P2Yq3TnK7r6",
      "product_name": "Tartare de saumon",
      "sku_ref": "Tartare de saumon",
      "subtotal": "9.90 EUR"
    },
    {
      "sku_name": "Café",
      "sku_ref": "Café",
      "quantity": 3,
      "subtotal": "6.00 EUR",
      "options": [],
      "product_ref": "Café",
      "product_name": "Café",
      "update_id": "8WjdwzvN7P2Yq3TnK7r6",
      "price": "6.00 EUR"
    }
  ],
  "payments": [
    {
      "payment_intent_id": "Z25UFD3eYBhrT68Ty2y1",
      "payment_type": "other_cb",
      "amount": "10.00 EUR"
    }
  ],
  "service_type": "eat_in",
  "catalog_id": "",
  "collection_code": "8WJD",
  "display_id": "8WJD",
  "update_id": "8WjdwzvN7P2Yq3TnK7r6",
  "waiter": "Vincent V.",
  "account_id": "gigi-de-su-crjgAxJ71",
  "timezone_name": "Europe/Paris",
  "id": "8WjdwzvN7P2Yq3TnK7r6",
  "expected_time": "2022-07-21T15:44:00.000Z",
  "end_preparation_time": "2022-07-21T15:44:00.000Z",
  "location_id": "gigi-de-su-dJEkOrj0K",
  "private_ref": "5B149459-C1754EFB-8C097708-D8D0C25F"
}

401 - Unauthorized

Unauthorized.

{
  "status": 401,
  "message": "Request Authorization not found",
  "code": "AUTHORIZATION_NOT_FOUND",
  "value": ""
}

404 - Order not found

Order not found.

{
  "status": 404,
  "message": "Not found",
  "code": "NOT_FOUND",
  "value": ""
}

422 - Unprocessable entity

Unprocessable entity, missing parameter.

{
  "status": 422,
  "message": "AccountId required",
  "code": "ACCOUNT_REQUIRED",
  "value": ""
}

500 - Server error

Server error.

{
  "status": 500,
  "message": "Error retrieving receipt",
  "code": "ERROR",
  "value": "
}

📖 Payload example

{
  "payment_intent_id": "Z25UFD3eYBhrT68Ty2y1",
  "payment_type": "other_cb",
  "amount": "10.00 EUR"
}