Home
Flipdish
Menus Menu Item Option Set Structure
Menus Menu Item Option Set Structure
Menu item option set
Type: object
Properties: 12
Restaurant Online Ordering Mobile Apps Point of Sale Orders Menu Payments Webhooks
MenuItemOptionSet is a JSON Structure definition published by Flipdish, describing 12 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.
Properties
MenuItemOptionSetId
ImageName
ImageUrl
MenuItemOptionSetItems
PublicId
CatalogItemId
Name
IsMasterOptionSet
DisplayOrder
MinSelectCount
MaxSelectCount
CellLayoutType
Meta-schema: https://json-structure.org/meta/core/v0/#
JSON Structure
{
"$schema": "https://json-structure.org/meta/core/v0/#",
"$id": "https://raw.githubusercontent.com/api-evangelist/flipdish/refs/heads/main/json-structure/menus-menu-item-option-set-structure.json",
"name": "MenuItemOptionSet",
"description": "Menu item option set",
"type": "object",
"properties": {
"MenuItemOptionSetId": {
"description": "Menu item option set identifier",
"type": "int32",
"example": 500123
},
"ImageName": {
"description": "Image Name",
"type": "string",
"example": "Example Name"
},
"ImageUrl": {
"description": "Image url",
"type": "string",
"example": "https://api.flipdish.co/example"
},
"MenuItemOptionSetItems": {
"description": "Option set items",
"type": "array",
"items": {
"$ref": "#/components/schemas/MenuItemOptionSetItem"
},
"example": []
},
"PublicId": {
"description": "Permanent reference to the item.",
"type": "uuid",
"example": "00000000-0000-0000-0000-000000000000"
},
"CatalogItemId": {
"description": "Catalog item Id when the OptionSet is associated to a Product",
"type": "string",
"example": "500123"
},
"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": {
"description": "Display order. Displayed in ascending order.",
"type": "int32",
"example": 1
},
"MinSelectCount": {
"description": "Minimum items must be selected",
"type": "int32",
"example": 3
},
"MaxSelectCount": {
"description": "Maximum number of items can be selected",
"type": "int32",
"example": 3
},
"CellLayoutType": {
"description": "Small | Medium | Large\r\nAffects the layout of the menu.",
"enum": [
"Small",
"Medium",
"Large",
"HiddenImage"
],
"type": "string",
"example": "Small"
}
}
}