Flipdish · Schema

MenuSummary

Menu Summary

RestaurantOnline OrderingMobile AppsPoint of SaleOrdersMenuPaymentsWebhooks

Properties

Name Type Description
MenuId integer Menu identifier
ModifiedTime string Last modified time
VersionNumber integer Menu version
MenuUrl string Menu Url
Name string Name of Menu, only shown in portal
Locked boolean Locked: is menu locked against modifcation
StoreNames array List of stores names which are associated with this menu
IsIntegrated boolean Flag to indicate if the menu is integrated (contains metadata)
View JSON Schema on GitHub

JSON Schema

menus-menu-summary-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-menu-summary-schema.json",
  "title": "MenuSummary",
  "description": "Menu Summary",
  "type": "object",
  "properties": {
    "MenuId": {
      "format": "int32",
      "description": "Menu identifier",
      "type": "integer",
      "example": 500123
    },
    "ModifiedTime": {
      "format": "date-time",
      "description": "Last modified time",
      "type": "string",
      "example": "2026-06-02T12:00:00Z"
    },
    "VersionNumber": {
      "format": "int32",
      "description": "Menu version",
      "type": "integer",
      "example": 3
    },
    "MenuUrl": {
      "description": "Menu Url",
      "type": "string",
      "example": "https://api.flipdish.co/example"
    },
    "Name": {
      "description": "Name of Menu, only shown in portal",
      "type": "string",
      "example": "Example Name"
    },
    "Locked": {
      "description": "Locked: is menu locked against modifcation",
      "type": "boolean",
      "example": true
    },
    "StoreNames": {
      "description": "List of stores names which are associated with this menu",
      "type": "array",
      "items": {
        "type": "string"
      },
      "example": [
        "Example Name"
      ]
    },
    "IsIntegrated": {
      "description": "Flag to indicate if the menu is integrated (contains metadata)",
      "type": "boolean",
      "example": true
    }
  }
}