ConsolaIr a la web

API de FlavosoReferencia de la APIMesas y zonas

Mesas y zonas

Las mesas y zonas del negocio, por ejemplo para asignar una reserva a una mesa. Solo lectura, con store:read o reservations:read. La clave del código QR de una mesa nunca aparece.

Endpoints

List tables

get/tables

Permiso:
store:readoreservations:read
Plan:
todos los planes

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.

Parámetros

NombreUbicaciónDescripción
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.

Respuesta200

OK

  • objectstringobligatorio

    Always list.

    Valores:"list"

  • dataTable[]obligatorio

    The items of this page.

    Campos anidados (7)
    • objectstringobligatorio

      Always table.

      Valores:"table"

    • idstring (uuid)obligatorio

      The table.

    • labelstringobligatorio

      Its name, e.g. 4 or Window.

    • seatsintegerobligatorio

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

    • area_idstring (uuid)obligatoriopuede ser null

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

    • bookable_onlinebooleanobligatorio

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

    • min_partyintegerobligatoriopuede ser null

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

  • has_morebooleanobligatorio

    Whether another page follows.

  • next_cursorstringobligatoriopuede ser null

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

Errores

  • 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.

Todos los códigos de error

Solicitud
curl "https://api.flavoso.com/v1/tables" \
  -H "Authorization: Bearer $ACCESS_TOKEN"
Respuesta
{
  "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

Permiso:
store:readoreservations:read
Plan:
todos los planes

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

Parámetros

NombreUbicaciónDescripción
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.

Respuesta200

OK

  • objectstringobligatorio

    Always list.

    Valores:"list"

  • dataArea[]obligatorio

    The items of this page.

    Campos anidados (4)
    • objectstringobligatorio

      Always area.

      Valores:"area"

    • idstring (uuid)obligatorio

      The area.

    • namestringobligatorio

      Its name, e.g. Terrace.

    • bookable_onlinebooleanobligatorio

      Its tables count for online bookings.

  • has_morebooleanobligatorio

    Whether another page follows.

  • next_cursorstringobligatoriopuede ser null

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

Errores

  • 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.

Todos los códigos de error

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

¿Algo no ha quedado claro? Escribe a support@flavoso.com e indica el identificador de X-Request-Id. Así podremos encontrar tu solicitud en el registro.