Toast · JSON Structure

Menus Catalog Product Option Structure

An option for a retail product.

Type: object Properties: 4
RestaurantsPoint Of SalePaymentsOnline OrderingDeliveryLoyaltyGift CardsMenusOrdersKitchenLaborSchedulingInventoryHospitalityPartner Integrations

CatalogProductOption is a JSON Structure definition published by Toast, describing 4 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

id name sortOrder values

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/toast-tab/refs/heads/main/json-structure/menus-catalog-product-option-structure.json",
  "name": "CatalogProductOption",
  "description": "An option for a retail product.\n",
  "type": "object",
  "properties": {
    "id": {
      "type": "uuid",
      "description": "The unique identifier for the product option.\n",
      "example": "5a401af8-d2e2-4090-8c45-9f87b8b6c4d1"
    },
    "name": {
      "type": "string",
      "description": "The name of the product option, for example, \"size\".\n",
      "example": "Example Name"
    },
    "sortOrder": {
      "type": "int32",
      "description": "The sort order of the product option.\n",
      "example": 1
    },
    "values": {
      "type": "array",
      "description": "List of values for the product option.\n",
      "items": {
        "$ref": "#/$defs/CatalogProductOptionValue"
      }
    }
  },
  "definitions": {
    "CatalogProductOptionValue": {
      "type": "object",
      "description": "A value within a catalog product option.\n",
      "properties": {
        "id": {
          "type": "uuid",
          "description": "The unique identifier for the product option value.\n",
          "example": "5a401af8-d2e2-4090-8c45-9f87b8b6c4d1"
        },
        "name": {
          "type": "string",
          "description": "The name of the product option value, for example, \"small\".\n",
          "example": "Example Name"
        },
        "sortOrder": {
          "type": "int32",
          "description": "The sort order of the product option value.\n",
          "example": 1
        }
      },
      "name": "CatalogProductOptionValue"
    }
  }
}