Flipdish · Schema

MenuItemOptionSetItemBase

Menu item option set item

RestaurantOnline OrderingMobile AppsPoint of SaleOrdersMenuPaymentsWebhooks

Properties

Name Type Description
Name string Name
Price number Price
DepositReturnFee number An optional fee that can be added to the price of the item.
IsAvailable boolean Is available
DisplayOrder integer Display order. Displayed in ascending order.
CellLayoutType string Small | Medium | Large Affects the layout of the menu.
ImageUrl string Image url
PublicId string Permanent reference to the item.
View JSON Schema on GitHub

JSON Schema

menus-menu-item-option-set-item-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-item-option-set-item-base-schema.json",
  "title": "MenuItemOptionSetItemBase",
  "description": "Menu item option set item",
  "type": "object",
  "properties": {
    "Name": {
      "description": "Name",
      "type": "string",
      "example": "Example Name"
    },
    "Price": {
      "format": "double",
      "description": "Price",
      "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
    },
    "IsAvailable": {
      "description": "Is available",
      "type": "boolean",
      "example": true
    },
    "DisplayOrder": {
      "format": "int32",
      "description": "Display order. Displayed in ascending order.",
      "type": "integer",
      "example": 1
    },
    "CellLayoutType": {
      "description": "Small | Medium | Large\r\nAffects the layout of the menu.",
      "enum": [
        "Small",
        "Medium",
        "Large",
        "HiddenImage"
      ],
      "type": "string",
      "example": "Small"
    },
    "ImageUrl": {
      "description": "Image url",
      "type": "string",
      "example": "https://api.flipdish.co/example"
    },
    "PublicId": {
      "format": "uuid",
      "description": "Permanent reference to the item.",
      "type": "string",
      "example": "00000000-0000-0000-0000-000000000000"
    }
  }
}