Otter · Schema

MenuItem_POS

Items are sold on the Menu. Modifiers to items are items themselves and their relationship is defined by ModifierGroup.

RestaurantOrder ManagementDeliveryOnline OrderingMenu ManagementAnalytics

Properties

Name Type Description
id string Internal identifier of this Item.
name string Name of this Item
photoIds array A list of Photo references associated with the Item.
price object
status object
description string Description of this Item
modifierGroupIds array Identifiers of each ModifierGroup within this Item.
priceOverrides array Specify price overrides for different service slugs.
skuDetails object
additionalCharges array Additional charges to apply for this item. Additional charges will be applied for every instance of this item within an order.
tax object The tax configuration for the menu item.
View JSON Schema on GitHub

JSON Schema

public-api-menu-item-pos-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "MenuItem_POS",
  "description": "Items are sold on the Menu. Modifiers to items are items themselves and their relationship is defined by ModifierGroup.",
  "$id": "https://raw.githubusercontent.com/api-evangelist/otter/refs/heads/main/json-schema/public-api-menu-item-pos-schema.json",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "minLength": 1,
      "description": "Internal identifier of this Item.",
      "example": "faa4c79f-480d-4de1-bc34-5fb74ef082ef"
    },
    "name": {
      "type": "string",
      "description": "Name of this Item",
      "example": "Bagel"
    },
    "photoIds": {
      "type": "array",
      "description": "A list of Photo references associated with the Item.",
      "items": {
        "type": "string"
      }
    },
    "price": {
      "$ref": "https://raw.githubusercontent.com/api-evangelist/otter/refs/heads/main/json-schema/public-api-money-schema.json"
    },
    "status": {
      "$ref": "https://raw.githubusercontent.com/api-evangelist/otter/refs/heads/main/json-schema/public-api-item-status-schema.json"
    },
    "description": {
      "type": "string",
      "description": "Description of this Item",
      "example": "Delicious bagel!"
    },
    "modifierGroupIds": {
      "type": "array",
      "default": [],
      "description": "Identifiers of each ModifierGroup within this Item.",
      "items": {
        "type": "string",
        "example": "7152ee6e-e941-45c1-9008-2e306b479114"
      }
    },
    "priceOverrides": {
      "type": "array",
      "nullable": true,
      "description": "Specify price overrides for different service slugs.",
      "items": {
        "$ref": "https://raw.githubusercontent.com/api-evangelist/otter/refs/heads/main/json-schema/public-api-item-price-override-schema.json"
      }
    },
    "skuDetails": {
      "$ref": "https://raw.githubusercontent.com/api-evangelist/otter/refs/heads/main/json-schema/public-api-sku-details-schema.json"
    },
    "additionalCharges": {
      "type": "array",
      "nullable": true,
      "description": "Additional charges to apply for this item. Additional charges will be applied for every instance of this item within an order.",
      "items": {
        "$ref": "https://raw.githubusercontent.com/api-evangelist/otter/refs/heads/main/json-schema/public-api-additional-charge-schema.json"
      }
    },
    "tax": {
      "$ref": "https://raw.githubusercontent.com/api-evangelist/otter/refs/heads/main/json-schema/public-api-item-tax-schema.json",
      "description": "The tax configuration for the menu item."
    }
  },
  "required": [
    "id",
    "name",
    "photoIds",
    "price",
    "status"
  ]
}