Areas
An Area is a virtual or physical destination to which orders are placed.
Physical areas (such as for Dine-in or Delivery) can include configured tables, or defined geographical delivery zones with settings, defining specifically where the order should be delivered to.
For virtual areas (such as for Takeout) orders can be placed directly on the area without requiring additional location information.
Areas have a Type ID and are assigned Order Types:
| ID | Area Type | Supported Order Type | Physical / Virtual | Description |
|---|---|---|---|---|
| 1 | Full-Service | 1 Dine-in (FS), 2 Bill Settling |
Physical | Full-Service area with configured tables |
| 2 | Pick & Pay | 3 Pick & Pay |
Virtual | Pick & Pay area, with no additional location settings |
| 3 | Quick Service | 4 Dine-in (QS) |
Virtual | Quick / Counter service area, with no additional location settings |
| 4 | Takeout | 6 Takeout |
Virtual | Pickup area, with no additional location settings |
| 5 | Delivery | 7 Delivery |
Physical | Delivery area with defined delivery zone and zone settings |
| 6 | Curbside | 8 Curbside |
Virtual | Curbside area, with no additional location settings |
| 7 | Foodspot | 9 Foodspot |
Virtual | Foodspot area. The collection point itself comes from the foodspot_id you send with the order, not from the area |
| 8 | Catering Delivery | 10 Catering Delivery |
Physical | Catering delivery area with defined delivery zone and zone settings |
| 9 | Catering Take-Out | 11 Catering Take-Out |
Virtual | Catering pickup area, with no additional location settings |
| 10 | Drive-Thru | 12 Drive-Thru |
Virtual | Drive-thru area, with no additional location settings |
Area Attributes
| Attribute | Type | Example Value | Description |
|---|---|---|---|
type_id |
int | 4 |
Type ID of Area |
singular_point_id |
string | "db2f3288-63f4-4939-81f6-d0351bce9c70" |
Singular Point UUID, which will be used for placing the order |
state |
int | 1 |
Current status of Area - refer to States reference |
order_types |
array[OrderType] | Array of OrderTypes that are configured for that Area | |
order_types.[i].type_id |
int | 4 |
Type of Order Types - see Order Types reference |
Full Service
{
"id": "175cff75-3f8f-4908-bde7-74d1f8c6a542",
"type_id": 1,
"reference_type": "AreaFullService",
"menu_id": "899129db-5b88-4c95-8fe2-972e6faec523",
"singular_point_id": "93397e8d-d889-4e6b-8764-fa3ecfbfe8bf",
"name": "Full Service",
"use_tablet": false,
"state": 1,
"is_table_supported": 1,
"order_types": [
{
"id": "81035813-b64f-4776-8a6c-ef00043aff05",
"type_id": 1,
"reference_type": "OrderTypeDineIn",
"state": 1,
"is_table_supported": null,
"tip_default": 0,
"tip_max": 0
}
]
}
Quick Service
{
"id": "2b7a5795-965a-4258-9f0d-8c9a987d0e26",
"type_id": 3,
"reference_type": "AreaQuickService",
"menu_id": "899129db-5b88-4c95-8fe2-972e6faec523",
"singular_point_id": "a1bb94d6-b4bb-4938-8388-1e63075afe4f",
"name": "Quick Service",
"use_tablet": true,
"state": 1,
"is_table_supported": 0,
"order_types": [
{
"id": "aaa1ae2f-6bbf-4547-b722-61375cf1f835",
"type_id": 4,
"reference_type": "OrderTypePreorder",
"state": 1,
"is_table_supported": null,
"tip_default": 0,
"tip_max": 0
}
],
"tablet": {
"id": "fdca7af8-1650-48dd-9481-df8059f33517",
"name": "SF tablet",
"state": 3,
"is_online": false,
"last_request_at": null,
"failure_reported": false,
"area_ids": [
"41d2dcf0-5e59-4204-b28d-67f03fcd4d91",
"b39d789b-ecad-455a-a8d2-ad5bfa4e43d0",
"c2e6402c-518f-4d54-8830-6d818b25b608",
"2b7a5795-965a-4258-9f0d-8c9a987d0e26"
]
}
}
Takeout
{
"id": "41d2dcf0-5e59-4204-b28d-67f03fcd4d91",
"type_id": 4,
"reference_type": "AreaTakeOut",
"menu_id": "899129db-5b88-4c95-8fe2-972e6faec523",
"singular_point_id": "db2f3288-63f4-4939-81f6-d0351bce9c70",
"name": "takeout",
"use_tablet": true,
"state": 1,
"is_table_supported": 0,
"order_types": [
{
"id": "b3265e27-eef5-425d-8f21-0f9780ff6236",
"type_id": 6,
"reference_type": "OrderTypeTakeOut",
"state": 1,
"is_table_supported": null,
"tip_default": 5,
"tip_max": 15
}
],
"tablet": {
"id": "fdca7af8-1650-48dd-9481-df8059f33517",
"name": "SF tablet",
"state": 3,
"is_online": false,
"last_request_at": null,
"failure_reported": false,
"area_ids": [
"41d2dcf0-5e59-4204-b28d-67f03fcd4d91",
"b39d789b-ecad-455a-a8d2-ad5bfa4e43d0",
"c2e6402c-518f-4d54-8830-6d818b25b608"
]
}
}
Delivery
{
"id": "181cbf5d-580c-4fb5-8391-79e850715872",
"type_id": 5,
"reference_type": "AreaDelivery",
"menu_id": "899129db-5b88-4c95-8fe2-972e6faec523",
"singular_point_id": "63b07572-302f-4c77-ba23-18b048fac9b9",
"name": "Delivery",
"use_tablet": true,
"state": 1,
"is_table_supported": 0,
"order_types": [
{
"id": "3ca0c042-4a89-43fa-b197-7820a2818782",
"type_id": 7,
"reference_type": "OrderTypeDelivery",
"state": 1,
"is_table_supported": null,
"tip_default": 0,
"tip_max": 0
}
],
"delivery_area_maps": [
{
"minimal_order_amount": 2000,
"name": "Zone 1",
"coordinate_polygon": [
[
[
-122.41478866031048,
37.786212408637766
],
[
-122.39770835330202,
37.78153183822485
],
[
-122.40809386661071,
37.75676736819847
],
[
-122.43779128482215,
37.75893883148851
],
[
-122.41478866031048,
37.786212408637766
]
]
],
"radius": null,
"state": 1,
"delivery_fee": {
"type_id": 1,
"reference_type": "DeliveryFeeFixed",
"price": 150,
"price_per_unit": 0,
"unit": "kilometer"
}
},
{
"minimal_order_amount": null,
"name": "Zone 2",
"coordinate_polygon": [
[
[
-122.464913782376,
37.75547803172418
],
[
-122.43015235354434,
37.74665565298056
],
[
-122.39324515749658,
37.75235638718793
],
[
-122.39556258608592,
37.790757026685185
],
[
-122.40431731631512,
37.79672565261811
],
[
-122.45487159183062,
37.79638653906568
],
[
-122.464913782376,
37.75547803172418
]
],
[
[
-122.43779128482215,
37.75893883148851
],
[
-122.40809386661071,
37.75676736819847
],
[
-122.39770835330202,
37.78153183822485
],
[
-122.41478866031048,
37.786212408637766
],
[
-122.43779128482215,
37.75893883148851
]
]
],
"radius": null,
"state": 1,
"delivery_fee": {
"type_id": 2,
"reference_type": "DeliveryFeeDistance",
"price": 0,
"price_per_unit": 200,
"unit": "kilometer"
}
}
],
"delivery_times": [
{
"id": "8b644f29-1604-47ac-9623-2e6b0596c9c2",
"type_id": 2,
"reference_type": "WeekDays",
"time_from": "09:30",
"time_to": "21:30",
"days": [
1,
2,
3,
4,
5
]
},
{
"id": "aa5eac96-99fa-483a-99f2-9c5f2b9a784a",
"type_id": 1,
"reference_type": "SpecialDays",
"time_from": null,
"time_to": null,
"delivery_at": null,
"date": "2023-08-31",
"date_to": "2023-08-31",
"working": false
},
{
"id": "7e328d69-18d8-4f73-8726-39e27d8ef9e2",
"type_id": 1,
"reference_type": "SpecialDays",
"time_from": "04:00",
"time_to": "14:00",
"delivery_at": null,
"date": "2023-09-01",
"date_to": "2023-09-05",
"working": true
}
],
"tablet": {
"id": "fdca7af8-1650-48dd-9481-df8059f33517",
"name": "SF tablet",
"state": 3,
"is_online": false,
"last_request_at": null,
"failure_reported": false,
"area_ids": [
"41d2dcf0-5e59-4204-b28d-67f03fcd4d91",
"b39d789b-ecad-455a-a8d2-ad5bfa4e43d0",
"c2e6402c-518f-4d54-8830-6d818b25b608",
"2b7a5795-965a-4258-9f0d-8c9a987d0e26",
"181cbf5d-580c-4fb5-8391-79e850715872"
]
}
}
Curbside
{
"id": "b39d789b-ecad-455a-a8d2-ad5bfa4e43d0",
"type_id": 6,
"reference_type": "AreaCurbside",
"menu_id": "899129db-5b88-4c95-8fe2-972e6faec523",
"singular_point_id": "661f5619-9495-4df0-94f0-a1e3dd552e99",
"name": "curbside",
"use_tablet": true,
"state": 1,
"is_table_supported": 0,
"order_types": [
{
"id": "5514ba04-70d9-47f8-826d-7c22deff741a",
"type_id": 8,
"reference_type": "OrderTypeCurbside",
"state": 1,
"is_table_supported": null,
"tip_default": 5,
"tip_max": 15
}
],
"tablet": {
"id": "fdca7af8-1650-48dd-9481-df8059f33517",
"name": "SF tablet",
"state": 3,
"is_online": false,
"last_request_at": null,
"failure_reported": false,
"area_ids": [
"41d2dcf0-5e59-4204-b28d-67f03fcd4d91",
"b39d789b-ecad-455a-a8d2-ad5bfa4e43d0",
"c2e6402c-518f-4d54-8830-6d818b25b608"
]
}
}