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

# Webhooks para Pedidos

Para pedidos, estos son los eventos disponibles.

## Eventos

| Tipo                                          | Descripción                                        |
| --------------------------------------------- | -------------------------------------------------- |
| [order-created](#order-created)               | Notifica la creación de pedido                     |
| [order-status-updated](#order-status-updated) | Notifica la actualización del estado del pedido    |
| [order-updated](#order-updated)               | Notifica la actualización del detalle de un pedido |
| [order-deleted](#order-deleted)               | Notifica la eliminación de un pedido               |

Cualquier evento enviado tendrá siempre la misma estructura:

```json5 theme={null}
{
  "event": "event", // Nombre del tipo de evento
  "data": {
    // Data específica del evento
  }
}
```

### **order-created**

Se notifica cuando una orden es creada.

La estructura sigue el mismo modelo de datos de la API REST para pedidos.

```json5 theme={null}
{
  "event": "order-created",
  "data": {
    // Consultar la REST API
  },
}
```

### **order-status-updated**

Cualquier cambio de estado que sufra la orden, ya sea por una integración, por cambios realizados desde el panel de administración o desde la API REST, será notificado.

| Item         | Descripción                  |
| ------------ | ---------------------------- |
| `id`         | ID de la orden               |
| `code`       | Código de la orden           |
| `erpCode`    | Código de la orden en el ERP |
| `status`     | Nuevo estado de la orden     |
| `statusType` | Identificador del `status`   |

```json5 theme={null}
{
  "event": "order-status-updated",
  "data": {
    "id": 1,
    "code": "P00001",
    "erpCode": "C0000234",
    "status": "Pagado",
    "statusType": "paid"
  }
}
```

### **order-updated**

Se emite al cambiar el detalle de una orden, excluyendo los cambios de estado.

Al igual que [order-created](#order-created), la estructura sigue el mismo modelo de la API REST. Sin embargo, las siguientes keys no estarán disponibles porque son datos que no pueden cambiar:

`status`, `vendor`, `userAgent`, `inventory`, `customer`, `creator`, `channel`, `comments`

```json5 theme={null}
{
  "event": "order-updated",
  "data": {
    // Consultar la REST API
  },
}
```

### **order-deleted**

Se emite cuando una orden es eliminada.

| Item        | Descripción                                    |
| ----------- | ---------------------------------------------- |
| `id`        | ID de la orden                                 |
| `code`      | Código de la orden                             |
| `erpCode`   | Código de la orden en el ERP                   |
| `deletedAt` | Fecha de eliminación en UTC y formato ISO 8601 |

```json5 theme={null}
{
  "event": "order-deleted",
  "data": {
    "id": 1,
    "code": "P00001",
    "erpCode": "C0000234",
    "deletedAt": "2021-01-01T00:00:00Z",
  }
}
```