Flipdish · Schema

MenuElementEditResponse

Response with any menu elements that had issues being hidden/shown

RestaurantOnline OrderingMobile AppsPoint of SaleOrdersMenuPaymentsWebhooks

Properties

Name Type Description
SectionName string Section name
ItemName string Item name
OptionSetName string Option Set name
OptionSetItemName string Element name
MenuElementId integer Holds the information for the A and CNAME Records of a domain.
MenuElementType string Type of menu element
ValidationCode string Validation message for menu element issue
View JSON Schema on GitHub

JSON Schema

menus-menu-element-edit-response-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-element-edit-response-schema.json",
  "title": "MenuElementEditResponse",
  "description": "Response with any menu elements that had issues being hidden/shown",
  "type": "object",
  "properties": {
    "SectionName": {
      "description": "Section name",
      "type": "string",
      "example": "Example Name"
    },
    "ItemName": {
      "description": "Item name",
      "type": "string",
      "example": "Example Name"
    },
    "OptionSetName": {
      "description": "Option Set name",
      "type": "string",
      "example": "Example Name"
    },
    "OptionSetItemName": {
      "description": "Element name",
      "type": "string",
      "example": "Example Name"
    },
    "MenuElementId": {
      "format": "int32",
      "description": "Holds the information for the A and CNAME Records of a domain.",
      "type": "integer",
      "example": 500123
    },
    "MenuElementType": {
      "description": "Type of menu element",
      "enum": [
        "Item",
        "OptionSetItem"
      ],
      "type": "string",
      "example": "Item"
    },
    "ValidationCode": {
      "description": "Validation message for menu element issue",
      "enum": [
        "Success",
        "MinimumCountViolation",
        "MasterOptionSetViolation",
        "IncorrectElementTypeInMenu",
        "DBFailed"
      ],
      "type": "string",
      "example": "Success"
    }
  }
}