Orders - Models - Item
Key | Type | Example Value | Description |
---|---|---|---|
name | string | Veggie Pizza 123 | REQUIRED- Item name here |
partners_uuid | string | 97-34-3534 | OPTIONAL - This is your unique order item reference number from your internal system. This should be unique across all items of an order |
category | string | Pizza | List of categories include Pizza, Salad, etc |
addons_type | string | pizza | OPTIONAL - Specify the type of addons can only be pizza or empty string |
addons | Array or Hash | [ "chilli sauce", "cheese", "nachos" ], {"whole": ["chicken"]} | This should be an array of strings or hash to specify pizza addons(whole, left, right). The latter requires addons_type to be set to pizza |
quantity | number | 1 | number of this item |
special_instructions | string | "more cheese" | Add any special instructions for the item |
display_on_kds | boolean | true | Specify if this item should be displayed on the KDS application, true by default. |
price | decimal | 12.34 | price of this item |
cookable | boolean | true | Specify if this item is cookable, true by default. |
Example Item
{`
"name": "Veggie Pizza 123",
"partners_uuid": "97-34-3534",
"category": "Salad",
"addons_type": "",
"quantity": 1,
"special_instructions": "make sure it fresh",
"display_on_kds": true,
"price": "12.34",
"cookable": true
}
Example Item - Pizza Addons
{
"name": "Meat Pizza 123",
"partners_uuid": "97-34-3534",
"category": "Salad",
"addons_type": "pizza",
"addons": {
"whole": ["vegan cheese"],
"left": ["tuna", "cucumbers"],
"right": ["steak", "mayo"]
},
"quantity": 1,
"special_instructions": "extra steak please",
"display_on_kds": true,
"price": "12.34",
"cookable": true
}