Show menu
Login

till_orderitem

The till_orderitem Object

There’s currently no direct way to manipulate a KAPI till_orderitem object, but they may be transmitted as a part of a till_order object, and will contain the following attributes:

Attribute Type Key Description
orderitemid Unsigned int Yes The order item id – must be unique per venueid
orderid Unsigned int No The order id
venueid Unsigned int Yes The venue id
itemid Unsigned int No KAPI till_itemcategory id
categoryid Unsigned int No KAPI till_item id
order_time YYYY-MM-DD hh:mm:ss No The timestamp (UTC) at which this item was ordered
tax_rate Float No Tax ratio – 20% would be 1.2, zero rated would be 1
promoid Unsigned int No KAPI till_discount id
item_price Float No The price the basic item was sold for
configuration_price Float No The price of any additional item configuration
discount Float No The amount by which this item was discounted as a result of any discount that wasn’t a fixed voucher (those are handled as payments)
fixed_discount Float No The amount by which this item was discounted as a result of any fixed voucher applied at the payment stage
notes String No Any notes that were sent with the work order about this item
configuration Array No Array of order item configuration objects applied to this item (see below)
bwaste Boolean No True if the order’s ingredients were used but generated no revenue
brefund Boolean No True if the order’s ingredients weren’t used and revenue was returned to the customer. Another order should contain the ingredient usage and revenue.
bdirector Boolean No True if the ingredients were used but the potential revenue generated was waived at the discretion of senior staff
bcomp Boolean No True if the ingredients were used but the potential revenue was lost as a gesture of good will to the customer
bvoid Boolean No True if the ingredients were never used and no revenue was generated
consumptionmode String No eatin / takeaway / delivery

 

Till Order Item Configuration Objects

Order item configuration allows a generic item to be sold and then have further instructions applied. Examples would be where an order item is a steak and the configuration would be how it is cooked (e.g. Rare, medium, well done etc.) or where an order item is a shot of vodka and the configuration would be a selection of mixer splashes.

When an order item object is uploaded it may contain an array of configuration objects. These can be identical: for instance if an order item is “2 scoops of ice cream” it would make sense for the configuration array to contain two identical configuration objects which describe a scoop of vanilla ice cream. Assuming the till_configoption id for vanilla ice cream is 1, the configuration objects should look like this:

"configuration":[
    {
       "config_option_id":"1",
    },
    {
       "config_option_id":"1",
    }
 ]