Menú: API reference

Llamadas a tu TPV

Obtener una cuenta

Llamada que honei hace a tu TPV para obtener la cuenta de una mesa. La implementas tú.

GET{yourApiURL}/tab
Ver la guía

Esta llamada la hace honei a tu TPV: eres tú quien debe implementar este endpoint.

La primera petición de una cuenta usa tableId. Cuando la cuenta es conocida, honei la pide cada minuto por tabId hasta que se cierra.

Cabeceras

honei se identifica en cada petición a tu TPV con el mismo tipo de credenciales que usas para llamarnos, de modo que puedes comprobar que la petición viene realmente de honei.

Nombre Valor
Authorization Bearer <clientSecret>: tu secreto de integración
venue-api-key El identificador del restaurante

Parámetros de consulta

Parámetro Valor de ejemplo
tabId 123
tableId 1

Respuesta

JSON
{
    "tabId": "3722",
    "openDate": 1737622036000,
    "status": "open", // "open", "closed" o "cancelled"
    "closeDate": null, // solo si status no es "open"
    "numberOfGuests": 3,
    "total": 11.8,
    "totalPaid": 3,
    "totalDue": 9.8,
    "items": [
        {
            "tabItemId": "12977",
            "name": "Patatas bravas",
            "unitPrice": 5.4,
            "price": 5.4,
            "modifierOptions": []
        },
        {
            "tabItemId": "12978",
            "name": "Patatas bravas",
            "unitPrice": 5.4,
            "price": 6.4,
            "modifierOptions": [
                {
                    "name": "salsa extra",
                    "supl": 1
                }
            ]
        }
    ],
    "payments": [
        {
            "paymentId": "67921035f2bbefb64e449337",
            "amount": 1,
            "tip": 0,
            "paidDate": 1737625653495
        },
        {
            "paymentId": "67921035f2bbefb64e449337",
            "amount": 2,
            "tip": 1,
            "paidDate": 1737625653495
        }
    ]
}
JSON
{
    "status": 404,
    "message": "This table currently does not have an open tab"
}