This guide will be removed on April 29, 2022. Please use our new, easier-to-use Toast technical documentation site. All updated content is on the new site.

This section provides reference information about the endpoints and data types of the Toast restaurants API. For general information about working with Toast APIs, see API overview.

Restaurants API

Base URL: /restaurants/v1, Version: 1.0.0

Returns information about the configuration of restaurant.

Default request content-types: application/json
Default response content-types: application/json
Schemes: https

Summary

Path Operation Description
/groups/{managementGroupGUID}/restaurants GET

Get restaurants in a management group

/restaurants/{restaurantGUID} GET

Get restaurant configuration information

Paths

Get restaurants in a management group

GET /groups/{managementGroupGUID}/restaurants

Returns an array of Restaurant objects that are a part of the restaurant management group you specify in the managementGroupGUID path parameter. Each Restaurant object contains the unique Toast platform identifier for the restaurant in its guid value.

managementGroupGUID

The GUID of the restaurant management group.

path string
Toast-Restaurant-External-ID

The Toast GUID of one restaurant location in the management group.

header string (string)

Uses default content-types: application/json

200 OK

An array of Restaurant objects.

Get restaurant configuration information

GET /restaurants/{restaurantGUID}

Returns a RestaurantInfo object that contains detailed information about the configuration of a restaurant.

restaurantGUID

The Toast GUID of the restaurant that you want to get information about.

path string
Toast-Restaurant-External-ID

The Toast GUID of the restaurant that you want to get information about.

header string (string)

Uses default content-types: application/json

200 OK

A RestaurantInfo object that contains detailed information about the configuration of a restaurant.

Schema definitions

DaySchedule: object

Information about the services and hours that are scheduled for a restaurant during a type of day. For example, a restaurant might have different services available on a type of day named weekday than it does on a type of day named weekend.

scheduleName: string

The name of the type of day. For example, weekday.

services: object[]

An array of Service objects that are available during the type of day.

openTime: string

The time of day that the first service for the type of day begins. For example, the first service might begin at 06:00:00.000.

closeTime: string

The time of day that the last service for the type of day ends. For example, the last service might end at 02:00:00.000.

Delivery: object

Information about delivery service provided by the restaurant.

enabled: boolean

Indicates whether the restaurant provides delivery service and has enabled the delivery configuration in the Toast administration back-end.

minimum: number (double)

The minimum order price that is qualified for delivery. For example, a restaurant might not deliver orders that cost less than $25.00.

area: string

The geographic area in which the restaurant provides delivery service. The delivery area is represented by an encoded set of latitude and longitude coordinates that describe a polygon area on a map. The coordinates are encoded using the Google maps encoded polyline algorithm format. See [more information about the way that the encoded polyline algorithm format encodes location coordinates] (https://developers.google.com/maps/documentation/utilities/polylinealgorithm). You can decode the coordinates of the delivery area using any software that supports the encoded polyline algorithm format. For example, you can decode the coordinates using [the Mapline Polyline decoding program] (https://github.com/mapbox/polyline). The delivery area coordinates are a JSON array of decimal degree latitude and longitude pairs. For example, [[42.36083,-71.14798],[42.34028,-71.15673],[42.3272,-71.14386]].

DeliveryPaymentOptions: object

Information about the forms of payment that the restaurant will accept for delivery orders.

cash: boolean

Indicates whether the restaurant accepts cash payment for delivery orders that are placed online.

ccSameDay: boolean

Indicates whether the restaurant accepts online credit card payment for delivery orders that are delivered on the same day.

ccFuture: boolean

Indicates whether the restaurant accepts online credit card payment for delivery orders that are to be delivered on a day after the guest places the order.

General: object

General information about a restaurant location.

name: string

The guest-facing name of the restaurant. For example, the name of a restaurant might be Tommy's Burgers.

locationName: string

A name used externally to differentiate multiple locations, like Neighborhood, Square, City, or Hotel.

locationCode: string

A code used internally to differentiate multiple locations, typically a 3 or 4 letter code.

description: string

A description of the restaurant, such as information about the atmosphere and food.

timeZone: string

The name of the restaurant's time zone in the IANA time zone database. For example, America/New_York.

closeoutHour: integer

The hour of the day that separates one business day from the next, also known as the "business day cutoff time". This is in the time zone of the restaurant. The closeoutHour is set to a value from 0-12 (midnight to noon) in the Business Day Cutoff field in the Toast administration back-end.

managementGroupGuid: string

The unique identifier of the restaurant group for the restaurant.

Hours: object

The period of time that the restaurant offers a service. For example, a service might be named "lunch" and it might be offered between 10:00:00.000 and 16:00:00.000.

startTime: string

The time of day that the service begins.

endTime: string

The time of day that the service ends.

Image: object

Information about an image.

width: integer (int32)

The width of the image, in pixels.

height: integer (int32)

The height of the image, in pixels.

url: string
heightWidthRatio: number (float)

The ratio of height to width

Location: object

Information about the physical location of a restaurant.

address1: string

The first line of the street address of the restaurant.

address2: string

The second line of the street address of the restaurant.

city: string

The city or town of the restaurant. restaurant.

stateCode: string

The abbreviation of the state or province of the restaurant.

zipCode: string

The ZIP or postal code of the restaurant.

country: string

The nation of the restaurant.

phone: string
latitude: number (double)

The north/south geographic coordinate of the restaurant, in decimal degrees.

longitude: number (double)

The east/west geographic coordinate of the restaurant, in decimal degrees.

OnlineOrdering: object

Information about the web-based ordering configuration for the restaurant.

enabled: boolean

Indicates whether the restaurant has enabled the Toast online ordering module. This value is true if the module has ever been enabled. The value does not indicate that a restaurant is accepting online orders or that the restaurant is using the Toast online ordering feature.

scheduling: boolean

Indicates whether the online ordering function for the restaurant allows guests to place orders that will be fulfilled in the future. If this value is false, orders will be fulfilled as soon as possible.

specialRequests: boolean

Indicates whether the online ordering function for the restaurant allows guests to include written notes with additional instructions for their orders.

specialRequestsMessage: string

A written message that is shown to guests when they include additional instructions with an order. For example, the message might be "no substitutions."

paymentOptions: PaymentOptions

Information about the forms of payment that the restaurant accepts for online orders.

PaymentOptions: object

Information about the forms of payment that the restaurant will accept for orders.

delivery: DeliveryPaymentOptions
takeout: TakeoutPaymentOptions
ccTip: boolean

enables credit card tips

PrepTimes: object

Information about the scheduled availability of the dining options that are provided by the restaurant.

deliveryPrepTime: integer (int32)

The amount of time, in minutes, that it takes to prepare an online delivery order.

deliveryTimeAfterOpen: integer (int32)

The amount of time, in minutes, that it takes for delivery service to become available after the restaurant opens.

deliveryTimeBeforeClose: integer (int32)

The amount of time, in minutes, before the restaurant closing time that delivery service becomes unavailable.

takeoutPrepTime: integer (int32)

The amount of time, in minutes, that it takes to prepare an online takeout order.

takeoutTimeAfterOpen: integer (int32)

The amount of time, in minutes, that it takes for takeout service to become available after the restaurant opens.

takeoutTimeBeforeClose: integer (int32)

The amount of time, in minutes, before the restaurant closing time that takeout service becomes unavailable.

takeoutThrottlingTime: integer

The amount of time, in minutes, that an online takeout order is delayed before the Toast POS fires it in the kitchen.

deliveryThrottlingTime: integer

The amount of time, in minutes, that an online delivery order is delayed before the Toast POS fires it in the kitchen.

Restaurant: object

The Toast POS GUID for a restaurant

guid: string

The unique identifier that the Toast POS assigns to a restaurant.

RestaurantInfo: object

Information about the configuration of a restaurant in the Toast POS.

guid: string
general: General
urls: URLs
location: Location
schedules: Schedules
delivery: Delivery
onlineOrdering: OnlineOrdering
prepTimes: PrepTimes

Schedules: object

Describes the types of service and hours of operation for the restaurant over a one week period. The schedules object contains service and hour schedules for types of days and the types of days for each day of the calendar week.

daySchedules: object

A map of DaySchedule objects. The value names in this object are key identifiers that are used to associate a day schedule with a day of the week in the weekSchedule value.

identifier: string
DaySchedule
weekSchedule: WeekSchedule

Service: object

A time-based division of the operation of the restaurant. For example, a service might be named lunch and it might be available between specific hours during the day.

name: string
hours: Hours
overnight: boolean

Indicates whether any portion of the period of time that a service is available occurs after 00:00 (midnight) and before the business day cutoff time for the restaurant which is available in the closeoutHour property. An overnight shift spans two calendar dates but occurs during one business day.

TakeoutPaymentOptions: object

Information about the forms of payment that the restaurant will accept for orders that a guest picks up in person.

cash: boolean

Indicates whether the restaurant accepts cash payment for takeout orders that are placed online.

ccSameDay: boolean

Indicates whether the restaurant accepts online credit card payment for takeout orders that the guest will pick up on the same day.

ccFuture: boolean

Indicates whether the restaurant accepts online credit card payment for takeout orders that the guest will pick up on a day after the guest places the order.

ccInStore: boolean

Indicates whether the restaurant accepts credit card payment at the time the guest picks up a takeout order.

URLs: object

Web addresses for the restaurant.

website: string

The primary website for the restaurant.

facebook: string

A Facebook™ page for the restaurant.

twitter: string

A Twitter™ handle for the restaurant.

orderOnline: string

A URL for the online ordering site for the restaurant.

purchaseGiftCard: string

A URL for the gift card purchasing site for the restaurant.

checkGiftCard: string

A URL for a site at which guests can find balances and other information about gift cards.

WeekSchedule: object

The day schedule used for each day of the week. A day schedule is the set of services (for example, "lunch") that a restaurant offers and the hours that it offers each one. If a day of the week value in this object is null, the restaurant is closed on that day. Values for each day of the week are identifiers for day schedules in the map of DaySchedule objects in the daySchedules value of the Schedules object.

monday: string

A key identifier for the DaySchedule object that represents the services and hours for the restaurant on this day of the week.

tuesday: string

A key identifier for the DaySchedule object that represents the services and hours for the restaurant on this day of the week.

wednesday: string

A key identifier for the DaySchedule object that represents the services and hours for the restaurant on this day of the week.

thursday: string

A key identifier for the DaySchedule object that represents the services and hours for the restaurant on this day of the week.

friday: string

A key identifier for the DaySchedule object that represents the services and hours for the restaurant on this day of the week.

saturday: string

A key identifier for the DaySchedule object that represents the services and hours for the restaurant on this day of the week.

sunday: string

A key identifier for the DaySchedule object that represents the services and hours for the restaurant on this day of the week.