Referência da API
Endpoints da API externa da Takeat. Selecione um endpoint para ver os parâmetros, respostas e testá-lo direto na página.
Endpoints
postAutenticar restauranteRealiza a autenticação do restaurante e retorna o token JWT usado nas
demais requisições.
- Utilize o token no header `Authorization: Bearer {token}` em todas as
chamadas autenticadas.
- O token possui validade de **15 dias**.
- Recomenda-se criar um usuário exclusivo por restaurante para acessar a
API externa (via Área do Gestor).
getListar sessões de comandaRetorna 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.
getListar métodos de pagamentoRetorna todos os métodos de pagamento ativos cadastrados no sistema.
Alguns métodos podem não ter `method` e/ou `brand` — principalmente os
criados pelo próprio restaurante. Isso é esperado.
getListar produtos por categoriaRetorna as categorias de produtos do restaurante e, dentro de cada
categoria, seus respectivos produtos.
**Observações**
- Produtos/categorias com `deleted_at` diferente de `null` já foram
deletados.
- `is_exclusive` indica categorias/produtos de uso exclusivo do
restaurante, que não aparecem para o cliente final.
- `price` é o preço presencial; `price_promotion` o preço promocional
presencial (se houver). `delivery_price` é o preço para
delivery/retirada; `delivery_price_promotion` o promocional para
delivery (se houver). Sem `delivery_price`, usa-se `price`/`price_promotion`.
- `available` indica disponibilidade presencial; `available_in_delivery`
a disponibilidade no delivery/retirada.
- `use_weight` indica se o produto é vendido por peso em vez de unidade.
getListar complementos por categoriaRetorna as categorias de complementos disponíveis no restaurante, com os
complementos associados a cada uma. Um complemento pode estar em mais de
uma categoria.
**Observações**
- `available` indica disponibilidade presencial; `available_in_delivery`
a disponibilidade no delivery/retirada.
- `question` é a pergunta exibida ao cliente ao apresentar a categoria.
- `minimum` é a quantidade mínima e `limit` (na categoria) a quantidade
máxima de complementos que podem ser adicionados naquela categoria.
- `optional` indica se a categoria é opcional; se `false`, é obrigatória.
- `additional` indica se os valores dos complementos são cobrados; se
`false`, os complementos não são cobrados mesmo tendo valor.
- `use_average` cobra a média dos complementos selecionados;
`more_expensive_only` cobra apenas o complemento mais caro.
- `is_exclusive` indica categorias/complementos de uso exclusivo do
restaurante.
- `limit` no complemento é a quantidade máxima daquele complemento.
- `price` é o preço presencial; `delivery_price` o de delivery/retirada.
Sem `delivery_price`, usa-se `price`.
getListar clientes do Clube de FidelidadeRetorna, 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.