Selection

A wrapper object with fields that allow reference to a Toast entity by Toast GUID.

Array of objects (AppliedDiscount) >= 0 items

The itemized discounts applied to this item.

Array of objects (AppliedTaxRate)

An array of AppliedTaxRate objects that contain information about tax payments made for the selection.

createdDate
string <date-time>

The date at which this selection was created. Defaults to current time if not specified. Use ISO 8601 date and time format for all Toast APIs.

deferred
boolean

Whether this selection is a deferred revenue transaction, e.g. gift card sales.

displayName
string

The display name of the selection. This field can be used to set a special request value, otherwise it will be generated from this Selection's item property.

entityType
required
string

The type of object this is.

externalId
string

External identifier string that is prefixed by the naming authority.

fulfillmentStatus
string
Default: "NEW"

Indicates the stage of the preparation workflow that the menu item selection is in. The fulfillmentStatus of a menu item selection changes as restaurant employees move the item through the functions of the Toast POS, for example order entry and the kitchen display system (KDS). Response only.

  • `NEW` - the menu item selection has been added to a check but has not been sent to the KDS for preparation.
  • `HOLD` - a restaurant employee has paused the menu item selection so that it does not appear in the KDS for preparation.
  • `SENT` - the menu item selection has been fired and appears in the KDS for preparation.
  • `READY` - preparation is complete, the menu item selection has been fulfilled and no longer appears in the KDS. If your restaurant does not use the Toast POS KDS, items in an order will not reach the `READY` status.
Enum: "NEW" "HOLD" "SENT" "READY"
guid
required
string

The GUID maintained by Toast.

required
object (ConfigReference)

A wrapper object with fields that allow reference to a Toast entity by Toast GUID.

object (ConfigReference)

A wrapper object with fields that allow reference to a Toast entity by Toast GUID.

modifiedDate
string <date-time>

The date at which this selection was last modified. Defaults to current time if not specified. Use ISO 8601 date and time format for all Toast APIs.

modifiers
Array of objects (Selection)

A list of modifiers applying to this selection.

object (ConfigReference)

A wrapper object with fields that allow reference to a Toast entity by Toast GUID.

preDiscountPrice
number <double>

Gross sale price for this selection. Excludes tax.

object (ConfigReference)

A wrapper object with fields that allow reference to a Toast entity by Toast GUID.

price
number <double>

Net price for this selection. The final price of the item after considering discounts (including discounts at the check level), quantity adjustments, and modifier prices at the time the item was selected for purchase.

quantity
required
number <double>

Quantity ordered. A decimal number for items sold by weight; a counting number for discrete items.

object (ConfigReference)

A wrapper object with fields that allow reference to a Toast entity by Toast GUID.

selectionType
string

Specifies whether this selection is a special request or other off-menu sale. If left null or NONE, describes a normal modifier or item selection.

Enum: "NONE" "OPEN_ITEM" "SPECIAL_REQUEST" "PORTION" "HOUSE_ACCOUNT_PAY_BALANCE"
tax
number <double>

The total tax amount for this selection.

taxInclusion
string

Indicates whether the menu item price includes one or more tax amounts. If the menu item is a modifier for another menu item selection, it always inherits the tax inclusion behavior of the menu item it applies to. Values are:

  • INCLUDED - the menu item price includes one or more tax amounts.
  • NOT_INCLUDED - the menu item price does not include any tax amounts.
  • INHERITED - the menu item is a modifier for another menu item selection in the check. The taxInclusion value of the parent menu item selection applies to the modifier. If a menu item selection that is not a modifier inherits tax inclusion behavior from a menu or menu group, the taxInclusion value will be either INCLUDED or NOT_INCLUDED.
Enum: "INCLUDED" "NOT_INCLUDED" "INHERITED"
unitOfMeasure
string

The unit of measure required for weighing the item. Default is NONE, which means the item is not meant to be weighed.

Enum: "NONE" "LB" "OZ" "KG" "G"
voidBusinessDate
integer

The business date (yyyyMMdd) on which this selection was voided.

voidDate
string <date-time>

The date at which this selection was voided. Use ISO 8601 date and time format for all Toast APIs.

voided
boolean

True if this selection has been voided.

object (ExternalReference)

A wrapper object with fields that allow reference to a Toast entity by Toast GUID.

{
  • "guid": "string",
  • "entityType": "string",
  • "externalId": "string",
  • "item": {
    },
  • "itemGroup": {
    },
  • "optionGroup": {
    },
  • "preModifier": {
    },
  • "quantity": 0,
  • "unitOfMeasure": "NONE",
  • "selectionType": "NONE",
  • "salesCategory": {
    },
  • "appliedDiscounts": [
    ],
  • "deferred": true,
  • "preDiscountPrice": 0,
  • "price": 0,
  • "tax": 0,
  • "voided": true,
  • "voidDate": "2019-08-24T14:15:22Z",
  • "voidBusinessDate": 0,
  • "voidReason": {
    },
  • "displayName": "string",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "modifiers": [
    ],
  • "fulfillmentStatus": "NEW",
  • "taxInclusion": "INCLUDED",
  • "appliedTaxes": [
    ]
}