Skip to main content

Orders - Models - Item

KeyTypeExample ValueDescription
namestringVeggie Pizza 123REQUIRED- Item name here
partners_uuidstring97-34-3534OPTIONAL - This is your unique order item reference number from your internal system. This should be unique across all items of an order
categorystringPizzaList of categories include Pizza, Salad, etc
addons_typestringpizzaOPTIONAL - Specify the type of addons can only be pizza or empty string
addonsArray 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
quantitynumber1number of this item
special_instructionsstring"more cheese"Add any special instructions for the item
display_on_kdsbooleantrueSpecify if this item should be displayed on the KDS application, true by default.
pricedecimal12.34price of this item
cookablebooleantrueSpecify 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
}