Takeat
Versão da documentação
Takeat
Clube de fidelidade

O API Legado será removido em breve

A Nova API V1.0 já está disponível para novas integrações. Migre autenticação e rotas seguindo o guia de migração para evitar interrupções quando esta versão for descontinuada.

API Legado · Referência

Listar clientes do Clube de Fidelidade

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. - `cashback_updated_at` é a data da última modificação do saldo de cashback — o evento mais recente entre uma compra que gerou cashback e um resgate. Expirações automáticas e ajustes manuais de saldo não são registrados e, portanto, **não** são refletidos nesse campo. - `favorite_product` pode ser `null` quando o cliente ainda não tem compras suficientes.

Console de requisiçõesConfigure os dados, envie e inspecione a resposta.
GETProxy seguro
RequisiçãoEdite os campos antes de enviar
GET
/api/v1/clube/clients

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.
  • cashback_updated_at é a data da última modificação do saldo de cashback — o evento mais recente entre uma compra que gerou cashback e um resgate. Expirações automáticas e ajustes manuais de saldo não são registrados e, portanto, não são refletidos nesse campo.
  • favorite_product pode ser null quando o cliente ainda não tem compras suficientes.

Authorization

bearerAuth
AuthorizationBearer <token>

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

In: header

Query Parameters

page?integer

Página (1-based).

per_page?integer

Itens por página (1 a 200).

Response Body

application/json

application/json

application/json

application/json

Listar produtos por categoria GET

Retorna 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.

Listar insumos GET

Retorna, de forma paginada, os **insumos** (matérias-primas) cadastrados no controle de estoque do restaurante autenticado, com saldo atual, custo e parâmetros de reposição. Insumo é o item base do estoque: aquilo que é comprado do fornecedor e consumido na produção (ex.: `Queijo mussarela`, `Copo 300ml`). Produtos e complementos consomem insumos através da ficha técnica, e produtos intermediários são compostos por eles — veja [Listar produtos intermediários](/externo/referencia/estoque/getIntermediaries). **Observações** - Somente insumos **ativos** são retornados. Insumos cancelados (`canceled_at` preenchido) ficam de fora da listagem e da contagem. - Os resultados vêm ordenados por `name` em ordem alfabética crescente. - O `limit` é fixo em **100** registros por requisição e não pode ser alterado. Use `offset` para paginar. - Valores numéricos (`quantidade`, `total_value`, `unitary_price`, `ideal_stock`, `minimum_stock`) são retornados como **string**. - `unidade` é a unidade de medida usada no controle de estoque. É um texto livre definido pelo restaurante na Área do Gestor (ex.: `kg`, `un`, `l`, `g`). - `total_value` é o valor total do insumo em estoque e `unitary_price` o custo unitário na unidade informada em `unidade`. - `ideal_stock` e `minimum_stock` são os parâmetros de reposição definidos pelo restaurante: quantidade ideal a manter em estoque e quantidade mínima antes do alerta de reposição. - `is_master` indica um insumo criado automaticamente para controlar o estoque de um produto diretamente (o produto "vira" um insumo, com o mesmo nome e unidade `un`), em vez de ser composto por outros insumos. - `cash_flow_category_subcategory` traz a categoria financeira vinculada ao insumo, no formato `Categoria: Subcategoria`. Quando não há vínculo, vem como string vazia (`""`).