Developer updates

Orders API

displayNumber added to orders API

The Order object in the orders API has been updated with a displayNumber value that provides a number for each order in a single day. Typically, the...

August 15, 2024

Partners API

New deleted value for inactive restaurants in partners API

The PartnerAccessExternalRep object in the partners API includes a new deleted value to indicate whether a restaurant is actively using the Toast platform....

August 5, 2024

Objects, fields, and values Restaurants API

New restaurants API parameter and response value to identify archived restaurants

The /v1/restaurants/{restaurantGUID} endpoint of the restaurants API has a new includeArchived query parameter. You use the includeArchived parameter to...

August 5, 2024

Error Handling Stock API

Stock API inventory update endpoint behavior change

The behavior of the /stock/v1/inventory/update endpoint of the stock API will change on 2024-08-26. The endpoint will no longer return an error response if...

August 5, 2024

Menus API Objects, fields, and values

posButtonColorLight and posButtonColorDark added to menus API

The Menu , MenuGroup , MenuItem , ModifierGroup , and Modifier objects of the menus API have been updated with the following values: When an employee...

June 18, 2024

Authentication

Bearer authorization type string enforced for API authentication

When you authenticate your API client to use Toast APIs, you provide a bearer-type authentication token in the Authorization header field of your request....

May 28, 2024

General API updates

TLS certificate provider change

The TLS certificate provider for Toast APIs will change from Let's Encrypt to Google . The Let's Encrypt root certificate is changing in September 2024 to a...

May 13, 2024

Objects, fields, and values Orders API

Optional phoneCountryCode field added to the orders API customer object

The orders API customer object now includes the optional phoneCountryCode field. The phoneCountryCode field specifies the international phone number country...

April 23, 2024

Objects, fields, and values Tender API

Tender API gratuity and reverse transactions now include order details

The tender API has been updated in the following ways: For more information about the tender API, see Tender provider integrations overview .

April 2, 2024

Orders API

Packaging configuration API is now available

The packaging configuration API is now available. The packaging configuration API lets you retrieve a restaurant's packaging preferences and add them to an...

April 2, 2024