O API Legado será removido em breve
API Legado · Referência
Listar insumos
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 (`""`).
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.
Observações
- Somente insumos ativos são retornados. Insumos cancelados
(
canceled_atpreenchido) ficam de fora da listagem e da contagem. - Os resultados vêm ordenados por
nameem ordem alfabética crescente. - O
limité fixo em 100 registros por requisição e não pode ser alterado. Useoffsetpara 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 eunitary_priceo custo unitário na unidade informada emunidade.ideal_stockeminimum_stocksã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_masterindica um insumo criado automaticamente para controlar o estoque de um produto diretamente (o produto "vira" um insumo, com o mesmo nome e unidadeun), em vez de ser composto por outros insumos.cash_flow_category_subcategorytraz a categoria financeira vinculada ao insumo, no formatoCategoria: Subcategoria. Quando não há vínculo, vem como string vazia ("").
Authorization
bearerAuth Token JWT obtido em POST /public/api/sessions. Envie como
Authorization: Bearer {token}.
In: header
Query Parameters
Quantidade de registros a pular (paginação). Valores negativos ou inválidos são tratados como 0.
Response Body
application/json
application/json
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. - `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.
Listar produtos intermediários GET
Retorna, de forma paginada, os **produtos intermediários** cadastrados no controle de estoque do restaurante autenticado, com saldo atual, custo e parâmetros de reposição. Produto intermediário é um item produzido internamente a partir de insumos (e, eventualmente, de outros intermediários) e que ainda não é vendido diretamente ao cliente — ex.: `Molho da casa`, `Massa de pizza`. Ele é consumido por produtos, complementos ou por outros intermediários. Os itens base estão em [Listar insumos](/externo/referencia/estoque/getInputs). **Observações** - Somente intermediários **ativos** são retornados. Intermediários 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`). - `unitary_price` é o custo unitário do intermediário, calculado a partir da sua ficha técnica, e `total_value` o valor total em estoque. - `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. - A composição da ficha técnica (quais insumos formam o intermediário) e o rendimento da receita **não** são retornados por este endpoint.