PrepStation

A wrapper object containing a Toast platform GUID.

Array of objects (ToastReference)

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

entityType
required
string

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

expoRouting
string

Determines how tickets are routed to the expediter. This field works in conjunction with includeWithExpediter to provide more granular control over expo routing. Values include:

  • SEND_TO_EXPO: Tickets are sent to both the prep station and the expediter (equivalent to includeWithExpediter: true)
  • EXPO_ONLY: Tickets are sent only to the expediter, not to the prep station
  • SKIP_EXPO: Tickets are sent only to the prep station, not to the expediter (equivalent to includeWithExpediter: false)

    *Related topics:*
    Using an expediter KDS
Enum: "SEND_TO_EXPO" "EXPO_ONLY" "SKIP_EXPO"
guid
required
string

A Toast platform identifier for an entity.

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

object (ToastReference)

A wrapper object containing a Toast platform GUID.

name
string

The name of this prep station.

printingMode
string

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.
Enum: "ON" "OFFLINE_ONLY"
{
  • "guid": "string",
  • "entityType": "string",
  • "connectedPrepStations": [
    ],
  • "printingMode": "ON",
  • "includeWithExpediter": true,
  • "expoRouting": "SEND_TO_EXPO",
  • "name": "string",
  • "kitchenPrinter": {
    }
}