Developer updates

Error Handling General API updates

Invalid Toast-Restaurant-External-ID value returns HTTP 400 response

Toast APIs now return an HTTP 400 (bad request) response if you submit a request with a Toast-Restaurant-External-ID header parameter value that is not a...

March 29, 2022

Error Handling Webhooks

Webhooks retry messages after HTTP 429 response

The Toast platform now retries sending webhook messages after a receiving endpoint returns an HTTP 429 (too many requests) response. Previously, the Toast...

March 11, 2022

Error Handling Webhooks

Updated error rate limits for Toast webhook subscriptions

The following list describes the new rules for pausing and stopping webhook subscriptions that are experiencing errors: Previously, the Toast platform...

March 2, 2022

Objects, fields, and values Orders API

Orders API includes a new order source enumeration value and an updated source value name

A new enumerated value has been added to the source value of the orders API Order object. The new value is Toast Pickup App which represents the Toast...

March 2, 2022

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