Pular para o conteúdo principal
GET
Listar eventos

Autorizações

Authorization
string
header
obrigatório

Access token opaco obtido em POST /oauth/token (host od.deliveryvip.com.br) com grant_type=client_credentials e escopo od.all.

Cabeçalhos

x-polling-merchants
string[]

Restringe a consulta a estas lojas. Aceita o merchantId informado no onboarding ou o identificador interno da loja, separados por vírgula. Todas precisam estar vinculadas ao token.

Parâmetros de consulta

eventType
enum<string>[]

Filtra pelos tipos de evento. Pode ser repetido (eventType=CREATED&eventType=CANCELLED) ou separado por vírgula.

Opções disponíveis:
CREATED,
CONFIRMED,
PREPARING,
DISPATCHED,
READY_FOR_PICKUP,
PICKUP_AREA_ASSIGNED,
PICKED_UP,
DELIVERED,
CONCLUDED,
CANCELLATION_REQUESTED,
CANCELLATION_REQUEST_DENIED,
CANCELLED,
ORDER_CANCELLATION_REQUEST,
CALL_WAITER,
CLOSE_ACCOUNT
orderType
enum<string>[]

Filtra pelo tipo do pedido. Pode ser repetido ou separado por vírgula.

Opções disponíveis:
DELIVERY,
TAKEOUT,
INDOOR

Resposta

Eventos pendentes de confirmação.

eventId
string<uuid>
obrigatório

Identificador do evento, usado na confirmação.

eventType
enum<string>
obrigatório
Opções disponíveis:
CREATED,
CONFIRMED,
PREPARING,
DISPATCHED,
READY_FOR_PICKUP,
PICKUP_AREA_ASSIGNED,
PICKED_UP,
DELIVERED,
CONCLUDED,
CANCELLATION_REQUESTED,
CANCELLATION_REQUEST_DENIED,
CANCELLED,
ORDER_CANCELLATION_REQUEST,
CALL_WAITER,
CLOSE_ACCOUNT
merchantId
string
obrigatório

merchantId informado no onboarding da loja ou, na ausência dele, o identificador interno da loja.

createdAt
string<date-time>
obrigatório

Momento de criação do evento (UTC).

Exemplo:

"2026-10-29T15:04:05Z"

metadata
object

Dados adicionais do evento. Omitido quando vazio.

orderId
string<uuid>

Identificador do pedido.

orderURL
string<uri>

URL para consultar o pedido.

Exemplo:

"https://od.deliveryvip.com.br/v1/orders/aa67c98c-d81f-5a9c-b0bc-26caa0051aea"

orderType
enum<string>

Tipo do pedido.

Opções disponíveis:
DELIVERY,
TAKEOUT,
INDOOR
placeName
string

Nome do local (mesa). Apenas em eventos de mesa.

placeId
string

Identificador do local (mesa). Apenas em eventos de mesa.

tab
string

Comanda. Apenas em eventos de mesa.

tabId
string

Identificador da comanda. Apenas em eventos de mesa.

tabCode
string

Código da comanda. Apenas em eventos de mesa.

tabName
string

Nome da comanda. Apenas em eventos de mesa.