O API Legado será removido em breve
API Legado · Referência
Listar sessões de comanda
Retorna as comandas das mesas do restaurante autenticado dentro do intervalo de datas informado. Inclui informações da comanda, mesa, pagamentos e método de pagamento, nota fiscal emitida (se houver), as contas individuais, cestas de cada conta e cada pedido com seu respectivo produto e complementos. **Observações importantes** - O intervalo entre as datas é de **no máximo 3 dias**. - As datas de consulta e de retorno estão em **UTC-0**. Para o horário de Brasília, adicione 3 horas. - Em `orders`, se `canceled_at` for diferente de `null`, o pedido foi cancelado e `cancel_reason` traz o motivo informado. - `total_price` é a soma dos produtos; `total_service_price` é o `total_price` + taxa de serviço. - Na `table_session`, `total_price`/`total_service_price` já consideram o desconto (se houver); `old_total_price` é o valor sem desconto. Em `bills`, `order_baskets` e `orders` os valores **não** têm o desconto aplicado. - Pagamentos consideram o troco no valor pago em dinheiro: `payment_value` é o valor que entrou no faturamento (já descontado o troco), `original_value` é o valor original pago pelo cliente e `change` é o troco. - `predicted_received_value` é o valor a receber já descontadas as taxas do método; `predicted_received_date` é a data prevista de recebimento, calculada a partir das configurações do método na Área do Gestor. - `channel` (em `order_baskets`) indica por onde o pedido foi feito.
Retorna as comandas das mesas do restaurante autenticado dentro do intervalo de datas informado.
Inclui informações da comanda, mesa, pagamentos e método de pagamento, nota fiscal emitida (se houver), as contas individuais, cestas de cada conta e cada pedido com seu respectivo produto e complementos.
Observações importantes
- O intervalo entre as datas é de no máximo 3 dias.
- As datas de consulta e de retorno estão em UTC-0. Para o horário de Brasília, adicione 3 horas.
- Em
orders, secanceled_atfor diferente denull, o pedido foi cancelado ecancel_reasontraz o motivo informado. total_priceé a soma dos produtos;total_service_priceé ototal_price+ taxa de serviço.- Na
table_session,total_price/total_service_pricejá consideram o desconto (se houver);old_total_priceé o valor sem desconto. Embills,order_basketseordersos valores não têm o desconto aplicado. - Pagamentos consideram o troco no valor pago em dinheiro:
payment_valueé o valor que entrou no faturamento (já descontado o troco),original_valueé o valor original pago pelo cliente echangeé o troco. predicted_received_valueé o valor a receber já descontadas as taxas do método;predicted_received_dateé a data prevista de recebimento, calculada a partir das configurações do método na Área do Gestor.channel(emorder_baskets) indica por onde o pedido foi feito.
Authorization
bearerAuth Token JWT obtido em POST /public/api/sessions. Envie como
Authorization: Bearer {token}.
In: header
Query Parameters
Data/hora inicial (UTC-0).
Data/hora final (UTC-0). No máximo 3 dias após start_date.
Response Body
application/json
application/json