DiningOption

A wrapper object with fields that allow reference to a Toast entity by Toast GUID or a partner's identifier.

behavior
string

The behavior of the dining option. TAKE_OUT and DELIVERY require a customer to be specified on the order, and DELIVERY requires a deliveryInfo value.

Enum: "DINE_IN" "TAKE_OUT" "DELIVERY"
curbside
boolean

Indicates whether the dining option has curbside behavior, and allows the guest to provide identifying information such as a description of their vehicle.

entityType
required
string

The type of object this is.

externalId
string

External identifier string, prefixed by the naming authority.

guid
required
string

The GUID maintained by the Toast POS.

name
string

The name of the dining option.

{
  • "guid": "string",
  • "entityType": "string",
  • "externalId": "string",
  • "name": "string",
  • "behavior": "DINE_IN",
  • "curbside": true
}