Skip to content

Venues

List active tables

The tables with an open bill right now, and what each bill comes to, whoever opened it.

GET/public/v1/venues/{venueId}/active-tables
Authentication

An API key in the X-Api-Key header

Permission
Can read active tables
Rate limit
About 120 requests a minute per key

Every table with an open bill, and what the bill comes to, whoever opened it: the staff at the till, a waiter, a guest ordering from the table's QR menu or your own software. Made for a venue's own screens and draws, such as a raffle among the tables sitting in the venue. More, with a raffle in code: Active tables.

Which tables. A table is listed while it has an open bill, and drops out when the venue closes the bill. A bill paid in full stays until then, because the party is still at the table. A table seated with nothing ordered has no bill and is not listed, and neither is a bill whose every item was cancelled. Tables pushed together for one party are one entry: table holds the party's bill and mergedTables names the others.

Amounts. In Turkish lira with VAT: the items, less the discounts, with the service fee. total counts what has already been paid as well as what is still owed, so a party that has paid half its bill has still spent all of it. A table's amounts are the sums of its bills.

minTotal. Leave it out for every active table. Given, only the tables whose total is at least that much are listed: minTotal=500 lists a table at 500.00 and leaves out one at 499.99.

Nothing about the guests. The answer never names anybody at a table, gives a phone number or says whether a guest has a Cibusy account. Announce a winner by the table, and find the bill at the till by its number.

Live. The bills are read on every call and the answer is sent with Cache-Control: no-store. asOf is the moment the amounts are true of.

The key needs the "Can read active tables" permission, which the venue gives it in its panel.

Parameters

venueIdstring · uuidPath parameterrequired

The venue's id, from the list of venues.

minTotalnumberQuery parameter

The smallest total, in lira, that a table must reach to be listed, for example 500. Zero or more; leave it out for every active table.

Accept-LanguagestringHeader

The language of userMessage in an error: tr (the default), en, de, fr, it, es, ar or ru. The first language in the header decides, without its region (en-US reads as en) and without weighing q values; a language Cibusy does not offer is answered in Turkish. It does not choose the language of a menu: that is lang on the menu call.

Responses

200

The tables with an open bill, and what each comes to.

400

minTotal is negative (PUBLIC_API_MIN_TOTAL_INVALID), or is not a number (VALIDATION_ERROR).

401

The X-Api-Key header is missing (PUBLIC_API_KEY_MISSING), or the key is invalid or has been revoked (PUBLIC_API_KEY_INVALID).

403

PUBLIC_API_SCOPE_MISSING: the key has not been given the "Can read active tables" permission.

404

The venue does not exist, or this key cannot reach it (PUBLIC_API_VENUE_NOT_FOUND).

429

The key's budget of about 120 requests a minute is spent; wait Retry-After seconds.

Retry-After

Seconds to wait. The next one-minute window opens within it.

The data of a successful answer

The venue's tables with an open bill right now, and what each bill comes to. Money is in Turkish lira, VAT included, rounded to two decimals.

venueIdstring · uuid

The venue the tables are at.

asOfstring · date-time

When the answer was worked out, in UTC. The bills are read on every call and nothing is kept, so this is the moment the amounts are true of.

currencystring

The currency of every amount, an ISO 4217 code. Always TRY.

minTotalnumbernullable

The minTotal the call asked for: a table is listed only when its total is at least this much. null when the call asked for every active table.

tablesobject[]

The active tables, in the order the venue's till shows them: area by area, and within an area the tables the venue has arranged first, then the rest by name with the numbers read as numbers (T2 before T10). Empty when no table has an open bill, or none reaches minTotal.

Fields of Active table
tableobject

The table the bill is on, as the list of the venue's tables shows it. A table the venue has since deleted is called Unknown table.

Fields of Table
idstring · uuid

The table's id, the one a dine-in order names.

namestring

The table's name as it is written on the till.

codestringnullable

The code printed on the table's QR card. null for a table that has none.

capacityintegernullable

How many people the table seats. null when the venue has not said.

areaobjectnullable

The floor, terrace or room the table is in. null only for a table the venue has since deleted.

Fields of Table's area
idstring · uuid

The area's id, the one the list of the venue's tables carries.

namestring

The area's name.

mergedTablesobject[]

The tables pushed together with this one for the same party, whose orders go on this table's bill. Empty for a table on its own.

Fields of Table
idstring · uuid

The table's id, the one a dine-in order names.

namestring

The table's name as it is written on the till.

codestringnullable

The code printed on the table's QR card. null for a table that has none.

capacityintegernullable

How many people the table seats. null when the venue has not said.

openedAtstring · date-time

When the oldest of the table's open bills was opened, in UTC.

totalnumber

What the table's open bills come to together: the items, less the discounts, with the service fee. Cancelled items are not in it, and what has already been paid still is. minTotal is compared with this. Always the sum of the bills' total.

paidnumber

What has been paid towards the table's open bills so far. The sum of the bills' paid.

remainingnumber

What is still owed on the table's open bills. The sum of the bills' remaining.

paymentStatusstring

How much of the table's bills has been paid. A table that has paid stays listed until the venue closes its bill.

Unpaid
Nothing has been paid on any of the table's bills.
PartiallyPaid
Part of it is paid: something has been paid on at least one bill, but not every bill is paid in full.
Paid
Every bill is paid in full. The table stays listed until the venue closes its bill.
billsobject[]

The table's open bills, oldest first. Usually one; a table can carry more when the venue keeps separate bills for the same table.

Fields of Open bill
idstring · uuid

The bill's id, which is the order's id: a bill placed through the API is the one GET /orders/{orderId} answers for, while a bill opened at the till or from the QR menu cannot be read there.

numberinteger

The number the venue calls the bill by, counted from 1 within the venue: the one printed on the kitchen ticket and on the bill, so staff can find it at the till.

openedAtstring · date-time

When the bill was opened, in UTC.

totalnumber

What the bill comes to: the items, less the discounts, with the service fee. Cancelled items are not in it, and what has already been paid still is.

paidnumber

What has been paid towards the bill so far.

remainingnumber

What is still owed on the bill.

paymentStatusstring

How much of the bill has been paid.

Unpaid
Nothing has been paid on the bill.
PartiallyPaid
Part of the bill has been paid.
Paid
The bill is paid in full, and stays open until the venue closes it.