Flipdish · Schema

CreateFullMenuItemOptionSet

Create menu item option set

RestaurantOnline OrderingMobile AppsPoint of SaleOrdersMenuPaymentsWebhooks

Properties

Name Type Description
MenuItemOptionSetId integer Menu item option set identifier
MenuItemOptionSetItems array Option set items
Name string Menu item option set name
IsMasterOptionSet boolean Is master option set. This can affect the layout of the options in the menu displayed to the customer. Usually it is true if the option could be considerd a standalone item as opposed to an addition (
DisplayOrder integer Display order. Displayed in ascending order.
MinSelectCount integer Minimum items must be selected
MaxSelectCount integer Maximum number of items can be selected
CellLayoutType string Small | Medium | Large Affects the layout of the menu.
PublicId string Permanent reference to the item.
View JSON Schema on GitHub

JSON Schema

menus-create-full-menu-item-option-set-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-item-option-set-schema.json",
  "title": "CreateFullMenuItemOptionSet",
  "description": "Create menu item option set",
  "type": "object",
  "properties": {
    "MenuItemOptionSetId": {
      "format": "int32",
      "description": "Menu item option set identifier",
      "type": "integer",
      "example": 500123
    },
    "MenuItemOptionSetItems": {
      "description": "Option set items",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/CreateFullMenuItemOptionSetItem"
      },
      "example": []
    },
    "Name": {
      "description": "Menu item option set name",
      "maxLength": 4000,
      "minLength": 0,
      "type": "string",
      "example": "Example Name"
    },
    "IsMasterOptionSet": {
      "description": "Is master option set. This can affect the layout of the options in the menu displayed to the customer. Usually it is true if the option could be considerd a standalone item as opposed to an addition (\"with ketchup\") or modifier (\"large\").",
      "type": "boolean",
      "example": true
    },
    "DisplayOrder": {
      "format": "int32",
      "description": "Display order. Displayed in ascending order.",
      "type": "integer",
      "example": 1
    },
    "MinSelectCount": {
      "format": "int32",
      "description": "Minimum items must be selected",
      "type": "integer",
      "example": 3
    },
    "MaxSelectCount": {
      "format": "int32",
      "description": "Maximum number of items can be selected",
      "type": "integer",
      "example": 3
    },
    "CellLayoutType": {
      "description": "Small | Medium | Large\r\nAffects the layout of the menu.",
      "enum": [
        "Small",
        "Medium",
        "Large",
        "HiddenImage"
      ],
      "type": "string",
      "example": "Small"
    },
    "PublicId": {
      "format": "uuid",
      "description": "Permanent reference to the item.",
      "type": "string",
      "example": "00000000-0000-0000-0000-000000000000"
    }
  }
}