Confirme eventos
curl --request POST \
--url https://api.dev.connect.onbeefapp.com.br/v1/events/acknowledgment \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"id": {},
"orderId": {},
"eventType": "<string>"
}
'Pedidos
Confirme eventos
Confirme os eventos que você processou.
POST
/
v1
/
events
/
acknowledgment
Confirme eventos
curl --request POST \
--url https://api.dev.connect.onbeefapp.com.br/v1/events/acknowledgment \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"id": {},
"orderId": {},
"eventType": "<string>"
}
'Confirme um evento somente depois de processá-lo e persistir tudo o que sua integração precisa. O acknowledgment remove o evento do polling permanentemente para a chave de integração que confirmou.
Se o açougue tiver outros integradores conectados, a sua confirmação não remove o evento do polling dos demais. Cada chave confirma os eventos no seu próprio ritmo.
Corpo da requisição
O corpo deve ser um array JSON de objetos. Cada objeto identifica um evento de pedido pelo parorderId e id, em que id corresponde ao eventId retornado pelo polling.
string (uuid)
required
Identificador do tipo de evento. Corresponde ao
eventId retornado pelo polling.Esse valor não identifica sozinho um evento de pedido. Todos os pedidos com o mesmo eventType compartilham o mesmo eventId. Use o par orderId e id para identificar o evento que será confirmado.string (uuid)
required
Identificador único do pedido associado ao evento. É o
orderId retornado pelo polling.string
required
Tipo do evento sendo confirmado. Deve coincidir com o
eventType retornado na resposta do polling.Valores reconhecidos: CREATED, CONFIRMED, READY_FOR_PICKUP, DISPATCHED, PICKUP_AREA_ASSIGNED, DELIVERED, CONCLUDED, CANCELLATION_REQUESTED, CANCELLATION_REQUEST_DENIED, CANCELLED, ORDER_CANCELLATION_REQUEST, CANCELLED_DENIEDResposta
202: Aceito
A confirmação foi aceita. Os eventos confirmados não aparecerão mais nas próximas respostas de polling desta chave de integração.Envie
orderId, id e eventType exatamente como recebidos no polling. Não altere nem combine valores de eventos diferentes. Combinações inconsistentes podem ser aceitas sem produzir o resultado esperado.400: Requisição inválida
Um dos campos é inválido (por exemplo,id ou orderId que não existem na plataforma). Corpo no formato { "title": "<campo com problema>", "status": 400 }.
401: Não autorizado
Retornado quando a requisição não inclui credenciais de autenticação válidas.404: Não encontrado
OorderId existe, mas o pedido não pertence ao seu merchant. Corpo: { "title": "Order not found", "status": 404 }.
503: Serviço indisponível
Falha interna temporária. Tente novamente com backoff exponencial.Exemplo de requisição
curl --request POST \
--url "https://api.dev.connect.onbeefapp.com.br/v1/events/acknowledgment" \
--header "Authorization: Bearer <token>" \
--header "Content-Type: application/json" \
--data '[
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"orderId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"eventType": "CREATED"
}
]'
curl --request POST \
--url "https://api.connect.onbeefapp.com.br/v1/events/acknowledgment" \
--header "Authorization: Bearer <token>" \
--header "Content-Type: application/json" \
--data '[
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"orderId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"eventType": "CREATED"
}
]'
Exemplo de corpo da requisição
[
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"orderId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"eventType": "CREATED"
},
{
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"orderId": "c4e2f1a3-b8d7-4c56-9e12-3f7a8b9c0d1e",
"eventType": "CONFIRMED"
}
]
Trate o acknowledgment como o commit final do processamento. Depois da confirmação, o evento não será retornado novamente pelo polling.A API não oferece um endpoint para listar todos os pedidos. Se você confirmar um evento e falhar antes de armazenar ou processar o pedido, poderá não conseguir reencontrá-lo.Para consultar pedidos antigos, mantenha uma chave de integração que não envia acknowledgment. Veja Histórico de pedidos.
Você pode agrupar vários eventos em uma chamada, mas confirme somente aqueles que já foram processados e persistidos com sucesso.
O processamento do array não é atômico: os itens são confirmados um a um, na ordem enviada. Se um item do meio falhar (por exemplo, com
404), os anteriores já terão sido confirmados. Reenviar o lote completo é seguro: confirmações repetidas não têm efeito adicional.