API · 04

Enviar comandos sem duplicar operações

Comandos alteram o estado operacional no NGolaBooking. Envie uma chave de idempotência única por intenção: se houver uma falha de rede, repita exatamente o mesmo pedido e a mesma chave.

Endpoint

POST /api/integrations/v1/restaurants/{restaurantId}/commands
X-NGola-Integration-Key: ngb_int_…
X-NGola-Integration-Secret: ngb_sec_…
Idempotency-Key: pos-transaction-20260926-001
Content-Type: application/json

Check-in de reserva

{
  "type": "booking.check_in",
  "resourceId": "bkg_01"
}

Check-out de reserva

{
  "type": "booking.check_out",
  "resourceId": "bkg_01"
}

Atualizar estado de pedido

{
  "type": "order.status",
  "resourceId": "ord_01",
  "status": "READY"
}

O estado tem de ser um estado válido de pedido no NGolaBooking. A resposta de aceite é:

{
  "version": "v1",
  "requestId": "req_01JZ8M7PA8Q0",
  "data": { "accepted": true, "eventId": "evt_01" }
}
ComandoCampos obrigatóriosEfeito
booking.check_intype, resourceIdMarca a reserva como SEATED.
booking.check_outtype, resourceIdMarca a reserva como COMPLETED e permite libertar a mesa pela operação normal.
order.statustype, resourceId, statusAtualiza o estado do pedido.