KeyValue

An abstract key-value pair, used anytime the Toast POS system needs to submit or accept one or more configurable values.

key
string

The key of the key-value pair.

maxLength
string

An optional maximum length of input value. Used for Tender search to limit the length of the input.

tenderPropertyType
string

An optional type describing the purpose of a key-value pair. If provided, allows Toast to use a key-value pair in a specialized way, such as displaying the room ID on receipts

Enum: "FOLIO" "GUEST_NAME" "GUEST_SURNAME" "RESULT_NUMBER" "ROOM_ID" "OTHER"
value
string

The value of the key-value pair.

{
  • "key": "string",
  • "value": "string",
  • "tenderPropertyType": "FOLIO",
  • "maxLength": "string"
}