Toast API Developer's Guide

entityType

The type of the menu component described by this JSON object. The value for a menu object is Menu.

String

name

A descriptive identifier for the menu. For example, Food or Drinks.

String

guid

The unique identifier for the menu, assigned by the Toast POS.

String

description

A written description of the menu.

String

groups

A JSON array of ??? objects.

JSON array

idString

This field is for Toast internal use only.

String

orderableOnline

Indicates whether the menu is available for online ordering. Valid values are true and false. This field is a Boolean version of the orderableOnlineStatus field.

Boolean

orderableOnlineStatus

Indicates whether the menu is available for online ordering. Valid values are YES and NO. This field is a string version of the orderableOnline field.

String

visibility

Indicates where the menu is displayed and who can see it. Values are:

String

startTime

The time of day when a time-based menu becomes available. The value is in milliseconds (for example, 41400000) since the start of the restaurant's day (the day starts at 0). When converted to 24-hour clock time, the result should be the same as the startTimeHHmm field.

Int

endTime

The time of day when a time-based menu stops being available. The value is in milliseconds (for example, 57600000) since the start of the restaurant's day (the day starts at 0). When converted to 24-hour clock time, the result should be the same as the endTimeHHmm field.

Int

startTimeHHmm

The time of day when a time-based menu becomes available. The time is in 24-hour HHmm format (for example, 15:45). This value is a conversion of the startTime field to a more readable format (the day starts at 00:00).

String

endTimeHHmm

The time of day when a time-based menu stops being available. The time is in 24-hour HHmm format (for example, 19:35). This value is a conversion of the endTime field to a more readable format (the day starts at 00:00).

String

startTimeLocalStandardTime

The time of day when a time-based menu becomes available. The value is in milliseconds since the start of the restaurant's day (the day starts at 0). The value adds the restaurant timezone's offset (for example, -5 hours in a 23400000 value). Note that Daylight Saving Time (DST) is ignored. When converted to 24-hour clock time, the result should be the same as the startTimeHHmm field.

Int

endTimeLocalStandardTime

The time of day when a time-based menu stops being available. The value is in milliseconds since the start of the restaurant's day (the day starts at 0). The value adds the restaurant timezone's offset (for example, -5 hours in a 36900000 value). Note that Daylight Saving Time (DST) is ignored. When converted to 24-hour clock time, the result should be the same as the startTimeLocalStandardTime field.

Int

startTimeHHmmLocalStandardTime

The time of day when a time-based menu becomes available. The time is in 24-hour HHmm format (for example, 15:45). This value is a conversion of the startTimeLocalStandardTime field to a more readable format (the day starts at 00:00).

String

endTimeHHmmLocalStandardTime

The time of day when a time-based menu stops being available. The time is in 24-hour HHmm format (for example, 19:35). This value is a conversion of the endTimeLocalStandardTime field to a more readable format (the day starts at 00:00).

String

availableAllTimes

Indicates whether the menu is available at all times of the day. If the value is false, then the startTime* fields and the endTime* fields list when this time-based menu is available.

Boolean

availableAllDays

Indicates whether the menu is available each day of the week.

Boolean

daysAvailableString

A JSON array of strings that lists the days of the week when the menu is available. The days are listed in an abbreviated format, such as Sun or Thurs.

In this example, the menu is available on all days except for Sunday and Saturday:

"daysAvailableString": [
   "Mon",
   "Tues",
   "Wed",
   "Thurs",
   "Fri"
]

JSON array

daysAvailableBits

This field is a numeric version of the daysAvailableString field and is for Toast internal use only.

Int

imageLink

A URL to an image located on Amazon S3. For example:

https://s3.amazonaws.com/toasttab/restaurants/restaurant-59760/menu/items/5/item-4989_149066.jpg

String

entityType

The type of the menu component described by this JSON object. The value for a menu object is MenuGroup.

String

name

A descriptive identifier for the menu group. For example, Appetizers or Entrees.

String

guid

The unique identifier for the menu group, assigned by the Toast POS.

String

description

A written description of the menu group.

String

subgroups

An array of other MenuGroup objects. For example, Red Wine is the menu group and it has the subgroups By the Glass and By the Bottle.

JSON array

items

An array of ??? objects.

JSON array

idString

This field is for Toast internal use only.

String

imageLink

A URL to an image located on Amazon S3. For example:

https://s3.amazonaws.com/toasttab/restaurants/restaurant-59760/menu/items/5/item-4989_149066.jpg

String

orderableOnline

Indicates whether the menu group is available for online ordering.

Boolean

visibility

Indicates where the menu group is displayed and who can see it. Values are:

String

entityType

The type of the menu component described by this JSON object. The value for a menu item object is MenuItem.

String

name

A descriptive identifier for the menu item. For example, Caesar Salad or Lemonade.

String

guid

The unique identifier for the menu item, assigned by the Toast POS.

String

description

A written description of the menu item.

String

sku

The stock keeping unit (SKU) identifier for the item.

String

plu

The price lookup (PLU) code for the item.

String

maxSelections

This value only applies to items in a ??? object.

Integer

price

The amount of money that the item costs, expressed in U.S. dollars. All currency in Toast is treated the same and uses the dollar symbol $. There is no conversion between currency.

prices

An array of menu-specific prices for the item. If an item is included in more than one menu, it can have different prices on each menu. For example, if you have a Lunch menu and a Dinner menu, a menu item can belong to both menus and have one price for the Lunch menu and a higher price for the Dinner menu.

JSON array

isDefault

Whether or not the item is selected unless a customer chooses to decline it.

Boolean

optionGroups

An array of ??? objects.

JSON array

idString

This field is for Toast internal use only.

String

itemGroupGuid

The unique identifier of the menu group to which this menu item belongs.

String

calories

The caloric value for this menu item. The value can be any positive or negative integer, or zero.

Integer

imageLink

A URL to an image located on Amazon S3. For example:

https://s3.amazonaws.com/toasttab/restaurants/restaurant-59760/menu/items/5/item-4989_149066.jpg

String

orderableOnline

Indicates whether the menu item is available for online ordering.

Boolean

visibility

Indicates where the menu item is displayed and who can see it. Values are:

String

entityType

The type of the menu component described by this JSON object. The value for a menu option group object is MenuOptionGroup.

String

name

A descriptive identifier for the menu option group. For example, Substitutions or Extras.

String

guid

The unique identifier for the menu option group, assigned by the Toast POS.

String

minSelections

The minimum number of options that a customer can choose from the menu option group. If a server must make a selection from the menu option group, the value is 1. For example, a menu item might require that a customer choose an option from a menu option group that specifies the level of doneness.

Integer

maxSelections

The maximum number of options that a customer can choose from the menu option group. If a customer can choose an unlimited number of options from a menu option group, the value is null.

As an example of a menu option group with a maximum greater than one, assume this configuration:

Group: Cheese
Items: ( Cheddar, American, Swiss )
maxSelections: 2
minSelections: 1

This means:

Integer or null

pricingMode

Indicates how the options in the menu option group affect the price of the menu items they are applied to. Values are:

String

pricingStrategy

Indicates the way prices are set for the options in this menu option group. Values are:

String

pricingStrategyRules

An object that contains the pricing rules for the chosen pricingStrategy. If the pricing strategy is NONE or UNSUPPORTED_STRATEGY, this object is set to NONE.

JSON object

defaultOptionsChargePrice

Indicates whether the prices associated with the menu option group's default options are added to the cost of the menu items they modify. Values are:

String

defaultOptionsSubstitutionPricing

Indicates whether substitution pricing is enabled for the menu options group. Values are:

There are two scenarios that can occur with substitution pricing:

String

items

An array of the objects that represent the options in the menu option group.

JSON array

idString

This field is for Toast internal use only.

String

visibility

Indicates where the menu option group is displayed and who can see it. Values are:

String

basePrice

Used when the pricingStrategy is set to BASE_PRICE. Defines a constant price for all of the options in the menu options group. For example:

"optionGroups": [ 
{
  "guid": "7aeae7d5-8891-4fa1-bcbd-647ad1f16c66",
  "name": "Toppings",
  ...
  "pricingStrategy":"BASE_PRICE",
  "pricingStategyRules": {
    "basePrice": 1.00
    }
  ...
}

Number

numberOfLevels

Used when the pricingStrategy is set to SEQUENCE_PRICE. Defines the number of levels for the sequence price. For example, if you have three levels, you can set a price for the first option added to the order, the second option added to the order, and all options added from the third option on. Used in conjunction with the sequencePrices array.

Number

sequencePrices

Sets the price for each level defined in the numberOfLevels value. For example:

"optionGroups": [ 
{
  "guid": "7aeae7d5-8891-4fa1-bcbd-647ad1f16c66",
  "name": "Toppings",
  ...
  "pricingStrategy": "SEQUENCE_PRICE",
  "pricingStrategyRules": {
    "numberOfLevels": 3,
    "sequencePrices": [
      0.50,
      0.75,
      1.00,
    ]
  }
  ...
}

JSON array