In Venue Kiosk - Order and Pay

Orders API - Order Type = 4

Use Cases

  • Self-service ordering kiosks

  • In-venue customer terminals

  • Quick-service restaurant kiosks

  • Fast food ordering stations

Technical Requirements

Mandatory Fields:

  • ✅ Kiosk terminal number (for reporting)

  • ✅ deviceid (kiosk hardware identifier)

  • ✅ webOrderDisplayNo (customer order reference number)

  • ✅ saleprops.terminalid (kiosk terminal ID)

Integration Flow:

Full API details can be found here: API Reference

1. AddOrder → Create order with kiosk identification
   - Set ordertype = 4
   - Include deviceid, webOrderDisplayNo, saleprops (terminalId)
   - Set tracktype and trackoffset

2. UpdateOrder (multiple) → Customer builds order
   - Add items with modifiers and condiments
   - Display running total
   - Apply age verification if needed

3. UpdateOrder → Calculate final price
   - Set calcsubtotaladjustments = true
   - Set forceSubTotal = true
   - Apply loyalty/gift cards

4. UpdateOrder → Payment and closure
   - Process payment at kiosk terminal
   - Include payment details
   - Set isOpen = false
   - Print receipt and order number

Key Characteristics

  • ✅ Progressive order building

  • ✅ Customer self-service workflow

  • ✅ Kitchen ticket generation

  • ✅ Order number displayed for collection

  • ✅ Segregated on POS for staff workflow

Last updated

Was this helpful?