Flipdish · Schema
OrderItem
Order item
RestaurantOnline OrderingMobile AppsPoint of SaleOrdersMenuPaymentsWebhooks
Properties
| Name | Type | Description |
|---|---|---|
| OrderItemOptions | array | Option list |
| Metadata | object | Metadata |
| MenuItemPublicId | string | Public id of the Menu Item |
| MenuSectionName | string | Menu section name |
| MenuSectionDisplayOrder | integer | Menu section display order |
| Name | string | Name |
| Description | string | Description |
| Price | number | Price |
| TaxAmount | number | Tax currency amount |
| PriceIncludingOptionSetItems | number | Price including option set items |
| MenuItemId | integer | Menu item identifier |
| MenuItemDisplayOrder | integer | Menu item display order |
| IsAvailable | boolean | Is available |
| DepositReturnFee | number | Deposit return fee |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/api-evangelist/flipdish/refs/heads/main/json-schema/customers-order-item-schema.json",
"title": "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": {
"format": "uuid",
"description": "Public id of the Menu Item",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"MenuSectionName": {
"description": "Menu section name",
"type": "string",
"example": "Example Name"
},
"MenuSectionDisplayOrder": {
"format": "int32",
"description": "Menu section display order",
"type": "integer",
"example": 1
},
"Name": {
"description": "Name",
"type": "string",
"example": "Example Name"
},
"Description": {
"description": "Description",
"type": "string",
"example": "string"
},
"Price": {
"format": "double",
"description": "Price",
"type": "number",
"example": 12.5
},
"TaxAmount": {
"format": "double",
"description": "Tax currency amount",
"type": "number",
"example": 12.5
},
"PriceIncludingOptionSetItems": {
"format": "double",
"description": "Price including option set items",
"type": "number",
"example": 12.5
},
"MenuItemId": {
"format": "int32",
"description": "Menu item identifier",
"type": "integer",
"example": 500123
},
"MenuItemDisplayOrder": {
"format": "int32",
"description": "Menu item display order",
"type": "integer",
"example": 1
},
"IsAvailable": {
"description": "Is available",
"type": "boolean",
"example": true
},
"DepositReturnFee": {
"format": "double",
"description": "Deposit return fee",
"type": "number",
"nullable": true,
"example": 12.5
}
}
}