Estado de un reporte
GET /api/download-tray/{download_tray_id}
Autenticación: Bearer del usuario del tenant (Authorization: Bearer <api_token>).
Devuelve el estado de un reporte. Úsalo para esperar a que termine (polling): cuando ready es true, descárgalo con download_url.
Quién puede usarlo: cualquier usuario autenticado. Cada usuario ve solo sus reportes; un administrador ve los de todos (y puede filtrar por user_id). Pedir el reporte de otro usuario sin ser administrador responde 403.
Formato de respuesta: estándar {success, data, message?} (registro único).
Parámetros de la ruta:
| Campo | Tipo | Obligatorio | Descripción / valores permitidos |
|---|---|---|---|
download_tray_id |
integer | Sí | Id que devolvió la solicitud (202). |
Campos de cada reporte:
| Campo | Tipo | Descripción |
|---|---|---|
id |
integer | Id del reporte en la bandeja. |
status |
string | IN_PROCESS (generándose), FINISHED (listo), ERROR o FAILED (no se pudo generar: solicítalo de nuevo). |
ready |
boolean | true cuando se puede descargar. |
report |
string o null | Tipo solicitado por la API (documents, kardex...). null en los reportes pedidos desde el panel web. |
module |
string | REPORT, INVENTORY o FINANCE (los pedidos desde el panel web pueden traer otros valores, p. ej. Reporte). |
type |
string | Nombre del reporte. |
format |
string | pdf, xlsx o zip (reporte dividido en lotes). |
file_name |
string o null | Nombre del archivo cuando está listo. |
user_id |
integer | Usuario que lo pidió. |
date_init / date_end |
string | Inicio y fin del proceso (YYYY-MM-DD HH:mm:ss). |
download_url |
string o null | URL de Descargar reporte cuando está listo. |
Errores:
403si el reporte es de otro usuario y no eres administrador.404si no existe.401sin token o con un token inválido.
Parámetros
| Parámetro | Dónde | Obligatorio | Ejemplo | Descripción |
|---|---|---|---|---|
download_tray_id |
ruta | sí | 1 |
Respuestas
200 — En proceso
{
"success": true,
"data": {
"id": 59,
"status": "IN_PROCESS",
"ready": false,
"report": "kardex",
"module": "INVENTORY",
"type": "Reporte Kardex",
"format": "pdf",
"file_name": null,
"user_id": 3,
"date_init": "2026-11-07 10:15:02",
"date_end": null,
"download_url": null
}
}
200 — Listo
{
"success": true,
"data": {
"id": 58,
"status": "FINISHED",
"ready": true,
"report": "documents",
"module": "REPORT",
"type": "Reporte Documentos - Ventas",
"format": "xlsx",
"file_name": "REPORT_Reporte_Documentos_Ventas_20261107101509.xlsx",
"user_id": 3,
"date_init": "2026-11-07 10:15:02",
"date_end": "2026-11-07 10:15:09",
"download_url": "https://empresa.dominio/api/download-tray/58/download"
}
}
403 — De otro usuario
{
"success": false,
"message": "No tienes permiso para acceder a este registro."
}
404 — No existe
{
"success": false,
"message": "Registro no encontrado."
}
Pruébalo
Prueba este endpoint con tu empresa y tu token: elige la URL en Servers, pega el token en Authorize y haz clic en Try it out.