Select a Store for Delivery
This guide explains how to build the flow that picks the store for a Delivery or Catering Delivery order.
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. Limits autocomplete results to these countries |
{
"method": "post",
"url": "https://api-public-demo.menu.app/api/autocomplete-addresses",
"headers": {
"X-Request-ID": "69da3547-204b-4093-a225-54e084c24215",
"Application": "f3a90488ffee32c3acb6fcd0ca417cf6",
"Api-Version": "<current-release-version>",
"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 go to a third-party mapping provider such as Google Maps, and the brand pays for each one. To keep that cost down, do not start sending them until the customer has typed 5 characters.
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
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-demo.menu.app/api/autocomplete-addresses/details",
"headers": {
"X-Request-ID": "69da3547-204b-4093-a225-54e084c24215",
"Application": "f3a90488ffee32c3acb6fcd0ca417cf6",
"Api-Version": "<current-release-version>",
"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" |
ZIP 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-demo.menu.app/api/autocomplete-addresses/details",
"headers": {
"X-Request-ID": "69da3547-204b-4093-a225-54e084c24215",
"Application": "f3a90488ffee32c3acb6fcd0ca417cf6",
"Api-Version": "<current-release-version>",
"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
Address details and reverse geocoding also go to a third-party mapping provider and are charged to the brand, so make as few /autocomplete-addresses/details calls as you can.
Call address details once, after the customer has picked an autocomplete result or confirmed their pin. Firing several details calls in quick succession 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-demo.menu.app/api/delivery/venues",
"headers": {
"X-Request-ID": "69da3547-204b-4093-a225-54e084c24215",
"Application": "f3a90488ffee32c3acb6fcd0ca417cf6",
"Api-Version": "<current-release-version>",
"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 PAR Ordering Dispatch enabled or not |
For Catering Delivery the call returns at most one store: the one that will handle the order, or an empty array if none can.
Delivery Quote (for Dispatch-enabled stores)
For Venues that use PAR Ordering Dispatch to manage their own driver fleets or connect to third-party Delivery Service Providers for logistics, you can ask for a delivery quote. The quote confirms that someone is actually available to deliver, and gives you a more precise estimated delivery time and fee than the store's own delivery settings.
Ask for the quote on the same call that finds the stores, by adding promise: true to Delivery Venues. You do not need a separate call, and you should not make one — see A note on /dispatch-service/promises below.
Request
{
"method": "post",
"url": "https://api-public-demo.menu.app/api/delivery/venues",
"headers": {
"X-Request-ID": "69da3547-204b-4093-a225-54e084c24215",
"Application": "f3a90488ffee32c3acb6fcd0ca417cf6",
"Api-Version": "<current-release-version>",
"Content-Type": "application/json"
},
"body": {
"latitude": 37.777356,
"longitude": -122.399737,
"order_type_id": 7,
"promise": true,
"street_name": "Market Street",
"street_number": "1",
"city": "San Francisco",
"postcode": "94105",
"formatted_address": "1 Market Street, San Francisco, CA 94105"
}
}
Send the address fields you have alongside the coordinates — they are passed to the delivery provider with the quote — and expected_delivery_time when the customer has chosen a time rather than ordering as soon as possible.
Response
Each store that got a quote carries two extra fields:
| Attribute | Type | Example Value | Description |
|---|---|---|---|
delivery_venues.[i].promise |
object | null | The quote itself — estimated delivery time, fee and the provider that would carry it. null when the store did not get one. |
|
delivery_venues.[i].promise_key |
string | null | "order_delivery_promise_3921ed0b-f4a6-40eb-89a4-d68b64f6fb77" |
Carry this through the rest of the flow. It is how we recognize the quote later, and it expires after 15 minutes. |
delivery_fee on the store is updated to the quoted fee when a quote came back, so you can show the customer the real price rather than the store's default.
A store without a quote is not an error
Read promise together with has_delivery_integration on the store's venue; the same null means two different things.
A store with has_delivery_integration: false always has promise: null. It does not use dispatch, so it is never quoted. It is still a perfectly good store to order from — its own delivery_fee and delivery_time come from the brand's delivery settings, and the order goes through. Do not filter these stores out.
A store with has_delivery_integration: true and promise: null cannot deliver right now. The store is set up for dispatch but no quote came back — no provider offered to deliver (out of range, no capacity, nobody on shift), or the store is flagged for dispatch without a hub configured. For that store Orders Filtered Pickup Times comes back with an empty pickup_times array, so the customer has nothing to choose and cannot complete the order. Tell them delivery is unavailable from that store right now, rather than showing them an empty time picker.
Carry the quote through to the order
The quote is only useful if you keep hold of promise_key. This is the sequence the PAR web app follows; the same key travels through three calls.
1. Delivery times. Send the key as customer_order_key on Orders Filtered Pickup Times, so the slots you offer are based on the quote rather than on generic estimates. The call still needs the store's singular_point_id, the delivery order type with the customer's coordinates and, once it exists, the cart_id, as described in Choosing a pickup or delivery time. Add expected_delivery_time when the customer has picked a time:
{
"singular_point_id": "5a1c8e2f-3b4d-4e6f-8a9b-0c1d2e3f4a5b",
"order_type": {
"id": 7,
"delivery_info": {
"latitude": 37.777356,
"longitude": -122.399737
}
},
"cart_id": "f6ce31f7b7549cc7c3e5326661cf1dc3b5ea5c3fd89cce634667e483e23fb51a",
"customer_order_key": "order_delivery_promise_3921ed0b-f4a6-40eb-89a4-d68b64f6fb77"
}
On a dispatch-enabled store the response carries the quote back to you as well as the slots:
| Attribute | Type | Description |
|---|---|---|
promise.estimated_pickup_time |
string | When the courier is expected to collect the order |
promise.estimated_delivery_time |
string | When the courier is expected to hand it over. Slots before this are already filtered out |
promise.token |
string | Dispatch's own identifier. Informational — do not send it anywhere |
customer_order_key |
string | The key for the quote these slots came from. Keep using this one |
You can also get a quote from this call directly. Omit customer_order_key on a dispatch-enabled store and a fresh quote is requested for you; the customer_order_key in the response is the new key. The web app uses this right before placing the order — one more Filtered Pickup Times call with no customer_order_key and current_capacity_check: true, which confirms the slot is still open and refreshes the quote in one go — and it is also the answer when a key has expired.
2. The cart. Put the latest key on the cart as metadata.order_type.delivery_info.promise_key, alongside the delivery address, on Update Cart before you check out. Order creation reads it from the cart; that is what attaches the quote to the order, sets its delivery time from the quote and hands the job to the right provider:
{
"metadata": {
"venue_id": "975ba87e-ac25-4da5-b04b-76844ef10421",
"order_type": {
"id": 7,
"delivery_info": {
"latitude": 37.777356,
"longitude": -122.399737,
"street_name": "Market Street",
"formatted_address": "1 Market Street, San Francisco, CA 94105",
"promise_key": "order_delivery_promise_3921ed0b-f4a6-40eb-89a4-d68b64f6fb77"
}
}
}
}
This shows only the delivery part of the request. An Update Cart request always carries the whole cart — cart.products, cart.discounts and cart.tip are required on every update — so merge this into your current cart body rather than sending it on its own. The Update Cart reference has a complete delivery example.
3. Place the order with POST /cart/{cart_id}/order as usual. There is nothing quote-related to add to that request.
A key lives for 15 minutes. If the customer takes longer than that between picking a store and paying, refresh it — the final Filtered Pickup Times call described above does this — and put the new key on the cart before checkout. A stale key means the order is placed without the quote attached.
A note on /dispatch-service/promises and the promise token
Delivery Promise Create is a lower-level dispatch endpoint. It returns a promises[].token, but nothing on the order path reads that token, so a quote obtained this way cannot be attached to an order. It also returns an error for a store that is flagged for dispatch but has no hub configured, where the promise: true flow simply returns that store with promise: null.
For the same reason, do not send a promise_token on order creation. Older clients did, and the field is still accepted, but the Ordering API does not read it; only delivery_info.promise_key on the cart attaches a quote. The PAR web app does not call the dispatch endpoint either — on the cart flow it uses promise: true on Delivery Venues and customer_order_key on Filtered Pickup Times, exactly as above. The dispatch endpoint is documented for reference and for internal tooling, not as part of the ordering flow.
Select a Store
A brand decides whether delivery customers choose the store themselves or the closest store to the delivery address is picked for them.
Read which it is from 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:
GET /venues/{venue_uuid} returns everything about one store:
Request
{
"method": "get",
"url": "https://api-public-demo.menu.app/api/venues/{venue_uuid}",
"headers": {
"X-Request-ID": "69da3547-204b-4093-a225-54e084c24215",
"Application": "f3a90488ffee32c3acb6fcd0ca417cf6",
"Api-Version": "<current-release-version>"
}
}
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.

