Takeat
Pedidos

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.

GET
/api/v1/table-sessions

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.

Authorization

bearerAuth
AuthorizationBearer <token>

Token JWT obtido em POST /public/api/sessions. Envie como Authorization: Bearer {token}.

In: header

Query Parameters

start_date*string

Data/hora inicial (UTC-0).

end_date*string

Data/hora final (UTC-0). No máximo 3 dias após start_date.

Response Body

application/json

application/json

curl -X GET "https://example.com/api/v1/table-sessions?start_date=2025-08-06T03%3A00%3A00&end_date=2025-08-07T03%3A00%3A00"
[  {    "id": 25962545,    "total_price": "59.00",    "total_service_price": "64.90",    "start_time": "2019-08-24T14:15:22Z",    "end_time": "2019-08-24T14:15:22Z",    "completed_at": "2019-08-24T14:15:22Z",    "status": "completed",    "old_total_price": "string",    "discount_percent": "string",    "discount_total": "string",    "discount_obs": "string",    "has_tax": true,    "is_delivery": false,    "with_withdrawal": true,    "delivery_tax_price": "string",    "total_delivery_price": "string",    "scheduled_to": "2019-08-24T14:15:22Z",    "attendance_password": "string",    "delivery_canceled_at": "2019-08-24T14:15:22Z",    "merchant_discount": "string",    "delivery_by": "string",    "people_at_table": "1.00",    "delivery_fee_discount": "0.00",    "table": {      "table_number": 1,      "table_type": "table"    },    "payments": [      {        "id": 28038525,        "payment_value": "50.00",        "created_at": "2019-08-24T14:15:22Z",        "payment_method": {          "id": 162,          "name": "Visa Crédito",          "keyword": "visa_credito",          "method": "CREDIT",          "brand": "VISA"        },        "original_value": "50.00",        "change": "0.00",        "predicted_received_date": "2019-08-24T14:15:22Z",        "predicted_received_value": "48.00"      }    ],    "nfce": {      "ref": "f5e6aa2a8843",      "status": "autorizado",      "type": "nfce",      "total_price": "64.90",      "numero": "25416",      "nfce_html": "string",      "nfce_xml": "string",      "created_at": "2019-08-24T14:15:22Z"    },    "bills": [      {        "id": 31605893,        "total_price": "59.00",        "total_service_price": "64.90",        "start_time": "2019-08-24T14:15:22Z",        "buyer": {          "phone": "(99) 99999-9999",          "name": "Matheus",          "created_by_waiter": "string",          "delivery_address": {            "country": "BR",            "state": "ES",            "city": "Cidade",            "neighborhood": "Bairro",            "street": "Rua",            "number": "746",            "complement": "",            "reference": "",            "zip_code": "11200-100",            "latitude": -25.3317912,            "longitude": -48.2922715          }        },        "waiter": {          "name": "string"        },        "order_baskets": [          {            "id": 49064977,            "order_status": "pending",            "basket_id": "613-3676",            "total_price": "59.00",            "total_service_price": "64.90",            "start_time": "2019-08-24T14:15:22Z",            "canceled_at": "2019-08-24T14:15:22Z",            "channel": "pdv",            "orders": [              {                "id": 74273471,                "amount": 1,                "price": "22.00",                "total_price": "26.00",                "total_service_price": "28.60",                "weight": "0.000",                "canceled_at": "2019-08-24T14:15:22Z",                "cancel_reason": "string",                "product": {                  "id": 1793622,                  "name": "X-Tudo"                },                "complement_categories": [                  {                    "id": 29544604,                    "complement_category": {                      "id": 562199,                      "name": "Adicionais"                    },                    "order_complements": [                      {                        "id": 40638125,                        "amount": 2,                        "complement": {                          "id": 1530822,                          "name": "Maionese Caseira"                        }                      }                    ]                  }                ]              }            ]          }        ]      }    ]  }]
{  "error": "token_invalid",  "message": "Token inválido ou expirado."}

Listar clientes do Clube de Fidelidade GET

Retorna, de forma paginada, os clientes do Clube de Fidelidade do restaurante autenticado, com dados relevantes para CRM: cadastro, saldo de cashback, pontos, visitas, produto favorito, histórico de resgates e histórico de mensagens enviadas. **Observações** - Disponível apenas para restaurantes com Clube de Fidelidade configurado. Caso contrário, retorna `400 clube_not_configured`. - Cada cliente pertence somente à loja autenticada — clientes de outras lojas nunca são retornados. - `messages` contém apenas mensagens **enviadas** ao cliente (não há registro de mensagens recebidas). - `cashback`, `total_spent` e `points` podem ser retornados como string numérica. - `cashback_expires_at` é a data em que o cashback do cliente expira; ela é renovada a cada nova compra e pode ser `null` se o cliente ainda não acumulou cashback. - `favorite_product` pode ser `null` quando o cliente ainda não tem compras suficientes.