PackagingItem

Configuration for a type of packaging

• guestDescription:
  string

  A longer description for the packaging item. Max 60 characters. This description is optional.

• guestDisplayName required:
  string

  A question to be shown to guests that asks if they want to include utensils in their order. For example, "Include Utensils?"

• guestInclusionType required:
  string

  guestInclusionType is an indication of what action the guest must take to include or exclude a packaging item.

  Details:

  • OPT_IN - The guest creating an order must take an action to receive the packaging item. For example, if there is a checkbox for "UTENSILS", and it is unchecked by default, the guest must check it for their order to include utensils.
  • OPT_OUT - The guest creating an order must take an action to not receive the packaging item. For example, if there is a checkbox for "UTENSILS", and it is checked by default, the guest must uncheck it for their order to not include utensils.
• id required:
  string

  Unique identifier for a packaging item.

• itemTypes required:
  Array of strings

  The possible packaging values like UTENSILS, NAPKINS, BAGS, STRAWS or CONDIMENTS. Packaging preferences can be configured in Toast Web at Takeout and Delivery > Packaging Preferences.

{
  "id": "string",
  "itemTypes": [
    "string"
  ],
  "guestDisplayName": "string",
  "guestDescription": "string",
  "guestInclusionType": "string"
}