> ## Documentation Index
> Fetch the complete documentation index at: https://docs.onbeef.app/llms.txt
> Use this file to discover all available pages before exploring further.

# Comece aqui

> Escolha o tipo de sistema, veja o que a API faz e não faz e chegue à primeira chamada.

A Onbeef Connect API liga o sistema da loja à Onbeef: catálogo, pedidos e entregas. É uma API REST no padrão [Open Delivery](https://abrasel-nacional.github.io/docs), nas partes de catálogo e de pedidos, aberta a qualquer integrador e sem custo pela integração.

Você é lojista e não vai programar? Vá para [Para lojistas](https://docs.onbeef.app/lojistas/overview.md).

## 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 →

[Open](https://docs.onbeef.app/desenvolvedores/pdv.md)

Empresa de entregas

Recebe os eventos dos pedidos da loja, chama o entregador e informa a saída e a entrega.

Integrar entregas →

[Open](https://docs.onbeef.app/desenvolvedores/logistica.md)

O seu sistema é um CRM, um atendimento ou um agente de IA? Veja [Outros sistemas](#outros-sistemas).

Integre meu sistema com a Onbeef Connect API seguindo [https://docs.onbeef.app/desenvolvedores.md](https://docs.onbeef.app/desenvolvedores.md) e [https://docs.onbeef.app/agent-ready.md](https://docs.onbeef.app/agent-ready.md)

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

A lista completa está nas [Perguntas frequentes](https://docs.onbeef.app/desenvolvedores/faq.md).

### 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.
* **`202` e `204` sã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](https://docs.onbeef.app/api-reference/errors.md#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 pelo `status`.
* **`start_at` em 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](mailto:rafael@onbeefapp.com.br). A Onbeef cria a loja no ambiente de teste (sandbox) e envia o login do painel. Veja [Ambiente de teste](https://docs.onbeef.app/environments/sandbox.md).

**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](https://docs.onbeef.app/quickstart.md) leva 10 minutos.

**3. Siga o roteiro do seu sistema**

[PDV ou ERP](https://docs.onbeef.app/desenvolvedores/pdv.md) ou [empresa de entregas](https://docs.onbeef.app/desenvolvedores/logistica.md). 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](https://docs.onbeef.app/environments/production.md#checklist).

## 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/merchant` traz categorias, produtos, preço e cortes.
* **Pedidos e clientes.** Receba os eventos por [webhook](https://docs.onbeef.app/guides/orders-webhook.md) 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](https://docs.onbeef.app/concepts/orders-history.md).

Peça à loja uma chave só para o seu sistema. Webhook e confirmação de eventos são por chave: você confirma os seus eventos sem tirar nada da integração do PDV.

Não dá para criar pedido pela API. Pedido que nasce no WhatsApp ou no telefone é lançado pela loja no painel, em **Painel de Vendas** > **Novo pedido**, e chega à API como qualquer outro.

## Precisa de ajuda?

Dúvida técnica vai por e-mail para [rafael@onbeefapp.com.br](mailto:rafael@onbeefapp.com.br). Envie o endpoint, o payload, o `id` do pedido e o horário da chamada.

Copia uma pergunta pronta para colar no Claude, no ChatGPT ou no seu assistente

> [card] [Início rápido](https://docs.onbeef.app/quickstart.md)
>
> Chave, token e primeira chamada em 10 minutos.

> [card] [Autenticação](https://docs.onbeef.app/authentication/overview.md)
>
> Como a chave funciona e como tratar 401 e 403.

> [card] [Ambiente de teste](https://docs.onbeef.app/environments/sandbox.md)
>
> Loja de teste, pedidos de teste e o que testar.

> [card] [Perguntas frequentes](https://docs.onbeef.app/desenvolvedores/faq.md)
>
> As dúvidas que os integradores mais mandam.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.