Orders
Working with orders in Menuflow
When opening a table the Menuflow platform automatically creates a new order_id. The order_id can be used to retrieve all of the order details as well as add and remove items and item modifiers.
The following calls allow you to manage orders.
Get Order
Call to retrieve the full details of an order
Get Order
GET https://api.menuflow.dev/go/order/{order_id}
Path Parameters
order_id*
integer
order_id of the order to retrieve
{
"status": 200,
"order_id": 1,
"result": {
"table": {
"table_id": 4,
"table_number": 4
},
"server": {
"staff_id": 4002,
"name": "Rajat Sharma"
},
"bill": {
"rates": {
"tax_rate": "20%",
"service": "18%"
},
"currency": "USD",
"subtotal": "37.00",
"tax": "7.40",
"service_charge": "6.66",
"total": "51.06"
},
"allergens": 0,
"no_items": 3,
"items": [
{
"order_item_id": 2,
"qty": 2,
"item_id": 8,
"item_name": "Madaline's Quesadillas",
"item_price": "17.00",
"item_modifiers": null,
"notes": ""
},
{
"order_item_id": 27,
"qty": 1,
"item_id": 69,
"item_name": "14 Oz Choice New York Steak*",
"item_price": "20.00",
"item_modifiers": [
{
"qty": 1,
"modifier": "Medium-Rare",
"price": 0
}
],
"notes": "no tomato or mushroom"
}
]
}
}Add Item
Call to add an item to an existing order
Add Item
POST https://api.menuflow.dev/go/order/{order_id}
The following is a sample JSON payload to add two items of various quantities and modifiers.
Path Parameters
order_id*
integer
order_id of the order to a
{
"status": 201,
"order_item_id": 38484
}Remove Item
Call to delete/remove an item from an existing order
Delete Item
DELETE https://api.menuflow.dev/go/order/{order_item_id}/item
Path Parameters
order_item_id*
integer
order_item_id to delete from order
{
"status": 200,
"item_id": 27,
"deleted": 1
}Delete Order
Call to delete an order, this is only possible if the order is not paid.
Delete Order
DELETE https://api.menuflow.dev/go/order/{order_id}
Path Parameters
order_id*
integer
order_id to delete
{
"status":201,
"order_id": 123
}Last updated
