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>"
}
'

POST

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 os eventos depois do processamento. Eventos não confirmados podem aparecer novamente no polling.

Corpo da requisição

O corpo deve ser um array JSON de objetos de evento. Cada objeto precisa referenciar um evento que exista na plataforma (os valores são validados contra os eventos retornados pelo polling).

string (uuid)

required

Identificador único do evento a ser confirmado. Corresponde ao campo eventId retornado pelo endpoint de polling.

orderId

string (uuid)

required

Identificador único do pedido associado ao evento. É o orderId retornado pelo polling.

eventType

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_DENIED

Resposta

202: Aceito

A confirmação foi aceita. Os eventos confirmados não aparecerão mais nas próximas respostas de polling.

401: Não autorizado

Retornado quando a requisição não inclui credenciais de autenticação válidas.

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"
  }
]

Confirme cada evento retornado no polling depois de processá-lo. Se você deixar de confirmar um evento, ele reaparecerá em todos os pollings futuros, podendo causar processamento duplicado: por isso seu processamento precisa ser idempotente.

Agrupe as confirmações de uma mesma resposta de polling em uma única chamada (um array com todos os eventos) para reduzir round-trips à API.

Consultar eventos Consultar pedido

⌘I

Visão geral

Autenticação

Merchant

Pedidos

Logística

Confirme eventos

Corpo da requisição

Resposta

202: Aceito

401: Não autorizado

503: Serviço indisponível

Exemplo de requisição

Exemplo de corpo da requisição

​Corpo da requisição

​Resposta

​202: Aceito

​401: Não autorizado

​503: Serviço indisponível

​Exemplo de requisição

​Exemplo de corpo da requisição

Corpo da requisição

Resposta

202: Aceito

401: Não autorizado

503: Serviço indisponível

Exemplo de requisição

Exemplo de corpo da requisição