Show menu
Login

till_order

The till_order Endpoint

KOBAS Cloud supports the upload of sales information from venue EPoS servers. By informing KOBAS Cloud of each order placed and its contents, KOBAS Cloud can monitor sales information and stock levels, improving labour spend analysis and stock management.

 

Data Information

The following attributes may be saved with POST or PUT requests. Key fields are mandatory with all requests. Other attributes may be available with GET requests. The KAPI may expose or remove other attributes at any time; only changes to those listed below will be notified in advance.

Attribute Type Key Description
orderid Unsigned int Yes The order id – must be unique per venueid
venueid Unsigned int Yes The venue id
tabid Unsigned int No KAPI till_tab id – these are unique per venueid
ordertotal Decimal 8,2 No Total value of the order after any applied discounts
orderdiscount Decimal 8,2 No Total discount applied to this order
orderdate YYYY-MM-DD No Date upon which the order was taken
ordertime hh:mm:ss No Time at which the order was taken
orderitems Array No Array of till_orderitem objects
promoid Unsigned int No KAPI till_discount id
voucherid Unsigned int No KAPI loyalty_customervouchers id
loyaltyid Unsigned int No KAPI loyalty_customers id
userid Unsigned int No KAPI users id
till String No Short (16 chars) till name, description or id
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
payments Array No Array of KAPI till_payment objects – note this should be empty if this order was placed on a tab – the KAPI till_tab object should contain till_payment objects
consumptionmode String No eatin / takeaway / delivery

 

Example JSON PUT Transmission

{
   "userid":"1000",
   "tabid":"0",
   "ordertotal":"43.90",
   "orderdiscount":"0.00",
   "orderitems":[
      {
         "orderid":"3219",
         "userid":"1000",
         "itemid":"46",
         "item_price":"19.00",
         "configuration_price":"0.00",
         "tax_rate":"1.200",
         "notes":null,
         "discount":"0.00",
         "fixed_discount":"0.00",
         "promoid":"0",
         "voucherid":"0",
         "till":"192.168.1.70",
         "bwaste":"0",
         "brefund":"0",
         "bdirector":"0",
         "bcomp":"0",
         "bvoid":"0",
         "buploaded":"0",
         "consumptionmode":"eatin",
         "configuration":[

         ],
         "orderitemid":"9366",
         "venueid":"1",
         "tabid":"0"
      },
      {
         "orderid":"3219",
         "userid":"1000",
         "itemid":"173",
         "item_price":"10.95",
         "configuration_price":"2.00",
         "tax_rate":"1.200",
         "notes":null,
         "discount":"0.00",
         "fixed_discount":"0.00",
         "promoid":"0",
         "voucherid":"0",
         "till":"192.168.1.70",
         "bwaste":"0",
         "brefund":"0",
         "bdirector":"0",
         "bcomp":"0",
         "bvoid":"0",
         "buploaded":"0",
         "consumptionmode":"eatin",
         "configuration":[
            {
               "config_option_id":"12",
               "config_option":"Cooking options",
               "config_option_response":"Medium rare"
            },
            {
               "config_option_id":"20",
               "config_option":"Burger Extra Toppings",
               "config_option_response":"Bacon & Cheese"
            }
         ],
         "orderitemid":"9367",
         "venueid":"1",
         "tabid":"0"
      },
      {
         "orderid":"3219",
         "userid":"1000",
         "itemid":"161",
         "item_price":"11.95",
         "configuration_price":"0.00",
         "tax_rate":"1.200",
         "notes":null,
         "discount":"0.00",
         "fixed_discount":"0.00",
         "promoid":"0",
         "voucherid":"0",
         "till":"192.168.1.70",
         "bwaste":"0",
         "brefund":"0",
         "bdirector":"0",
         "bcomp":"0",
         "bvoid":"0",
         "buploaded":"0",
         "consumptionmode":"eatin",
         "configuration":[

         ],
         "orderitemid":"9368",
         "venueid":"1",
         "tabid":"0"
      }
   ],
   "promoid":"0",
   "voucherid":"0",
   "loyaltyid":"0",
   "till":"192.168.1.70",
   "bpaid":"1",
   "bwaste":"0",
   "brefund":"0",
   "bdirector":"0",
   "bcomp":"0",
   "bvoid":"0",
   "consumptionmode":"eatin",
   "promos":[

   ],
   "orderid":"3219",
   "venueid":"1",
   "payments":[
      {
         "userid":"1000",
         "tabid":"0",
         "orderid":"3219",
         "discountid":"0",
         "voucherid":"0",
         "paid_cash":"0.00",
         "paid_card":"43.90",
         "paid_voucher":"0.00",
         "tips_card":"0.00",
         "service_cash":"0.00",
         "service_card":"0.00",
         "change_due":"0.00",
         "net":"36.58",
         "tax":"7.32",
         "tax_exempt":"0",
         "type":"final",
         "till":"192.168.1.70"
      }
   ]
}