Toast Orders API (2.2.7)

Download OpenAPI specification:Download

The orders API includes operations that create, update, and retrieve information about restaurant guest orders.

Information on orders includes the checks, items ordered, prices, payments, discounts, and customer data.

You can create a new order. The orders API includes an operation to retrieve the order prices before you POST the order.

You can add items to an existing check.

The orders API also allows you to retrieve payment information for the order and add a credit card payment to the order. You cannot update an existing payment, but you can update the tip amount.

For delivery orders, you can update the delivery information.

You can retrieve the applicable discounts for an order, and then add a discount to a menu item selection or a check.

The orders API supports email addresses that:

• Are up to 53 characters long.
• Start with the email prefix, ends with the email domain name, where the prefix and domain are separated by an @.
• Use the following supported characters:
  • a-z
  • A-Z
  • 0-9
  • _ (underscore)
  • International characters are not supported

Orders

Related to orders made by restaurant guests. For example, a restaurant guest orders items from a menu. Toast platform orders include one or more guest check.