Os eventos notificados são separados por módulos. No momento apenas eventos relacionados aos pedidos são enviados.
Eventos de pedidos
A seguir, estão listados os eventos relacionados aos pedidos, todos seguindo a seguinte estrutura:
{
"type": "object",
"properties": {
"event_id": {
"type": "string",
"description": "ID do evento de notificação"
},
"event_type": {
"type": "string",
"description": "Tipo do evento notificado"
},
"merchant_id": {
"type": "number",
"description": "ID do estabelecimento"
},
"order_id": {
"type": "number",
"description": "ID do pedido"
},
"order_status": {
"type": "string",
"description": "Status do pedido"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Data e hora que o evento ocorreu no formato ISO 8601"
}
}
}
Pedidos de mesas e comandas são notificados somente quando são cancelados ou finalizados, utilizando o tipo de notificação ORDER_CREATED. Não ocorrerão eventos de ORDER_STATUS_UPDATED nesses casos.
Novo pedido (ORDER_CREATED)
Este evento é enviado sempre que um novo pedido chega ao estabelecimento.
Exemplo
{
"event_id": "067c677bf1c096ad7db136dc",
"event_type": "ORDER_CREATED",
"merchant_id": 3268,
"order_id": 237456,
"order_status": "waiting_confirmation",
"created_at": "2023-06-22T19:04:20.292-03:00"
}
Status do pedido atualizado (ORDER_STATUS_UPDATED)
Este evento é enviado sempre que um pedido tiver seu status alterado.
Exemplo
{
"event_id": "016546b1f726a0e906f0f83e",
"event_type": "ORDER_STATUS_UPDATED",
"merchant_id": 2413,
"order_id": 135466,
"order_status": "canceled",
"created_at": "2023-06-22T18:32:51.810-03:00"
}
