Flipdish · Schema

CreateFullMenuSectionItem

Create menu section item

RestaurantOnline OrderingMobile AppsPoint of SaleOrdersMenuPaymentsWebhooks

Properties

Name Type Description
MenuItemOptionSets array Menu item option sets
Metadata array List of metadata
TaxRateName string Tax rate name
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
ExcludeFromVoucherDiscounting boolean If true, the item is excluded from voucher discount calculations
PublicId string Permanent reference to the item.
View JSON Schema on GitHub

JSON Schema

menus-create-full-menu-section-item-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/flipdish/refs/heads/main/json-schema/menus-create-full-menu-section-item-schema.json",
  "title": "CreateFullMenuSectionItem",
  "description": "Create menu section item",
  "type": "object",
  "properties": {
    "MenuItemOptionSets": {
      "description": "Menu item option sets",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/CreateFullMenuItemOptionSet"
      },
      "example": []
    },
    "Metadata": {
      "description": "List of metadata",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/CreateMetadata"
      },
      "example": []
    },
    "TaxRateName": {
      "description": "Tax rate name",
      "type": "string",
      "example": "Example Name"
    },
    "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
    },
    "ExcludeFromVoucherDiscounting": {
      "description": "If true, the item is excluded from voucher discount calculations",
      "type": "boolean",
      "example": true
    },
    "PublicId": {
      "format": "uuid",
      "description": "Permanent reference to the item.",
      "type": "string",
      "example": "00000000-0000-0000-0000-000000000000"
    }
  }
}