This guide will be removed on April 29, 2022. Please use our new, easier-to-use Toast technical documentation site. All updated content is on the new site.

This section provides reference information about the endpoints and data types of the Toast kitchen API. For general information about working with Toast APIs, see API overview.

Kitchen API

Base URL: /kitchen/v1/published, Version: 1.0.0

Returns information about kitchen operations.

Default request content-types: application/json
Default response content-types: application/json
Schemes: https

Summary

Path Operation Description
/prepStations GET

Get all prep stations

/prepStations/{guid} GET

Get a prep station

Paths

Get all prep stations

GET /prepStations

Returns the configuration for every prep station that has been created for the specified restaurant. A prep station represents the location of a kitchen printer or KDS device that receives orders for fulfillment. You can use optional query parameters to paginate the results. If a lastModified date is specified, returns all objects that were created or modified after that date.

Related topics:
Routing to prep stations

pageToken

A string that identifies the set of data objects that the endpoint will return in its response data. You can use this parameter to control the pagination of response data. You get the value that you supply in the pageToken parameter from the Toast-Next-Page-Token header field value of a previous request to the endpoint. For more information, see Paginating response data.

query string
lastModified

Limits the return data to objects created or modified after a specific date and time. For example: 2021-12-01T00:00:00.000+0000.

query string (date)
Toast-Restaurant-External-ID

The Toast platform identifier for the restaurant.

header string

Uses default content-types: application/json

200 OK

Returns an array of PrepStation objects. A prep station represents the location of a kitchen printer or KDS device that receives orders for fulfillment.
Related topics:
Routing to prep stations

Toast-Next-Page-Token

A string that identifies the following set of objects that the endpoint will return. You can use this value to control the pagination of response data. To return the next page of objects you supply this value in the pageToken parameter of the next request to the endpoint. For more information, see Paginating response data.

The endpoint does not return the Toast-Next-Page-Token field if there is no following page of response data objects. For example, the endpoint will not return a Toast-Next-Page-Token header field if all the data objects fit in one response or if you have reached the last page of response objects.

string
Get a prep station

GET /prepStations/{guid}

Returns the configuration for a single prep station that has been defined for the specified restaurant. A prep station represents the location of a kitchen printer or KDS device that receives orders for fulfillment.

Related topics:
Routing to prep stations

Toast-Restaurant-External-ID

The Toast platform identifier for the restaurant.

header string
guid path string

Uses default content-types: application/json

200 OK

Returns a PrepStation object.

Schema definitions

PrepStation:

The configuration for a single prep station. A prep station represents the location of a kitchen printer or KDS device that receives orders for fulfillment.

Related topics:
Add a prep station

connectedPrepStations: object[]

An array of ToastReference objects containing the identifiers of the other prep stations that this prep station monitors.

Allowing a prep station to monitor other prep stations makes it easier for restaurant employees to coordinate when an order includes items that are fulfilled at more than one prep station.

Related topics:
Monitoring items at other prep stations
Configure printing of other stations' items

printingMode: string , x ∈ { ON , OFFLINE_ONLY }

Determines whether tickets sent to this prep station are printed at the prep station's assigned printer. Values include:

  • ON: Every ticket sent to this prep station prints at the prep station's assigned printer.
  • OFFLINE_ONLY: Tickets sent to this prep station only print at the assigned printer if the prep station normally uses a KDS device for ticket display but that device is offline.
includeWithExpediter: boolean

True if tickets sent to this prep station should also be sent to the printer or KDS device that has been set up for the restaurant's expediter.

Related topics:
Using an expediter KDS

name: string

The name of this prep station.

kitchenPrinter: ToastReference

A ToastReference object containing the identifier of the kitchen printer assigned to this prep station.

ToastReference: object

A wrapper object containing a Toast platform GUID.

guid: string

A Toast platform identifier for an entity.

entityType: string

The type of object this is. For prep stations, entityType is set to PrepStation.