Skip to main content
GET
Consulte eventos
Consulte este endpoint para receber eventos de pedidos. Depois de processá-los, use Confirmar eventos.

​
Parâmetros de consulta

​
eventType
array of strings
Filtra eventos por tipo. Repita o parâmetro para informar vários tipos (?eventType=CREATED&eventType=CONFIRMED). Eventos de tipos não incluídos no filtro simplesmente não são retornados nesta resposta; eles não são confirmados automaticamente e continuam pendentes até que você os confirme. Omita este parâmetro para receber todos os tipos de eventos pendentes.Valores aceitos:
  • CREATED: O pedido foi criado.
  • CONFIRMED: O pedido foi confirmado pelo merchant.
  • READY_FOR_PICKUP: O pedido está pronto para retirada pelo entregador ou cliente.
  • DISPATCHED: O pedido saiu da loja para entrega.
  • PICKUP_AREA_ASSIGNED: Uma área de retirada foi designada para o pedido.
  • DELIVERED: O pedido foi entregue ao cliente.
  • CONCLUDED: O ciclo de vida do pedido está concluído.
  • CANCELLATION_REQUESTED: Uma solicitação de cancelamento foi enviada do Software Service ao Ordering Application.
  • CANCELLATION_REQUEST_DENIED: O Ordering Application negou a solicitação de cancelamento.
  • CANCELLED: O pedido foi efetivamente cancelado.
  • ORDER_CANCELLATION_REQUEST: Solicitação de cancelamento do Ordering Application para o Software Service.
  • CANCELLED_DENIED: O Software Service negou a solicitação de cancelamento do Ordering Application.
​
start_at
string (date)
Filtro de data/hora inicial dos eventos. Formatos aceitos: Y-m-d ou Y-m-d H:i. Somente eventos criados nessa data/hora ou depois são retornados.
​
end_at
string (date)
Filtro de data/hora final dos eventos. Formatos aceitos: Y-m-d ou Y-m-d H:i. Somente eventos criados nessa data/hora ou antes são retornados.

​
Resposta

​
200: Sucesso

Retorna um array de objetos de evento pendentes. Cada objeto inclui o identificador do evento, o tipo, o ID do pedido associado e um link para os detalhes do pedido.
​
eventId
string (uuid)
Identificador único do evento. Use este valor ao confirmar o evento pelo endpoint de confirmação.
​
eventType
string
Tipo do evento (por exemplo, CREATED, CONFIRMED, CANCELLED).
​
orderId
string (uuid)
Identificador único do pedido associado a este evento, gerado pela Onbeef.
​
orderURL
string (url)
URL apontando para o recurso completo com os detalhes do pedido.
​
createdAt
string (date-time)
Timestamp ISO 8601 de quando o evento foi criado.
​
sourceAppId
string (uuid)
Identificador da aplicação que originou este evento.
​
virtualBrand
string
Marca virtual associada ao pedido, se aplicável.

​
401: Não autorizado

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

​
Exemplo de requisição

​
Exemplo de resposta

Sempre confirme os eventos após processá-los. Se você não chamar o endpoint Confirmar eventos com o eventId, os mesmos eventos serão retornados a cada polling, o que pode causar processamento duplicado no seu PDV.
Recomendamos fazer polling neste endpoint a cada 30 segundos durante o horário de operação. Use o filtro eventType para limitar a resposta apenas aos tipos que sua integração precisa tratar.