AppliedPackagingItem

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/toast-tab/refs/heads/main/json-schema/orders-applied-packaging-item-schema.json",
  "title": "AppliedPackagingItem",
  "description": "Indicates the guest preference for an individual packaging item in this order.\n",
  "type": "object",
  "allOf": [
    {
      "$ref": "#/$defs/ToastReference"
    },
    {
      "type": "object",
      "required": [
        "itemConfigId",
        "inclusion"
      ],
      "properties": {
        "itemConfigId": {
          "type": "string",
          "description": "The identifier GUID of the packaging preference option.\n"
        },
        "inclusion": {
          "type": "string",
          "description": "The packaging preference choice that the guest selected in your ordering interface.\n",
          "enum": [
            "YES",
            "NO"
          ]
        },
        "itemTypes": {
          "x-toast-read-only": true,
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "The packaging item types relevant for this packaging item as configured by the restaurant in Toast Web. Response only.\n"
        },
        "guestDisplayName": {
          "x-toast-read-only": true,
          "type": "string",
          "description": "The guest-facing name, configured by the restaurant in Toast Web, for this packaging item. Response only.\n"
        }
      }
    }
  ],
  "$defs": {
    "ToastReference": {
      "type": "object",
      "description": "A wrapper object with fields that allow reference to a Toast entity by Toast GUID.",
      "required": [
        "guid",
        "entityType"
      ],
      "properties": {
        "guid": {
          "description": "The GUID maintained by the Toast platform.",
          "type": "string",
          "example": "5a401af8-d2e2-4090-8c45-9f87b8b6c4d1"
        },
        "entityType": {
          "x-toast-read-only": true,
          "description": "The type of object this is. Response only.",
          "type": "string",
          "example": "string"
        }
      }
    }
  }
}