> ## Documentation Index
> Fetch the complete documentation index at: https://docs.cardapioweb.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Eventos de webhook do módulo de Pedidos

> Lista e estrutura dos eventos de webhook enviados pelo módulo de Pedidos da Cardápio Web, com payloads JSON de criação e atualização de status.

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:

```json theme={null}
{
  "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"
    }
  }
}
```

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

### Novo pedido (`ORDER_CREATED`)

Este evento é enviado sempre que um novo pedido chega ao estabelecimento.

**Exemplo**

```json theme={null}
{
  "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**

```json theme={null}
{
  "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"
}
```