API de itinerarios
Accede a datos de reservas en tiempo casi real para tus clientes
Con nuestra API de itinerarios, puedes mostrar la información de las reservas de tus clientes y ayudarles a encontrar productos o servicios relacionados, como visitas o experiencias. También puedes utilizar los datos de esta API para analizar las tendencias de las reservas y crear informes para las partes interesadas.
Campos disponibles
En las tablas siguientes encontrarás los campos, incluidos objetos anidados, disponibles a través de nuestros métodos de entrega push y pull.
Nombre del campo | Definición | Ejemplo |
---|---|---|
itinerary_id | Número de itinerario o el número de referencia del pedido en el punto de venta. | 72622069245694 |
status | Estado del itinerario y de sus elementos individuales. | Valores posibles: Reservado Cancelado |
creation_date * | Fecha en que se hizo inicialmente una reserva; se representa en formato de fecha ISO8601 (AAAA-MM-DD). | 2023-02-05 |
update_date_time * | Fecha y hora de la última actualización del itinerario; se representa en formato de fecha ISO8601 (AAAA-MM-dd"T"HH:mm:ss.SSSZ). | 2023-10-21T00:00:00.000-08:00 |
online | Indica si el itinerario se reservó por Internet o a través de un agente. Se representa con un valor booleano. | true |
package | Indica si el itinerario se reservó por Internet o a través de un agente. Se representa con un valor booleano. | false |
payment_type | Método utilizado en el momento del pago. | Valores posibles: Tarjeta de crédito Puntos Pago fraccionado |
point_of_sale_country_code | Código de país del punto de venta desde el que el cliente hizo la reserva. Se representa en formato ISO 3166-1 alfa-2 de dos letras. | GB |
purchaser | Identificación de la persona que hizo la reserva. Consulta la tabla purchaser para ver la lista de elementos anidados. | |
property_booking_items | Componentes del alojamiento reservados como parte del itinerario. Consulta la tabla property_booking_items para ver la lista de elementos anidados. | |
flight_booking_items | Componentes aéreos reservados como parte del itinerario. Consulta la tabla flight_booking_items para ver la lista de elementos anidados. | |
car_booking_items | Componentes de coche reservados como parte del itinerario. Consulta la tabla car_booking_items para ver la lista de elementos anidados. | |
activity_booking_items | Componentes de actividad reservados como parte del itinerario. Consulta la tabla activity_booking_items para ver la lista de elementos anidados. | |
insurance_booking_items | Componentes de seguro reservados como parte del itinerario. Consulta la tabla insurance_booking_items para ver la lista de elementos anidados. | |
rate | Tarifa y detalles del precio de un elemento de la reserva o del itinerario completo. Consulta la tabla rate para ver la lista de elementos anidados. | |
coupon | El cupón aplicado al itinerario, cuando proceda. Consulta la tabla coupon para ver la lista de elementos anidados. |
* Los campos de fecha se indican en Tiempo Universal Coordinado (UTC).
** Datos de información personal identificable (IPI). Asegúrate de gestionar esta información correctamente según las directrices de tu empresa. Inclúyela solo cuando sea absolutamente necesario.
*** Los datos de estos campos estarán disponibles entre las 18:00 y las 20:00 UTC del día siguiente a la creación o actualización de la reserva. Actualmente no están disponibles en tiempo casi real.
Modos de entrega
La API de Itinerarios proporciona datos de dos mecanismos: push y pull.
Mecanismo push
El servicio push se ha diseñado para enviar actualizaciones del itinerario a medida que estén disponibles en tiempo casi real, centrándose en los detalles esenciales del itinerario. Este servicio se dirige a los siguientes casos de uso:
- Permitir a los colaboradores mostrar la información de las reservas de los clientes en su sitio web o aplicación.
- Permitir a los colaboradores comercializar productos y servicios relacionados con las reservas.
Los eventos se enviarán mediante un webhook a la URL que proporciones en formato de mensaje HTTP POST. Recuerda que los mensajes pueden llegar desordenados. Consulta los elementos creation_date
y update_date_time
para determinar el orden.
Para obtener más detalles sobre el proceso de autenticación, consulta Cómo empezar.
Mecanismo pull
El servicio pull proporciona datos detallados del itinerario para respaldar casos de uso como los siguientes:
- Permitir el análisis de datos.
- Activar la recuperación de datos para períodos de tiempo en los que falló la entrega push.
- Habilitar el servicio de asistencia en tiempo real.
Este servicio consta de dos puntos finales HTTP GET: uno pone a disposición una lista de itinerarios creados o actualizados en un intervalo de tiempo especificado y el otro recupera itinerarios concretos por su ID. Los parámetros de consulta son:
creation_date_start
creation_date_end
update_date_time_start
update_date_time_end
itinerary_id
Para obtener más detalles sobre el proceso de autenticación, consulta Cómo empezar.
Detalles de la API
Explora las definiciones de los puntos de conexión en esta página y usa un software de pruebas de API para ver la diferencia entre los ejemplos y las definiciones de esquemas, y el resultado real.