Flipdish · JSON Structure

Customers Order Item Structure

Order item

Type: object Properties: 14

RestaurantOnline OrderingMobile AppsPoint of SaleOrdersMenuPaymentsWebhooks

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

Properties

OrderItemOptions Metadata MenuItemPublicId MenuSectionName MenuSectionDisplayOrder Name Description Price TaxAmount PriceIncludingOptionSetItems MenuItemId MenuItemDisplayOrder IsAvailable DepositReturnFee

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/customers-order-item-structure.json",
  "name": "OrderItem",
  "description": "Order item",
  "type": "object",
  "properties": {
    "OrderItemOptions": {
      "description": "Option list",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/OrderItemOption"
      },
      "example": []
    },
    "Metadata": {
      "description": "Metadata",
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    },
    "MenuItemPublicId": {
      "description": "Public id of the Menu Item",
      "type": "uuid",
      "example": "00000000-0000-0000-0000-000000000000"
    },
    "MenuSectionName": {
      "description": "Menu section name",
      "type": "string",
      "example": "Example Name"
    },
    "MenuSectionDisplayOrder": {
      "description": "Menu section display order",
      "type": "int32",
      "example": 1
    },
    "Name": {
      "description": "Name",
      "type": "string",
      "example": "Example Name"
    },
    "Description": {
      "description": "Description",
      "type": "string",
      "example": "string"
    },
    "Price": {
      "description": "Price",
      "type": "double",
      "example": 12.5
    },
    "TaxAmount": {
      "description": "Tax currency amount",
      "type": "double",
      "example": 12.5
    },
    "PriceIncludingOptionSetItems": {
      "description": "Price including option set items",
      "type": "double",
      "example": 12.5
    },
    "MenuItemId": {
      "description": "Menu item identifier",
      "type": "int32",
      "example": 500123
    },
    "MenuItemDisplayOrder": {
      "description": "Menu item display order",
      "type": "int32",
      "example": 1
    },
    "IsAvailable": {
      "description": "Is available",
      "type": "boolean",
      "example": true
    },
    "DepositReturnFee": {
      "description": "Deposit return fee",
      "type": "double",
      "nullable": true,
      "example": 12.5
    }
  }
}