Developer updates

Orders API

Summary of the Order object now available

A new Order object summary section has been added to the Toast API Developer Guide . The new section contains an overview diagram of the Order object. It...

March 2, 2022

Loyalty API Objects, fields, and values

Loyalty API externalId value for menu entities will be null

Loyalty API requests for restaurants using an upcoming release of the Toast POS app will always include a null externalId value for menu entities. This...

February 9, 2022

Menus API Objects, fields, and values

New multiLocationId identifier for menus API menu entities

The menus API includes a new multiLocationId identifier for menu entities. The multiLocationId identifier is equivalent to the masterId identifier and is...

January 31, 2022

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