O API Legado será removido em breve
API Legado · Referência
Listar produtos intermediários
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.
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.
Observações
- Somente intermediários ativos são retornados. Intermediários
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).unitary_priceé o custo unitário do intermediário, calculado a partir da sua ficha técnica, etotal_valueo valor total em estoque.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.- 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.
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 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 (`""`).
Listar sessões de comanda GET
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.