Flipdish · Schema

MenuItemOptionSetItem

Menu item option set item

RestaurantOnline OrderingMobile AppsPoint of SaleOrdersMenuPaymentsWebhooks

Properties

Name	Type	Description
MenuItemOptionSetItemId	integer	Menu item option set item identifier
PublicId	string	Permanent reference to the item.
Metadata	array	List of metadata
NextMenuItemOptionSetId	integer	if null, next option set is next. if -1, this is the final option set
CatalogItemId	string	Catalog item Id when the OptionSet is associated to a Product
TaxRateName	string	Tax rate name
TaxRateId	integer	TaxRateId.
TaxValue	number	TaxValue.
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

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/flipdish/refs/heads/main/json-schema/platform-menu-item-option-set-item-schema.json",
  "title": "MenuItemOptionSetItem",
  "description": "Menu item option set item",
  "type": "object",
  "properties": {
    "MenuItemOptionSetItemId": {
      "format": "int32",
      "description": "Menu item option set item identifier",
      "type": "integer",
      "example": 500123
    },
    "PublicId": {
      "format": "uuid",
      "description": "Permanent reference to the item.",
      "type": "string",
      "example": "00000000-0000-0000-0000-000000000000"
    },
    "Metadata": {
      "description": "List of metadata",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/CreateMetadata"
      },
      "example": []
    },
    "NextMenuItemOptionSetId": {
      "format": "int32",
      "description": "if null, next option set is next. if -1, this is the final option set",
      "type": "integer",
      "nullable": true,
      "example": 500123
    },
    "CatalogItemId": {
      "description": "Catalog item Id when the OptionSet is associated to a Product",
      "type": "string",
      "example": "500123"
    },
    "TaxRateName": {
      "description": "Tax rate name",
      "type": "string",
      "example": "Example Name"
    },
    "TaxRateId": {
      "format": "int32",
      "description": "TaxRateId.",
      "type": "integer",
      "nullable": true,
      "example": 500123
    },
    "TaxValue": {
      "format": "double",
      "description": "TaxValue.",
      "type": "number",
      "example": 1.0
    },
    "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"
    }
  }
}