In Venue Collections - Order and Pay

Orders API - Order Type = 8

Use Cases

  • In-venue ordering apps: Customer orders from their device in the venue

  • Order ahead: Order before arrival, ready on arrival

Business Rules:

  • Orders must be same-day only

  • Orders not visible in kitchen until payment complete

  • Cannot interact with existing POS transactions

  • Order numbers must be shared for order collection purposes

Integration Flow:

Full API details can be found here: API Reference

1. AddOrder → Create order
   - Set ordertype = 8
   - Set Order Number

2. UpdateOrder (multiple) → Build order
   - Add items progressively
   - Apply discounts and promotions
   - Calculate totals

3. UpdateOrder → Process payment
   - Customer pays via app
   - Include payment details
   - Set isOpen = false

4. Kitchen Visibility → After payment
   - Order appears in kitchen and on customer collection screen only when paid
   - Staff prepare order
   - Order shown as ready to collect on order collection screen

Key Characteristics

  • ✅ Same-day orders only

  • ✅ Progressive order building

  • ❌ NOT live POS transactions

  • ✅ Kitchen visibility on payment

  • ✅ Segregated on POS from other order types

Last updated

Was this helpful?