Skip to main content
Sua integração consulta eventos, obtém o pedido e atualiza seu estado até a entrega.

​
Estados principais

​
Eventos

A Onbeef entrega eventos por webhook ou polling. Processe cada evento nesta ordem:
1

Receba

Receba a notificação pelo webhook ou consulte o estado atual em GET /v1/events:polling.
2

Consulte e armazene

Use orderId para consultar o pedido. Valide e persista os dados necessários no seu sistema.
3

Execute a ação

Execute a ação exigida pelo evento. Para CREATED, aceite o pedido com POST /v1/orders/{orderId}/confirm.
4

Confirme por último

Depois de concluir e persistir o processamento, envie o evento para POST /v1/events/acknowledgment.
O acknowledgment é irreversível e remove o evento do polling. Trate essa chamada como o commit final. Nunca confirme antes de armazenar o pedido e concluir a ação necessária.
O polling representa o estado atual dos pedidos, não um histórico de transições. Cada pedido aparece no máximo uma vez, com seu evento mais recente. Um evento não confirmado pode reaparecer enquanto continuar sendo o evento atual do pedido. Se o pedido mudar de status, o novo evento substituirá o anterior. Processe os eventos de forma idempotente. Confirme cada evento logo depois de concluir e persistir o processamento, mas nunca antes.

​
Dados do pedido

GET /v1/orders/{orderId} retorna itens, cliente, pagamento, entrega, valores e estado atual. Use o orderId em todas as mudanças de estado. Use orderExternalCode para associar o pedido ao seu sistema quando esse campo for solicitado.

​
Cancelamentos

Sua integração pode cancelar um pedido ou responder a uma solicitação do cliente:

Processar pedidos

Siga o fluxo completo, do polling à entrega.