Toast · Schema

CatalogProductVariant

The specific version of the retail product that this menu item represents, defined by a unique combination of option values (for example, a T-Shirt with options `Red` and size `Small`).

Food ServicePoint of SaleRestaurantsHospitality

Properties

Name Type Description
id string The unique identifier for the product variant.
name string The name of the variant, for example, "T-Shirt - Small".
description string The description of the variant.
selectedOptions array List of selected options for the variant.
View JSON Schema on GitHub

JSON Schema

menus-catalog-product-variant-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/toast/refs/heads/main/json-schema/menus-catalog-product-variant-schema.json",
  "title": "CatalogProductVariant",
  "description": "The specific version of the retail product that this menu item represents, defined by a unique combination of option values (for example, a T-Shirt with options `Red` and size `Small`).\n",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "description": "The unique identifier for the product variant.\n"
    },
    "name": {
      "type": "string",
      "description": "The name of the variant, for example, \"T-Shirt - Small\".\n"
    },
    "description": {
      "type": "string",
      "description": "The description of the variant.\n",
      "x-nullable": true
    },
    "selectedOptions": {
      "type": "array",
      "description": "List of selected options for the variant.\n",
      "items": {
        "$ref": "#/definitions/CatalogProductVariantOption"
      }
    }
  }
}