Flipdish · Schema

MenuSectionBase

Menu section

RestaurantOnline OrderingMobile AppsPoint of SaleOrdersMenuPaymentsWebhooks

Properties

Name Type Description
Name string Name
Description string Description
DisplayOrder integer Display order
IsAvailable boolean Is available
IsHiddenFromCustomers boolean Is hidden from customer. Perhaps when the item is out of stock.
ImageUrl string Image url
MenuSectionId integer Menu Section Id
PublicId string Permanent reference to the item.
View JSON Schema on GitHub

JSON Schema

menus-menu-section-base-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-section-base-schema.json",
  "title": "MenuSectionBase",
  "description": "Menu section",
  "type": "object",
  "properties": {
    "Name": {
      "description": "Name",
      "maxLength": 4000,
      "minLength": 0,
      "type": "string",
      "example": "Example Name"
    },
    "Description": {
      "description": "Description",
      "maxLength": 4000,
      "minLength": 0,
      "type": "string",
      "example": "string"
    },
    "DisplayOrder": {
      "format": "int32",
      "description": "Display order",
      "type": "integer",
      "example": 1
    },
    "IsAvailable": {
      "description": "Is available",
      "type": "boolean",
      "example": true
    },
    "IsHiddenFromCustomers": {
      "description": "Is hidden from customer. Perhaps when the item is out of stock.",
      "type": "boolean",
      "example": true
    },
    "ImageUrl": {
      "description": "Image url",
      "type": "string",
      "example": "https://api.flipdish.co/example"
    },
    "MenuSectionId": {
      "format": "int32",
      "description": "Menu Section Id",
      "type": "integer",
      "example": 500123
    },
    "PublicId": {
      "format": "uuid",
      "description": "Permanent reference to the item.",
      "type": "string",
      "example": "00000000-0000-0000-0000-000000000000"
    }
  }
}