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

# Consulte eventos

> Obtenha os eventos pendentes.

Consulte este endpoint para receber eventos de pedidos. Depois de processá-los, use [Confirmar eventos](/api-reference/orders/confirm-events).

## Parâmetros de consulta

<ParamField query="eventType" type="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.
</ParamField>

<ParamField query="start_at" type="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.
</ParamField>

<ParamField query="end_at" type="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.
</ParamField>

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

<ResponseField name="eventId" type="string (uuid)">
  Identificador único do evento. Use este valor ao confirmar o evento pelo endpoint de confirmação.
</ResponseField>

<ResponseField name="eventType" type="string">
  Tipo do evento (por exemplo, `CREATED`, `CONFIRMED`, `CANCELLED`).
</ResponseField>

<ResponseField name="orderId" type="string (uuid)">
  Identificador único do pedido associado a este evento, gerado pela Onbeef.
</ResponseField>

<ResponseField name="orderURL" type="string (url)">
  URL apontando para o recurso completo com os detalhes do pedido.
</ResponseField>

<ResponseField name="createdAt" type="string (date-time)">
  Timestamp ISO 8601 de quando o evento foi criado.
</ResponseField>

<ResponseField name="sourceAppId" type="string (uuid)">
  Identificador da aplicação que originou este evento.
</ResponseField>

<ResponseField name="virtualBrand" type="string">
  Marca virtual associada ao pedido, se aplicável.
</ResponseField>

### 401: Não autorizado

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

## Exemplo de requisição

<CodeGroup>
  ```bash Sandbox theme={null}
  curl --request GET \
    --url "https://api.dev.connect.onbeefapp.com.br/v1/events:polling?eventType=CREATED&eventType=CONFIRMED" \
    --header "Authorization: Bearer <token>"
  ```

  ```bash Produção theme={null}
  curl --request GET \
    --url "https://api.connect.onbeefapp.com.br/v1/events:polling?eventType=CREATED&eventType=CONFIRMED" \
    --header "Authorization: Bearer <token>"
  ```
</CodeGroup>

## Exemplo de resposta

```json theme={null}
[
  {
    "eventId": "d6703cc8-9e79-415d-ac03-a4dc7f6ab43c",
    "eventType": "CREATED",
    "orderId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
    "orderURL": "https://api.connect.onbeefapp.com.br/v1/orders/f47ac10b-58cc-4372-a567-0e02b2c3d479",
    "createdAt": "2019-08-24T14:15:22Z",
    "sourceAppId": "fb08c6b7-a844-43c6-b104-98e70c00fc20",
    "virtualBrand": null
  }
]
```

<Warning>
  Sempre confirme os eventos após processá-los. Se você não chamar o endpoint [Confirmar eventos](/api-reference/orders/confirm-events) com o `eventId`, os mesmos eventos serão retornados a cada polling, o que pode causar processamento duplicado no seu PDV.
</Warning>

<Tip>
  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.
</Tip>