Listar bandeja de descargas
GET /api/download-tray
Autenticación: Bearer del usuario del tenant (Authorization: Bearer <api_token>).
Lista los reportes solicitados (por la API o desde el panel web), del más reciente al más antiguo.
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: listado con paginación por cursor {success, data[], pagination: {next_cursor, has_more}}.
Parámetros de la URL (query):
| Campo | Tipo | Obligatorio | Descripción / valores permitidos |
|---|---|---|---|
status |
string | No | IN_PROCESS, FINISHED, ERROR o FAILED. |
module |
string | No | REPORT, INVENTORY o FINANCE. |
date |
YYYY-MM-DD | No | Solo los solicitados ese día. |
user_id |
integer | No | Solo administradores: reportes de ese usuario. Para un vendedor se ignora. |
limit / cursor |
integer / string | No | Paginación por cursor. |
Paginación por cursor: envía limit (1 a 100, por defecto 15). La respuesta trae pagination.next_cursor; para la página siguiente repite la misma consulta agregando cursor=<next_cursor>. Cuando pagination.has_more es false no hay más páginas.
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:
422sistatusodatetienen un valor no permitido.401sin token o con un token inválido.
Parámetros
| Parámetro | Dónde | Obligatorio | Ejemplo | Descripción |
|---|---|---|---|---|
status |
query | no | FINISHED |
Estado. |
module |
query | no | REPORT |
Módulo. |
date |
query | no | 2026-11-07 |
Día de la solicitud. |
user_id |
query | no | 3 |
Solo administradores. |
limit |
query | no | 15 |
Registros por página, de 1 a 100. Por defecto 15. |
cursor |
query | no | Valor de pagination.next_cursor de la respuesta anterior para obtener la página siguiente. |
Respuestas
200 — Listado
{
"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
},
{
"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"
}
],
"pagination": {
"next_cursor": "eyJpZCI6MTUsIl9wb2ludHNUb05leHRJdGVtcyI6dHJ1ZX0",
"has_more": true
}
}
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.