ConsoleGo to website

Flavoso APIAPI referenceTables and areas

Tables and areas

The restaurant's tables and areas, for example to assign a reservation to a table. Read only, with store:read or reservations:read. The key in a table's QR code is never included.

Endpoints

List tables

get/tables

Scope:
store:readorreservations:read
Plan:
every plan

The restaurant's tables with seats, area and booking rules, in the order they were created. Table orders (Order.table.id) and reservations (Reservation.table_ids) point to these ids. Needs store:read or reservations:read.

Parameters

NameInDescription
limitintegerqueryPage size, 1 to 100. Default 25.1 to 100 · default 25
cursorstringquerynext_cursor of the previous page. Opaque; send the same filters again with it.

Response200

OK

  • objectstringrequired

    Always list.

    Values:"list"

  • dataTable[]required

    The items of this page.

    Child fields (7)
    • objectstringrequired

      Always table.

      Values:"table"

    • idstring (uuid)required

      The table.

    • labelstringrequired

      Its name, e.g. 4 or Window.

    • seatsintegerrequired

      Seats; the restaurant's default table size when none is set.

    • area_idstring (uuid)requirednullable

      The area (GET /areas); null when not placed in one.

    • bookable_onlinebooleanrequired

      Guests may get it when booking online (staff and your app may always).

    • min_partyintegerrequirednullable

      Only given to parties of at least this size; null for any.

  • has_morebooleanrequired

    Whether another page follows.

  • next_cursorstringrequirednullable

    Pass as cursor (with the same filters) to get the next page; null on the last page.

Errors

  • 400invalid_request: a parameter or the body is wrong, or it contains a query parameter or field the operation does not know. param names the field.
  • 401unauthorized: missing, malformed, expired or revoked access token, or the app was disconnected or suspended.
  • 403insufficient_scope, plan_required (with param when an order type is not in the plan) or account_inactive.
  • 429rate_limited: more than 120 requests per minute on this connection. Wait Retry-After seconds.
  • 500server_error. Safe to retry with the same Idempotency-Key.

All error codes

Request
curl "https://api.flavoso.com/v1/tables" \
  -H "Authorization: Bearer $ACCESS_TOKEN"
Response
{
  "object": "list",
  "data": [
    {
      "object": "table",
      "id": "3c7a9e1f-5b2d-4f8a-9c6e-7d1b3a5f9e24",
      "label": "4",
      "seats": 4,
      "area_id": "9e2d4b6f-1a3c-4e5d-8b7f-2c4e6a8d0f13",
      "bookable_online": true,
      "min_party": null
    }
  ],
  "has_more": false,
  "next_cursor": null
}

List areas

get/areas

Scope:
store:readorreservations:read
Plan:
every plan

The areas of the floor plan (dining room, terrace), in the order they were created. Needs store:read or reservations:read.

Parameters

NameInDescription
limitintegerqueryPage size, 1 to 100. Default 25.1 to 100 · default 25
cursorstringquerynext_cursor of the previous page. Opaque; send the same filters again with it.

Response200

OK

  • objectstringrequired

    Always list.

    Values:"list"

  • dataArea[]required

    The items of this page.

    Child fields (4)
    • objectstringrequired

      Always area.

      Values:"area"

    • idstring (uuid)required

      The area.

    • namestringrequired

      Its name, e.g. Terrace.

    • bookable_onlinebooleanrequired

      Its tables count for online bookings.

  • has_morebooleanrequired

    Whether another page follows.

  • next_cursorstringrequirednullable

    Pass as cursor (with the same filters) to get the next page; null on the last page.

Errors

  • 400invalid_request: a parameter or the body is wrong, or it contains a query parameter or field the operation does not know. param names the field.
  • 401unauthorized: missing, malformed, expired or revoked access token, or the app was disconnected or suspended.
  • 403insufficient_scope, plan_required (with param when an order type is not in the plan) or account_inactive.
  • 429rate_limited: more than 120 requests per minute on this connection. Wait Retry-After seconds.
  • 500server_error. Safe to retry with the same Idempotency-Key.

All error codes

Request
curl "https://api.flavoso.com/v1/areas" \
  -H "Authorization: Bearer $ACCESS_TOKEN"
Response
{
  "object": "list",
  "data": [
    {
      "object": "area",
      "id": "9e2d4b6f-1a3c-4e5d-8b7f-2c4e6a8d0f13",
      "name": "Terrace",
      "bookable_online": true
    }
  ],
  "has_more": false,
  "next_cursor": null
}

Still unclear? Write to support@flavoso.com and include the id from X-Request-Id. It lets us find your request in the log.