# Orders
The payload samples (JSON samples) are just to show all possible order fields, so you might see contradicted cases e.g. closed order that has declined_at value
Also, don't rely on these samples for order calculations
# The Order Object
# Sample
"order": {
"branch": {
"id": "8d82ff0c",
"name": "Branch 01",
"name_localized": null,
"type": 1,
"latitude": null,
"longitude": null,
"phone": null,
"opening_from": "08:00",
"opening_to": "00:00",
"inventory_end_of_day_time": "00:00",
"receipt_header": null,
"receipt_footer": null,
"created_at": "2019-04-22 12:54:02",
"updated_at": "2019-10-28 15:42:50",
"deleted_at": null,
"reference": "B06"
},
"promotion": {
"id": "8da3050d",
"name": "Weekend promotion",
"name_localized": null,
"type": 1,
"from_date": "2019-05-07",
"to_date": "2019-12-03",
"from_time": 0,
"to_time": 23,
"is_sat": true,
"is_sun": true,
"is_mon": true,
"is_tue": true,
"is_wed": true,
"is_thu": true,
"is_fri": true,
"is_active": true,
"include_modifiers": true,
"target_quantity": 2,
"reward_type": 1,
"reward_quantity": 3,
"reward_amount": 3,
"maximum_discount_amount": 30,
"created_at": "2019-05-08 10:57:19",
"updated_at": "2019-11-19 09:20:49",
"deleted_at": "2019-11-19 09:20:49",
"condition_type": null,
"priority": null,
"order_types": [
1,
2,
3
]
},
"original_order": null,
"table": null,
"creator": {
"pin": "*****",
"is_owner": true,
"id": "8d82ff0c",
"name": "Cashier",
"number": null,
"email": "cashier@Restaurant.com",
"phone": "0",
"lang": "en",
"display_localized_names": false,
"email_verified": false,
"last_console_login_at": "2019-11-28 09:06:22",
"created_at": "2019-04-22 12:54:02",
"updated_at": "2019-11-28 09:06:22",
"deleted_at": null,
"last_cashier_login_at": null
},
"closer": {
"pin": "*****",
"is_owner": true,
"id": "8d82ff0c",
"name": "Cashier",
"number": null,
"email": "cashier@Restaurant.com",
"phone": "0",
"lang": "en",
"display_localized_names": false,
"email_verified": false,
"last_console_login_at": "2019-11-28 09:06:22",
"created_at": "2019-04-22 12:54:02",
"updated_at": "2019-11-28 09:06:22",
"deleted_at": null,
"last_cashier_login_at": null
},
"driver": null,
"customer": {
"id": "8d831d65",
"name": "Alin Mado",
"dial_code": 966,
"phone": "542325489",
"email": "m.steuber@ecs.net",
"gender": 1,
"birth_date": "1986-09-17",
"is_blacklisted": false,
"is_house_account_enabled": true,
"house_account_limit": 1000,
"is_loyalty_enabled": 1,
"created_at": "2019-04-22 14:18:54",
"updated_at": "2019-11-28 10:23:21",
"deleted_at": null,
"last_order_at": "2019-11-28 06:05:00",
"order_count": 79
},
"customer_address": {
"delivery_zone": {
"id": "8d86ac81",
"name": "District Naz",
"name_localized": null,
"coordinates": [
52.2156,
31.0214,
10.5646,
45.5455,
45.5565
],
"created_at": "2019-04-24 08:46:33",
"updated_at": "2019-10-30 12:30:15",
"deleted_at": null,
"reference": null
},
"id": "8d92cc27",
"name": "Work",
"description": "15688 Kohler Ceceliaville, RI 90603",
"latitude": "-26.295234",
"longitude": "4.076668",
"created_at": "2019-04-30 09:24:58",
"updated_at": "2019-05-28 09:35:02",
"deleted_at": null
},
"discount": null,
"tags": [],
"coupon": null,
"gift_card": null,
"charges": [
{
"charge": {
"id": "8e296c3d",
"name": "Service Charge",
"name_localized": null,
"type": 2,
"is_auto_applied": false,
"value": 10,
"created_at": "2019-07-14 06:26:47",
"updated_at": "2019-10-30 12:23:28",
"deleted_at": null,
"order_types": [
1,
3,
2
]
},
"taxes": [
{
"pivot": {
"amount": 0.4,
"rate": 5,
"tax_exclusive_discount_amount": null
},
"id": "8d84bebc",
"name": "VAT",
"name_localized": null,
"rate": 5,
"created_at": "2019-04-23 09:45:52",
"updated_at": "2019-04-23 09:45:52",
"deleted_at": null
}
],
"amount": 8,
"tax_exclusive_amount": 8
}
],
"payments": [
{
"user": {
"pin": "*****",
"is_owner": true,
"id": "8d82ff0c",
"name": "Cashier",
"number": null,
"email": "cashier@Restaurant.com",
"phone": "0",
"lang": "en",
"display_localized_names": false,
"email_verified": false,
"last_console_login_at": "2019-11-28 09:06:22",
"created_at": "2019-04-22 12:54:02",
"updated_at": "2019-11-28 09:06:22",
"deleted_at": null,
"last_cashier_login_at": null
},
"payment_method": {
"id": "8df57bde",
"name": "Cash",
"name_localized": null,
"type": 7,
"code": "Cash",
"auto_open_drawer": true,
"is_active": true,
"created_at": "2019-06-18 10:47:26",
"updated_at": "2019-10-08 15:03:25",
"deleted_at": null
},
"amount": 24.15,
"tendered": 25,
"tips": 0,
"business_date": "2019-11-28",
"added_at": "2019-11-28 06:07:00",
"meta": null
}
],
"products": [
{
"product": {
"category": {
"id": "8d90b7a1",
"name": "Sandwiches",
"name_localized": null,
"created_at": "2019-04-29 08:35:55",
"updated_at": "2019-04-29 08:35:55",
"deleted_at": null,
"reference": null
},
"id": "8d90b8d1",
"sku": "P002",
"barcode": "1561630164",
"name": "Tuna Sandwich",
"name_localized": null,
"description": "Desc",
"description_localized": null,
"image": "https://alwans-dev.s3.amazonaws.com/q5pk2aglz.jpg",
"is_active": true,
"is_stock_product": false,
"is_ready": true,
"pricing_method": 2,
"selling_method": 2,
"costing_method": 2,
"preparation_time": 6,
"price": 10,
"cost": null,
"calories": null,
"created_at": "2019-04-29 08:39:15",
"updated_at": "2019-11-27 07:28:27",
"deleted_at": null
},
"promotion": null,
"discount": {
"id": "8e2a01a0",
"name": "Sprint Discount",
"name_localized": null,
"qualification": 3,
"amount": 10,
"minimum_product_price": 10,
"minimum_order_price": 20,
"maximum_amount": 900,
"is_percentage": true,
"is_taxable": false,
"created_at": "2019-07-14 13:24:30",
"updated_at": "2019-10-22 12:23:18",
"deleted_at": null,
"reference": null,
"order_types": [
1,
2
]
},
"options": [
{
"modifier_option": {
"id": "8d90d06e",
"name": "Cheese Slice",
"name_localized": null,
"sku": "M002",
"is_active": true,
"costing_method": 2,
"created_at": "2019-04-29 09:45:17",
"updated_at": "2019-11-27 11:37:12",
"deleted_at": null,
"price": 4,
"cost": null,
"calories": null
},
"taxes": [
{
"pivot": {
"amount": 0.225,
"rate": 5,
"tax_exclusive_discount_amount": null
},
"id": "8d84bebc",
"name": "VAT",
"name_localized": null,
"rate": 5,
"created_at": "2019-04-23 09:45:52",
"updated_at": "2019-04-23 09:45:52",
"deleted_at": null
}
],
"quantity": 2,
"partition": 1,
"unit_price": 3,
"total_price": 12,
"total_cost": 0.362,
"tax_exclusive_unit_price": 3,
"tax_exclusive_total_price": 12,
"added_at": "2019-11-28 06:05:03",
"tax_exclusive_discount_amount": 6
}
],
"taxes": [
{
"pivot": {
"amount": 0.525,
"rate": 5,
"tax_exclusive_discount_amount": null
},
"id": "8d84bebc",
"name": "VAT",
"name_localized": null,
"rate": 5,
"created_at": "2019-04-23 09:45:52",
"updated_at": "2019-04-23 09:45:52",
"deleted_at": null
}
],
"timed_events": [
{
"id": "8df3cf21",
"name": "Always",
"name_localized": null,
"type": 1,
"value": 4,
"from_date": "2019-04-17",
"to_date": "2019-12-20",
"from_time": 0,
"to_time": 23,
"is_sat": true,
"is_sun": true,
"is_mon": true,
"is_tue": true,
"is_wed": true,
"is_thu": true,
"is_fri": true,
"is_active": true,
"created_at": "2019-06-17 14:48:36",
"updated_at": "2019-11-18 09:01:59",
"deleted_at": null,
"priority": 7,
"order_types": [
3
]
}
],
"void_reason": null,
"creator": {
"pin": "*****",
"is_owner": true,
"id": "8d82ff0c",
"name": "Cashier",
"number": null,
"email": "Cashier@Restaurant.com",
"phone": "0",
"lang": "en",
"display_localized_names": false,
"email_verified": false,
"last_console_login_at": "2019-11-28 09:06:22",
"created_at": "2019-04-22 12:54:02",
"updated_at": "2019-11-28 09:06:22",
"deleted_at": null,
"last_cashier_login_at": null
},
"voider": null,
"discount_type": 1,
"quantity": 2,
"unit_price": 14,
"discount_amount": 20,
"total_price": 20,
"total_cost": 1.932,
"tax_exclusive_discount_amount": 20,
"tax_exclusive_unit_price": 14,
"tax_exclusive_total_price": 20,
"status": 4,
"is_ingredients_wasted": 0,
"is_ingredients_returned": 0,
"delay_in_seconds": null,
"kitchen_notes": "Some Product Kitchen Notes 72725",
"added_at": "2019-11-28 06:05:00",
"closed_at": "2019-11-28 06:07:00",
"meta": null
}
],
"combos": [
{
"combo_size": {
"combo": {
"id": "8ed2588f",
"sku": "sk-0014",
"barcode": null,
"name": "Lunch Combo",
"name_localized": null,
"description": null,
"description_localized": null,
"image": null,
"is_active": true,
"is_ready": true,
"created_at": "2019-10-06 05:46:40",
"updated_at": "2019-11-27 06:56:53",
"deleted_at": null
},
"id": "8ed25ce1-2368-4bf2-9232-a45b2e2021cd",
"name": "Small",
"name_localized": null,
"created_at": "2019-10-06 05:58:45",
"updated_at": "2019-10-06 05:58:45",
"deleted_at": null
},
"products": [
{
"product": {
"category": {
"id": "8d90b7a1",
"name": "Sandwiches",
"name_localized": null,
"created_at": "2019-04-29 08:35:55",
"updated_at": "2019-04-29 08:35:55",
"deleted_at": null,
"reference": null
},
"id": "8d90b7dd",
"sku": "P001",
"barcode": null,
"name": "Burger",
"name_localized": null,
"description": null,
"description_localized": null,
"image": "https://image.com/q5pk2aglz.jpg",
"is_active": true,
"is_stock_product": false,
"is_ready": true,
"pricing_method": 2,
"selling_method": 1,
"costing_method": 1,
"preparation_time": 0,
"price": null,
"cost": 4,
"calories": null,
"created_at": "2019-04-29 08:36:35",
"updated_at": "2019-11-18 07:26:09",
"deleted_at": null
},
"promotion": null,
"discount": null,
"options": [
{
"modifier_option": {
"id": "8d90cd87",
"name": "Sugar",
"name_localized": null,
"sku": "M001",
"is_active": true,
"costing_method": 2,
"created_at": "2019-04-29 09:37:09",
"updated_at": "2019-11-18 07:24:21",
"deleted_at": null,
"price": 2,
"cost": null,
"calories": null
},
"taxes": [
{
"pivot": {
"amount": 0,
"rate": 5,
"tax_exclusive_discount_amount": null
},
"id": "8d84bebc",
"name": "VAT",
"name_localized": null,
"rate": 5,
"created_at": "2019-04-23 09:45:52",
"updated_at": "2019-04-23 09:45:52",
"deleted_at": null
}
],
"quantity": 2,
"partition": 1,
"unit_price": 0,
"total_price": 0,
"total_cost": 0,
"tax_exclusive_unit_price": null,
"tax_exclusive_total_price": null,
"added_at": null,
"tax_exclusive_discount_amount": null
}
],
"taxes": [
{
"pivot": {
"amount": 0,
"rate": 5,
"tax_exclusive_discount_amount": null
},
"id": "8d84bebc",
"name": "VAT",
"name_localized": null,
"rate": 5,
"created_at": "2019-04-23 09:45:52",
"updated_at": "2019-04-23 09:45:52",
"deleted_at": null
}
],
"timed_events": [],
"void_reason": null,
"creator": null,
"voider": null,
"discount_type": null,
"quantity": 2,
"unit_price": 0,
"discount_amount": 0,
"total_price": 0,
"total_cost": 8,
"tax_exclusive_discount_amount": null,
"tax_exclusive_unit_price": null,
"tax_exclusive_total_price": null,
"status": 4,
"is_ingredients_wasted": 0,
"is_ingredients_returned": 0,
"delay_in_seconds": null,
"kitchen_notes": "well done",
"added_at": null,
"closed_at": null,
"meta": {
"external_additional_product_info": "some info"
},
"combo_option": {
"id": "8ed25e2a",
"combo_item_id": "8ed25cff",
"name": "Burger",
"name_localized": null,
"hid": null,
"created_at": "2019-10-06 06:02:21",
"updated_at": "2019-10-06 06:02:21",
"deleted_at": null
},
"combo_size": {
"id": "8ed25ce1",
"combo_id": "8ed2588f",
"name": "Small",
"name_localized": null,
"hid": null,
"created_at": "2019-10-06 05:58:45",
"updated_at": "2019-10-06 05:58:45",
"deleted_at": null
}
},
{
"product": {
"category": {
"id": "8d9ce58b",
"name": "Salad",
"name_localized": null,
"created_at": "2019-05-05 09:54:15",
"updated_at": "2019-05-06 11:34:50",
"deleted_at": null,
"reference": null
},
"id": "8e296e10",
"sku": "P003",
"barcode": null,
"name": "Salad",
"name_localized": null,
"description": null,
"description_localized": null,
"image": "https://image.com/q5pk2aglz.jpg",
"is_active": true,
"is_stock_product": false,
"is_ready": true,
"pricing_method": 1,
"selling_method": 1,
"costing_method": 1,
"preparation_time": null,
"price": 8,
"cost": 2.2,
"calories": null,
"created_at": "2019-07-14 06:31:53",
"updated_at": "2019-11-05 09:27:36",
"deleted_at": null
},
"promotion": null,
"discount": null,
"options": [
{
"modifier_option": {
"id": "8d90d06e",
"name": "Cheese Slice",
"name_localized": null,
"sku": "M002",
"is_active": true,
"costing_method": 2,
"created_at": "2019-04-29 09:45:17",
"updated_at": "2019-11-27 11:37:12",
"deleted_at": null,
"price": 4,
"cost": null,
"calories": null
},
"taxes": [
{
"pivot": {
"amount": 0,
"rate": 5,
"tax_exclusive_discount_amount": null
},
"id": "8d84bebc",
"name": "VAT",
"name_localized": null,
"rate": 5,
"created_at": "2019-04-23 09:45:52",
"updated_at": "2019-04-23 09:45:52",
"deleted_at": null
}
],
"quantity": 2,
"partition": 1,
"unit_price": 0,
"total_price": 0,
"total_cost": 0.362,
"tax_exclusive_unit_price": null,
"tax_exclusive_total_price": null,
"added_at": null,
"tax_exclusive_discount_amount": null
}
],
"taxes": [
{
"pivot": {
"amount": 0,
"rate": 5,
"tax_exclusive_discount_amount": null
},
"id": "8d84bebc",
"name": "VAT",
"name_localized": null,
"rate": 5,
"created_at": "2019-04-23 09:45:52",
"updated_at": "2019-04-23 09:45:52",
"deleted_at": null
}
],
"timed_events": [],
"void_reason": null,
"creator": null,
"voider": null,
"discount_type": null,
"quantity": 2,
"unit_price": 0,
"discount_amount": 0,
"total_price": 0,
"total_cost": 4.4,
"tax_exclusive_discount_amount": null,
"tax_exclusive_unit_price": null,
"tax_exclusive_total_price": null,
"status": 4,
"is_ingredients_wasted": 0,
"is_ingredients_returned": 0,
"delay_in_seconds": null,
"kitchen_notes": "well done",
"added_at": null,
"closed_at": null,
"meta": {
"external_additional_product_info": "some info"
},
"combo_option": {
"id": "8ed4ca7d",
"combo_item_id": "8ed25d07",
"name": "Side Dish",
"name_localized": null,
"hid": null,
"created_at": "2019-10-07 10:56:54",
"updated_at": "2019-11-27 06:34:48",
"deleted_at": null
},
"combo_size": {
"id": "8ed25ce1",
"combo_id": "8ed2588f",
"name": "Small",
"name_localized": null,
"hid": null,
"created_at": "2019-10-06 05:58:45",
"updated_at": "2019-10-06 05:58:45",
"deleted_at": null
}
}
],
"discount_type": null,
"quantity": 2,
"returned_quantity": 0,
"discount_amount": 0
}
],
"id": "8f3d59aa",
"promotion_id": "8da3050d",
"discount_type": 1,
"reference": "00292",
"number": 1,
"type": 3,
"source": 1,
"status": 4,
"delivery_status": null,
"guests": 1,
"kitchen_notes": "Some Kitchen Notes 73664",
"customer_notes": "Some Customer Notes 83083",
"business_date": "2019-11-28",
"subtotal_price": 20,
"discount_amount": 5,
"rounding_amount": 0,
"total_price": 24.15,
"tax_exclusive_discount_amount": 5,
"delay_in_seconds": null,
"meta": {
"Ristecho": {
"device_id": "9097982a-93bc-4808-b7cf-b7bef375be89",
"kitchen_done_at": "2019-11-28 20:51:48",
"kitchen_received_at": "2019-11-28-06 20:49:22",
"decline_at": "2019-11-28 22:10:12",
"joined_orders": [
"90ef30db-ae09-4a15-8ad2-24520c52209b"
]
}
},
"opened_at": "2019-11-28 06:05:00",
"accepted_at": null,
"due_at": "2019-11-28 06:30:00",
"driver_assigned_at": null,
"dispatched_at": null,
"driver_collected_at": null,
"delivered_at": null,
"closed_at": "2019-11-28 06:07:00",
"created_at": "2019-11-28 10:23:21",
"updated_at": "2019-11-28 10:23:21"
}
}
# Attributes
| Field | Type | Rule | Description |
|---|---|---|---|
id | string | Unique id for the order | |
reference | string | nullable | Unique reference for the order |
reference_x | string | nullable | External reference for the order if exists |
app_id | string | nullable | Unique id for the cashier app the order was sent from. |
number | integer | nullable | User friendly order number (not unique) |
type | integer | The Order Type | |
source | integer | The Order Source | |
status | integer | The Order Status | |
delivery_status | integer | nullable | The Order Delivery Status |
guests | integer | Number of guests attached to the order | |
kitchen_notes | string | nullable | Kitchen related notes |
customer_notes | string | nullable | Customer related notes |
business_date | string | The business date for the order in YYYY-MM-DD | |
subtotal_price | double | Order subtotal price | |
discount_amount | double | Order discount amount | |
rounding_amount | double | Order rounding amount | |
total_price | double | Order total price | |
tax_exclusive_discount_amount | double | Discount amount without tax | |
delay_in_seconds | integer | nullable | Order delay in seconds |
discount_type | integer | The Discount Type | |
branch | object | includable | The Branch attached to the order |
table | object | nullable includable | The Table attached to the order |
creator | object | includable | The User who created the order |
closer | object | nullable includable | The User who closed the order |
original_order | object | nullable includable | The original order in case of order return, order split |
driver | object | nullable includable | The User who delivers the order |
customer | object | nullable includable | The Customer attached to the order |
customer_address | object | nullable includable | The Customer Address attached to the order |
discount | object | nullable includable | The Discount attached to the order |
coupon | object | nullable includable | The Coupon attached to the order |
payments | array | includable | List of Payments attached to the order |
charges | array | includable | List of Charges attached to the order |
taxes | array | List of Taxes attached to the order | |
gift_card | object | nullable includable | The sold Gift Card |
products | array | List of Products attached to the order | |
combos | array | includable | List of Combos attached to the order |
tags | array | includable | List of Tags attached to the order |
promotion | object | nullable includable | The Promotion attached to the order |
meta | object | nullable | Additional information related to the order |
meta.Ristecho.device_id | string | The Cashier Device that handled the order | |
meta.Ristecho.joined_orders | array | List of orders ids that have been joined to the current order | |
meta.Ristecho.kitchen_received_at | string | Time YYYY-MM-DD HH-MM-SS in UTC at which the order was received at kitchen | |
meta.Ristecho.kitchen_done_at | string | Time YYYY-MM-DD HH-MM-SS in UTC at which the order was done in kitchen | |
meta.Ristecho.decline_at | string | Time YYYY-MM-DD HH-MM-SS in UTC at which the order was declined | |
opened_at | string | nullable | Time YYYY-MM-DD HH-MM-SS in UTC at which the order was opened |
due_at | string | nullable | Time YYYY-MM-DD HH-MM-SS in UTC at which the order is due |
kitchen_received_at | string | nullable | Time YYYY-MM-DD HH-MM-SS in UTC at which the order was received at kitchen |
kitchen_done_at | string | nullable | Time YYYY-MM-DD HH-MM-SS in UTC at which the order was done in kitchen |
driver_assigned_at | string | nullable | Time YYYY-MM-DD HH-MM-SS in UTC at which the order was assigned to driver |
dispatched_at | string | nullable | Time YYYY-MM-DD HH-MM-SS in UTC at which the order was dispatched |
driver_collected_at | string | nullable | Time YYYY-MM-DD HH-MM-SS in UTC at which the order was collected by driver |
delivered_at | string | nullable | Time YYYY-MM-DD HH-MM-SS in UTC at which the order was delivered |
closed_at | string | nullable | Time YYYY-MM-DD HH-MM-SS in UTC at which the order was closed |
created_at | string | sortable | Time YYYY-MM-DD HH-MM-SS in UTC at which the order was created |
updated_at | string | sortable | Time YYYY-MM-DD HH-MM-SS in UTC at which the order was updated |
# Order Products Attributes
| Field | Type | Rule | Description |
|---|---|---|---|
products.product | object | includable | The details of the Product |
product.discount | object | includable | The details of the Discount attached to the product |
product.category | object | The category of which the product belongs to | |
products.creator | object | includable | The User who added the product |
products.voider | object | includable | The User who voided the product |
products.timed_events | array | includable | List of Timed Events attached to the product. |
products.promotion | object | includable | The Promotion attached to the product |
products.void_tag | object | The Void Tag attached to the product | |
products.taxes | array | includable | List of Taxes attached to the product |
products.options | array | includable | List of Product Options attached to product |
products.options.modifier_option | object | includable | The details of the Product Modifier Option attached to product |
products.options.taxes | array | includable | The details of the Product Modifier Option Taxes attached to produc |
discount_type | integer | The type of the Discount attached to the product | |
quantity | integer | The product ordered quantity | |
returned_quantity | integer | The returned quantity of the ordered product | |
unit_price | double | Product unit price | |
discount_amount | double | Product discount amount | |
total_price | double | Product total price | |
total_cost | double | Product total cose | |
tax_exclusive_discount_amount | double | Product discount amount without tax | |
tax_exclusive_unit_price | double | Product unit price without tax | |
tax_exclusive_total_price | double | Product total price without tax | |
status | integer | The Product Status | |
is_ingredients_wasted | boolean | True if product is returned and marked as waste | |
is_ingredients_returned | boolean | True if product is returned and not marked as waste | |
delay_in_seconds | integer | The product delay time in seconds | |
kitchen_notes | string | User entered notes for the kitchen | |
meta | object | nullable | Additional information about the products |
added_at | string | Time YYYY-MM-DD HH-MM-SS in UTC at which the product was added to the order | |
closed_at | string | Time YYYY-MM-DD HH-MM-SS in UTC at which the product was sold | |
void_reason | string | nullable | The void reason submitting when voiding this product |
# Order Products Modifiers Attributes
| Field | Type | Rule | Description |
|---|---|---|---|
modifier_option | object | The details of the Modifier Option | |
taxes | array | List of Taxes attached to the modifier option | |
quantity | integer | The modifier option ordered quantity | |
unit_price | double | The modifier option unit price | |
total_price | double | The modifier option total price | |
total_cost | double | The modifier option total cost | |
tax_exclusive_unit_price | double | The modifier option unit price without tax | |
tax_exclusive_total_price | double | The modifier option total price without tax | |
Added At | string | Time YYYY-MM-DD HH-MM-SS in UTC at which the product was added to the order |
# Order Taxes Attributes
| Field | Type | Rule | Description |
|---|---|---|---|
id | string | unique id for the tax | |
name | string | name of the tax | |
pivot.amount | double | The tax amount | |
pivot.rate | double | The tax rate. | |
tax_exclusive_discount_amount | double | Product discount amount without tax |
# Order Charges Attributes
| Field | Type | Rule | Description |
|---|---|---|---|
charges.charge | object | includable | The details of the Charge |
charges.taxes | array | includable | List of Taxes attached to the charge |
amount | double | The charge amount | |
tax_exclusive_amount | double | The charge amount without tax |
# Order Payments Attributes
| Field | Type | Rule | Description |
|---|---|---|---|
payments.payment_method | object | includable | The details of the Payment Method |
payments.user | object | includable | The User who added the payment. (null if the payment came from API) |
amount | double | The payment amount paid by the customer | |
tendered | double | The tendered amount given by the customer (change = tendered - amount). | |
tips | double | The tips amount that was added by the customer. | |
business_date | string | The business date of the payment. | |
added_at | string | The actual date of the payment. | |
meta | object | Additional information about the payment |
# Order Combos Attributes
| Field | Type | Rule | Description |
|---|---|---|---|
combos.combo_size | object | includable | The Combo Size |
combos.combo_size.combo | object | includable | The details of the combo |
combos.products | array | includable | List of combo products |
combos.products.combo_option | object | includable | The details of the product combo option |
combos.products.combo_size | object | includable | The details of the product combo size |
combos.products.product | object | includable | The details of the combo product |
combos.products.discount | object | includable | The details of the combo product discount |
combos.products.options | array | includable | The details of the combo product options |
combos.products.options.modifier_option | object | includable | The details of the combo product |
combos.products.options.taxes | array | includable | The combo products options taxes |
combos.products.taxes | array | includable | The combo products taxes |
combos.products.timed_events | array | includable | The combo products times events |
combos.products.promotion | object | includable | The combo products promotion |
combos.products.void_tag | object | The combo products void tag | |
discount | object | The details of the Discount attached to the combo | |
quantity | integer | The combo ordered quantity | |
discount_type | integer | The Discount Type | |
products | array | List of Products attached to the combo |
# Orders Types
| Type | Description |
|---|---|
1 | Dine In |
2 | Pick Up |
3 | Delivery |
4 | Drive Thru |
# Orders Sources
| Source | Description |
|---|---|
1 | Cashier |
2 | API |
3 | Call Center |
# Orders Statuses
| Status | Description |
|---|---|
1 | Pending |
2 | Active |
3 | Declined |
4 | Closed |
5 | Returned |
6 | Joined |
7 | Void |
# Orders Delivery Statuses
| Status | Description |
|---|---|
1 | sent to kitchen |
2 | ready |
3 | assigned |
4 | en route |
5 | delivered |
6 | closed |
# Products Statuses
| Status | Description |
|---|---|
1 | Pending |
2 | Active |
3 | Closed |
4 | Moved |
5 | Void |
6 | Returned |
7 | Declined |
# Discounts Types
| Type | Description |
|---|---|
1 | Open |
2 | Predefined |
3 | Coupon |
4 | Loyalty |
5 | Promotion |
# List Orders
GET /orders
# Pagination in List Orders
The API will return 50 orders per page, to handle pagination in orders, use the below approach
With each list /orders request, even if you are on first page (you didn't process any order before), add the below parameters
sort=referencefilter[reference_after]= the reference of the last order you processed at your side(put 0 if you didn't process any order before)
For example, assume the last order reference that you processed is 850
Your next request will be GET /orders?sort=reference&filter[reference_after]=850
This will return the next 50 orders after the order with reference 850, so you will get orders from reference 851 to 900
Important Note:
If you try to paginate /orders using the page parameter, you will be limited to 10 pages max, the API will stop returning orders after the 10th page
# Scope
orders.list OR orders.limited.read
# Filters
idbusiness_datedue_oncreated_onupdated_onreferencereference_afternumberbranch_idtable_idcoupon_idcreator_idcloser_iddriver_idcustomer_iddiscount_idtags.idoriginal_order_idis_aheadtypesourcestatusapp_iddelivery_statusupdated_afterbusiness_date_beforebusiness_date_aftercheck_numberhas_tagsdevice_idcustomer_noteskitchen_noteshas_terminal_payment
# Response
{
"data": [
{
"branch": {
"id": "8d82ff0c",
"name": "Branch 01",
"name_localized": "الفرع الأول",
"type": 1,
"latitude": 46.25362,
"longitude": 24.6265,
"phone": "0138100000",
"opening_from": "08:00",
"opening_to": "00:00",
"inventory_end_of_day_time": "03:00",
"receipt_header": "Welcome",
"receipt_footer": "Thank You",
"created_at": "2019-04-22 12:54:02",
"updated_at": "2019-10-28 15:42:50",
"deleted_at": null,
"reference": "B06"
},
"promotion": {
"id": "8da3050d",
"name": "Weekend promotion",
"name_localized": null,
"type": 1,
"from_date": "2019-05-07",
"to_date": "2020-12-03",
"from_time": 0,
"to_time": 23,
"is_sat": true,
"is_sun": true,
"is_mon": true,
"is_tue": true,
"is_wed": true,
"is_thu": true,
"is_fri": true,
"is_active": true,
"include_modifiers": true,
"target_quantity": 2,
"reward_type": 1,
"reward_quantity": 3,
"reward_amount": 3,
"maximum_discount_amount": 30,
"created_at": "2019-05-08 10:57:19",
"updated_at": "2019-11-19 09:20:49",
"deleted_at": "2019-11-19 09:20:49",
"condition_type": null,
"priority": null,
"order_types": [
1,
2,
3
]
},
"original_order": null,
"table": {
"section": {
"id": "901a3325",
"name": "Section 1",
"name_localized": null,
"created_at": "2020-03-17 05:13:36",
"updated_at": "2020-03-17 05:13:36",
"deleted_at": null
},
"id": "901a332a",
"name": "New Table 3",
"status": 1,
"seats": 1,
"created_at": "2020-03-17 05:13:39",
"updated_at": "2020-03-17 05:13:39",
"deleted_at": null
},
"creator": {
"pin": "*****",
"is_owner": true,
"id": "8d82ff0c",
"name": "Cashier",
"number": null,
"email": "cashier@Restaurant.com",
"phone": "0",
"lang": "en",
"display_localized_names": false,
"email_verified": false,
"last_console_login_at": "2019-11-28 09:06:22",
"created_at": "2019-04-22 12:54:02",
"updated_at": "2019-11-28 09:06:22",
"deleted_at": null,
"last_cashier_login_at": null
},
"closer": {
"pin": "*****",
"is_owner": true,
"id": "8d82ff0c",
"name": "Cashier",
"number": null,
"email": "cashier@Restaurant.com",
"phone": "0",
"lang": "en",
"display_localized_names": false,
"email_verified": false,
"last_console_login_at": "2019-11-28 09:06:22",
"created_at": "2019-04-22 12:54:02",
"updated_at": "2019-11-28 09:06:22",
"deleted_at": null,
"last_cashier_login_at": null
},
"driver": {
"pin": "*****",
"is_owner": true,
"id": "8d82ff0c",
"name": "Cashier",
"number": null,
"email": "cashier@Restaurant.com",
"phone": "0",
"lang": "en",
"display_localized_names": false,
"email_verified": false,
"last_console_login_at": "2019-11-28 09:06:22",
"created_at": "2019-04-22 12:54:02",
"updated_at": "2019-11-28 09:06:22",
"deleted_at": null,
"last_cashier_login_at": null
},
"customer": {
"id": "8d831d65",
"name": "Alin Mado",
"dial_code": 966,
"phone": "542325489",
"email": "m.steuber@ecs.net",
"gender": 1,
"birth_date": "1986-09-17",
"is_blacklisted": false,
"is_house_account_enabled": true,
"house_account_limit": 1000,
"is_loyalty_enabled": 1,
"created_at": "2019-04-22 14:18:54",
"updated_at": "2019-11-28 10:23:21",
"deleted_at": null,
"last_order_at": "2019-11-28 06:05:00",
"order_count": 79
},
"customer_address": {
"delivery_zone": {
"id": "8d86ac81",
"name": "District Naz",
"name_localized": null,
"coordinates": [
52.2156,
31.0214,
10.5646,
45.5455,
45.5565
],
"created_at": "2019-04-24 08:46:33",
"updated_at": "2019-10-30 12:30:15",
"deleted_at": null,
"reference": null
},
"id": "8d92cc27",
"name": "Work",
"description": "15688 Kohler Ceceliaville, RI 90603",
"latitude": "-26.295234",
"longitude": "4.076668",
"created_at": "2019-04-30 09:24:58",
"updated_at": "2019-05-28 09:35:02",
"deleted_at": null
},
"discount": {
"id": "8fd2819b",
"name": "Coupon Discount",
"name_localized": null,
"qualification": 2,
"amount": 5,
"minimum_product_price": null,
"minimum_order_price": null,
"maximum_amount": 25,
"is_percentage": false,
"is_taxable": true,
"order_types": [
1,
2,
3
],
"reference": "disc-03",
"created_at": "2020-02-10 13:53:23",
"updated_at": "2020-02-10 13:53:23",
"deleted_at": null
},
"tags": [
{
"id": "8f89c2df",
"type": 4,
"name": "Staff",
"name_localized": null,
"created_at": "2020-01-05 10:00:26",
"updated_at": "2020-01-05 10:00:26",
"deleted_at": null,
"pivot": {
"order_id": "90ab955a",
"tag_id": "8f89c2df"
}
}
],
"coupon": {
"id": "905cc4bc",
"name": "Weekend",
"maximum_uses": 5,
"is_active": true,
"from_date": "2020-04-18",
"to_date": "2021-05-20",
"from_time": 0,
"to_time": 0,
"is_sat": true,
"is_sun": true,
"is_mon": true,
"is_tue": true,
"is_wed": true,
"is_thu": true,
"is_fri": true,
"created_at": "2020-04-19 07:25:20",
"updated_at": "2020-05-20 10:15:58",
"deleted_at": null
},
"gift_card": {
"gift_card_product": {
"id": "8f7bf149",
"name": "100 SAR Card",
"name_localized": null,
"sku": "sk-0030",
"barcode": null,
"pricing_method": 1,
"price": 100,
"is_active": true,
"created_at": "2019-12-29 13:08:38",
"updated_at": "2019-12-29 13:08:38",
"deleted_at": null
},
"id": "90ab94e3",
"amount": 100,
"balance": 100,
"created_at": "2020-05-28 11:41:57",
"updated_at": "2020-05-28 11:41:57"
},
"charges": [
{
"charge": {
"id": "8e296c3d",
"name": "Service Charge",
"name_localized": null,
"type": 2,
"is_auto_applied": false,
"value": 10,
"created_at": "2019-07-14 06:26:47",
"updated_at": "2019-10-30 12:23:28",
"deleted_at": null,
"order_types": [
1,
3,
2
]
},
"taxes": [
{
"pivot": {
"amount": 0.4,
"rate": 5,
"tax_exclusive_discount_amount": null
},
"id": "8d84bebc",
"name": "VAT",
"name_localized": null,
"rate": 5,
"created_at": "2019-04-23 09:45:52",
"updated_at": "2019-04-23 09:45:52",
"deleted_at": null
}
],
"amount": 8,
"tax_exclusive_amount": 8
}
],
"payments": [
{
"user": {
"pin": "*****",
"is_owner": true,
"id": "8d82ff0c",
"name": "Cashier",
"number": null,
"email": "cashier@Restaurant.com",
"phone": "0",
"lang": "en",
"display_localized_names": false,
"email_verified": false,
"last_console_login_at": "2019-11-28 09:06:22",
"created_at": "2019-04-22 12:54:02",
"updated_at": "2019-11-28 09:06:22",
"deleted_at": null,
"last_cashier_login_at": null
},
"payment_method": {
"id": "8df57bde",
"name": "Cash",
"name_localized": null,
"type": 7,
"code": "Cash",
"auto_open_drawer": true,
"is_active": true,
"created_at": "2019-06-18 10:47:26",
"updated_at": "2019-10-08 15:03:25",
"deleted_at": null
},
"amount": 24.15,
"tendered": 25,
"tips": 0,
"business_date": "2019-11-28",
"added_at": "2019-11-28 06:07:00",
"meta": null
}
],
"products": [
{
"product": {
"category": {
"id": "8d90b7a1",
"name": "Sandwiches",
"name_localized": null,
"created_at": "2019-04-29 08:35:55",
"updated_at": "2019-04-29 08:35:55",
"deleted_at": null,
"reference": null
},
"id": "8d90b8d1",
"sku": "P002",
"barcode": "1561630164",
"name": "Tuna Sandwich",
"name_localized": null,
"description": "Desc",
"description_localized": null,
"image": "https://alwans-dev.s3.amazonaws.com/q5pk2aglz.jpg",
"is_active": true,
"is_stock_product": false,
"is_ready": true,
"pricing_method": 2,
"selling_method": 2,
"costing_method": 2,
"preparation_time": 6,
"price": 10,
"cost": null,
"calories": null,
"created_at": "2019-04-29 08:39:15",
"updated_at": "2019-11-27 07:28:27",
"deleted_at": null
},
"promotion": null,
"discount": {
"id": "8e2a01a0",
"name": "Sprint Discount",
"name_localized": null,
"qualification": 3,
"amount": 10,
"minimum_product_price": 10,
"minimum_order_price": 20,
"maximum_amount": 900,
"is_percentage": true,
"is_taxable": false,
"created_at": "2019-07-14 13:24:30",
"updated_at": "2019-10-22 12:23:18",
"deleted_at": null,
"reference": null,
"order_types": [
1,
2
]
},
"options": [
{
"modifier_option": {
"id": "8d90d06e",
"name": "Cheese Slice",
"name_localized": null,
"sku": "M002",
"is_active": true,
"costing_method": 2,
"created_at": "2019-04-29 09:45:17",
"updated_at": "2019-11-27 11:37:12",
"deleted_at": null,
"price": 4,
"cost": null,
"calories": null
},
"taxes": [
{
"pivot": {
"amount": 0.225,
"rate": 5,
"tax_exclusive_discount_amount": null
},
"id": "8d84bebc",
"name": "VAT",
"name_localized": null,
"rate": 5,
"created_at": "2019-04-23 09:45:52",
"updated_at": "2019-04-23 09:45:52",
"deleted_at": null
}
],
"quantity": 2,
"partition": 1,
"unit_price": 3,
"total_price": 12,
"total_cost": 0.362,
"tax_exclusive_unit_price": 3,
"tax_exclusive_total_price": 12,
"added_at": "2019-11-28 06:05:03",
"tax_exclusive_discount_amount": 6
}
],
"taxes": [
{
"pivot": {
"amount": 0.525,
"rate": 5,
"tax_exclusive_discount_amount": null
},
"id": "8d84bebc",
"name": "VAT",
"name_localized": null,
"rate": 5,
"created_at": "2019-04-23 09:45:52",
"updated_at": "2019-04-23 09:45:52",
"deleted_at": null
}
],
"timed_events": [
{
"id": "8df3cf21",
"name": "Always",
"name_localized": null,
"type": 1,
"value": 4,
"from_date": "2019-04-17",
"to_date": "2019-12-20",
"from_time": 0,
"to_time": 23,
"is_sat": true,
"is_sun": true,
"is_mon": true,
"is_tue": true,
"is_wed": true,
"is_thu": true,
"is_fri": true,
"is_active": true,
"created_at": "2019-06-17 14:48:36",
"updated_at": "2019-11-18 09:01:59",
"deleted_at": null,
"priority": 7,
"order_types": [
3
]
}
],
"void_reason": null,
"creator": {
"pin": "*****",
"is_owner": true,
"id": "8d82ff0c",
"name": "Cashier",
"number": null,
"email": "Cashier@Restaurant.com",
"phone": "0",
"lang": "en",
"display_localized_names": false,
"email_verified": false,
"last_console_login_at": "2019-11-28 09:06:22",
"created_at": "2019-04-22 12:54:02",
"updated_at": "2019-11-28 09:06:22",
"deleted_at": null,
"last_cashier_login_at": null
},
"voider": null,
"discount_type": 1,
"quantity": 2,
"unit_price": 14,
"discount_amount": 20,
"total_price": 20,
"total_cost": 1.932,
"tax_exclusive_discount_amount": 20,
"tax_exclusive_unit_price": 14,
"tax_exclusive_total_price": 20,
"status": 4,
"is_ingredients_wasted": 0,
"is_ingredients_returned": 0,
"delay_in_seconds": null,
"kitchen_notes": "Some Product Kitchen Notes 72725",
"added_at": "2019-11-28 06:05:00",
"closed_at": "2019-11-28 06:07:00",
"meta": null
}
],
"combos": [
{
"combo_size": {
"combo": {
"id": "8ed2588f",
"sku": "sk-0014",
"barcode": null,
"name": "Lunch Combo",
"name_localized": null,
"description": null,
"description_localized": null,
"image": null,
"is_active": true,
"is_ready": true,
"created_at": "2019-10-06 05:46:40",
"updated_at": "2019-11-27 06:56:53",
"deleted_at": null
},
"id": "8ed25ce1-2368-4bf2-9232-a45b2e2021cd",
"name": "Small",
"name_localized": null,
"created_at": "2019-10-06 05:58:45",
"updated_at": "2019-10-06 05:58:45",
"deleted_at": null
},
"products": [
{
"product": {
"category": {
"id": "8d90b7a1",
"name": "Sandwiches",
"name_localized": null,
"created_at": "2019-04-29 08:35:55",
"updated_at": "2019-04-29 08:35:55",
"deleted_at": null,
"reference": null
},
"id": "8d90b7dd",
"sku": "P001",
"barcode": null,
"name": "Burger",
"name_localized": null,
"description": null,
"description_localized": null,
"image": "https://image.com/q5pk2aglz.jpg",
"is_active": true,
"is_stock_product": false,
"is_ready": true,
"pricing_method": 2,
"selling_method": 1,
"costing_method": 1,
"preparation_time": 0,
"price": null,
"cost": 4,
"calories": null,
"created_at": "2019-04-29 08:36:35",
"updated_at": "2019-11-18 07:26:09",
"deleted_at": null
},
"promotion": null,
"discount": null,
"options": [
{
"modifier_option": {
"id": "8d90cd87",
"name": "Sugar",
"name_localized": null,
"sku": "M001",
"is_active": true,
"costing_method": 2,
"created_at": "2019-04-29 09:37:09",
"updated_at": "2019-11-18 07:24:21",
"deleted_at": null,
"price": 2,
"cost": null,
"calories": null
},
"taxes": [
{
"pivot": {
"amount": 0,
"rate": 5,
"tax_exclusive_discount_amount": null
},
"id": "8d84bebc",
"name": "VAT",
"name_localized": null,
"rate": 5,
"created_at": "2019-04-23 09:45:52",
"updated_at": "2019-04-23 09:45:52",
"deleted_at": null
}
],
"quantity": 2,
"partition": 1,
"unit_price": 0,
"total_price": 0,
"total_cost": 0,
"tax_exclusive_unit_price": null,
"tax_exclusive_total_price": null,
"added_at": null,
"tax_exclusive_discount_amount": null
}
],
"taxes": [
{
"pivot": {
"amount": 0,
"rate": 5,
"tax_exclusive_discount_amount": null
},
"id": "8d84bebc",
"name": "VAT",
"name_localized": null,
"rate": 5,
"created_at": "2019-04-23 09:45:52",
"updated_at": "2019-04-23 09:45:52",
"deleted_at": null
}
],
"timed_events": [],
"void_reason": null,
"creator": null,
"voider": null,
"discount_type": null,
"quantity": 2,
"unit_price": 0,
"discount_amount": 0,
"total_price": 0,
"total_cost": 8,
"tax_exclusive_discount_amount": null,
"tax_exclusive_unit_price": null,
"tax_exclusive_total_price": null,
"status": 4,
"is_ingredients_wasted": 0,
"is_ingredients_returned": 0,
"delay_in_seconds": null,
"kitchen_notes": "well done",
"added_at": null,
"closed_at": null,
"meta": {
"external_additional_product_info": "some info"
},
"combo_option": {
"id": "8ed25e2a",
"combo_item_id": "8ed25cff",
"name": "Burger",
"name_localized": null,
"created_at": "2019-10-06 06:02:21",
"updated_at": "2019-10-06 06:02:21",
"deleted_at": null
},
"combo_size": {
"id": "8ed25ce1",
"combo_id": "8ed2588f",
"name": "Small",
"name_localized": null,
"created_at": "2019-10-06 05:58:45",
"updated_at": "2019-10-06 05:58:45",
"deleted_at": null
}
},
{
"product": {
"category": {
"id": "8d9ce58b",
"name": "Salad",
"name_localized": null,
"created_at": "2019-05-05 09:54:15",
"updated_at": "2019-05-06 11:34:50",
"deleted_at": null,
"reference": null
},
"id": "8e296e10",
"sku": "P003",
"barcode": null,
"name": "Salad",
"name_localized": null,
"description": null,
"description_localized": null,
"image": "https://image.com/q5pk2aglz.jpg",
"is_active": true,
"is_stock_product": false,
"is_ready": true,
"pricing_method": 1,
"selling_method": 1,
"costing_method": 1,
"preparation_time": null,
"price": 8,
"cost": 2.2,
"calories": null,
"created_at": "2019-07-14 06:31:53",
"updated_at": "2019-11-05 09:27:36",
"deleted_at": null
},
"promotion": null,
"discount": null,
"options": [
{
"modifier_option": {
"id": "8d90d06e",
"name": "Cheese Slice",
"name_localized": null,
"sku": "M002",
"is_active": true,
"costing_method": 2,
"created_at": "2019-04-29 09:45:17",
"updated_at": "2019-11-27 11:37:12",
"deleted_at": null,
"price": 4,
"cost": null,
"calories": null
},
"taxes": [
{
"pivot": {
"amount": 0,
"rate": 5,
"tax_exclusive_discount_amount": null
},
"id": "8d84bebc",
"name": "VAT",
"name_localized": null,
"rate": 5,
"created_at": "2019-04-23 09:45:52",
"updated_at": "2019-04-23 09:45:52",
"deleted_at": null
}
],
"quantity": 2,
"partition": 1,
"unit_price": 0,
"total_price": 0,
"total_cost": 0.362,
"tax_exclusive_unit_price": null,
"tax_exclusive_total_price": null,
"added_at": null,
"tax_exclusive_discount_amount": null
}
],
"taxes": [
{
"pivot": {
"amount": 0,
"rate": 5,
"tax_exclusive_discount_amount": null
},
"id": "8d84bebc",
"name": "VAT",
"name_localized": null,
"rate": 5,
"created_at": "2019-04-23 09:45:52",
"updated_at": "2019-04-23 09:45:52",
"deleted_at": null
}
],
"timed_events": [],
"void_reason": null,
"creator": null,
"voider": null,
"discount_type": null,
"quantity": 2,
"unit_price": 0,
"discount_amount": 0,
"total_price": 0,
"total_cost": 4.4,
"tax_exclusive_discount_amount": null,
"tax_exclusive_unit_price": null,
"tax_exclusive_total_price": null,
"status": 4,
"is_ingredients_wasted": 0,
"is_ingredients_returned": 0,
"delay_in_seconds": null,
"kitchen_notes": "well done",
"added_at": null,
"closed_at": null,
"meta": {
"external_additional_product_info": "some info"
},
"combo_option": {
"id": "8ed4ca7d",
"combo_item_id": "8ed25d07",
"name": "Side Dish",
"name_localized": null,
"created_at": "2019-10-07 10:56:54",
"updated_at": "2019-11-27 06:34:48",
"deleted_at": null
},
"combo_size": {
"id": "8ed25ce1",
"combo_id": "8ed2588f",
"name": "Small",
"created_at": "2019-10-06 05:58:45",
"updated_at": "2019-10-06 05:58:45",
"deleted_at": null
}
}
],
"discount_type": null,
"quantity": 2,
"returned_quantity": 0,
"discount_amount": 0
}
],
"id": "8f3d59aa",
"promotion_id": "8da3050d",
"discount_type": 1,
"reference": "00292",
"number": 1,
"type": 3,
"source": 1,
"status": 4,
"delivery_status": 2,
"guests": 1,
"kitchen_notes": "Some Kitchen Notes 73664",
"customer_notes": "Some Customer Notes 83083",
"business_date": "2019-11-28",
"subtotal_price": 20,
"discount_amount": 5,
"rounding_amount": 0,
"total_price": 24.15,
"tax_exclusive_discount_amount": 5,
"delay_in_seconds": null,
"meta": {
"Ristecho": {
"device_id": "9097982a-93bc-4808-b7cf-b7bef375be89",
"kitchen_done_at": "2019-11-28 20:51:48",
"kitchen_received_at": "2019-11-28-06 20:49:22",
"decline_at": "2019-11-28 22:10:12",
"joined_orders": [
"90ef30db-ae09-4a15-8ad2-24520c52209b"
]
}
},
"opened_at": "2019-11-28 05:21:00",
"accepted_at": null,
"due_at": "2019-11-28 06:30:00",
"driver_assigned_at": "2019-11-28 05:30:00",
"dispatched_at": "2019-11-28 05:36:00",
"driver_collected_at": "2019-11-28 05:42:00",
"delivered_at": "2019-11-28 06:04:00",
"closed_at": "2019-11-28 06:07:00",
"created_at": "2019-11-28 05:23:21",
"updated_at": "2019-11-28 06:07:00"
}
]
}
# Get Order
GET /orders/{orderId}
# Scope
orders.limited.get
# Response
{
"branch": {
"id": "8d82ff0c",
"name": "Branch 01",
"name_localized": "الفرع الأول",
"type": 1,
"latitude": 46.25362,
"longitude": 24.6265,
"phone": "0138100000",
"opening_from": "08:00",
"opening_to": "00:00",
"inventory_end_of_day_time": "03:00",
"receipt_header": "Welcome",
"receipt_footer": "Thank You",
"created_at": "2019-04-22 12:54:02",
"updated_at": "2019-10-28 15:42:50",
"deleted_at": null,
"reference": "B06"
},
"promotion": {
"id": "8da3050d",
"name": "Weekend promotion",
"name_localized": null,
"type": 1,
"from_date": "2019-05-07",
"to_date": "2020-12-03",
"from_time": 0,
"to_time": 23,
"is_sat": true,
"is_sun": true,
"is_mon": true,
"is_tue": true,
"is_wed": true,
"is_thu": true,
"is_fri": true,
"is_active": true,
"include_modifiers": true,
"target_quantity": 2,
"reward_type": 1,
"reward_quantity": 3,
"reward_amount": 3,
"maximum_discount_amount": 30,
"created_at": "2019-05-08 10:57:19",
"updated_at": "2019-11-19 09:20:49",
"deleted_at": "2019-11-19 09:20:49",
"condition_type": null,
"priority": null,
"order_types": [
1,
2,
3
]
},
"original_order": null,
"table": {
"section": {
"id": "901a3325",
"name": "Section 1",
"name_localized": null,
"created_at": "2020-03-17 05:13:36",
"updated_at": "2020-03-17 05:13:36",
"deleted_at": null
},
"id": "901a332a",
"name": "New Table 3",
"status": 1,
"seats": 1,
"created_at": "2020-03-17 05:13:39",
"updated_at": "2020-03-17 05:13:39",
"deleted_at": null
},
"creator": {
"pin": "*****",
"is_owner": true,
"id": "8d82ff0c",
"name": "Cashier",
"number": null,
"email": "cashier@Restaurant.com",
"phone": "0",
"lang": "en",
"display_localized_names": false,
"email_verified": false,
"last_console_login_at": "2019-11-28 09:06:22",
"created_at": "2019-04-22 12:54:02",
"updated_at": "2019-11-28 09:06:22",
"deleted_at": null,
"last_cashier_login_at": null
},
"closer": {
"pin": "*****",
"is_owner": true,
"id": "8d82ff0c",
"name": "Cashier",
"number": null,
"email": "cashier@Restaurant.com",
"phone": "0",
"lang": "en",
"display_localized_names": false,
"email_verified": false,
"last_console_login_at": "2019-11-28 09:06:22",
"created_at": "2019-04-22 12:54:02",
"updated_at": "2019-11-28 09:06:22",
"deleted_at": null,
"last_cashier_login_at": null
},
"driver": {
"pin": "*****",
"is_owner": true,
"id": "8d82ff0c",
"name": "Cashier",
"number": null,
"email": "cashier@Restaurant.com",
"phone": "0",
"lang": "en",
"display_localized_names": false,
"email_verified": false,
"last_console_login_at": "2019-11-28 09:06:22",
"created_at": "2019-04-22 12:54:02",
"updated_at": "2019-11-28 09:06:22",
"deleted_at": null,
"last_cashier_login_at": null
},
"customer": {
"id": "8d831d65",
"name": "Alin Mado",
"dial_code": 966,
"phone": "542325489",
"email": "m.steuber@ecs.net",
"gender": 1,
"birth_date": "1986-09-17",
"is_blacklisted": false,
"is_house_account_enabled": true,
"house_account_limit": 1000,
"is_loyalty_enabled": 1,
"created_at": "2019-04-22 14:18:54",
"updated_at": "2019-11-28 10:23:21",
"deleted_at": null,
"last_order_at": "2019-11-28 06:05:00",
"order_count": 79
},
"customer_address": {
"delivery_zone": {
"id": "8d86ac81",
"name": "District Naz",
"name_localized": null,
"coordinates": [
52.2156,
31.0214,
10.5646,
45.5455,
45.5565
],
"created_at": "2019-04-24 08:46:33",
"updated_at": "2019-10-30 12:30:15",
"deleted_at": null,
"reference": null
},
"id": "8d92cc27",
"name": "Work",
"description": "15688 Kohler Ceceliaville, RI 90603",
"latitude": "-26.295234",
"longitude": "4.076668",
"created_at": "2019-04-30 09:24:58",
"updated_at": "2019-05-28 09:35:02",
"deleted_at": null
},
"discount": {
"id": "8fd2819b",
"name": "Coupon Discount",
"name_localized": null,
"qualification": 2,
"amount": 5,
"minimum_product_price": null,
"minimum_order_price": null,
"maximum_amount": 25,
"is_percentage": false,
"is_taxable": true,
"order_types": [
1,
2,
3
],
"reference": "disc-03",
"created_at": "2020-02-10 13:53:23",
"updated_at": "2020-02-10 13:53:23",
"deleted_at": null
},
"tags": [
{
"id": "8f89c2df",
"type": 4,
"name": "Staff",
"name_localized": null,
"created_at": "2020-01-05 10:00:26",
"updated_at": "2020-01-05 10:00:26",
"deleted_at": null,
"pivot": {
"order_id": "90ab955a",
"tag_id": "8f89c2df"
}
}
],
"coupon": {
"id": "905cc4bc",
"name": "Weekend",
"maximum_uses": 5,
"is_active": true,
"from_date": "2020-04-18",
"to_date": "2021-05-20",
"from_time": 0,
"to_time": 0,
"is_sat": true,
"is_sun": true,
"is_mon": true,
"is_tue": true,
"is_wed": true,
"is_thu": true,
"is_fri": true,
"created_at": "2020-04-19 07:25:20",
"updated_at": "2020-05-20 10:15:58",
"deleted_at": null
},
"gift_card": {
"gift_card_product": {
"id": "8f7bf149",
"name": "100 SAR Card",
"name_localized": null,
"sku": "sk-0030",
"barcode": null,
"pricing_method": 1,
"price": 100,
"is_active": true,
"created_at": "2019-12-29 13:08:38",
"updated_at": "2019-12-29 13:08:38",
"deleted_at": null
},
"id": "90ab94e3",
"amount": 100,
"balance": 100,
"created_at": "2020-05-28 11:41:57",
"updated_at": "2020-05-28 11:41:57"
},
"charges": [
{
"charge": {
"id": "8e296c3d",
"name": "Service Charge",
"name_localized": null,
"type": 2,
"is_auto_applied": false,
"value": 10,
"created_at": "2019-07-14 06:26:47",
"updated_at": "2019-10-30 12:23:28",
"deleted_at": null,
"order_types": [
1,
3,
2
]
},
"taxes": [
{
"pivot": {
"amount": 0.4,
"rate": 5,
"tax_exclusive_discount_amount": null
},
"id": "8d84bebc",
"name": "VAT",
"name_localized": null,
"rate": 5,
"created_at": "2019-04-23 09:45:52",
"updated_at": "2019-04-23 09:45:52",
"deleted_at": null
}
],
"amount": 8,
"tax_exclusive_amount": 8
}
],
"payments": [
{
"user": {
"pin": "*****",
"is_owner": true,
"id": "8d82ff0c",
"name": "Cashier",
"number": null,
"email": "cashier@Restaurant.com",
"phone": "0",
"lang": "en",
"display_localized_names": false,
"email_verified": false,
"last_console_login_at": "2019-11-28 09:06:22",
"created_at": "2019-04-22 12:54:02",
"updated_at": "2019-11-28 09:06:22",
"deleted_at": null,
"last_cashier_login_at": null
},
"payment_method": {
"id": "8df57bde",
"name": "Cash",
"name_localized": null,
"type": 7,
"code": "Cash",
"auto_open_drawer": true,
"is_active": true,
"created_at": "2019-06-18 10:47:26",
"updated_at": "2019-10-08 15:03:25",
"deleted_at": null
},
"amount": 24.15,
"tendered": 25,
"tips": 0,
"business_date": "2019-11-28",
"added_at": "2019-11-28 06:07:00",
"meta": null
}
],
"products": [
{
"product": {
"category": {
"id": "8d90b7a1",
"name": "Sandwiches",
"name_localized": null,
"created_at": "2019-04-29 08:35:55",
"updated_at": "2019-04-29 08:35:55",
"deleted_at": null,
"reference": null
},
"id": "8d90b8d1",
"sku": "P002",
"barcode": "1561630164",
"name": "Tuna Sandwich",
"name_localized": null,
"description": "Desc",
"description_localized": null,
"image": "https://alwans-dev.s3.amazonaws.com/q5pk2aglz.jpg",
"is_active": true,
"is_stock_product": false,
"is_ready": true,
"pricing_method": 2,
"selling_method": 2,
"costing_method": 2,
"preparation_time": 6,
"price": 10,
"cost": null,
"calories": null,
"created_at": "2019-04-29 08:39:15",
"updated_at": "2019-11-27 07:28:27",
"deleted_at": null
},
"promotion": null,
"discount": {
"id": "8e2a01a0",
"name": "Sprint Discount",
"name_localized": null,
"qualification": 3,
"amount": 10,
"minimum_product_price": 10,
"minimum_order_price": 20,
"maximum_amount": 900,
"is_percentage": true,
"is_taxable": false,
"created_at": "2019-07-14 13:24:30",
"updated_at": "2019-10-22 12:23:18",
"deleted_at": null,
"reference": null,
"order_types": [
1,
2
]
},
"options": [
{
"modifier_option": {
"id": "8d90d06e",
"name": "Cheese Slice",
"name_localized": null,
"sku": "M002",
"is_active": true,
"costing_method": 2,
"created_at": "2019-04-29 09:45:17",
"updated_at": "2019-11-27 11:37:12",
"deleted_at": null,
"price": 4,
"cost": null,
"calories": null
},
"taxes": [
{
"pivot": {
"amount": 0.225,
"rate": 5,
"tax_exclusive_discount_amount": null
},
"id": "8d84bebc",
"name": "VAT",
"name_localized": null,
"rate": 5,
"created_at": "2019-04-23 09:45:52",
"updated_at": "2019-04-23 09:45:52",
"deleted_at": null
}
],
"quantity": 2,
"partition": 1,
"unit_price": 3,
"total_price": 12,
"total_cost": 0.362,
"tax_exclusive_unit_price": 3,
"tax_exclusive_total_price": 12,
"added_at": "2019-11-28 06:05:03",
"tax_exclusive_discount_amount": 6
}
],
"taxes": [
{
"pivot": {
"amount": 0.525,
"rate": 5,
"tax_exclusive_discount_amount": null
},
"id": "8d84bebc",
"name": "VAT",
"name_localized": null,
"rate": 5,
"created_at": "2019-04-23 09:45:52",
"updated_at": "2019-04-23 09:45:52",
"deleted_at": null
}
],
"timed_events": [
{
"id": "8df3cf21",
"name": "Always",
"name_localized": null,
"type": 1,
"value": 4,
"from_date": "2019-04-17",
"to_date": "2019-12-20",
"from_time": 0,
"to_time": 23,
"is_sat": true,
"is_sun": true,
"is_mon": true,
"is_tue": true,
"is_wed": true,
"is_thu": true,
"is_fri": true,
"is_active": true,
"created_at": "2019-06-17 14:48:36",
"updated_at": "2019-11-18 09:01:59",
"deleted_at": null,
"priority": 7,
"order_types": [
3
]
}
],
"void_reason": null,
"creator": {
"pin": "*****",
"is_owner": true,
"id": "8d82ff0c",
"name": "Cashier",
"number": null,
"email": "Cashier@Restaurant.com",
"phone": "0",
"lang": "en",
"display_localized_names": false,
"email_verified": false,
"last_console_login_at": "2019-11-28 09:06:22",
"created_at": "2019-04-22 12:54:02",
"updated_at": "2019-11-28 09:06:22",
"deleted_at": null,
"last_cashier_login_at": null
},
"voider": null,
"discount_type": 1,
"quantity": 2,
"unit_price": 14,
"discount_amount": 20,
"total_price": 20,
"total_cost": 1.932,
"tax_exclusive_discount_amount": 20,
"tax_exclusive_unit_price": 14,
"tax_exclusive_total_price": 20,
"status": 4,
"is_ingredients_wasted": 0,
"is_ingredients_returned": 0,
"delay_in_seconds": null,
"kitchen_notes": "Some Product Kitchen Notes 72725",
"added_at": "2019-11-28 06:05:00",
"closed_at": "2019-11-28 06:07:00",
"meta": null
}
],
"combos": [
{
"combo_size": {
"combo": {
"id": "8ed2588f",
"sku": "sk-0014",
"barcode": null,
"name": "Lunch Combo",
"name_localized": null,
"description": null,
"description_localized": null,
"image": null,
"is_active": true,
"is_ready": true,
"created_at": "2019-10-06 05:46:40",
"updated_at": "2019-11-27 06:56:53",
"deleted_at": null
},
"id": "8ed25ce1-2368-4bf2-9232-a45b2e2021cd",
"name": "Small",
"name_localized": null,
"created_at": "2019-10-06 05:58:45",
"updated_at": "2019-10-06 05:58:45",
"deleted_at": null
},
"products": [
{
"product": {
"category": {
"id": "8d90b7a1",
"name": "Sandwiches",
"name_localized": null,
"created_at": "2019-04-29 08:35:55",
"updated_at": "2019-04-29 08:35:55",
"deleted_at": null,
"reference": null
},
"id": "8d90b7dd",
"sku": "P001",
"barcode": null,
"name": "Burger",
"name_localized": null,
"description": null,
"description_localized": null,
"image": "https://image.com/q5pk2aglz.jpg",
"is_active": true,
"is_stock_product": false,
"is_ready": true,
"pricing_method": 2,
"selling_method": 1,
"costing_method": 1,
"preparation_time": 0,
"price": null,
"cost": 4,
"calories": null,
"created_at": "2019-04-29 08:36:35",
"updated_at": "2019-11-18 07:26:09",
"deleted_at": null
},
"promotion": null,
"discount": null,
"options": [
{
"modifier_option": {
"id": "8d90cd87",
"name": "Sugar",
"name_localized": null,
"sku": "M001",
"is_active": true,
"costing_method": 2,
"created_at": "2019-04-29 09:37:09",
"updated_at": "2019-11-18 07:24:21",
"deleted_at": null,
"price": 2,
"cost": null,
"calories": null
},
"taxes": [
{
"pivot": {
"amount": 0,
"rate": 5,
"tax_exclusive_discount_amount": null
},
"id": "8d84bebc",
"name": "VAT",
"name_localized": null,
"rate": 5,
"created_at": "2019-04-23 09:45:52",
"updated_at": "2019-04-23 09:45:52",
"deleted_at": null
}
],
"quantity": 2,
"partition": 1,
"unit_price": 0,
"total_price": 0,
"total_cost": 0,
"tax_exclusive_unit_price": null,
"tax_exclusive_total_price": null,
"added_at": null,
"tax_exclusive_discount_amount": null
}
],
"taxes": [
{
"pivot": {
"amount": 0,
"rate": 5,
"tax_exclusive_discount_amount": null
},
"id": "8d84bebc",
"name": "VAT",
"name_localized": null,
"rate": 5,
"created_at": "2019-04-23 09:45:52",
"updated_at": "2019-04-23 09:45:52",
"deleted_at": null
}
],
"timed_events": [],
"void_reason": null,
"creator": null,
"voider": null,
"discount_type": null,
"quantity": 2,
"unit_price": 0,
"discount_amount": 0,
"total_price": 0,
"total_cost": 8,
"tax_exclusive_discount_amount": null,
"tax_exclusive_unit_price": null,
"tax_exclusive_total_price": null,
"status": 4,
"is_ingredients_wasted": 0,
"is_ingredients_returned": 0,
"delay_in_seconds": null,
"kitchen_notes": "well done",
"added_at": null,
"closed_at": null,
"meta": {
"external_additional_product_info": "some info"
},
"combo_option": {
"id": "8ed25e2a",
"combo_item_id": "8ed25cff",
"name": "Burger",
"name_localized": null,
"created_at": "2019-10-06 06:02:21",
"updated_at": "2019-10-06 06:02:21",
"deleted_at": null
},
"combo_size": {
"id": "8ed25ce1",
"combo_id": "8ed2588f",
"name": "Small",
"name_localized": null,
"created_at": "2019-10-06 05:58:45",
"updated_at": "2019-10-06 05:58:45",
"deleted_at": null
}
},
{
"product": {
"category": {
"id": "8d9ce58b",
"name": "Salad",
"name_localized": null,
"created_at": "2019-05-05 09:54:15",
"updated_at": "2019-05-06 11:34:50",
"deleted_at": null,
"reference": null
},
"id": "8e296e10",
"sku": "P003",
"barcode": null,
"name": "Salad",
"name_localized": null,
"description": null,
"description_localized": null,
"image": "https://image.com/q5pk2aglz.jpg",
"is_active": true,
"is_stock_product": false,
"is_ready": true,
"pricing_method": 1,
"selling_method": 1,
"costing_method": 1,
"preparation_time": null,
"price": 8,
"cost": 2.2,
"calories": null,
"created_at": "2019-07-14 06:31:53",
"updated_at": "2019-11-05 09:27:36",
"deleted_at": null
},
"promotion": null,
"discount": null,
"options": [
{
"modifier_option": {
"id": "8d90d06e",
"name": "Cheese Slice",
"name_localized": null,
"sku": "M002",
"is_active": true,
"costing_method": 2,
"created_at": "2019-04-29 09:45:17",
"updated_at": "2019-11-27 11:37:12",
"deleted_at": null,
"price": 4,
"cost": null,
"calories": null
},
"taxes": [
{
"pivot": {
"amount": 0,
"rate": 5,
"tax_exclusive_discount_amount": null
},
"id": "8d84bebc",
"name": "VAT",
"name_localized": null,
"rate": 5,
"created_at": "2019-04-23 09:45:52",
"updated_at": "2019-04-23 09:45:52",
"deleted_at": null
}
],
"quantity": 2,
"partition": 1,
"unit_price": 0,
"total_price": 0,
"total_cost": 0.362,
"tax_exclusive_unit_price": null,
"tax_exclusive_total_price": null,
"added_at": null,
"tax_exclusive_discount_amount": null
}
],
"taxes": [
{
"pivot": {
"amount": 0,
"rate": 5,
"tax_exclusive_discount_amount": null
},
"id": "8d84bebc",
"name": "VAT",
"name_localized": null,
"rate": 5,
"created_at": "2019-04-23 09:45:52",
"updated_at": "2019-04-23 09:45:52",
"deleted_at": null
}
],
"timed_events": [],
"void_reason": null,
"creator": null,
"voider": null,
"discount_type": null,
"quantity": 2,
"unit_price": 0,
"discount_amount": 0,
"total_price": 0,
"total_cost": 4.4,
"tax_exclusive_discount_amount": null,
"tax_exclusive_unit_price": null,
"tax_exclusive_total_price": null,
"status": 4,
"is_ingredients_wasted": 0,
"is_ingredients_returned": 0,
"delay_in_seconds": null,
"kitchen_notes": "well done",
"added_at": null,
"closed_at": null,
"meta": {
"external_additional_product_info": "some info"
},
"combo_option": {
"id": "8ed4ca7d",
"combo_item_id": "8ed25d07",
"name": "Side Dish",
"name_localized": null,
"created_at": "2019-10-07 10:56:54",
"updated_at": "2019-11-27 06:34:48",
"deleted_at": null
},
"combo_size": {
"id": "8ed25ce1",
"combo_id": "8ed2588f",
"name": "Small",
"created_at": "2019-10-06 05:58:45",
"updated_at": "2019-10-06 05:58:45",
"deleted_at": null
}
}
],
"discount_type": null,
"quantity": 2,
"returned_quantity": 0,
"discount_amount": 0
}
],
"id": "8f3d59aa",
"promotion_id": "8da3050d",
"discount_type": 1,
"reference": "00292",
"number": 1,
"type": 3,
"source": 1,
"status": 4,
"delivery_status": 2,
"guests": 1,
"kitchen_notes": "Some Kitchen Notes 73664",
"customer_notes": "Some Customer Notes 83083",
"business_date": "2019-11-28",
"subtotal_price": 20,
"discount_amount": 5,
"rounding_amount": 0,
"total_price": 24.15,
"tax_exclusive_discount_amount": 5,
"delay_in_seconds": null,
"meta": {
"Ristecho": {
"device_id": "9097982a-93bc-4808-b7cf-b7bef375be89",
"kitchen_done_at": "2019-11-28 20:51:48",
"kitchen_received_at": "2019-11-28-06 20:49:22",
"decline_at": "2019-11-28 22:10:12",
"joined_orders": [
"90ef30db-ae09-4a15-8ad2-24520c52209b"
]
}
},
"opened_at": "2019-11-28 05:21:00",
"accepted_at": null,
"due_at": "2019-11-28 06:30:00",
"driver_assigned_at": "2019-11-28 05:30:00",
"dispatched_at": "2019-11-28 05:36:00",
"driver_collected_at": "2019-11-28 05:42:00",
"delivered_at": "2019-11-28 06:04:00",
"closed_at": "2019-11-28 06:07:00",
"created_at": "2019-11-28 05:23:21",
"updated_at": "2019-11-28 06:07:00"
}
# Create Order
POST /orders
# Scope
orders.limited.create
# Request
{
"guests": 3,
"type": 1,
"branch_id": "8f7ab00a",
"discount_type": 2,
"discount_id": "8f7b8e43",
"discount_amount": 5,
"kitchen_notes": "well done",
"due_at": "2019-07-31 15:50:00",
"table_id": "901a332a",
"customer_notes": "some customer related notes",
"driver_id": "8f7aafee",
"customer_address_id": "8fb30326",
"customer_id": "8f89a6ad",
"meta": {
"3rd_party_order_number": "120153"
},
"charges": [
{
"charge_id": "8f98de52",
"amount": 5,
"tax_exclusive_amount": 5,
"taxes": [
{
"id": "8f7abcc6",
"rate": 5,
"amount": 0.23
}
]
}
],
"products": [
{
"product_id": "8f7bb4f5",
"quantity": 1,
"unit_price": 22,
"discount_amount": 10,
"discount_id": "8f7b8e43",
"discount_type": 2,
"meta": {
"external_additional_product_info": "some info"
},
"options": [
{
"modifier_option_id": "8f7baae9",
"quantity": 1,
"unit_price": 2,
"total_price": 2,
"taxes": [
{
"id": "8f7abcc6",
"rate": 5,
"amount": 0.09
}
]
},
{
"modifier_option_id": "8f7ba83b",
"quantity": 1,
"unit_price": 1,
"total_price": 1,
"taxes": [
{
"id": "8f7abcc6",
"rate": 5,
"amount": 0.047
}
]
},
{
"modifier_option_id": "8f7ba867",
"quantity": 1,
"unit_price": 1,
"total_price": 1,
"taxes": [
{
"id": "8f7abcc6",
"rate": 5,
"amount": 0.04
}
]
}
],
"total_price": 16,
"taxes": [
{
"id": "8f7abcc6",
"rate": 5,
"amount": 1.04
}
]
}
],
"combos": [
{
"combo_size_id": "8f7be99c",
"quantity": 2,
"discount_type": 2,
"discount_id": "8f7b8e43",
"discount_amount": 10,
"products": [
{
"options": [
{
"modifier_option_id": "8f7baaae",
"quantity": 1,
"unit_price": 3,
"total_price": 6,
"taxes": [
{
"id": "8f7abcc6",
"rate": 5,
"amount": 0.28
}
]
}
],
"product_id": "8f7bc5af",
"combo_option_id": "8f7be9f9",
"combo_size_id": "8f7be99c",
"unit_price": 26,
"quantity": 2,
"total_price": 51.09,
"taxes": [
{
"id": "8f7abcc6",
"rate": 5,
"amount": 2.47
}
]
},
{
"options": [
{
"modifier_option_id": "8f7ba95a",
"quantity": 1,
"unit_price": 2,
"total_price": 4,
"taxes": [
{
"id": "8f7abcc6",
"rate": 5,
"amount": 0.19
}
]
},
{
"modifier_option_id": "8f7ba96f",
"quantity": 1,
"unit_price": 2,
"total_price": 4,
"taxes": [
{
"id": "8f7abcc6",
"rate": 5,
"amount": 0.19
}
]
}
],
"product_id": "8f7bd509",
"combo_option_id": "8f7bea3b",
"combo_size_id": "8f7be99c",
"unit_price": 6,
"quantity": 2,
"total_price": 17.61,
"taxes": [
{
"id": "8f7abcc6",
"rate": 5,
"amount": 0.57
}
]
},
{
"product_id": "8f7bdd7f",
"combo_option_id": "8f7bea8f",
"combo_size_id": "8f7be99c",
"unit_price": 3,
"quantity": 2,
"total_price": 5.28,
"taxes": [
{
"id": "8f7abcc6",
"rate": 5,
"amount": 0.28
}
]
}
]
}
],
"tags": [
{
"id": "8fb90c71"
}
],
"payments": [
{
"amount": 91.25,
"tendered": 91.25,
"payment_method_id": "8f89c571",
"tips": 0,
"meta": {
"external_additional_payment_info": "some info"
}
}
],
"subtotal_price": 85.7,
"rounding_amount": 0.05,
"total_price": 91.25
}
# Response
{
"data": {
"branch": {
"id": "8f7ab00a",
"name": "Branch 2"
},
"promotion": null,
"original_order": null,
"table": {
"section": {
"id": "901a3325",
"name": "Section 1"
},
"id": "901a332a-ccbf-4ae2-9873-08fabc419e4a",
"name": "Table 3"
},
"creator": null,
"closer": null,
"driver": null,
"customer": {
"id": "8f89a6ad",
"name": "Ahmed Ali",
"dial_code": 966,
"phone": "567898765"
},
"customer_address": null,
"discount": {
"id": "8f7b8e43",
"name": "10% Discount"
},
"tags": [
{
"id": "8fb90c71",
"name": "B2B Customer"
}
],
"coupon": null,
"gift_card": null,
"charges": [
{
"charge": {
"id": "8f98de52",
"name": "Special Event Charge"
},
"taxes": [
{
"pivot": {
"amount": 0.2381,
"rate": 5
},
"id": "8f7abcc6",
"name": "VAT"
}
],
"amount": 5,
"tax_exclusive_amount": 4.7619
}
],
"payments": [
{
"payment_method": {
"id": "8f89c571",
"name": "API Payment"
},
"meta": [],
"amount": 91.25,
"tendered": 91.25,
"tips": 0,
"business_date": null,
"added_at": null
}
],
"products": [
{
"product": {
"category": {
"id": "8f7ab8de",
"name": "Sandwiches"
},
"id": "8f7bb4f5",
"sku": "sk-0012",
"barcode": "200101",
"name": "Lamb Beef Burger"
},
"promotion": null,
"discount": {
"id": "8f7b8e43",
"name": "10% Discount"
},
"options": [
{
"modifier_option": {
"id": "8f7baae9",
"name": "Yellow Cheese"
},
"taxes": [
{
"pivot": {
"amount": 0.09,
"rate": 5
},
"id": "8f7abcc6",
"name": "VAT"
}
],
"quantity": 1,
"partition": 1,
"unit_price": 2,
"total_price": 2,
"total_cost": 0,
"tax_exclusive_unit_price": 1.90476,
"tax_exclusive_total_price": 1.90476,
"tax_exclusive_discount_amount": null,
"added_at": "2020-04-22 12:04:51"
},
{
"modifier_option": {
"id": "8f7ba83b",
"name": "Onion Slices"
},
"taxes": [
{
"pivot": {
"amount": 0.04762,
"rate": 5
},
"id": "8f7abcc6",
"name": "VAT"
}
],
"quantity": 1,
"partition": 1,
"unit_price": 1,
"total_price": 1,
"total_cost": 0.026,
"tax_exclusive_unit_price": 0.95238,
"tax_exclusive_total_price": 0.95238,
"tax_exclusive_discount_amount": null,
"added_at": "2020-04-22 12:04:51"
},
{
"modifier_option": {
"id": "8f7ba867",
"name": "Pickles Slices"
},
"taxes": [
{
"pivot": {
"amount": 0.047,
"rate": 5
},
"id": "8f7abcc6-083a-4d5e-af97-bcbed0992c79",
"name": "VAT"
}
],
"quantity": 1,
"partition": 1,
"unit_price": 1,
"total_price": 1,
"total_cost": 0.02,
"tax_exclusive_unit_price": 0.95,
"tax_exclusive_total_price": 0.95,
"tax_exclusive_discount_amount": null,
"added_at": "2020-04-22 12:04:51"
}
],
"taxes": [
{
"pivot": {
"amount": 1.04762,
"rate": 5
},
"id": "8f7abcc6",
"name": "VAT"
}
],
"timed_events": [],
"void_reason": null,
"creator": null,
"voider": null,
"discount_type": 2,
"quantity": 1,
"returned_quantity": 0,
"unit_price": 22,
"discount_amount": 10,
"total_price": 16,
"total_cost": 2.97274,
"tax_exclusive_discount_amount": 9.52,
"tax_exclusive_unit_price": 20.95,
"tax_exclusive_total_price": 15.23,
"status": 1,
"is_ingredients_wasted": 0,
"delay_in_seconds": null,
"kitchen_notes": null,
"meta": null,
"added_at": "2020-04-22 12:04:51",
"closed_at": null
}
],
"combos": [
{
"combo_size": {
"combo": {
"id": "8f7be85a",
"sku": "sk-0026",
"barcode": "300100",
"name": "Lunch Combo"
},
"id": "8f7be99c",
"name": "Large"
},
"products": [
{
"product": {
"category": {
"id": "8f7bc526",
"name": "Main Courses"
},
"id": "8f7bc5af",
"sku": "sk-0014",
"barcode": "200103",
"name": "Veal Beef Steak (200 G)"
},
"promotion": null,
"discount": {
"id": "8f7b8e43",
"name": "10% Discount"
},
"options": [
{
"modifier_option": {
"id": "8f7baaae",
"name": "Parmesan Cheese"
},
"taxes": [
{
"pivot": {
"amount": 0.28571,
"rate": 5
},
"id": "8f7abcc6",
"name": "VAT"
}
],
"quantity": 1,
"partition": 1,
"unit_price": 3,
"total_price": 6,
"total_cost": 0,
"tax_exclusive_unit_price": 2.85,
"tax_exclusive_total_price": 5.71,
"tax_exclusive_discount_amount": null,
"added_at": "2020-04-22 12:04:51"
}
],
"taxes": [
{
"pivot": {
"amount": 2.47619,
"rate": 5
},
"id": "8f7abcc",
"name": "VAT"
}
],
"timed_events": [],
"void_reason": null,
"creator": null,
"voider": null,
"discount_type": 2,
"quantity": 2,
"returned_quantity": 0,
"unit_price": 26,
"discount_amount": 6.90476,
"total_price": 51.09524,
"total_cost": 6.1915,
"tax_exclusive_discount_amount": 6.57596,
"tax_exclusive_unit_price": 24.7619,
"tax_exclusive_total_price": 48.66213,
"status": 1,
"is_ingredients_wasted": 0,
"delay_in_seconds": null,
"kitchen_notes": null,
"meta": null,
"added_at": "2020-04-22 12:04:51",
"closed_at": null,
"combo_option": {
"id": "8f7be9f9",
"combo_item_id": "8f7be9b6",
"name": "Veal Beef"
},
"combo_size": {
"id": "8f7be99c",
"combo_id": "8f7be85a",
"name": "Large"
}
},
{
"product": {
"category": {
"id": "8f7bd4b9",
"name": "Side Orders"
},
"id": "8f7bd509",
"sku": "sk-0022",
"barcode": "200111",
"name": "French Fries - Large"
},
"promotion": null,
"discount": {
"id": "8f7b8e43",
"name": "10% Discount"
},
"options": [
{
"modifier_option": {
"id": "8f7ba95a",
"name": "Garlic Sauce"
},
"taxes": [
{
"pivot": {
"amount": 0.19048,
"rate": 5
},
"id": "8f7abcc6",
"name": "VAT"
}
],
"quantity": 1,
"partition": 1,
"unit_price": 2,
"total_price": 4,
"total_cost": 0.19,
"tax_exclusive_unit_price": 1.90,
"tax_exclusive_total_price": 3.80,
"tax_exclusive_discount_amount": null,
"added_at": "2020-04-22 12:04:51"
},
{
"modifier_option": {
"id": "8f7ba96f",
"name": "Hot Sauce"
},
"taxes": [
{
"pivot": {
"amount": 0.19048,
"rate": 5
},
"id": "8f7abcc6",
"name": "VAT"
}
],
"quantity": 1,
"partition": 1,
"unit_price": 2,
"total_price": 4,
"total_cost": 0.2105,
"tax_exclusive_unit_price": 1.90,
"tax_exclusive_total_price": 3.80,
"tax_exclusive_discount_amount": null,
"added_at": "2020-04-22 12:04:51"
}
],
"taxes": [
{
"pivot": {
"amount": 0.57,
"rate": 5
},
"id": "8f7abcc",
"name": "VAT"
}
],
"timed_events": [],
"void_reason": null,
"creator": null,
"voider": null,
"discount_type": 2,
"quantity": 2,
"returned_quantity": 0,
"unit_price": 6,
"discount_amount": 2.38,
"total_price": 17.61,
"total_cost": 1.31,
"tax_exclusive_discount_amount": 2.26,
"tax_exclusive_unit_price": 5.71,
"tax_exclusive_total_price": 16.78,
"status": 1,
"is_ingredients_wasted": 0,
"delay_in_seconds": null,
"kitchen_notes": null,
"meta": null,
"added_at": "2020-04-22 12:04:51",
"closed_at": null,
"combo_option": {
"id": "8f7bea3b",
"combo_item_id": "8f7be9c6",
"name": "Fries"
},
"combo_size": {
"id": "8f7be99c",
"combo_id": "8f7be85a",
"name": "Large"
}
},
{
"product": {
"category": {
"id": "8f7ab8c9",
"name": "Drinks",
"reference": "cat-01",
"created_at": "2019-12-28 22:34:49",
"updated_at": "2019-12-28 22:34:49",
"deleted_at": null
},
"id": "8f7bdd7f",
"sku": "sk-0024",
"name": "Coca Cola"
},
"promotion": null,
"discount": {
"id": "8f7b8e43",
"name": "10% Discount"
},
"options": [],
"taxes": [
{
"pivot": {
"amount": 0.28,
"rate": 5
},
"id": "8f7abcc6",
"name": "VAT",
"rate": 5
}
],
"timed_events": [],
"void_reason": null,
"creator": null,
"voider": null,
"discount_type": 2,
"quantity": 2,
"returned_quantity": 0,
"unit_price": 3,
"discount_amount": 0.71,
"total_price": 5.28,
"total_cost": 2.33,
"tax_exclusive_discount_amount": 0.68,
"tax_exclusive_unit_price": 2.85,
"tax_exclusive_total_price": 5.03,
"status": 1,
"is_ingredients_wasted": 0,
"delay_in_seconds": null,
"kitchen_notes": null,
"meta": null,
"added_at": "2020-04-22 12:04:51",
"closed_at": null,
"combo_option": {
"id": "8f7bea8f",
"combo_item_id": "8f7be9ce",
"name": "Cola"
},
"combo_size": {
"id": "8f7be99c",
"combo_id": "8f7be85a",
"name": "Large"
}
}
],
"discount_type": 2,
"discount_amount": 10,
"quantity": 2
}
],
"id": "906331a6",
"app_id": "8f7fa3c8",
"promotion_id": null,
"discount_type": 2,
"reference": null,
"number": null,
"type": 1,
"source": 2,
"status": 1,
"delivery_status": null,
"guests": 1,
"kitchen_notes": "well done",
"customer_notes": "some customer related notes",
"business_date": null,
"subtotal_price": 85.71429,
"discount_amount": 5,
"rounding_amount": 0.05952,
"total_price": 91.25,
"tax_exclusive_discount_amount": 4.7619,
"delay_in_seconds": null,
"meta": {
"3rd_party_order_number": "120153"
},
"opened_at": "2020-04-22 12:04:51",
"accepted_at": null,
"due_at": "2019-07-31 15:50:00",
"driver_assigned_at": null,
"dispatched_at": null,
"driver_collected_at": null,
"delivered_at": null,
"closed_at": null,
"created_at": "2020-04-22 12:04:51",
"updated_at": "2020-04-22 12:04:51"
}
}
# Update Order
PUT /orders/{orderId}
# Scope
orders.write
or
orders.limited.deliver
# Request
{
"driver_assigned_at": "2020-04-22 13:55:30",
"dispatched_at": "2020-04-22 13:50:30",
"driver_collected_at": "2020-04-22 13:58:30",
"delivered_at": "2020-04-22 14:15:30",
"delivery_status": 5,
"driver_id": "8f7ab326"
}
# Response
{
"data": {
"branch": {
"id": "8f7ab00a-d07d-4acc-a59b-363d5a93c63b",
"name": "Branch 2"
},
"promotion": null,
"original_order": null,
"table": null,
"creator": {
"id": "8f7aafee-e535-482f-85ce-38b7d72d8c56",
"name": "Cashier"
},
"closer": {
"id": "8f7aafee",
"name": "Cashier"
},
"driver": {
"id": "8f7ab326",
"name": "Alex"
},
"customer": {
"id": "8f89a6ad",
"name": "Ahmed Ali",
"dial_code": 966,
"phone": "567898765"
},
"customer_address": {
"delivery_zone": {
"id": "8f7ab5fb",
"name": "Area 1"
},
"id": "8fb30326",
"name": "Work",
"description": "Near Hama Hotel Gate 3"
},
"discount": null,
"tags": [],
"coupon": null,
"gift_card": null,
"charges": [],
"payments": [
{
"user": {
"id": "8f7aafee",
"name": "Cashier"
},
"payment_method": {
"id": "8f7b95b1",
"name": "Card"
},
"meta": [],
"amount": 32,
"tendered": 32,
"tips": 0,
"business_date": "2020-04-22",
"added_at": "2020-04-22 14:05:18"
}
],
"products": [
{
"product": {
"category": {
"id": "8f7ab8ee",
"name": "Sweets"
},
"id": "8f7bd07f",
"sku": "sk-0016",
"barcode": "200105",
"name": "Apple Cake"
},
"promotion": null,
"discount": null,
"options": [],
"taxes": [
{
"pivot": {
"amount": 1.52381,
"rate": 5
},
"id": "8f7abcc6",
"name": "VAT"
}
],
"timed_events": [],
"void_reason": null,
"creator": {
"id": "8f7aafee",
"name": "Cashier"
},
"voider": null,
"discount_type": null,
"quantity": 1,
"returned_quantity": 0,
"unit_price": 32,
"discount_amount": 0,
"total_price": 32,
"total_cost": 0,
"tax_exclusive_discount_amount": 0,
"tax_exclusive_unit_price": 30.47619,
"tax_exclusive_total_price": 30.47619,
"status": 3,
"is_ingredients_wasted": 0,
"delay_in_seconds": null,
"kitchen_notes": null,
"meta": null,
"added_at": "2020-04-22 14:05:13",
"closed_at": "2020-04-22 14:05:18"
}
],
"combos": [],
"id": "90635cd1",
"app_id": "8f786664",
"promotion_id": null,
"discount_type": null,
"reference": "00579",
"number": 1,
"type": 3,
"source": 1,
"status": 4,
"delivery_status": 5,
"guests": 1,
"kitchen_notes": null,
"customer_notes": null,
"business_date": "2020-04-22",
"subtotal_price": 30.47619,
"discount_amount": 0,
"rounding_amount": 0,
"total_price": 32,
"tax_exclusive_discount_amount": 0,
"delay_in_seconds": null,
"meta": {
"Ristecho": {
"device_id": "9097982a-93bc-4808-b7cf-b7bef375be89",
"kitchen_done_at": "2020-04-22 20:51:48",
"kitchen_received_at": "2020-04-22 20:49:22",
"decline_at": "2020-04-22 22:10:12",
"joined_orders": [
"90ef30db-ae09-4a15-8ad2-24520c52209b"
]
}
},
"opened_at": "2020-04-22 14:05:13",
"accepted_at": null,
"due_at": null,
"driver_assigned_at": "2020-04-22 13:55:30",
"dispatched_at": "2020-04-22 13:50:30",
"driver_collected_at": "2020-04-22 13:58:30",
"delivered_at": "2020-04-22 14:15:30",
"closed_at": "2020-04-22 14:05:18",
"created_at": "2020-04-22 14:05:34",
"updated_at": "2020-04-22 14:10:02"
}
}