Flipdish · JSON Structure

Menus Menu Section Item Structure

Menu item

Type: object Properties: 23
RestaurantOnline OrderingMobile AppsPoint of SaleOrdersMenuPaymentsWebhooks

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

Properties

ActualPrice MenuItemOptionSets DailySpecialHours PublicId TaxRateName TaxRateId TaxValue ExcludeFromVoucherDiscounting Metadata CatalogItemId Name Description SpicinessRating Price DepositReturnFee DisplayOrder Alcohol IsAvailable CellLayoutType DisableVouchers ImageName ImageUrl MenuItemId

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/flipdish/refs/heads/main/json-structure/menus-menu-section-item-structure.json",
  "name": "MenuSectionItem",
  "description": "Menu item",
  "type": "object",
  "properties": {
    "ActualPrice": {
      "description": "Actual price - the minimum price possible when all required option set items prices are included.",
      "type": "double",
      "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": {
      "description": "Permanent reference to the item.",
      "type": "uuid",
      "example": "00000000-0000-0000-0000-000000000000"
    },
    "TaxRateName": {
      "description": "Tax rate name",
      "type": "string",
      "example": "Example Name"
    },
    "TaxRateId": {
      "description": "TaxRate",
      "type": "int32",
      "nullable": true,
      "example": 500123
    },
    "TaxValue": {
      "description": "TaxValue - the tax associated with this item, based on TaxRate / TaxType and Currency (currency determines decimal point precision)",
      "type": "double",
      "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": {
      "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": "double",
      "example": 12.5
    },
    "DepositReturnFee": {
      "description": "An optional fee that can be added to the price of the item.",
      "type": "double",
      "nullable": true,
      "example": 12.5
    },
    "DisplayOrder": {
      "description": "Display order",
      "type": "int32",
      "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": {
      "description": "Menu Item Id",
      "type": "int32",
      "example": 500123
    }
  }
}