Empowering Restaurants through Integration

  1. Grubhub Developers
  2. Order Taking
  3. API Specification
Follow

Restaurants

These API endpoints return various information about restaurants, including menu items and availability.

Paths

Returns information about a restaurant.

GET /restaurants/v{version}/{restaurant_id}
Description

Returns information about a specified restaurant, including delivery information, current availability, and, optionally, menu items. This is the primary method you should use to get restaurant information. You must already have the desired restaurant's {restaurant_id} to call this method. Your system should already have data that through bulk information feeds that we have provided.

To minimize the size of the returned JSON array, append hideMenuItems=true to your parameters. This will return the restaurant information without the list of menu items. If you still want menu items returned, you can use the hideChoiceCategories to filter out the individual menu item choices (i.e. toppings or size for a pizza).

As this is a GET call, all parameters must be passed within the URI used to call this API method.

Path Parameters
restaurant_id
labelRequired
UUID
The unique identifier of the restaurant for which you want to view information.
version
labelRequired
Integer
The version of the restaurant data that you want to return, either 1 or 3. Version 3 data includes several advanced modifier options for menu items. It is currently only used on a small subset of chain restaurants, but it will eventually be rolled out to all Grubhub restaurants.
Query Parameters
hideChoiceCategories
label_outlineOptional
boolean
Set this to `true` to filter out the menu item choices (i.e. pizza toppings, included appetizers, etc.) from the return value.
hideMenuItems
label_outlineOptional
boolean
Set this to `true` to filter out menu items (including menu item choices) from the return value.
hideUnavailableMenuItems
label_outlineOptional
boolean
Set this to `true` to filter out menu items that cannot currently be ordered.
location
label_outlineOptional
String
The delivery location of the diner requesting this restaurant information. This will impact the value of the `delivery_offered_to_diner_location` field. This field uses WKT format, so pass this information in the format "Point({longitude}, {latitude})".
showHoursInRestaurantLocalTime
label_outlineOptional
boolean
Set to `true` to display the restaurant availability hours in its local time zone, instead of the diner's time zone.
zipCode
label_outlineOptional
String
The ZIP Code or Postcode of the diner requesting the restaurant information.
time
label_outlineOptional
String
The time for which to consider availability, measure in Unix epoch time, which is the number of milliseconds from 00:00:00 UTC on Thursday, 1 January 1970, minus leap seconds. If this parameter is omitted, then the current time will be used.
isFutureOrder
label_outlineOptional
Boolean
Whether the diner is intending to place an order for future pickup or delivery. This causes the `future_order_info` object to be returned within the `restaurant_availability` part of the payload.
Responses
200
RestaurantData
OK
404
UNKNOWN
Not found - This could indicated that the restaurant ID is invalid.
422
UNKNOWN
Unprocessable entity - This could indicate that the coordinates provided are invalid.

Return a single menu item.

GET /restaurants/{restaurant_id}/menu_items/{menu_item_id}
Description

Returns the specified menu item from the specified restaurant. The data returned includes any choices the menu item requires, availability information, and pricing.

Path Parameters
restaurant_id
labelRequired
UUID
The unique identifier of the restaurant that has the menu item for which you want to view information.
menu_item_id
labelRequired
UUID
The ID of the menu item for which you want to view information.
Query Parameters
time
label_outlineOptional
String
The time for which to consider availability, measure in Unix epoch time, which is the number of milliseconds from 00:00:00 UTC on Thursday, 1 January 1970, minus leap seconds. If this parameter is omitted, then the current time will be used.
Responses
200
MenuItem
OK

Return availability information for up to 30 restaurants.

GET restaurants/availability_summaries
Description

Returns information on whether the specified restaurants accept orders for pickup and delivery currently. You can provide up to 30 restaurant IDs as parameters within the API call URI.

You must already have the desired restaurants' {restaurant_id} to call this method. Your system should already have data that through bulk information feeds that we have provided.

Query Parameters
ids
labelRequired
Integer
The restaurant IDs for which you want to return restaurant availability information. You can include this parameter up to 30 times, and therefore check the availability of 30 restaurants at a time.
location
label_outlineOptional
String
The location of the diner for whom to check availability. This field uses WKT format, so pass this information in the format "Point({longitude}, {latitude})". This location will affect `delivery_offered_to_diner_location` and `delivery_estimate` return values.
includeImages
label_outlineOptional
boolean
Set this to true to include media and image information in the response.
time
label_outlineOptional
String
The time for which to consider availability, measure in Unix epoch time, which is the number of milliseconds from 00:00:00 UTC on Thursday, 1 January 1970, minus leap seconds. If this parameter is omitted, then the current time will be used.
isFutureOrder
label_outlineOptional
Boolean
Whether you want to check availability for a future pickup or delivery. This causes the `future_order_info` object to be returned within the payload.
Responses
200
RestaurantAvailabilitySummary
OK
422
UNKNOWN
Unprocessable entity - This could indicate that one of the restaurant IDs provided are invalid.

Models

Address

A full street address broken into its constituent parts.

Properties
locality
label_outlineOptional
String
The city, town, or other locality in which this address is located.
region
label_outlineOptional
String
The state, county, or other larger region in which this address is located.
postal_code
label_outlineOptional
String
The ZIP Code or Postcode of the address.
street_address
label_outlineOptional
String
The house number and street name portion of the address.
country
label_outlineOptional
String
The country in which this address is located.

AvailableHours

The day-by-day hours when a restaurant is available to accept orders.

Properties
day_of_week
label_outlineOptional
Integer
The day of the week expressed as an integer, where 1 is Monday.
time_ranges
label_outlineOptional
array
The times on which this restaurant is open for a single day.

ChoiceCategory

A category of choices for a single menu item.

Properties
uuid
label_outlineOptional
UUID
A UUID that uniquely identifies this category within the Grubhub system.
id
label_outlineOptional
String
A unique identifier for this choice category.
name
label_outlineOptional
String
The display name for this category.
min_choice_options
label_outlineOptional
Integer
The minimum number of choices that a diner must make in order to add the menu item to their cart.
included_choice_options
label_outlineOptional
Integer
Indicates the number of choices that are included as part of the item price.
max_choice_options
label_outlineOptional
Integer
The maximum number of choices that a diner can make when adding this menu item to their cart.
choice_option_list
label_outlineOptional
List<ChoiceOption>
The choices available in this category.
available_hours_list
label_outlineOptional
AvailableHours
Information about when this category of choices is available to diners.
variation_target
label_outlineOptional
boolean
Whether this category causes additional price changes for other categories of choices.
item_variation_id
label_outlineOptional
Long
The category ID whose selection will affect the price changes in this category.
get_minimum_choice_price
label_outlineOptional
Price
The minimum price increase possible from this category.
get_maximum_choice_price
label_outlineOptional
Price
The maximum price increase possible from this category.
sequence
label_outlineOptional
Integer
The order in which this category displays among the other choice categories.

ChoiceOption

A single option in a series of choices for a menu item.

Properties
uuid
label_outlineOptional
UUID
A UUID that uniquely identifies this choice within the Grubhub system.
id
label_outlineOptional
Integer
An identifying number for this choice option.
description
label_outlineOptional
String
The displayed description for this option.
label
label_outlineOptional
String
A longer description of the item. This description may or may not be used in your integration.
price
label_outlineOptional
Price
How much this option adds to the price of the menu item.
delivery_price
label_outlineOptional
Price
How much this option adds to the price of the menu item in delivery orders.
pickup_price
label_outlineOptional
Price
How much this option adds to the price of the menu item in pickup orders.
choice_category_list
label_outlineOptional
List<ChoiceCategory>
The categories of choices associated with this individual choice option. This lets you offer additional depth to menu item choices. For example, you could offer a choice of additional sides, one of which has a selection of sauces, one of which can be mild, medium, or spicy. Choices can be nested like this down five levels at most.
tax
label_outlineOptional
BigDecimal
The tax rate on this choice's price as a percentage.
price_changes
label_outlineOptional
Map
A map of price changes for this option based on the selection from another option; for example, the price of toppings on a pizza may change depending on the size of pizza selected. The String portion of the map is the ID number of the individual choice selections.
sequence
label_outlineOptional
Integer
The order in which this option displays with the other options in this choice category.
defaulted
label_outlineOptional
boolean
Indicated whether this choice option is automatically selected by default.

FeeV2

A newer version of the fee model that accounts for both flat and percentage-based fees.

Properties
fee_type
label_outlineOptional
String
The calculation method used for this fee, either 'FLAT' or 'PERCENT'.
flat_cents_value
label_outlineOptional
Price
The amount of the fee as a flat value in cents. Only valid for 'FLAT' fee types.
percent_value
label_outlineOptional
BigDecimal
The amount of the fee as a percentage to be applied to the cart subtotal. Only valid for 'PERCENT' fee types.

FutureOrderAvailability

Information about the availability of orders scheduled for fulfillment at a future time.

Properties
order_send_time_delivery
label_outlineOptional
DateTime
The time (in UTC time) on which an order must be sent in order for a restaurant to prepare and deliver it before they close.
open_order_send_time_delivery
label_outlineOptional
boolean
Whether the restaurant is open at the time specified in `order_send_time_delivery`.
order_send_time_pickup
label_outlineOptional
DateTime
The time (in UTC time) on which an order must be sent in order for a restaurant to prepare it for a diner to pickup before they close.
open_order_send_time_pickup
label_outlineOptional
boolean
Whether the restaurant is open at the time specified in `order_send_time_pickup`.

Menu

The hours for which a menu applies.

Properties
menu_name
label_outlineOptional
String
The name of this menu.
sunday_hours
label_outlineOptional
String
The displayed hours for Sunday.
monday_hours
label_outlineOptional
String
The displayed hours for Monday.
tuesday_hours
label_outlineOptional
String
The displayed hours for Tuesday.
wednesday_hours
label_outlineOptional
String
The displayed hours for Wednesday.
thursday_hours
label_outlineOptional
String
The displayed hours for Thursday.
friday_hours
label_outlineOptional
String
The displayed hours for Friday.
saturday_hours
label_outlineOptional
String
The displayed hours for Saturday.

MenuCategory

A category of menu items, as well as the menu items that they contain.

Properties
uuid
label_outlineOptional
UUID
A UUID that can identify this category.
id
label_outlineOptional
Integer
The identifier of this category.
name
label_outlineOptional
String
The display name of this category.
menu_item_list
label_outlineOptional
MenuItem
A list of the menu items within this category.
sequence
label_outlineOptional
Integer
The order in which this category should appear on the displayed menu.

MenuItem

Information about an item on a menu, including price, choices, and availability.

Properties
uuid
label_outlineOptional
UUID
A UUID identifier for this menu item.
id
label_outlineOptional
String
The unique identifier of this item on the restaurant menu.
menu_category_name
label_outlineOptional
String
The display name of the menu category.
menu_category_id
label_outlineOptional
Integer
The ID of the category in which this menu item can be found on this restaurant's menu.
name
label_outlineOptional
String
The display name of the menu item.
description
label_outlineOptional
String
A restaurant-provided description of the menu item.
price
label_outlineOptional
Price
The cost of the menu item.
tax
label_outlineOptional
BigDecimal
The amount of tax on the item in cents.
tax_rate
label_outlineOptional
TaxRate
The tax rate that applies to this menu item. This overrides any tax rates applied at the restaurant.
minimum_cart_total
label_outlineOptional
Price
The minimum price cart that a diner must have before they can add this item.
sequence
label_outlineOptional
Integer
The order in which this menu item displays within its category.
minimum_price_variation
label_outlineOptional
Price
The minimum amount that this menu item will vary based on diner choices.
delivery_minimum_price_variation
label_outlineOptional
Price
The minimum amount that this menu item will vary based on diner choices within delivery orders.
pickup_minimum_price_variation
label_outlineOptional
Price
The minimum amount that this menu item will vary based on diner choices within pickup orders.
maximum_price_variation
label_outlineOptional
Price
The maximum amount that this menu item will vary based on diner choices.
delivery_maximum_price_variation
label_outlineOptional
Price
The maximum amount that this menu item will vary based on diner choices within delivery orders.
pickup_maximum_price_variation
label_outlineOptional
Price
The maximum amount that this menu item will vary based on diner choices within delivery orders.
available
label_outlineOptional
boolean
Whether this item is currenly available to order.
available_future_order_send_time_delivery
label_outlineOptional
boolean
Whether this item is available to order for delivery at the time specified if future ordering has been indicated.
available_future_order_send_time_pickup
label_outlineOptional
boolean
Whether this item is available to order for pickup at the time specified if future ordering has been indicated.
choice_category_list
label_outlineOptional
List<ChoiceCategory>
The categories of choices that a diner must make in order to add this menu item to their cart.
allowable_order_types
label_outlineOptional
List
The types of orders that this menu item can be added to. Possible order types are "standard", "catering", and "group".
menu_item_features
label_outlineOptional
List
V3 only. The advanced menu item features, such as extended choices and modifiers, that this menu item utilizes. Possible values are CHOICE_CATEGORY_QUANTITIES, CHOICE_OPTION_QUANTITIES, CHOICE_OPTION_DEFAULTS, MENU_ITEM_COMBOS, CHOICE_OPTION_MEDIA, and SUBCATEGORIES.
menu_item_blackout
label_outlineOptional
MenuItemBlackout
Information about when a menu item is temporarily unavailable.
popular
label_outlineOptional
boolean
Whether this item is among the most popular items in this restaurant.
has_required_choices
label_outlineOptional
boolean
Whether the diner has selected the required choices for this menu item.

MenuItemBlackout

Information about when a menu item is not available during normal availability hours.

Properties
menu_item_id
label_outlineOptional
Long
The identifer of the menu item affected.
start_date_in_u_t_c
label_outlineOptional
DateTime
The date and time when this menu item starts being unavailable.
end_date_in_u_t_c
label_outlineOptional
DateTime
The date and time when this item becomes available again.

NextOpenClosedContainer

Information about when this restaurant will be able to next fulfill orders. Generally used to manage future orders. NOTE - Any of these fields could return an empty value if you have reached your availability check limit.

Properties
next_order_send_time_delivery
label_outlineOptional
DateTime
The next time that an order can be sent to this restaurant for delivery. The restaurant will need time after this to prepare and deliver the order.
next_order_send_time_pickup
label_outlineOptional
DateTime
The next time that an order can be sent to this restaurant for pickup. The restaurant will need time after this to prepare the order.
next_delivery_time
label_outlineOptional
DateTime
The next estimated time that an order can be fulfilled by delivery. If a restaurant is currently open, this value will be the current time (in UTC) plus the value of `delivery_estimate`.
next_pickup_time
label_outlineOptional
DateTime
The next estimated time that an order can be fulfilled by pickup. If a restaurant is currently open, this value will be the current time (in UTC) plus the value of `pickup_estimate`.
next_cutoff_order_send_time_delivery
label_outlineOptional
DateTime
The next time that a restaurant will stop accepting delivery orders.
next_cutoff_order_send_time_pickup
label_outlineOptional
DateTime
The next time that a restaurant will stop accepting delivery orders.
order_tiers
label_outlineOptional
List<NextOpenClosedContainerTier>
Next open/close information for orders above certain value thresholds, which allows restaurants to indicate that they need a little extra time to prepare larger orders. Next times presented to diners should be based on the largest threshold that their order has passed.

NextOpenClosedContainerTier

A single tier of next open/close information for orders above a value threshold and the extra time they need to prepare that order. Next times presented to diners should be based on the largest threshold that their order has passed.

Properties
threshold_type
label_outlineOptional
String
The type of threshold described by this ordering tier. This will be one of `ORDER_AMOUNT_CENTS` or `UNKNOWN`.
threshold
label_outlineOptional
Integer
The value of the threshold in cents.
additional_prep_time_minutes
label_outlineOptional
Integer
The amount of extra time over the original delivery and pickup estimates that this tier needs to prepare orders.
next_delivery_time
label_outlineOptional
DateTime
The next estimated time that an order of this tier can be fulfilled by delivery. If a restaurant is currently open, this value will be the current time (in UTC) plus the value of `delivery_estimate` plus `additional_prep_time_minutes`.
next_order_send_time_delivery
label_outlineOptional
DateTime
The next time that an order of this tier can be sent to this restaurant for delivery. The restaurant will need time after this to prepare and deliver the order.
next_pickup_time
label_outlineOptional
DateTime
The next estimated time that an order of this tier can be fulfilled by pickup. If a restaurant is currently open, this value will be the current time (in UTC) plus the value of `pickup_estimate` plus `additional_prep_time_minutes`.
next_order_send_time_pickup
label_outlineOptional
DateTime
The next time that an order of this tier can be sent to this restaurant for pickup. The restaurant will need time after this to prepare the order.

OrderTypeSettings

Information about orders for restaurants that have more complicated fee structures.

Properties
max_order_amount
label_outlineOptional
Price
The maximum price allowable for this order.

Price

A price structure that indicates an amount - usually in cents or the smallest value in a currency - and the currency to use.

Properties
amount
label_outlineOptional
Integer
The amount currency that this price adds.
currency
label_outlineOptional
String
The currency unit applied to the price value.

Restaurant

Information about a restaurant, including menu items and ratings.

Properties
id
label_outlineOptional
String
The unique identifer for this restaurant in the Grubhub system.
merchant_uuid
label_outlineOptional
UUID
A UUID identifier that can be used to identify the restaurant instead of the ID.
name
label_outlineOptional
String
The display name of the restaurant.
address
label_outlineOptional
Address
The address of this restaurant.
cross_street_required
label_outlineOptional
boolean
Whether this restaurant requires a cross street in order to deliver an order.
pickup_offered
label_outlineOptional
boolean
Whether this restaurant accepts pickup orders.
latitude
label_outlineOptional
String
The latitude coordinate of this restaurant.
longitude
label_outlineOptional
String
The longitude coordinate of this restaurant.
minimum_tip_percent
label_outlineOptional
double
The minimum percentage of the total order that this restaurant charges for delivery.
default_tip_percent
label_outlineOptional
double
The default percentage that this restaurant applies to delivery orders as a tip.
minimum_tip
label_outlineOptional
Price
The minimum amount that this restaurant applies to delivery orders as a tip.
menu_category_list
label_outlineOptional
List<MenuCategory>
The items on this restaurant's menu organized by category.
description
label_outlineOptional
String
A restaurant-provided description of its wares.
order_type_settings
label_outlineOptional
OrderTypeSettings
Information about orders for restaurants that have more complicated fee structures.

RestaurantAvailability

Information about a restaurant's hours of operation, delivery range, and taxes and fees.

Properties
restaurant_id
label_outlineOptional
String
The unique identifier for the restaurant whose availability is shown.
delivery_fee
label_outlineOptional
Price
The cost of the delivery fee.
delivery_fee_estimate
label_outlineOptional
Price
The estimated price of the delivery fee.
delivery_fee_without_discounts
label_outlineOptional
Price
The full delivery fee before any discounts have been applied.
delivery_fee_as_percentage
label_outlineOptional
BigDecimal
The delivery fee as a percentage of the total order price.
delivery_fee_taxable
label_outlineOptional
Boolean
Indicates whether the fee is subject to state or local taxes.
order_minimum
label_outlineOptional
Price
The minimum value of menu items that a diner must order from this restaurant before they will fulfill it.
sales_tax
label_outlineOptional
BigDecimal
The amount of state and local sales tax added to this restaurant's orders.
delivery_offered_to_diner_location
label_outlineOptional
boolean
Indicates whether this restaurant delivers to the diner's current location.
open
label_outlineOptional
boolean
Indicates whether the restaurant is open at the time requested.
open_delivery
label_outlineOptional
boolean
Whether this restaurant is open for delivery at the requested time.
open_pickup
label_outlineOptional
boolean
Whether this restaurant is open for pickup orders at the requested time.
available_for_delivery
label_outlineOptional
boolean
Whether this restaurant is available to take and fulfill delivery orders at the requested time.
available_for_pickup
label_outlineOptional
boolean
Whether this restaurant is available to take and fulfill pickup orders at the requested time.
delivery_estimate
label_outlineOptional
Integer
An estimate of the time an order would take to arrive at the diner's location.
pickup_estimate
label_outlineOptional
Integer
An estimate of the time an order would take to be ready for pickup.
cash_accepted
label_outlineOptional
boolean
Whether this restaurant accepts cash as a form of payment for Grubhub orders.
credit_card_accepted
label_outlineOptional
boolean
Whether this restaurant accepts credit cards as a form of payment for Grubhub orders.
paypal_accepted
label_outlineOptional
boolean
Whether this restaurant accepts paypal as a form of payment for Grubhub orders.
time_zone_id
label_outlineOptional
String
A text identifier of the time zone in which this restaurant is located.
time_zone_offset
label_outlineOptional
Integer
The number of hours that this restaurant's time zone differs from UTC.
distance_in_miles
label_outlineOptional
Integer
The distance from the restaurant to the diner's location in hundreths of a mile.
decimal_distance_in_miles
label_outlineOptional
Double
The full distance from the restaurant to the diner without rounding.
delivery_cutoff
label_outlineOptional
Integer
The number of minutes before the closing time that the restaurant stops accepting delivery orders.
pickup_cutoff
label_outlineOptional
Integer
The number of minutes before the closing time that the restaurant stops accepting pickup orders.
cutoff_for_delivery
label_outlineOptional
boolean
Whether the current time is after the cutoff time for delivery.
cutoff_for_pickup
label_outlineOptional
boolean
Whether the current time is after the cutoff time for pickup orders.
available_hours
label_outlineOptional
array
The day-by-day availability of this restaurant.
available_hours_delivery
label_outlineOptional
array
The day-by-day availability of this restaurant for delivery orders in the local time of the restaurant.
available_hours_pickup
label_outlineOptional
List<AvailableHours>
The day-by-day hours when this restaurant accepts pickup orders.
future_order_available_hours_delivery
label_outlineOptional
List<AvailableHours>
The hours in which the restaurant will be able to deliver a future order, taking into account the open, close, preparation, and delivery time requirements of an order.
future_order_available_hours_pickup
label_outlineOptional
List<AvailableHours>
The hours in which the restaurant will be able to make a future order available for a diner to pickup, taking into account the open, close, and preparation time requirements of an order.
min_delivery_fee
label_outlineOptional
Price
The minimum fee applied to any delivery order.
future_order_info
label_outlineOptional
FutureOrderAvailability
Information about restaurant availability for future orders.
next_open_closed_info
label_outlineOptional
NextOpenClosedContainer
Information about when this restaurant will be able to next fulfill orders. Generally used to manage future orders.
blacked_out
label_outlineOptional
boolean
Whether this restaurant is currently unavailable when it would normally be available.
white_in
label_outlineOptional
boolean
Whether this restaurant is available when it normally would be unavailable.
innundated
label_outlineOptional
boolean
Whether this restaurant is currently not taking new orders due to being overwhelmed by their current workload.

RestaurantAvailabilitySummary

Information about a restaurant's pickup and delivery information.

Properties
restaurant_id
label_outlineOptional
String
The restaurant whose availability information is shown.
open
label_outlineOptional
boolean
Whether this restaurant is currently open.
available_for_delivery
label_outlineOptional
boolean
Whether this restaurant is currently available to fulfill delivery orders.
available_for_pickup
label_outlineOptional
boolean
Whether this restaurant is currently available to fulfill pickup orders.
delivery_offered_to_diner_location
label_outlineOptional
boolean
Whether the diner is within the delivery range of this restaurant.
restaurant_name
label_outlineOptional
String
The display name of this restaurant.
address
label_outlineOptional
Address
The street address where this restaurant mis located.
decimal_distance_in_miles
label_outlineOptional
Double
The distance from this restaurant to the diner's location.
logo
label_outlineOptional
String
The URL for this restaurant's logo image.
delivery_estimate
label_outlineOptional
Integer
The time that the Grubhub system estimates that it would take to deliver food from this restaurant to the diner.
pickup_estimate
label_outlineOptional
Integer
The time that the Grubhub system estimates that an order would be ready to pickup from this restaurant.
order_minimum
label_outlineOptional
Price
The minimum value of menu items that a diner needs to add to their cart in order to qualify for delivery.
delivery_fee
label_outlineOptional
Unknown
The fee added to the diner's cart if they choose to have their food delivered.
delivery_cutoff
label_outlineOptional
Integer
The number of minutes before the closing time that the restaurant stops accepting delivery orders.
pickup_cutoff
label_outlineOptional
Integer
The number of minutes before the closing time that the restaurant stops accepting pickup orders.
future_order_info
label_outlineOptional
FutureOrderAvailability
Information about restaurant availability for future orders.
is_cutoff_for_delivery
label_outlineOptional
boolean
Whether the current time is after the cutoff time for delivery.
is_cutoff_for_pickup
label_outlineOptional
boolean
Whether the current time is after the cutoff time for pickup orders.

RestaurantData

Information about a single restaurant.

Properties
restaurant_availability
label_outlineOptional
RestaurantAvailability
Information about this restaurant's open hours, delivery range, fees, and payment types.
restaurant
label_outlineOptional
Restaurant
Information about the restaurant, including ratings, general details, and optionally menu items.

RestaurantSummariesData

Availability information for up to 30 restaurants.

Properties
availability_summaries
label_outlineOptional
List<RestaurantAvailabilitySummary>
Information about the availability for one or more restaurants.

ServiceFee

An additional fee attached to pickup and/or delivery orders.

Properties
name
label_outlineOptional
String
The name of this service fee, which may be display to the diner.
description
label_outlineOptional
String
A human-readable string that explains why this restaurant charges this fee.
delivery_fee
label_outlineOptional
FeeV2
An additional amount added to any delivery orders.
pickup_fee
label_outlineOptional
FeeV2
An additional amount added to any pickup orders.

SmallOrderFee

The minimum order amount and the fee charged for orders that fall under it.

Properties
name
label_outlineOptional
String
A displayable name for this fee.
description
label_outlineOptional
String
Additional information to explain this additional fee.
minimum_order_value_cents
label_outlineOptional
Integer
The amount that an order must exceed in order to avoid the small order fee.
fee
label_outlineOptional
FeeV2
The fee charged to orders that do not meet the stated minimum.

Tax Rate

Information about a tax rate associated with a menu item.

Properties
name
label_outlineOptional
String
A human-readable name for this tax rate.
rate
label_outlineOptional
BigDecimal
The percentage of the menu item's value added to an order as tax.
flat
label_outlineOptional
BigDecimal
A flat amount added as tax to an order that includes this menu item.
includedInItemPrice
label_outlineOptional
boolean
Whether the tax amount is added to the item's total price or shown as a separate charge.