Flipdish · Schema

MenuSectionItem

Menu item

RestaurantOnline OrderingMobile AppsPoint of SaleOrdersMenuPaymentsWebhooks

Properties

Name	Type	Description
ActualPrice	number	Actual price - the minimum price possible when all required option set items prices are included.
MenuItemOptionSets	array	Menu item option sets
DailySpecialHours	array	Daily special hours
PublicId	string	Permanent reference to the item.
TaxRateName	string	Tax rate name
TaxRateId	integer	TaxRate
TaxValue	number	TaxValue - the tax associated with this item, based on TaxRate / TaxType and Currency (currency determines decimal point precision)
ExcludeFromVoucherDiscounting	boolean	If true, the item is excluded from voucher discount calculations
Metadata	array	List of metadata
CatalogItemId	string	Catalog item Id when the Item is associated to a Product
Name	string	Menu item name (like "Korma")
Description	string	Description (like "A lovely dish from the east")
SpicinessRating	string	Spiciness rating
Price	number	Price - this is only used when there is no master option set and should be set to 0 if a master option set exists.
DepositReturnFee	number	An optional fee that can be added to the price of the item.
DisplayOrder	integer	Display order
Alcohol	boolean	To be set true if the item or an option of the item contains an alcoholic drink.
IsAvailable	boolean	True if we accept orders for this item still
CellLayoutType	string	Small \| Medium \| Large Affects the layout of the menu.
DisableVouchers	boolean	If true, then vouchers won't be applied for this item
ImageName	string	Image url
ImageUrl	string	Image url
MenuItemId	integer	Menu Item Id

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/flipdish/refs/heads/main/json-schema/platform-menu-section-item-schema.json",
  "title": "MenuSectionItem",
  "description": "Menu item",
  "type": "object",
  "properties": {
    "ActualPrice": {
      "format": "double",
      "description": "Actual price - the minimum price possible when all required option set items prices are included.",
      "type": "number",
      "example": 12.5
    },
    "MenuItemOptionSets": {
      "description": "Menu item option sets",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/MenuItemOptionSet"
      },
      "example": []
    },
    "DailySpecialHours": {
      "description": "Daily special hours",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/BusinessHoursPeriod"
      },
      "example": []
    },
    "PublicId": {
      "format": "uuid",
      "description": "Permanent reference to the item.",
      "type": "string",
      "example": "00000000-0000-0000-0000-000000000000"
    },
    "TaxRateName": {
      "description": "Tax rate name",
      "type": "string",
      "example": "Example Name"
    },
    "TaxRateId": {
      "format": "int32",
      "description": "TaxRate",
      "type": "integer",
      "nullable": true,
      "example": 500123
    },
    "TaxValue": {
      "format": "double",
      "description": "TaxValue - the tax associated with this item, based on TaxRate / TaxType and Currency (currency determines decimal point precision)",
      "type": "number",
      "example": 1.0
    },
    "ExcludeFromVoucherDiscounting": {
      "description": "If true, the item is excluded from voucher discount calculations",
      "type": "boolean",
      "example": true
    },
    "Metadata": {
      "description": "List of metadata",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/CreateMetadata"
      },
      "example": []
    },
    "CatalogItemId": {
      "description": "Catalog item Id when the Item is associated to a Product",
      "type": "string",
      "example": "500123"
    },
    "Name": {
      "description": "Menu item name (like \"Korma\")",
      "maxLength": 4000,
      "minLength": 0,
      "type": "string",
      "example": "Example Name"
    },
    "Description": {
      "description": "Description (like \"A lovely dish from the east\")",
      "maxLength": 4000,
      "minLength": 0,
      "type": "string",
      "example": "string"
    },
    "SpicinessRating": {
      "description": "Spiciness rating",
      "enum": [
        "NotRated",
        "Mild",
        "Medium",
        "Hot"
      ],
      "type": "string",
      "example": "NotRated"
    },
    "Price": {
      "format": "double",
      "description": "Price - this is only used when there is no master option set and should be set to 0 if a master option set exists.",
      "type": "number",
      "example": 12.5
    },
    "DepositReturnFee": {
      "format": "double",
      "description": "An optional fee that can be added to the price of the item.",
      "type": "number",
      "nullable": true,
      "example": 12.5
    },
    "DisplayOrder": {
      "format": "int32",
      "description": "Display order",
      "type": "integer",
      "example": 1
    },
    "Alcohol": {
      "description": "To be set true if the item or an option of the item contains an alcoholic drink.",
      "type": "boolean",
      "example": true
    },
    "IsAvailable": {
      "description": "True if we accept orders for this item still",
      "type": "boolean",
      "example": true
    },
    "CellLayoutType": {
      "description": "Small | Medium | Large\r\nAffects the layout of the menu.",
      "enum": [
        "Small",
        "Medium",
        "Large",
        "HiddenImage"
      ],
      "type": "string",
      "example": "Small"
    },
    "DisableVouchers": {
      "description": "If true, then vouchers won't be applied for this item",
      "type": "boolean",
      "example": true
    },
    "ImageName": {
      "description": "Image url",
      "type": "string",
      "example": "Example Name"
    },
    "ImageUrl": {
      "description": "Image url",
      "type": "string",
      "example": "https://api.flipdish.co/example"
    },
    "MenuItemId": {
      "format": "int32",
      "description": "Menu Item Id",
      "type": "integer",
      "example": 500123
    }
  }
}