Select a Store for Delivery or Catering Delivery
This guide explains how to build a flow to select a Venue (Store / Location) for Delivery or Catering Delivery.
Determine Delivery Location
To understand which Venues can deliver to the customer, a delivery location (location coordinates) needs to be established. You can provide two options to your customers:
Address Autocomplete
Using the /autocomplete-addresses API endpoint you can offer your customers an address auto-complete experience:
Request
| Attribute | Type | Example Value | Description |
|---|---|---|---|
input |
string | "398 7th St" |
Customer's auto-complete input |
country_codes |
array[string] | ["US"] |
Recommended to be specified, in order to limit autocomplete results to a specific list of countries |
{
"method": "post",
"url": "https://api-public-playground.menu.app/api/autocomplete-addresses",
"headers": {
"X-Request-ID": "69da3547-204b-4093-a225-54e084c24215",
"Application": "f3a90488ffee32c3acb6fcd0ca417cf6",
"Api-Version": 4.38.0,
"Content-Type": "application/json"
},
"body": {
"input": "398 7th St",
"country_codes": [
"US"
]
}
}
Response
{
"status": "OK",
"code": 200,
"data": {
"location_provider": "Google",
"addresses": [
{
"id": "ChIJaS_iBCp-j4ARPRQp0dT328Q",
"street_name": null,
"street_number": null,
"locality": null,
"place": null,
"administrative_area": null,
"administrative_area_short": null,
"country": null,
"country_short": null,
"longitude": 0,
"latitude": 0,
"postcode": null,
"formatted_address": "398 7th Street, San Francisco, CA, USA",
"is_custom": false,
"is_number_first": null
},
{
"id": "ChIJ8x4PAZC3t4kRVwxQMO1RmXE",
"street_name": null,
"street_number": null,
"locality": null,
"place": null,
"administrative_area": null,
"administrative_area_short": null,
"country": null,
"country_short": null,
"longitude": 0,
"latitude": 0,
"postcode": null,
"formatted_address": "398 7th Street Northwest, Washington, DC, USA",
"is_custom": false,
"is_number_first": null
},
{
"id": "ChIJa2clkUpXwokRZ_v5B3hQo3Y",
"street_name": null,
"street_number": null,
"locality": null,
"place": null,
"administrative_area": null,
"administrative_area_short": null,
"country": null,
"country_short": null,
"longitude": 0,
"latitude": 0,
"postcode": null,
"formatted_address": "398 7th Street, Jersey City, NJ, USA",
"is_custom": false,
"is_number_first": null
},
{
"id": "ChIJDe-BY1T8wokRSOOpacSSOFU",
"street_name": null,
"street_number": null,
"locality": null,
"place": null,
"administrative_area": null,
"administrative_area_short": null,
"country": null,
"country_short": null,
"longitude": 0,
"latitude": 0,
"postcode": null,
"formatted_address": "398 North 7th Street, Prospect Park, NJ, USA",
"is_custom": false,
"is_number_first": null
},
{
"id": "EigzOTggN3RoIFN0cmVldCBXZXN0LCBTYWludCBQYXVsLCBNTiwgVVNBIjESLwoUChIJBUarebgq9ocRVy5gIyRznlQQjgMqFAoSCdFeIIRVKvaHEfTYhoCyd20R",
"street_name": null,
"street_number": null,
"locality": null,
"place": null,
"administrative_area": null,
"administrative_area_short": null,
"country": null,
"country_short": null,
"longitude": 0,
"latitude": 0,
"postcode": null,
"formatted_address": "398 7th Street West, Saint Paul, MN, USA",
"is_custom": false,
"is_number_first": null
}
]
}
}
| Attribute | Type | Example Value | Description |
|---|---|---|---|
addresses |
array[AutocompleteAddress] | Array of Autocomplete address results | |
addresses.[i].id |
string | "ChIJaS_iBCp-j4ARPRQp0dT328Q" |
ID of returned Autocomplete result |
addresses.[i].formatted_addresses |
string | "398 7th Street, San Francisco, CA, USA" |
Full address result (to be presented to the customer) |
Make sure to optimize autocomplete calls
Autocomplete calls connect to a third-party mapping provider, for example Google Maps, and as such are charged as third-party cost to the brand. In order to keep API fees as low as possible, only start sending autocomplete API requests after the user has entered 5 characters into the input field.
Prior to going into production, generally review your application to make sure you are not making any unnecessary autocomplete calls in your implementation.
Map Pinning
| You can allow your customers to pin their exact delivery location on a map, which is especially convenient in regions where mapping provider coverage for autocomplete is less robust. After confirming their pin location, you can reverse geo-code the location coordinates, in order to show the returned address to the customer. The customer should be able to make adjustments to the address details before proceeding. |
 |
Retrieve Address Details
Once the customer has selected an auto-complete result or provided their location coordinates, you can make a call to get high-fidelity details for that address / location coordinate pair.
Using the /autocomplete-addresses/details API endpoint, you can get full high-fidelity details for an autocomplete address or a pair of location coordinates:
From Address Autocomplete result
Request
| Attribute | Type | Example Value | Description |
|---|---|---|---|
address_id |
string | "ChIJaS_iBCp-j4ARPRQp0dT328Q" |
Address Autocomplete ID from /autocomplete-addresses API call |
{
"method": "post",
"url": "https://api-public-playground.menu.app/api/autocomplete-addresses/details",
"headers": {
"X-Request-ID": "69da3547-204b-4093-a225-54e084c24215",
"Application": "f3a90488ffee32c3acb6fcd0ca417cf6",
"Api-Version": 4.38.0,
"Content-Type": "application/json"
},
"body": {
"address_id": "ChIJaS_iBCp-j4ARPRQp0dT328Q",
"longitude": 19.8418477,
"latitude": 45.2510104
}
}
Response
{
"status": "OK",
"code": 200,
"data": {
"address": {
"id": "ChIJaS_iBCp-j4ARPRQp0dT328Q",
"street_name": "7th Street",
"street_number": "398",
"locality": null,
"place": "San Francisco",
"administrative_area": "California",
"administrative_area_short": "CA",
"country": "United States",
"country_short": "US",
"longitude": -122.4065609,
"latitude": 37.7755527,
"postcode": "94103",
"formatted_address": "398 7th St",
"is_custom": false,
"is_number_first": false
}
}
}
| Attribute | Type | Example Value | Description |
|---|---|---|---|
address.id |
string | "ChIJy8YaadV_j4AR4sEBBuQ4cqU" |
Autocomplete address UUID |
address.street_name |
string | "5th Street" |
Street name |
address.street_number |
string | "548" |
Street number |
address.latitude |
float | 37.7772051 |
Delivery location latitude |
address.longitude |
float | -122.3998365 |
Delivery location longitude |
address.postcode |
string | "78719" |
Post code |
address.country |
string | "US" |
Country |
address.formatted_address |
string | "548 5th St" |
Formatted address should contain the street name and numer |
address.administrative_area |
string | "San Francisco" |
Address State |
address.administrative_area_short |
string | "CA" |
Address State short |
From Location Coordinates
Request
| Attribute | Type | Example Value | Description |
|---|---|---|---|
latitude |
float | 37.777356 |
Latitude of location coordinates |
longitude |
float | -122.399737 |
Longitude of location coordinates |
{
"method": "post",
"url": "https://api-public-playground.menu.app/api/autocomplete-addresses/details",
"headers": {
"X-Request-ID": "69da3547-204b-4093-a225-54e084c24215",
"Application": "f3a90488ffee32c3acb6fcd0ca417cf6",
"Api-Version": 4.38.0,
"Content-Type": "application/json"
},
"body": {
"latitude": 37.777356,
"longitude": -122.399737
}
}
Response
{
"status": "OK",
"code": 200,
"data": {
"address": {
"id": "ChIJy8YaadV_j4AR4sEBBuQ4cqU",
"street_name": "5th Street",
"street_number": "548",
"locality": null,
"place": "San Francisco",
"administrative_area": "California",
"administrative_area_short": "CA",
"country": "United States",
"country_short": "US",
"longitude": -122.3998365,
"latitude": 37.7772051,
"postcode": "94107",
"formatted_address": "548 5th St",
"is_custom": false,
"is_number_first": false
}
}
}
Make sure to optimize your Autocomplete Address Details calls
In order to retrieve high-fidelity address details or perform a reverse geo-code (from location coordinates to address), we connect to third-party mapping providers, such as Google Maps. Since these calls are charged to brands as third-party cost, make sure to optimize your implementation to make the least /autocomplete-addresses/details calls as possible.
Only make an address details call once your customer has chosen a specific autocomplete result or has fully confirmed their pin location - making multiple address details calls in quick succession after each other is not allowed and will not pass integration certification.
Ask for Delivery Venues
Using the obtained location coordinates, we can retrieve the Venues (Stores / Locations) that deliver to that location. Which Venues deliver to the delivery location is dependent on delivery zones that have been configured in the Management Center for the Venue:
A Venue can have an unlimited amount of delivery zones and can define different delivery fees and minimal order amounts for each zone. See here to learn more about how to set up delivery zones in the Management Center. Delivery and Catering Delivery have separate configurations for delivery zones.
Using /delivery/venues we can retrieve delivering venues based on location coordinates:
Request
| Attribute | Type | Example Value | Description |
|---|---|---|---|
latitude |
float | 37.777356 |
Latitude of delivery location |
longitude |
float | -122.399737 |
Longitude of delivery location |
order_type_id |
int | 7 |
Order type id for delivery order type (see Order Types for more information) |
{
"method": "post",
"url": "https://api-public-playground.menu.app/api/delivery/venues",
"headers": {
"X-Request-ID": "69da3547-204b-4093-a225-54e084c24215",
"Application": "f3a90488ffee32c3acb6fcd0ca417cf6",
"Api-Version": 4.38.0,
"Content-Type": "application/json"
},
"body": {
"latitude": 37.777356,
"longitude": -122.399737
}
}
Response
{
"status": "OK",
"code": 200,
"data": {
"delivery_venues": [
{
"venue": {
"id": "67984194-717f-46e7-aca6-03a7b64009f3",
"uuid": "67984194-717f-46e7-aca6-03a7b64009f3",
"name": "Kauwela San Francisco 4",
"code": "3341",
"currency_id": "692f600e-3e2a-4c43-9bed-66e5a23473bc",
"language_id": 1,
"external_dlc_id": null,
"serving_time_mode": 1,
"brand_id": "de3a0527-7e4c-4888-91de-71b6d29efa74",
"timezone": {
"name": "America/Los_Angeles",
"offset": "-07:00"
},
"description": "",
"kiosk_receipt_footer": "",
"imprint": "",
"welcome_message": "welcome_message welcome_messagewelcome_message",
"translations": {
"description": "",
"kiosk_receipt_footer": null,
"welcome_message": "welcome_message welcome_messagewelcome_message"
},
"address": "3515 20th St",
"state": 1,
"city": "San Francisco",
"zip": "94110",
"latitude": 37.7558409,
"longitude": -122.4203925,
"tax_number": "123XYZ234",
"phone": "134829481",
"price_configuration": {
"order_types": [
{
"type_id": 1,
"price_configuration": null
},
{
"type_id": 4,
"price_configuration": null
},
{
"type_id": 6,
"price_configuration": null
},
{
"type_id": 7,
"price_configuration": 3
},
{
"type_id": 8,
"price_configuration": null
},
{
"type_id": 9,
"price_configuration": null
}
],
"external_channels": []
},
"used_price_configurations": [
3
],
"cuisine": "",
"store_url": "",
"is_shown_in_directory": true,
"allow_item_comments": false,
"tip_default": 2,
"tip_max": 15,
"service_charge": 0,
"pickup_time": 5,
"is_pickup_on_open_allowed": false,
"calculation_method": "exclusive",
"image": {
"thumbnail_small": "https://s3.eu-central-1.amazonaws.com/api.playground/images/venue_images/_thumbs280/2023-07-27/3494efb97c741996b588fe535bb7d13e.jpeg",
"thumbnail_medium": "https://s3.eu-central-1.amazonaws.com/api.playground/images/venue_images/_thumbs720/2023-07-27/3494efb97c741996b588fe535bb7d13e.jpeg",
"fullsize": "https://s3.eu-central-1.amazonaws.com/api.playground/images/venue_images/2023-07-27/3494efb97c741996b588fe535bb7d13e.jpeg"
},
"available_payment_methods": [
{
"payment_method_id": "e3423d4d-7200-4c16-a154-a51fb2695838",
"payment_method_type_id": 1,
"payment_method_brand": "Visa",
"payment_processor_type_id": 32,
"payment_processor_id": "5bab16ce-bb27-4e62-aff4-124266647eaf",
"properties": null,
"fraud_detection_processor_id": null,
"visibility_scopes": null
},
{
"payment_method_id": "ea1ac590-b980-4d79-9376-9411fae5ff11",
"payment_method_type_id": 1,
"payment_method_brand": "MasterCard",
"payment_processor_type_id": 32,
"payment_processor_id": "5bab16ce-bb27-4e62-aff4-124266647eaf",
"properties": null,
"fraud_detection_processor_id": null,
"visibility_scopes": null
},
{
"payment_method_id": "8f78d853-2ad1-4371-9a47-68ca18f291cf",
"payment_method_type_id": 1,
"payment_method_brand": "Amex",
"payment_processor_type_id": 32,
"payment_processor_id": "5bab16ce-bb27-4e62-aff4-124266647eaf",
"properties": null,
"fraud_detection_processor_id": null,
"visibility_scopes": null
}
],
"country": {
"id": "5123365b-2d43-45bf-8418-21dcacc595ef",
"currency_id": "692f600e-3e2a-4c43-9bed-66e5a23473bc",
"name": "American Samoa",
"code": "AS",
"code_alpha3": "ASM",
"code_numeric": "016",
"calling_code": "+1-684",
"distance_unit": "km",
"is_address_number_first": false,
"currency_settings": {
"currency_space": true,
"decimal_separator": ".",
"thousands_separator": ",",
"symbol_position": "left"
},
"supported_travel_modes": [
"driving"
],
"available_payment_methods": []
},
"currency": {
"id": "692f600e-3e2a-4c43-9bed-66e5a23473bc",
"code": "EUR",
"code_numeric": "978",
"symbol": "€",
"rounding_unit": 0.01,
"rounding_unit_tip": 0.01
},
"order_types": [
{
"id": "12bf5e15-694e-45b8-aed1-45050e847853",
"type_id": 4,
"reference_type": "OrderTypePreorder",
"state": 1,
"is_table_supported": false,
"external_channel_only": false,
"tip_default": 0,
"tip_max": 0
},
{
"id": "8627a8be-e4d8-435f-b020-4c10f3de9007",
"type_id": 6,
"reference_type": "OrderTypeTakeOut",
"state": 1,
"is_table_supported": false,
"external_channel_only": false,
"tip_default": 0,
"tip_max": 0
},
{
"id": "b948b08e-355d-4048-92c3-e7c565801b6b",
"type_id": 7,
"reference_type": "OrderTypeDelivery",
"state": 1,
"is_table_supported": false,
"external_channel_only": false,
"tip_default": 2,
"tip_max": 15
}
],
"temporary_updated_entities": [],
"serving_times": [
{
"id": "5dfcc93b-7d32-45ba-b5f2-d32dc7ae3f72",
"type_id": 2,
"reference_type": "WeekDays",
"time_from": null,
"time_to": null,
"delivery_at": null,
"days": [
1,
2,
3,
4,
5,
6,
0
]
}
],
"is_open": true,
"will_open": true,
"has_discounts": true,
"has_loyalty": true,
"has_promotions": true,
"has_delivery_integration": true,
"delivery_integration_properties": {
"restaurant_id": "3341"
},
"delivery_travel_type": "driving",
"is_calculated_delivery_buffer_used": false,
"is_monitoring_enabled": false,
"is_threeds_enabled": false,
"is_fraud_detection_enabled": false,
"is_smart_orders_enabled": false,
"use_pos_order_number": false,
"has_uc_capacity_management": false,
"kiosk_face_count": null,
"is_order_regret_enabled": false,
"is_billable": true,
"default_delivery_buffer": 15,
"integration": {
"id": "43cfe9bd-1bc7-47b2-a192-fee21cb3b2e4",
"type_id": 1,
"reference_type": "Plain",
"is_windows_pos": false,
"pos_modifier_group_type": 1,
"support_combo_meals": false,
"max_comment_limit": 0,
"allow_multiple_days_in_advance": true
},
"created_at": "2023-07-24 13:54:42",
"updated_at": "2023-08-04 09:52:41",
"areas": [
{
"id": "75516f2f-69d3-4603-824d-896f34e9e266",
"type_id": 4,
"reference_type": "AreaTakeOut",
"menu_id": "4c092b16-6e6c-4477-9927-4b029d0735a6",
"singular_point_id": "a16e309d-fb5e-475d-9383-d3a34afe9406",
"pos_id": null,
"name": "takeout",
"use_tablet": true,
"state": 1,
"is_table_supported": 0,
"properties": {
"location_type": "table"
},
"order_types": [
{
"id": "8627a8be-e4d8-435f-b020-4c10f3de9007",
"type_id": 6,
"reference_type": "OrderTypeTakeOut",
"state": 1,
"is_table_supported": null,
"external_channel_only": false,
"tip_default": 0,
"tip_max": 0
}
],
"table_pos_id": null,
"tablet": {
"id": "5a278144-927a-43cc-890e-2d3a6f583c60",
"name": "SF tablet",
"use_notifications": 0,
"show_kiosk_orders": false,
"kiosk_notification_type": 0,
"middleware_endpoint": null,
"pls_name": null,
"state": 3,
"is_online": false,
"last_request_at": null,
"failure_reported": false,
"is_critical": false,
"area_ids": [
"75516f2f-69d3-4603-824d-896f34e9e266",
"2f02ecbd-0cfd-4054-9bbb-ac6445a57fd6",
"e13ca919-016a-4748-9ea4-a17b26cb2b3b"
],
"allow_disable_product": false
}
},
{
"id": "2f02ecbd-0cfd-4054-9bbb-ac6445a57fd6",
"type_id": 5,
"reference_type": "AreaDelivery",
"menu_id": "4c092b16-6e6c-4477-9927-4b029d0735a6",
"singular_point_id": "061fa11e-3b69-482b-9ed8-2d951f2c5788",
"pos_id": null,
"name": "delivery",
"use_tablet": true,
"state": 1,
"is_table_supported": 0,
"properties": null,
"order_types": [
{
"id": "b948b08e-355d-4048-92c3-e7c565801b6b",
"type_id": 7,
"reference_type": "OrderTypeDelivery",
"state": 1,
"is_table_supported": null,
"external_channel_only": false,
"tip_default": 2,
"tip_max": 15
}
],
"delivery_area_maps": [
{
"minimal_order_amount": 1500,
"name": "SF",
"coordinate_polygon": [
[
[
-122.45275871617471,
37.777042543444026
],
[
-122.38847153050745,
37.77853502205501
],
[
-122.3705329166168,
37.73978866119312
],
[
-122.43550674779314,
37.743793165739575
],
[
-122.45275871617471,
37.777042543444026
]
]
],
"radius": null,
"state": 1,
"created_at": "2023-07-27 12:37:41",
"updated_at": "2023-07-27 12:37:41",
"delivery_fee": {
"type_id": 1,
"reference_type": "DeliveryFeeFixed",
"price": 0,
"price_per_unit": 0,
"unit": "kilometer",
"created_at": "2023-07-27 12:37:36",
"updated_at": "2023-07-27 12:37:36"
}
}
],
"delivery_times": [
{
"id": "d994fe70-0ee9-43fa-8f69-efe5ab6f3e78",
"type_id": 2,
"reference_type": "WeekDays",
"time_from": null,
"time_to": null,
"delivery_at": null,
"days": [
1,
2,
3,
4,
5,
6,
0
]
}
],
"tablet": {
"id": "5a278144-927a-43cc-890e-2d3a6f583c60",
"name": "SF tablet",
"use_notifications": 0,
"show_kiosk_orders": false,
"kiosk_notification_type": 0,
"middleware_endpoint": null,
"pls_name": null,
"state": 3,
"is_online": false,
"last_request_at": null,
"failure_reported": false,
"is_critical": false,
"area_ids": [
"75516f2f-69d3-4603-824d-896f34e9e266",
"2f02ecbd-0cfd-4054-9bbb-ac6445a57fd6",
"e13ca919-016a-4748-9ea4-a17b26cb2b3b"
],
"allow_disable_product": false
}
},
{
"id": "e13ca919-016a-4748-9ea4-a17b26cb2b3b",
"type_id": 3,
"reference_type": "AreaQuickService",
"menu_id": "4c092b16-6e6c-4477-9927-4b029d0735a6",
"singular_point_id": "15b0345f-7e86-4f94-8242-5f8d9e04d647",
"pos_id": null,
"name": "quick service",
"use_tablet": true,
"state": 1,
"is_table_supported": 0,
"properties": {
"location_type": "table"
},
"order_types": [
{
"id": "12bf5e15-694e-45b8-aed1-45050e847853",
"type_id": 4,
"reference_type": "OrderTypePreorder",
"state": 1,
"is_table_supported": null,
"external_channel_only": false,
"tip_default": 0,
"tip_max": 0
}
],
"table_pos_id": null,
"tablet": {
"id": "5a278144-927a-43cc-890e-2d3a6f583c60",
"name": "SF tablet",
"use_notifications": 0,
"show_kiosk_orders": false,
"kiosk_notification_type": 0,
"middleware_endpoint": null,
"pls_name": null,
"state": 3,
"is_online": false,
"last_request_at": null,
"failure_reported": false,
"is_critical": false,
"area_ids": [
"75516f2f-69d3-4603-824d-896f34e9e266",
"2f02ecbd-0cfd-4054-9bbb-ac6445a57fd6",
"e13ca919-016a-4748-9ea4-a17b26cb2b3b"
],
"allow_disable_product": false
}
}
],
"menu_id": "4c092b16-6e6c-4477-9927-4b029d0735a6",
"days_in_advance": 0,
"payment_processors": [
{
"id": 3287,
"venue_id": 3341,
"payment_method_type_id": 1,
"payment_processor_id": 3866,
"properties": null
}
]
},
"deliver_now": true,
"deliver_later": true,
"relative_time": 34,
"absolute_time": "2023-08-05 20:28:10",
"delivery_fee": 0,
"minimal_order_amount": 1500,
"dsp_promise_info": null
},
{
"venue": {
"id": "a9d6d0c8-1689-4114-b1ec-6da9c33f0384",
"uuid": "a9d6d0c8-1689-4114-b1ec-6da9c33f0384",
"name": "Kauwela San Francisco 5",
"code": "3342",
"currency_id": "692f600e-3e2a-4c43-9bed-66e5a23473bc",
"language_id": 1,
"external_dlc_id": null,
"serving_time_mode": 1,
"brand_id": "de3a0527-7e4c-4888-91de-71b6d29efa74",
"timezone": {
"name": "America/Los_Angeles",
"offset": "-07:00"
},
"description": "",
"kiosk_receipt_footer": "",
"imprint": "",
"welcome_message": "welcome_message welcome_messagewelcome_message",
"translations": {
"description": "",
"kiosk_receipt_footer": null,
"welcome_message": "welcome_message welcome_messagewelcome_message"
},
"address": "798 Brannan St",
"state": 1,
"city": "San Francisco",
"zip": "94103",
"latitude": 37.7737509,
"longitude": -122.4135012,
"tax_number": "123XYZ234",
"phone": "134829481",
"price_configuration": {
"order_types": [
{
"type_id": 1,
"price_configuration": null
},
{
"type_id": 4,
"price_configuration": null
},
{
"type_id": 6,
"price_configuration": null
},
{
"type_id": 7,
"price_configuration": 3
},
{
"type_id": 8,
"price_configuration": null
},
{
"type_id": 9,
"price_configuration": null
}
],
"external_channels": []
},
"used_price_configurations": [
3
],
"cuisine": "",
"store_url": "",
"is_shown_in_directory": true,
"allow_item_comments": false,
"tip_default": 5,
"tip_max": 15,
"service_charge": 0,
"pickup_time": 5,
"is_pickup_on_open_allowed": false,
"calculation_method": "exclusive",
"image": {
"thumbnail_small": "https://s3.eu-central-1.amazonaws.com/api.playground/images/venue_images/_thumbs280/2023-07-27/5ffd72acf623047511e49a2f91e19a55.jpeg",
"thumbnail_medium": "https://s3.eu-central-1.amazonaws.com/api.playground/images/venue_images/_thumbs720/2023-07-27/5ffd72acf623047511e49a2f91e19a55.jpeg",
"fullsize": "https://s3.eu-central-1.amazonaws.com/api.playground/images/venue_images/2023-07-27/5ffd72acf623047511e49a2f91e19a55.jpeg"
},
"available_payment_methods": [
{
"payment_method_id": "e3423d4d-7200-4c16-a154-a51fb2695838",
"payment_method_type_id": 1,
"payment_method_brand": "Visa",
"payment_processor_type_id": 32,
"payment_processor_id": "5bab16ce-bb27-4e62-aff4-124266647eaf",
"properties": null,
"fraud_detection_processor_id": null,
"visibility_scopes": null
},
{
"payment_method_id": "ea1ac590-b980-4d79-9376-9411fae5ff11",
"payment_method_type_id": 1,
"payment_method_brand": "MasterCard",
"payment_processor_type_id": 32,
"payment_processor_id": "5bab16ce-bb27-4e62-aff4-124266647eaf",
"properties": null,
"fraud_detection_processor_id": null,
"visibility_scopes": null
},
{
"payment_method_id": "8f78d853-2ad1-4371-9a47-68ca18f291cf",
"payment_method_type_id": 1,
"payment_method_brand": "Amex",
"payment_processor_type_id": 32,
"payment_processor_id": "5bab16ce-bb27-4e62-aff4-124266647eaf",
"properties": null,
"fraud_detection_processor_id": null,
"visibility_scopes": null
},
{
"payment_method_id": "e7ac7117-13ba-4da3-a7f2-142cba95eb48",
"payment_method_type_id": 1,
"payment_method_brand": "Diners Club",
"payment_processor_type_id": 32,
"payment_processor_id": "5bab16ce-bb27-4e62-aff4-124266647eaf",
"properties": null,
"fraud_detection_processor_id": null,
"visibility_scopes": null
}
],
"country": {
"id": "5123365b-2d43-45bf-8418-21dcacc595ef",
"currency_id": "692f600e-3e2a-4c43-9bed-66e5a23473bc",
"name": "American Samoa",
"code": "AS",
"code_alpha3": "ASM",
"code_numeric": "016",
"calling_code": "+1-684",
"distance_unit": "km",
"is_address_number_first": false,
"currency_settings": {
"currency_space": true,
"decimal_separator": ".",
"thousands_separator": ",",
"symbol_position": "left"
},
"supported_travel_modes": [
"driving"
],
"available_payment_methods": []
},
"currency": {
"id": "692f600e-3e2a-4c43-9bed-66e5a23473bc",
"code": "EUR",
"code_numeric": "978",
"symbol": "€",
"rounding_unit": 0.01,
"rounding_unit_tip": 0.01
},
"order_types": [
{
"id": "81035813-b64f-4776-8a6c-ef00043aff05",
"type_id": 1,
"reference_type": "OrderTypeDineIn",
"state": 1,
"is_table_supported": true,
"external_channel_only": false,
"tip_default": 0,
"tip_max": 0
},
{
"id": "aaa1ae2f-6bbf-4547-b722-61375cf1f835",
"type_id": 4,
"reference_type": "OrderTypePreorder",
"state": 1,
"is_table_supported": false,
"external_channel_only": false,
"tip_default": 0,
"tip_max": 0
},
{
"id": "b3265e27-eef5-425d-8f21-0f9780ff6236",
"type_id": 6,
"reference_type": "OrderTypeTakeOut",
"state": 1,
"is_table_supported": false,
"external_channel_only": false,
"tip_default": 5,
"tip_max": 15
},
{
"id": "3ca0c042-4a89-43fa-b197-7820a2818782",
"type_id": 7,
"reference_type": "OrderTypeDelivery",
"state": 1,
"is_table_supported": false,
"external_channel_only": false,
"tip_default": 0,
"tip_max": 0
},
{
"id": "5514ba04-70d9-47f8-826d-7c22deff741a",
"type_id": 8,
"reference_type": "OrderTypeCurbside",
"state": 1,
"is_table_supported": false,
"external_channel_only": false,
"tip_default": 5,
"tip_max": 15
},
{
"id": "a20372c5-d989-4d20-b64c-141f558f499e",
"type_id": 9,
"reference_type": "OrderTypeFoodspot",
"state": 1,
"is_table_supported": false,
"external_channel_only": false,
"tip_default": 0,
"tip_max": 0
}
],
"temporary_updated_entities": [],
"serving_times": [
{
"id": "219f26ca-2ccc-4433-b099-dcb4147cc512",
"type_id": 2,
"reference_type": "WeekDays",
"time_from": "06:30",
"time_to": "23:00",
"delivery_at": null,
"days": [
1,
2,
3,
4,
5
]
},
{
"id": "60931918-f682-4e4a-a9db-65ae8d3d9d1f",
"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": "4adfb91d-19a0-4313-8b42-86c96b3a737e",
"type_id": 1,
"reference_type": "SpecialDays",
"time_from": "08:00",
"time_to": "13:00",
"delivery_at": null,
"date": "2023-09-01",
"date_to": "2023-09-05",
"working": true
}
],
"is_open": false,
"will_open": false,
"has_discounts": true,
"has_loyalty": true,
"has_promotions": true,
"has_delivery_integration": false,
"delivery_integration_properties": null,
"delivery_travel_type": "driving",
"is_calculated_delivery_buffer_used": false,
"is_monitoring_enabled": false,
"is_threeds_enabled": false,
"is_fraud_detection_enabled": false,
"is_smart_orders_enabled": false,
"use_pos_order_number": false,
"has_uc_capacity_management": false,
"kiosk_face_count": null,
"is_order_regret_enabled": false,
"is_billable": true,
"default_delivery_buffer": 20,
"integration": {
"id": "361cc1a1-ca5d-451c-a893-3963c2efd0d7",
"type_id": 1,
"reference_type": "Plain",
"is_windows_pos": false,
"pos_modifier_group_type": 1,
"support_combo_meals": false,
"max_comment_limit": 0,
"allow_multiple_days_in_advance": true
},
"created_at": "2023-07-24 13:54:56",
"updated_at": "2023-08-05 22:34:33",
"areas": [
{
"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",
"pos_id": null,
"name": "takeout",
"use_tablet": true,
"state": 1,
"is_table_supported": 0,
"properties": {
"location_type": "table"
},
"order_types": [
{
"id": "b3265e27-eef5-425d-8f21-0f9780ff6236",
"type_id": 6,
"reference_type": "OrderTypeTakeOut",
"state": 1,
"is_table_supported": null,
"external_channel_only": false,
"tip_default": 5,
"tip_max": 15
}
],
"table_pos_id": null,
"tablet": {
"id": "fdca7af8-1650-48dd-9481-df8059f33517",
"name": "SF tablet",
"use_notifications": 0,
"show_kiosk_orders": false,
"kiosk_notification_type": 0,
"middleware_endpoint": null,
"pls_name": null,
"state": 3,
"is_online": false,
"last_request_at": null,
"failure_reported": false,
"is_critical": 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"
],
"allow_disable_product": false
}
},
{
"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",
"pos_id": null,
"name": "curbside",
"use_tablet": true,
"state": 1,
"is_table_supported": 0,
"properties": null,
"order_types": [
{
"id": "5514ba04-70d9-47f8-826d-7c22deff741a",
"type_id": 8,
"reference_type": "OrderTypeCurbside",
"state": 1,
"is_table_supported": null,
"external_channel_only": false,
"tip_default": 5,
"tip_max": 15
}
],
"table_pos_id": null,
"tablet": {
"id": "fdca7af8-1650-48dd-9481-df8059f33517",
"name": "SF tablet",
"use_notifications": 0,
"show_kiosk_orders": false,
"kiosk_notification_type": 0,
"middleware_endpoint": null,
"pls_name": null,
"state": 3,
"is_online": false,
"last_request_at": null,
"failure_reported": false,
"is_critical": 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"
],
"allow_disable_product": false
}
},
{
"id": "c2e6402c-518f-4d54-8830-6d818b25b608",
"type_id": 7,
"reference_type": "AreaFoodspot",
"menu_id": "899129db-5b88-4c95-8fe2-972e6faec523",
"singular_point_id": "d24c7292-455f-447c-8434-3d42da923a5d",
"pos_id": null,
"name": "FoodSpot",
"use_tablet": true,
"state": 1,
"is_table_supported": 0,
"properties": null,
"order_types": [
{
"id": "a20372c5-d989-4d20-b64c-141f558f499e",
"type_id": 9,
"reference_type": "OrderTypeFoodspot",
"state": 1,
"is_table_supported": null,
"external_channel_only": false,
"tip_default": 0,
"tip_max": 0
}
],
"table_pos_id": null,
"tablet": {
"id": "fdca7af8-1650-48dd-9481-df8059f33517",
"name": "SF tablet",
"use_notifications": 0,
"show_kiosk_orders": false,
"kiosk_notification_type": 0,
"middleware_endpoint": null,
"pls_name": null,
"state": 3,
"is_online": false,
"last_request_at": null,
"failure_reported": false,
"is_critical": 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"
],
"allow_disable_product": false
}
},
{
"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",
"pos_id": null,
"name": "Full Service",
"use_tablet": false,
"state": 1,
"is_table_supported": 1,
"properties": {
"location_type": "table"
},
"order_types": [
{
"id": "81035813-b64f-4776-8a6c-ef00043aff05",
"type_id": 1,
"reference_type": "OrderTypeDineIn",
"state": 1,
"is_table_supported": null,
"external_channel_only": false,
"tip_default": 0,
"tip_max": 0
}
],
"singular_point_input_type": "ManualInput"
},
{
"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",
"pos_id": null,
"name": "Quick Service",
"use_tablet": true,
"state": 1,
"is_table_supported": 0,
"properties": {
"location_type": "table"
},
"order_types": [
{
"id": "aaa1ae2f-6bbf-4547-b722-61375cf1f835",
"type_id": 4,
"reference_type": "OrderTypePreorder",
"state": 1,
"is_table_supported": null,
"external_channel_only": false,
"tip_default": 0,
"tip_max": 0
}
],
"table_pos_id": null,
"tablet": {
"id": "fdca7af8-1650-48dd-9481-df8059f33517",
"name": "SF tablet",
"use_notifications": 0,
"show_kiosk_orders": false,
"kiosk_notification_type": 0,
"middleware_endpoint": null,
"pls_name": null,
"state": 3,
"is_online": false,
"last_request_at": null,
"failure_reported": false,
"is_critical": 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"
],
"allow_disable_product": false
}
},
{
"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",
"pos_id": null,
"name": "Delivery",
"use_tablet": true,
"state": 1,
"is_table_supported": 0,
"properties": null,
"order_types": [
{
"id": "3ca0c042-4a89-43fa-b197-7820a2818782",
"type_id": 7,
"reference_type": "OrderTypeDelivery",
"state": 1,
"is_table_supported": null,
"external_channel_only": false,
"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,
"created_at": "2023-08-05 22:21:54",
"updated_at": "2023-08-05 22:21:54",
"delivery_fee": {
"type_id": 1,
"reference_type": "DeliveryFeeFixed",
"price": 150,
"price_per_unit": 0,
"unit": "kilometer",
"created_at": "2023-08-05 22:21:33",
"updated_at": "2023-08-05 22:21:33"
}
},
{
"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,
"created_at": "2023-08-05 22:21:54",
"updated_at": "2023-08-05 22:21:54",
"delivery_fee": {
"type_id": 2,
"reference_type": "DeliveryFeeDistance",
"price": 0,
"price_per_unit": 200,
"unit": "kilometer",
"created_at": "2023-08-05 22:21:48",
"updated_at": "2023-08-05 22:21:48"
}
}
],
"delivery_times": [
{
"id": "8b644f29-1604-47ac-9623-2e6b0596c9c2",
"type_id": 2,
"reference_type": "WeekDays",
"time_from": "09:30",
"time_to": "21:30",
"delivery_at": null,
"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",
"use_notifications": 0,
"show_kiosk_orders": false,
"kiosk_notification_type": 0,
"middleware_endpoint": null,
"pls_name": null,
"state": 3,
"is_online": false,
"last_request_at": null,
"failure_reported": false,
"is_critical": 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"
],
"allow_disable_product": false
}
}
],
"menu_id": "899129db-5b88-4c95-8fe2-972e6faec523",
"days_in_advance": 0,
"payment_processors": [
{
"id": 3288,
"venue_id": 3342,
"payment_method_type_id": 1,
"payment_processor_id": 3866,
"properties": null
}
]
},
"deliver_now": false,
"deliver_later": false,
"relative_time": 31,
"absolute_time": "2023-08-05 20:25:10",
"delivery_fee": 150,
"minimal_order_amount": 2000,
"dsp_promise_info": null
}
]
}
}
| Attribute | Type | Example Value | Description |
|---|---|---|---|
delivery_venues.[i].deliver_now |
bool | true |
If a delivery order for ASAP can currently be placed at the Venue |
delivery_venues.[i].deliver_later |
bool | true |
If a delivery order can currently be placed later for the current day at the Venue |
delivery_venues.[i].relative_time |
int | 34 |
Number of minutes for a delivery order to arrive from order placement |
delivery_venues.[i].absolute_time |
string | "2023-08-05 20:28:10" |
Absolute time that a delivery order will arrive at if placed right now |
delivery_venues.[i].delivery_fee |
int | 150 |
Delivery fee amount (lowest unit) from specified delivery location |
delivery_venues.[i].minimal_order_amount |
int | 1500 |
The minimum order value that needs to be reached to place an order, based on the specified delivery location |
delivery_venues.[i].venue |
Venue resource | Venue resource - see Select a Store for Dine-in or Takeout for more details | |
delivery_venues.[i].venue.days_in_advance |
int | 3 |
The number of allowed future days for scheduled ordering (only for Delivery order type) |
delivery_venues.[i].has_delivery_integration |
bool | true |
Defines whether the Venue has MENU Dispatch enabled or not |
Note
For Catering delivery the endpoint will always return only one venue or an empty array if no venues are found.
Delivery Quote (for Dispatch-enabled stores)
For Venues that use MENU Dispatch to manage their own driver fleets or connect to third-party Delivery Service Providers for logistics, you should make a Delivery Quote call, which will allow you to ensure that coverage / capacity is available to deliver the order, as well as get a more precise Estimated Delivery Time and Delivery Fee.
To determine whether a Venue has Dispatch enabled, look at the has_delivery_integration flag on the Venue resource.
Using /dispatch-service/quotes you can check the capacity / coverage of the brand's own fleet and / or third-party Delivery Service Providers for a specified list of stores, as well as get an estimated delivery time and delivery fee:
Request
| Attribute | Type | Example Value | Description |
|---|---|---|---|
latitude |
float | 37.777356 |
Latitude of delivery location coordinates |
longitude |
float | -122.399737 |
Longitude of delivery location coordinates |
store_ids |
array[string] | ["67984194-717f-46e7-aca6-03a7b64009f3"] |
Array of Venue UUIDs for which quote should be checked - provide list of Venues received on /delivery/venues API call that have has_delivery_integration enabled |
estimated_delivery_time |
string | "2023-08-11 17:00:00" |
Can be optionally provided if the customer is not ordering for ASAP, but for a specific time in advance |
order_type_id |
int | 10 |
If not specified the fallback value is 7 - Delivery order type |
{
"method": "post",
"url": "https://api-public-playground.menu.app/api/dispatch-service/quotes",
"headers": {
"X-Request-ID": "69da3547-204b-4093-a225-54e084c24215",
"Application": "f3a90488ffee32c3acb6fcd0ca417cf6",
"Api-Version": 4.38.0,
"Content-Type": "application/json"
},
"body": {
"latitude": 37.777356,
"longitude": -122.399737,
"store_ids": [
"67984194-717f-46e7-aca6-03a7b64009f3",
"a9d6d0c8-1689-4114-b1ec-6da9c33f0384"
],
"expected_delivery_time": "2023-08-11 17:00:00"
}
}
Response
{
"code": 200,
"data": {
"promises": [
{
"state": "Ready to order",
"token": "3921ed0b-f4a6-40eb-89a4-d68b64f6fb77",
"store_id": "b8b96123-3f22-11ed-936c-1a67b454859d",
"order_token": "null",
"estimated_pickup_time": "null",
"estimated_delivery_fee": 705,
"expected_delivery_time": "2023-01-23T19:00:00.000Z",
"estimated_delivery_time": "2023-05-24T13:57:40.000Z",
"target_delivery_providers": [
"dsp1"
],
"external_delivery_provider_promise_order_id": "null"
}
]
},
"status": "OK"
}
| Attribute | Type | Example Value | Description |
|---|---|---|---|
promises.[i].token |
string | "3921ed0b-f4a6-40eb-89a4-d68b64f6fb77" |
Uniquely identifies the provided quote - needed for subsequent delivery API calls |
promises.[i].store_id |
float | "b8b96123-3f22-11ed-936c-1a67b454859d" |
UUID of Venue (Store / Location) that promise was provided for |
promises.[i].estimated_delivery_time |
float | "2023-05-24T13:57:40.000Z" |
Timestamp of estimated delivery time based on own fleet data or third-party DSP estimates |
promises.[i].estimated_delivery_fee |
float | 705 |
Estimated delivery fee cost (lowest unit) for third-party DSPs |
Since /dispatch-service/quotes will only return stores that have coverage (by own fleet or third-party DSP) to deliver, you can use a cross of both responses to determine which Venue should be ordered from.
Select a Store
Brands have the possibility of configuring through the Management Center whether they want to give their customers the possibility of choosing the specific Venue (Store / Location) that they want to order from for Delivery, or whether the application should determine this automatically, based on which Venue is closer to the customer's delivery location.
In order to check the Brand's configuration, you can look at the use_first_delivery_venue flag on /init-application. Review Application Initialization for more information.
Venues returned from the /delivery/venues API endpoint are always already sorted by distance to the delivery location, so in case the use_first_delivery_venue flag is true, you can just proceed with automatically selecting the first result from the list (in case of Dispatch, ensure the Venue returned a delivery quote). Otherwise, you can present the customer a list of all available Delivery Venues and allow them to make their own selection.
For Catering delivery there is no option for selecting a store, and only one venue is returned by the /delivery/venues API endpoint.
Once the store has been selected, you can make a call to get more details about that specific Venue:
The /venues/{venue_uuid} call allows you to fetch all details of a specific Venue by UUID:
Request
{
"method": "get",
"url": "https://api-public-playground.menu.app/api/venues/{venue_uuid}",
"headers": {
"X-Request-ID": "69da3547-204b-4093-a225-54e084c24215",
"Application": "f3a90488ffee32c3acb6fcd0ca417cf6",
"Api-Version": 4.38.0
}
}
Response
{
"status": "OK",
"code": 200,
"data": {
"venue": {
"id": "a9d6d0c8-1689-4114-b1ec-6da9c33f0384",
"uuid": "a9d6d0c8-1689-4114-b1ec-6da9c33f0384",
"name": "Kauwela San Francisco 5",
"code": "3342",
"currency_id": "692f600e-3e2a-4c43-9bed-66e5a23473bc",
"language_id": 1,
"external_dlc_id": null,
"serving_time_mode": 1,
"brand_id": "de3a0527-7e4c-4888-91de-71b6d29efa74",
"timezone": {
"name": "America/Los_Angeles",
"offset": "-07:00"
},
"description": "",
"kiosk_receipt_footer": "",
"imprint": "",
"welcome_message": "welcome_message welcome_messagewelcome_message",
"translations": {
"description": "",
"kiosk_receipt_footer": null,
"welcome_message": "welcome_message welcome_messagewelcome_message"
},
"address": "798 Brannan St",
"state": 1,
"city": "San Francisco",
"zip": "94103",
"latitude": 37.7737509,
"longitude": -122.4135012,
"tax_number": "123XYZ234",
"phone": "134829481",
"price_configuration": {
"order_types": [
{
"type_id": 1,
"price_configuration": null
},
{
"type_id": 4,
"price_configuration": null
},
{
"type_id": 6,
"price_configuration": null
},
{
"type_id": 7,
"price_configuration": 3
},
{
"type_id": 8,
"price_configuration": null
},
{
"type_id": 9,
"price_configuration": null
}
],
"external_channels": []
},
"used_price_configurations": [
3
],
"cuisine": "",
"store_url": "",
"is_shown_in_directory": true,
"allow_item_comments": false,
"tip_default": 5,
"tip_max": 15,
"service_charge": 0,
"pickup_time": 5,
"is_pickup_on_open_allowed": false,
"calculation_method": "exclusive",
"image": {
"thumbnail_small": "https://s3.eu-central-1.amazonaws.com/api.playground/images/venue_images/_thumbs280/2023-07-27/5ffd72acf623047511e49a2f91e19a55.jpeg",
"thumbnail_medium": "https://s3.eu-central-1.amazonaws.com/api.playground/images/venue_images/_thumbs720/2023-07-27/5ffd72acf623047511e49a2f91e19a55.jpeg",
"fullsize": "https://s3.eu-central-1.amazonaws.com/api.playground/images/venue_images/2023-07-27/5ffd72acf623047511e49a2f91e19a55.jpeg"
},
"available_payment_methods": [
{
"payment_method_id": "e3423d4d-7200-4c16-a154-a51fb2695838",
"payment_method_type_id": 1,
"payment_method_brand": "Visa",
"payment_processor_type_id": 32,
"payment_processor_id": "5bab16ce-bb27-4e62-aff4-124266647eaf",
"properties": null,
"fraud_detection_processor_id": null,
"visibility_scopes": null
},
{
"payment_method_id": "ea1ac590-b980-4d79-9376-9411fae5ff11",
"payment_method_type_id": 1,
"payment_method_brand": "MasterCard",
"payment_processor_type_id": 32,
"payment_processor_id": "5bab16ce-bb27-4e62-aff4-124266647eaf",
"properties": null,
"fraud_detection_processor_id": null,
"visibility_scopes": null
},
{
"payment_method_id": "8f78d853-2ad1-4371-9a47-68ca18f291cf",
"payment_method_type_id": 1,
"payment_method_brand": "Amex",
"payment_processor_type_id": 32,
"payment_processor_id": "5bab16ce-bb27-4e62-aff4-124266647eaf",
"properties": null,
"fraud_detection_processor_id": null,
"visibility_scopes": null
},
{
"payment_method_id": "e7ac7117-13ba-4da3-a7f2-142cba95eb48",
"payment_method_type_id": 1,
"payment_method_brand": "Diners Club",
"payment_processor_type_id": 32,
"payment_processor_id": "5bab16ce-bb27-4e62-aff4-124266647eaf",
"properties": null,
"fraud_detection_processor_id": null,
"visibility_scopes": null
}
],
"country": {
"id": "5123365b-2d43-45bf-8418-21dcacc595ef",
"currency_id": "692f600e-3e2a-4c43-9bed-66e5a23473bc",
"name": "American Samoa",
"code": "AS",
"code_alpha3": "ASM",
"code_numeric": "016",
"calling_code": "+1-684",
"distance_unit": "km",
"is_address_number_first": false,
"currency_settings": {
"currency_space": true,
"decimal_separator": ".",
"thousands_separator": ",",
"symbol_position": "left"
},
"supported_travel_modes": [
"driving"
],
"available_payment_methods": []
},
"currency": {
"id": "692f600e-3e2a-4c43-9bed-66e5a23473bc",
"code": "EUR",
"code_numeric": "978",
"symbol": "€",
"rounding_unit": 0.01,
"rounding_unit_tip": 0.01
},
"order_types": [
{
"id": "81035813-b64f-4776-8a6c-ef00043aff05",
"type_id": 1,
"reference_type": "OrderTypeDineIn",
"state": 1,
"is_table_supported": true,
"external_channel_only": false,
"tip_default": 0,
"tip_max": 0
},
{
"id": "aaa1ae2f-6bbf-4547-b722-61375cf1f835",
"type_id": 4,
"reference_type": "OrderTypePreorder",
"state": 1,
"is_table_supported": false,
"external_channel_only": false,
"tip_default": 0,
"tip_max": 0
},
{
"id": "b3265e27-eef5-425d-8f21-0f9780ff6236",
"type_id": 6,
"reference_type": "OrderTypeTakeOut",
"state": 1,
"is_table_supported": false,
"external_channel_only": false,
"tip_default": 5,
"tip_max": 15
},
{
"id": "3ca0c042-4a89-43fa-b197-7820a2818782",
"type_id": 7,
"reference_type": "OrderTypeDelivery",
"state": 1,
"is_table_supported": false,
"external_channel_only": false,
"tip_default": 0,
"tip_max": 0
},
{
"id": "5514ba04-70d9-47f8-826d-7c22deff741a",
"type_id": 8,
"reference_type": "OrderTypeCurbside",
"state": 1,
"is_table_supported": false,
"external_channel_only": false,
"tip_default": 5,
"tip_max": 15
},
{
"id": "a20372c5-d989-4d20-b64c-141f558f499e",
"type_id": 9,
"reference_type": "OrderTypeFoodspot",
"state": 1,
"is_table_supported": false,
"external_channel_only": false,
"tip_default": 0,
"tip_max": 0
}
],
"temporary_updated_entities": [],
"serving_times": [
{
"id": "219f26ca-2ccc-4433-b099-dcb4147cc512",
"type_id": 2,
"reference_type": "WeekDays",
"time_from": "06:30",
"time_to": "23:00",
"delivery_at": null,
"days": [
1,
2,
3,
4,
5
]
},
{
"id": "60931918-f682-4e4a-a9db-65ae8d3d9d1f",
"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": "4adfb91d-19a0-4313-8b42-86c96b3a737e",
"type_id": 1,
"reference_type": "SpecialDays",
"time_from": "08:00",
"time_to": "13:00",
"delivery_at": null,
"date": "2023-09-01",
"date_to": "2023-09-05",
"working": true
}
],
"is_open": false,
"will_open": false,
"has_discounts": true,
"has_loyalty": true,
"has_promotions": true,
"has_delivery_integration": false,
"delivery_integration_properties": null,
"delivery_travel_type": "driving",
"is_calculated_delivery_buffer_used": false,
"is_monitoring_enabled": false,
"is_threeds_enabled": false,
"is_fraud_detection_enabled": false,
"is_smart_orders_enabled": false,
"use_pos_order_number": false,
"has_uc_capacity_management": false,
"kiosk_face_count": null,
"is_order_regret_enabled": false,
"is_billable": true,
"default_delivery_buffer": 20,
"integration": {
"id": "361cc1a1-ca5d-451c-a893-3963c2efd0d7",
"type_id": 1,
"reference_type": "Plain",
"is_windows_pos": false,
"pos_modifier_group_type": 1,
"support_combo_meals": false,
"max_comment_limit": 0,
"allow_multiple_days_in_advance": true
},
"created_at": "2023-07-24 13:54:56",
"updated_at": "2023-08-05 22:34:33",
"areas": [
{
"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",
"pos_id": null,
"name": "takeout",
"use_tablet": true,
"state": 1,
"is_table_supported": 0,
"properties": {
"location_type": "table"
},
"order_types": [
{
"id": "b3265e27-eef5-425d-8f21-0f9780ff6236",
"type_id": 6,
"reference_type": "OrderTypeTakeOut",
"state": 1,
"is_table_supported": null,
"external_channel_only": false,
"tip_default": 5,
"tip_max": 15
}
],
"table_pos_id": null,
"tablet": {
"id": "fdca7af8-1650-48dd-9481-df8059f33517",
"name": "SF tablet",
"use_notifications": 0,
"show_kiosk_orders": false,
"kiosk_notification_type": 0,
"middleware_endpoint": null,
"pls_name": null,
"state": 3,
"is_online": false,
"last_request_at": null,
"failure_reported": false,
"is_critical": 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"
],
"allow_disable_product": false
}
},
{
"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",
"pos_id": null,
"name": "curbside",
"use_tablet": true,
"state": 1,
"is_table_supported": 0,
"properties": null,
"order_types": [
{
"id": "5514ba04-70d9-47f8-826d-7c22deff741a",
"type_id": 8,
"reference_type": "OrderTypeCurbside",
"state": 1,
"is_table_supported": null,
"external_channel_only": false,
"tip_default": 5,
"tip_max": 15
}
],
"table_pos_id": null,
"tablet": {
"id": "fdca7af8-1650-48dd-9481-df8059f33517",
"name": "SF tablet",
"use_notifications": 0,
"show_kiosk_orders": false,
"kiosk_notification_type": 0,
"middleware_endpoint": null,
"pls_name": null,
"state": 3,
"is_online": false,
"last_request_at": null,
"failure_reported": false,
"is_critical": 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"
],
"allow_disable_product": false
}
},
{
"id": "c2e6402c-518f-4d54-8830-6d818b25b608",
"type_id": 7,
"reference_type": "AreaFoodspot",
"menu_id": "899129db-5b88-4c95-8fe2-972e6faec523",
"singular_point_id": "d24c7292-455f-447c-8434-3d42da923a5d",
"pos_id": null,
"name": "FoodSpot",
"use_tablet": true,
"state": 1,
"is_table_supported": 0,
"properties": null,
"order_types": [
{
"id": "a20372c5-d989-4d20-b64c-141f558f499e",
"type_id": 9,
"reference_type": "OrderTypeFoodspot",
"state": 1,
"is_table_supported": null,
"external_channel_only": false,
"tip_default": 0,
"tip_max": 0
}
],
"table_pos_id": null,
"tablet": {
"id": "fdca7af8-1650-48dd-9481-df8059f33517",
"name": "SF tablet",
"use_notifications": 0,
"show_kiosk_orders": false,
"kiosk_notification_type": 0,
"middleware_endpoint": null,
"pls_name": null,
"state": 3,
"is_online": false,
"last_request_at": null,
"failure_reported": false,
"is_critical": 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"
],
"allow_disable_product": false
}
},
{
"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",
"pos_id": null,
"name": "Full Service",
"use_tablet": false,
"state": 1,
"is_table_supported": 1,
"properties": {
"location_type": "table"
},
"order_types": [
{
"id": "81035813-b64f-4776-8a6c-ef00043aff05",
"type_id": 1,
"reference_type": "OrderTypeDineIn",
"state": 1,
"is_table_supported": null,
"external_channel_only": false,
"tip_default": 0,
"tip_max": 0
}
],
"singular_point_input_type": "ManualInput"
},
{
"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",
"pos_id": null,
"name": "Quick Service",
"use_tablet": true,
"state": 1,
"is_table_supported": 0,
"properties": {
"location_type": "table"
},
"order_types": [
{
"id": "aaa1ae2f-6bbf-4547-b722-61375cf1f835",
"type_id": 4,
"reference_type": "OrderTypePreorder",
"state": 1,
"is_table_supported": null,
"external_channel_only": false,
"tip_default": 0,
"tip_max": 0
}
],
"table_pos_id": null,
"tablet": {
"id": "fdca7af8-1650-48dd-9481-df8059f33517",
"name": "SF tablet",
"use_notifications": 0,
"show_kiosk_orders": false,
"kiosk_notification_type": 0,
"middleware_endpoint": null,
"pls_name": null,
"state": 3,
"is_online": false,
"last_request_at": null,
"failure_reported": false,
"is_critical": 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"
],
"allow_disable_product": false
}
},
{
"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",
"pos_id": null,
"name": "Delivery",
"use_tablet": true,
"state": 1,
"is_table_supported": 0,
"properties": null,
"order_types": [
{
"id": "3ca0c042-4a89-43fa-b197-7820a2818782",
"type_id": 7,
"reference_type": "OrderTypeDelivery",
"state": 1,
"is_table_supported": null,
"external_channel_only": false,
"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,
"created_at": "2023-08-05 22:21:54",
"updated_at": "2023-08-05 22:21:54",
"delivery_fee": {
"type_id": 1,
"reference_type": "DeliveryFeeFixed",
"price": 150,
"price_per_unit": 0,
"unit": "kilometer",
"created_at": "2023-08-05 22:21:33",
"updated_at": "2023-08-05 22:21:33"
}
},
{
"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,
"created_at": "2023-08-05 22:21:54",
"updated_at": "2023-08-05 22:21:54",
"delivery_fee": {
"type_id": 2,
"reference_type": "DeliveryFeeDistance",
"price": 0,
"price_per_unit": 200,
"unit": "kilometer",
"created_at": "2023-08-05 22:21:48",
"updated_at": "2023-08-05 22:21:48"
}
}
],
"delivery_times": [
{
"id": "8b644f29-1604-47ac-9623-2e6b0596c9c2",
"type_id": 2,
"reference_type": "WeekDays",
"time_from": "09:30",
"time_to": "21:30",
"delivery_at": null,
"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",
"use_notifications": 0,
"show_kiosk_orders": false,
"kiosk_notification_type": 0,
"middleware_endpoint": null,
"pls_name": null,
"state": 3,
"is_online": false,
"last_request_at": null,
"failure_reported": false,
"is_critical": 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"
],
"allow_disable_product": false
}
}
],
"menu_id": "899129db-5b88-4c95-8fe2-972e6faec523",
"days_in_advance": 0,
"payment_processors": [
{
"id": 3288,
"venue_id": 3342,
"payment_method_type_id": 1,
"payment_processor_id": 3866,
"properties": null
}
]
}
}
}
| Attribute | Type | Example Value | Description |
|---|---|---|---|
venue |
Venue resource | Venue resource - see Select a Store for Dine-in or Takeout for more details | |
venue.areas[i].delivery_area_maps[i].minimal_order_amount |
int | 0 |
Minimal order amount for Delivery and Catering delivery |
Next Steps
After you have selected a Venue, you can proceed with Displaying the Menu.