Flows
This page shows flows for various use-cases. Flows are split to Required, Recommended and Optional.
You must integrate required flows.
We recommend you to integrate recommended flows.
It is up to you to integrate optional flows.
Required
QR codes pairing
This flow describes the process which pairs QR codes to tables in the restaurant.
The actor loads QR codes pairing page in Qerko’s Restaurant Admin.
Refs methods: getTableList(…)
Payment
This flow describes a typical payment in the restaurant. The customer comes, scans a QR code, picks his items and proceeds to payment.
Refs methods: getTableContents(…), getBill(…), paymentStart(…), paymentProcessed(…), paymentClosed(…)
Recommended
Order byCustomer - always paid in advance
This flow describes an order to an empty table. The customer wants to order a meal that he will pick up in a while. Ie. 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’re unable to verify the customer’s intentions that he’s really going to pick the order up.
Reach out to techsupport@qerko.com to configure orders for you. Orders are not a part of the default configuration.
Refs methods: getTableContents(…), getMealMenus(…), orderPrepare(…), orderMarkAsPaid(…), orderClose(…), updateQerkoOrderStatus(…)
Order toBill - never paid in advance
This flow describes an order to an existing bill. The customer just wants another tea. Ie. your POS should just append ordered items to existing bill. The bill can be paid later by Qerko or any other payment method as the customer pleases, e.g. by cash.
This type of order is never paid in advance because it doesn’t make any sense to add paid items to a bill.
Reach out to techsupport@qerko.com to configure orders for you. Orders are not a 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 him on the table. Ie. your POS should create new bill on specified table. The created bill can be paid later by Qerko or any other payment method as the customer pleases, e.g. by cash.
This flow describes a variant that is not paid in advance, but this type of order can be paid in advance—Order toTable - paid in advance. This behavior is configured on Qerko’s side.
Difference between prepaid flow and not-paid (this) flow is in the method markAsPaid(...). It is called only in the prepaid flow.
Reach out to techsupport@qerko.com to configure orders for you. Orders are not a 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 him on the table. Ie. your POS should create new bill on specified table.
This flow describes a variant that is paid in advance, but this type of order can be not-paid in advance—Order toTable - not paid in advance. This behavior is configured on Qerko’s side.
Difference between prepaid (this) flow and not-paid flow is in the method markAsPaid(...). It is called only in the prepaid flow.
Reach out to techsupport@qerko.com to configure orders for you. Orders are not a part of the default configuration.
Refs methods: getTableContents(…), getMealMenus(…), orderPrepare(…), orderMarkAsPaid(…), orderClose(…), updateQerkoOrderStatus(…)
Optional
Cancel payment
This flow shows how POS can cancel any paid payment. This is relevant when the restaurant’s staff wants to refund money to the customer due to various reasons.
Make sure that the staff really wants the money to be refunded or if they are only cancelling the receipt due to an administrative reason. Sometimes it happens that the staff doesn’t expect the money to be really refunded.
Refs methods: cancelPayment(…)
Push menu to Qerko
This flow shows how POS can any time push a menu to Qerko. Use this flow when there is a change to the menu, eg. when an item runs out of stock.
Refs methods: updateMenus(…)
Need help? If you get stuck or have questions, email us at techsupport@qerko.com—we’re here for you!