Sign in

v1

latestOpenAPI 3.0.32026-07-2410639570.9 KB
Reservas del Hotel - V2

Listar reservas del hotel

get/api/v2/hotels/reservations

Query parameters

limitinteger
Example:20

Cantidad de registros por página. Debe estar entre 5 y 50. Por defecto 20 si se omite.

pageinteger
Example:1

Número de página a recuperar. Comienza en 1. Por defecto 1 si se omite.

stage'confirm_registered' | 'checkin_registered' | 'checkout_registered'
Example:confirm_registered

Filtra las reservas según su etapa operacional actual. Valores posibles:

  • confirm_registered: reserva confirmada pero el huésped aún no ha hecho check-in.
  • checkin_registered: el huésped se encuentra actualmente hospedado en el hotel.
  • checkout_registered: la estadía ha finalizado, el huésped ya hizo check-out.
search_all_date_fields[start_date]string date
Example:2024-01-01

Inicio del rango de fechas para el filtro. Debe usarse junto con search_all_date_fields[end_date]. Coincide con cualquier reserva donde al menos uno de estos campos de fecha esté dentro del rango: fecha de check-in (start_at), fecha de check-out (end_at), o fecha de creación (created_at). Formato: YYYY-MM-DD. Ejemplo: 2024-01-01.

search_all_date_fields[end_date]string date
Example:2024-01-31

Fin del rango de fechas para el filtro. Debe usarse junto con search_all_date_fields[start_date]. Formato: YYYY-MM-DD. Ejemplo: 2024-01-31.

pre_reservationsboolean
Example:true

Cuando es true, retorna solo las reservas cuya fecha de check-in (start_at) está en el pasado (antes de hoy). Útil para revisar estadías pasadas o reservas actualmente en curso. No puede combinarse con post_reservations.

post_reservationsboolean
Example:true

Cuando es true, retorna solo las reservas cuya fecha de check-in (start_at) es hoy o en el futuro. Útil para ver reservas próximas y planificación diaria. No puede combinarse con pre_reservations.

Response

ok

Example response

{
  "data": [
    {
      "id": 1001,
      "status": "ok",
      "total": 250000,
      "start_at": "2024-03-15",
      "end_at": "2024-03-18",
      "adults": 2,
      "children": 1,
      "stage": "checkin_registered",
      "created_at": "2024-03-10T14:30:00.000Z"
    }
  ],
  "filters": {
    "stage": "checkin_registered",
    "search_all_date_fields": {
      "start_date": "2024-03-01",
      "end_date": "2024-03-31"
    }
  }
}