Skip to main content
GET
Retorna el listado paginado de órdenes con status cancelado (5) de un negocio. Útil para identificar carritos abandonados: filtrando por cancelReason se aíslan las órdenes que el bot canceló por inactividad en el chat, en lugar de cancelaciones manuales o de otro origen.

Autenticación

Requiere el encabezado x-api-key con el App Key del negocio. Consulta Autenticación.

Parámetros de ruta

number
required
ID del negocio cuyas órdenes canceladas se desean obtener.

Parámetros de consulta

string
required
Fecha inicial del rango de creación de la orden, en formato ISO 8601 (2026-08-01 o 2026-08-01T00:00:00Z).
string
required
Fecha final del rango de creación de la orden, en formato ISO 8601.
string
Canal de la orden, por ejemplo wa para WhatsApp.
string
Filtra por coincidencia parcial en el motivo de cancelación (cancel_reason). Usa inactividad para obtener solo los carritos abandonados que el bot cancela automáticamente por falta de respuesta del cliente (cancel_reason: (BOT) Cancelada por inactividad en el chat). Si se omite, se incluyen las órdenes canceladas por cualquier motivo.
number
default:"1"
Página de resultados, empezando en 1.
number
default:"10"
Registros por página.

Comportamiento

  • Una orden se considera cancelada cuando status es 5, sin importar el motivo — ese es siempre el filtro base.
  • cancelReason es un filtro adicional opcional (LIKE %valor% sobre cancel_reason); no reemplaza el filtro de status.
  • Los resultados se ordenan por fecha de creación descendente (la orden más reciente primero).
  • data retorna el registro completo de la orden (todas las columnas de orders), con el chat y el contacto de WhatsApp incluidos. No incluye el detalle de productos ni un total calculado.

Respuesta

boolean
true cuando la solicitud se procesó correctamente.
object[]
Listado de órdenes canceladas.
object