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.

Takeout and delivery quote and throttling times

In the response to the GET request to the /restaurants/{restaurantGUID}/ endpoint, the prepTimes object contains the current quote time and throttling time configurations.

  • The deliveryPrepTime and takeoutPrepTime values contain the delivery and takeout quote times.

  • The deliveryThrottlingTime and takeoutThrottlingTime values contain the current delivery and takeout throttling times.

The following example shows the prepTimes object from the response from a GET request to the /restaurants/{restaurantGUID} endpoint of the restaurants API.

Example takeout and delivery preparation and throttling time configuration from the restaurants API

  "prepTimes": {
    "deliveryPrepTime": 60,1
    "deliveryThrottlingTime": 0,2
    "takeoutPrepTime": 30,3
    "takeoutThrottlingTime": 0,4
    "deliveryTimeAfterOpen": 0,5
    "deliveryTimeBeforeClose": 0,
    "takeoutTimeAfterOpen": 0,
    "takeoutTimeBeforeClose": 0
  }

1

The amount of time, in minutes, that it takes to prepare and deliver a delivery order.

2

The amount of time, in minutes, that restaurant employees have chosen to delay delivery orders from firing. The throttling time allows restaurant employees to handle a temporary surge in orders.

3

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

4

The amount of time, in minutes, that restaurant employees have chosen to delay takeout orders from firing. The throttling time allows restaurant employees to handle a temporary surge in orders.

5

The deliveryTimeAfterOpen, deliveryTimeBeforeClose, takeoutTimeAfterOpen, and takeoutTimeBeforeClose settings are discontinued. They cannot be configured in the Toast platform. In the response from the restaurants API, the values are always 0.