Escolha o seu sistema
PDV ou ERP
Mantém preço e disponibilidade do catálogo online e importa o pedido fechado para faturar.
Integrar PDV ou ERP →
Empresa de entregas
Recebe os eventos dos pedidos da loja, chama o entregador e informa a saída e a entrega.
Integrar entregas →
A API em 30 segundos
O que ela faz
- Catálogo, do seu sistema para a Onbeef. Cria e atualiza categorias, produtos, preço e disponibilidade. Abre e fecha a loja.
- Pedidos, da Onbeef para o seu sistema. Avisa de cada pedido novo e de cada mudança de status. Entrega o pedido completo: itens, pesos, totais, pagamento, cliente e endereço.
- Status e cancelamento, do seu sistema para a Onbeef. Aceita o pedido, marca como pronto, em rota e entregue, ou cancela.
O que ela não faz
- Criar pedido. A Onbeef é a origem do pedido: ele nasce no catálogo online ou no painel da loja.
- Alterar itens, peso ou valor de um pedido. A API recebe só status e cancelamento.
- Levar estoque, promoção, cortes, kits ou clientes. Tudo isso fica no painel da Onbeef.
- Avisar o seu sistema de mudanças de catálogo feitas no painel. O catálogo é mão única: do seu sistema para a Onbeef.
- Homologação. Terminou de testar, a integração já pode ser ativada em lojas.
Regras
- Uma chave por loja. A chave é o par ID e Chave que a loja gera no painel. Rede com 50 lojas tem 50 chaves.
202e204são recebimento, não resultado. O resultado chega depois, num evento do pedido ou no status da sincronização. Veja Deu 202 ou 204 e nada aconteceu.- O mesmo evento pode chegar mais de uma vez. Um evento é um aviso de que o pedido mudou: chegou, ficou pronto, foi cancelado. Identifique cada um pelo par
orderId+eventId. - Erro sempre no mesmo formato. Todo erro responde
{ "title": "...", "status": 400 }. Decida pelostatus. start_atem toda consulta de eventos. Sem ele, a consulta devolve primeiro os pedidos mais antigos da loja.- A loja precisa do plano Expert. Se a loja sai do plano, as chaves dela ficam inativas.
Primeiros passos
1
Peça uma loja de teste
Escreva para rafael@onbeefapp.com.br. A Onbeef cria a loja no ambiente de teste (sandbox) e envia o login do painel. Veja Ambiente de teste.
2
Faça a primeira chamada
Gere a chave no painel de teste, peça o token e consulte a loja. O Início rápido leva 10 minutos.
3
Siga o roteiro do seu sistema
PDV ou ERP ou empresa de entregas. Cada roteiro diz o que implementar e em que ordem.
4
Passe para produção
Troque a URL e a chave, cadastre o webhook de novo se você usa e confira o checklist de produção.
Outros sistemas
CRM, atendimento e agente de IA usam a mesma API e o mesmo tipo de chave. O que dá para ler:- Catálogo e preços.
GET /v1/merchanttraz categorias, produtos, preço e cortes. - Pedidos e clientes. Receba os eventos por webhook ou polling e busque o pedido em
GET /v1/orders/{id}. Os dados do cliente vêm dentro do pedido. - Pedidos anteriores à integração. Veja Consulte pedidos antigos.
Precisa de ajuda?
Dúvida técnica vai por e-mail para rafael@onbeefapp.com.br. Envie o endpoint, o payload, oid do pedido e o horário da chamada.
Início rápido
Chave, token e primeira chamada em 10 minutos.
Autenticação
Como a chave funciona e como tratar 401 e 403.
Ambiente de teste
Loja de teste, pedidos de teste e o que testar.
Perguntas frequentes
As dúvidas que os integradores mais mandam.
