Developer updates

Menus API

posName, posButtonColorLight, and posButtonColorDark added to Premodifier object in menus API

The Premodifier object of the menus API has been updated with the following values: When an employee configures the POS button color for a premodifier, they...

September 18, 2024

General API updates

OpenAPI specification files now available for Toast APIs

You can now download OpenAPI specification files for Toast platform APIs. OpenAPI is a standard for defining HTTP REST APIs. You can use OpenAPI...

September 11, 2024

Gift Cards API

New relatedTransaction value for gift cards API redeem transactions

The gift cards integration API includes a new relatedTransaction value in the TransactionInformationRedeem object for gift card redeem transactions. The...

September 5, 2024

Tender API

Tender API requests will include HTTP header field Accept

The tender API will include an HTTP Accept header field in the REST requests it sends to your tender API integration on 2024-09-19. The value of the new...

September 5, 2024

Menus API

posName added to menus API

For menus API V2, the Menu , MenuGroup , MenuItem , ModifierGroup , and ModifierOption objects have been updated with a posName value. This value contains...

August 15, 2024

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

Restaurants API Objects, fields, and values

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

Stock API Error Handling

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