Skip to main content

Módulo de Reservas

image.png

El módulo de Reservas devuelve las reservas asociadas a cada cliente, filtradas por su identificador o por estados de reservas y fechas. 

💡 Nota:
Actualmente, las consultas devuelven únicamente las reservas del cliente titular.
Si desea incluir pasajeros no titulares, consulte con el equipo técnico de Airvi si esta opción está habilitada en su instancia.

Consultar reservas por ID 

Ruta:

GET {BASE_URL}/api/public_api/clients/{id}/reservations

Parámetros disponibles:

Parámetro Descripción
assignment_date_from, assignment_date_to Fecha de asignación del viaje.
trip_date_from, trip_date_to Fecha del viaje.
skip, take Control de paginación.

Pasos:

  1. Reemplace {id} por el ID del cliente.

  2. Escriba las fechas en formato YYYY-MM-DD.

  3. Envíe la petición.

  4. Verifique que el resultado sea 200 OK.

  5. Si no hay registros, el sistema devolverá un arreglo vacío en data.items.

Consultar reservas

Función:
Devuelve un listado paginado de reservaciones que puede ser filtrado según diferentes criterios operativos.

Ruta:

GET {BASE_URL}/api/public/reservations

Descripción general:
Esta función retorna una lista de reservaciones aplicando los siguientes filtros opcionales:

  • Rango de fechas del viaje: trip_date_from, trip_date_to

  • Rango de fechas de asignación: assignation_date_from, assignation_date_to

  • Estado de la reserva: confirmado, borrador, cancelado

  • Estado del pago: pagado, impagado, abonado

Datos incluidos por cada reserva:

  • Identificadores de la reserva (ID y UUID)

  • Moneda y valores financieros (total a pagar, monto pendiente, abonado)

  • Fecha de asignación

  • Información del viaje (nombre, fecha, estado)

  • Estado actual de la reserva y del pago

Comportamiento de la respuesta:

  • Los resultados se devuelven paginados mediante los parámetros skip y take.

  • El listado se ordena automáticamente por la fecha del viaje en orden descendente.

  • Si ocurre un error durante la consulta, la API retorna un mensaje con estado INTERNAL_ERROR e incluye el campo trace_id para seguimiento técnico.

Back to top