Developer updates

Objects, fields, and values Orders API

Orders API includes new Invoice order source enumeration value

The source value enumeration in the orders API Order object will include a new Invoice value on 2022-02-07. The value Invoice indicates that the order was...

January 31, 2022

Loyalty API Objects, fields, and values

Loyalty account identifier on reversal can be null

The Toast loyalty API will change the behavior of the loyaltyIdentifier value in the TransactionInformationReverse object for reversal transaction requests...

January 21, 2022

Menus API Objects, fields, and values

Menus API menu item includes taxInclusion value

The MenuItem object returned by the menus API now has a taxInclusion value that you can use to determine if the taxes on a menu item are included in the item...

January 21, 2022

Gift Cards API

Gift card add value transactions limited to $500

The Toast platform now limits gift card add value transactions to $500. If you use the Toast gift card integration , your integration will no longer receive...

January 21, 2022

Webhooks

New email subscription for webhook notifications

You can now designate an email address for Toast webhook start and stop notification messages. These messages indicate that a webhook subscription has...

January 21, 2022

Error Handling General API updates

409 error indicates a restaurant published new data during retrieval of a paginated response

It is possible that a restaurant will change its configuration while your integration client is in the process of retrieving paginated data for that...

December 16, 2021

Menus API

Detailed menu hierarchy description and diagram are available

A new Menu hierarchy section has been added to the Toast platform guide that provides detailed information about the menu hierarchy and its menu entities....

December 16, 2021

Configuration API

New order management configuration API

The new order management configuration API provides information about the online ordering schedule for a restaurant. The ordering schedule indicates the...

December 16, 2021

Menus API Webhooks

New menus webhook indicates changed menus

The new menus webhook sends a message when a restaurant that uses your integration publishes a change to its menus. The message payload includes the GUID of...

December 10, 2021