Flipdish · JSON Structure

Menus Menu Item Option Set Item Structure

Menu item option set item

Type: object Properties: 15
RestaurantOnline OrderingMobile AppsPoint of SaleOrdersMenuPaymentsWebhooks

MenuItemOptionSetItem is a JSON Structure definition published by Flipdish, describing 15 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

MenuItemOptionSetItemId PublicId Metadata NextMenuItemOptionSetId CatalogItemId TaxRateName TaxRateId TaxValue Name Price DepositReturnFee IsAvailable DisplayOrder CellLayoutType ImageUrl

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$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-item-structure.json",
  "name": "MenuItemOptionSetItem",
  "description": "Menu item option set item",
  "type": "object",
  "properties": {
    "MenuItemOptionSetItemId": {
      "description": "Menu item option set item identifier",
      "type": "int32",
      "example": 500123
    },
    "PublicId": {
      "description": "Permanent reference to the item.",
      "type": "uuid",
      "example": "00000000-0000-0000-0000-000000000000"
    },
    "Metadata": {
      "description": "List of metadata",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/CreateMetadata"
      },
      "example": []
    },
    "NextMenuItemOptionSetId": {
      "description": "if null, next option set is next. if -1, this is the final option set",
      "type": "int32",
      "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": {
      "description": "TaxRateId.",
      "type": "int32",
      "nullable": true,
      "example": 500123
    },
    "TaxValue": {
      "description": "TaxValue.",
      "type": "double",
      "example": 1.0
    },
    "Name": {
      "description": "Name",
      "type": "string",
      "example": "Example Name"
    },
    "Price": {
      "description": "Price",
      "type": "double",
      "example": 12.5
    },
    "DepositReturnFee": {
      "description": "An optional fee that can be added to the price of the item.",
      "type": "double",
      "nullable": true,
      "example": 12.5
    },
    "IsAvailable": {
      "description": "Is available",
      "type": "boolean",
      "example": true
    },
    "DisplayOrder": {
      "description": "Display order. Displayed in ascending order.",
      "type": "int32",
      "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"
    }
  }
}