Flows
This page outlines the core integration flows, grouped into Required, Recommended, and Optional sections.
Implement the required flows.
We recommend integrating the recommended flows.
Integrating the optional flows is up to you.
Required
QR Code Pairing
This flow describes the process of pairing QR codes with tables in the restaurant.
The staff loads the QR codes pairing page in Qerko’s Restaurant Admin.
Refs methods: getTableList(…)
Payment
This flow describes a typical payment in a restaurant. The customer arrives, scans a QR code, selects their items, and proceeds to payment.
Refs methods: getTableContents(…), getBill(…), paymentStart(…), paymentProcessed(…), paymentClosed(…)
Recommended
Order byCustomer (always paid in advance)
This flow describes an order for an empty table. The customer wants to order a meal to pick up later. Your POS should notify the staff so the order is ready when the customer arrives.
This type of order is always paid in advance because we cannot verify the customer’s intention to pick up the order.
Contact techsupport@qerko.com to configure orders for you. Orders are not part of the default configuration.
The status Complete is sent only once for the whole order. We do not track completion of individual items.
Refs methods: getTableContents(…), getMealMenus(…), orderPrepare(…), orderMarkAsPaid(…), orderClose(…), updateQerkoOrderStatus(…)
Order toBill (never paid in advance)
This flow describes an order added to an existing bill. The customer just wants another tea. Your POS should simply append the ordered items to the existing bill. The bill can be paid later by Qerko or any other payment method, such as cash.
This type of order is never paid in advance, because it does not make sense to add prepaid items to a bill.
Contact techsupport@qerko.com to enable orders for your integration. Orders are not part of the default configuration.
Refs methods: getTableContents(…), getMealMenus(…), orderPrepare(…), orderClose(…), updateQerkoOrderStatus(…)
Order toTable (not paid in advance)
This flow describes an order to an empty table. The customer wants to create a new bill for themselves at the table. Your POS should create a new bill on the specified table. The bill can be paid later by Qerko or any other payment method, such as cash.
This flow describes a variant that is not paid in advance, but this type of order can also be prepaid. See Order toTable (paid in advance). This behavior is configured on Qerko’s side.
The difference between the prepaid flow and the not-paid (this) flow is the markAsPaid(...) method. It is called only in the prepaid flow.
Contact techsupport@qerko.com to configure orders for you. Orders are not part of the default configuration.
Refs methods: getTableContents(…), getMealMenus(…), orderPrepare(…), orderClose(…), updateQerkoOrderStatus(…)
Order toTable (paid in advance)
This flow describes an order to an empty table. The customer wants to create a new bill for themselves at the table. Your POS should create a new bill on the specified table.
This flow describes a variant that is paid in advance, but this type of order can also be postpaid. See Order toTable (not paid in advance). This behavior is configured on Qerko’s side.
The difference between the prepaid (this) flow and the not-paid flow is the markAsPaid(...) method. It is called only in the prepaid flow.
Contact techsupport@qerko.com to configure orders for you. Orders are not part of the default configuration.
Refs methods: getMealMenus(…), orderPrepare(…), orderMarkAsPaid(…), orderClose(…), updateQerkoOrderStatus(…)
Optional
Cancel payment
This flow shows how the POS can cancel any paid payment. This is relevant when the restaurant staff wants to refund money to the customer for various reasons.
Confirm with the staff that they intend to issue a refund rather than cancel the receipt for administrative reasons. In many cases a cancellation is requested only for bookkeeping and should not trigger a refund.
Refs methods: cancelPayment(…)
Push menu to Qerko
This flow shows how the POS can push a menu to Qerko at any time. Use this flow when there is a change to the menu, e.g., when an item runs out of stock.
Refs methods: updateMenus(…)
Need help? Contact techsupport@qerko.com for assistance.