Entrega de la API para itinerarios
Con «Itinerarios», puedes mostrar la información de las reservas de los clientes y ayudarles a encontrar productos o servicios de « booking-related », como excursiones o experiencias. También puedes usar los datos para analizar las tendencias de reservas y crear informes para tus partes interesadas.
Opciones de envío
Tu API para el envío de datos de itinerarios puede utilizar tanto un mecanismo «push» como uno «pull».
Mecanismo push
El servicio push envía actualizaciones del itinerario en cuanto se producen. Los campos principales de la reserva están disponibles a los pocos minutos de realizar una transacción, y los campos secundarios y de ampliación, en un plazo de 2 a 4 horas. Esta opción te permite:
- Muestra la información de las reservas de los clientes en tu página web o aplicación
- Ofrece a los viajeros productos y servicios adicionales que puedan comprar para su viaje
Los eventos push se enviarán mediante un webhook a la URL que nos facilites, en formato de mensaje HTTP POST. Es posible que estos mensajes lleguen sin un orden concreto, así que fíjate en los elementos creation_date y update_date_time para determinar el orden.
>> Ver más detalles sobre la configuración de la API
Trabajar con eventos «push»
Como los datos del itinerario se envían a medida que están disponibles, es posible que recibas varios eventos para un mismo itinerario: un evento inicial con los campos principales, seguido de eventos posteriores a medida que se completan los datos complementarios o se actualiza el itinerario.
Qué hacer:
- En cada itinerario habrá varios eventos: usa
itinerary_idpara relacionar los eventos y ten siempre en cuenta que la versión más reciente deupdate_date_timees la que prevalece. - Elige cómo gestionar las actualizaciones: cuando recibas un nuevo evento para un itinerario ya existente, puedes sobrescribir el registro anterior con los datos más recientes o añadir cada evento al final para mantener un historial de cambios
- Gestiona adecuadamente los campos que faltan: es posible que los campos secundarios no estén presentes en los eventos iniciales; comprueba si los campos están presentes antes de procesarlos
Evita lo siguiente:
- Supongamos que el primer evento contiene la carga útil completa:. Los campos adicionales aparecen en eventos posteriores.
- Considera como errores los eventos múltiples en un mismo itinerario:. Este es el comportamiento esperado.
- Considera que las cifras de real-time son definitivas:, aunque pueden sufrir modificaciones en las próximas 24 horas
Mecanismo pull
El servicio de consulta proporciona datos detallados sobre itinerarios para facilitar:
- Análisis de datos
- Conciliar los registros de reservas con los datos de Expedia Group
- Recuperación de datos para intervalos de tiempo en los que falló el envío por push
- Investigaciones del servicio de asistencia técnica
Al igual que con la entrega «push», los datos del itinerario están disponibles en dos niveles para la entrega «pull»: se puede acceder a los campos principales (itinerary_ID, status, gross_booking_value, checkin_date y checkout_date) a los pocos minutos de realizar una reserva o una actualización, mientras que los campos complementarios y de enriquecimiento están disponibles en un plazo de 2 a 4 horas.
>> Echa un vistazo a «Campos disponibles» para ver un desglose completo por campo
Este servicio consta de dos puntos de conexión de HTTP GET que te permiten:
- Crea una lista de itinerarios creados o actualizados en un intervalo de tiempo determinado utilizando las variables
creation_date_start,creation_date_end,update_date_time_startyupdate_date_time_end - Busca itinerarios concretos por su
itinerary_id
>> Echa un vistazo a la configuración de la API para saber más sobre el proceso de autenticación
Recuperación de datos de itinerarios por intervalo de tiempo
Para obtener los datos del itinerario correspondientes a un intervalo de tiempo determinado, realiza una consulta al punto final « GET /itineraries » utilizando update_date_time_start y update_date_time_end como intervalo de consulta.
Enfoque recomendado:
- Utiliza los campos de update_date_time en la ventana de búsqueda:. Utiliza
update_date_time_startyupdate_date_time_endcomo ventana de búsqueda para recuperar los itinerarios creados o actualizados en un periodo determinado. Si solo usascreation_date, te perderás las actualizaciones del itinerario. - Guarda la marca de tiempo de tu última consulta correcta:. Úsala como tu próximo
update_date_time_start, ampliando la ventana poco a poco. - Deduplicar:. Usa
itinerary_id+update_date_timeen tus consultas. Es posible que el mismo itinerario aparezca en varias ventanas de consulta a medida que se van completando los campos complementarios. Considera siempre como referencia el registro que aparece enupdate_date_time.
Si tu caso de uso requiere los datos de itinerario más completos y actualizados, te recomendamos el envío push.
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. La columna «Disponibilidad» indica cuándo suele estar disponible cada campo tras una reserva o una actualización:
- ****o en tiempo real: disponible a los pocos minutos de realizar una reserva o una actualización
- Near-real-time: Disponible entre 2 y 4 horas después de hacer una reserva o una modificación
Los nombres de campo que empiezan por un nombre seguido de un punto (por ejemplo, <variable>.<nested variable>) indican una relación de anidamiento.
Plataforma de viajes de marca blanca
| Nombre del campo | Definición | Ejemplo | Disponibilidad |
|---|---|---|---|
itinerary_id | Número de itinerario o el número de referencia del pedido en el punto de venta. | 72622069245694 | En tiempo real |
status | Estado del itinerario y de sus elementos individuales. | Valores posibles: confirmado cancelado | En tiempo real |
creation_date* | La fecha en la que se hizo la reserva por primera vez, expresada en el formato de fecha ISO 8601 (YYYY-MM-DD). | 2023-02-05 | En tiempo real |
update_date_time* | La fecha y la hora de la última actualización del itinerario, expresadas en el formato de fecha ISO 8601 (YYYY-MM-dd'T"HH:mm:ss.SSSZ). | 2023-10-21T00:00:00.000Z | En tiempo real |
online | Indica si el itinerario se reservó por Internet (verdadero) o a través de un agente (falso). Se representa con un valor booleano. | true | Near-real-time |
package | Indica si el itinerario forma parte de un paquete o si es una reserva independiente. Se representa con un valor booleano. | false | Near-real-time |
payment_type | Método utilizado en el momento del pago. | Valores posibles: Tarjeta de crédito Puntos Pago fraccionado | En tiempo real |
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 | Near-real-time |
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. |
Notas sobre todos los campos de la plataforma de viajes de marca blanca
- Los campos de fecha están en hora universal coordinada (UTC).
** Esto se refiere a datos de información de identificación personal (PII). Asegúrate de hacerlo bien, siguiendo las directrices de tu empresa. Inclúyelo solo cuando sea absolutamente necesario.
Programa de afiliados para agencias de viajes (TAAP)
| Nombre del campo | Definición | Ejemplo | Disponibilidad |
|---|---|---|---|
itinerary_id | Número de itinerario o el número de referencia del pedido en el punto de venta. | 72622069245694 | En tiempo real |
agency_reference_code | Una referencia del itinerario personalizado que te da la agencia al finalizar la compra. | 86549B_GB | En tiempo real |
status | Estado del itinerario y de sus elementos individuales. | Valores posibles: confirmado cancelado | Near-real-time |
creation_date* | La fecha en la que se realizó inicialmente la reserva, expresada en el formato de fecha ISO 8601 (YYYY-MM-DD). | 2023-02-05 | En tiempo real |
update_date_time* | La fecha y la hora de la última actualización del itinerario, expresadas en el formato de fecha ISO 8601 (YYYY-MM-dd'T"HH:mm:ss.SSSZ). | 2023-10-21T00:00:00.000Z | En tiempo real |
online | Indica si el itinerario se reservó por Internet (verdadero) o a través de un agente (falso). Se representa con un valor booleano. | true | Near-real-time |
point_of_sale_country_code | El código del país en el que el cliente ha hecho la reserva. Se representa en formato ISO 3166-1 alfa-2 de dos letras. | GB | Near-real-time |
purchaser | Identificación de la persona que hizo la reserva. Consulta la tabla purchaser para ver la lista de elementos anidados. | ||
agency | Identificación de la agencia y del agente de TAAP que hicieron la reserva. Consulta la tabla agency para ver la lista de elementos anidados. | ||
payment | Información sobre el pago del itinerario. Consulta la tabla payment 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. | ||
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. | ||
earnings | Los detalles de la comisión de una reserva concreta o de todo el itinerario. Te informo de... Consulta la tabla earnings para ver la lista de elementos anidados. |
Notas sobre todos los campos de TAAP
- Los campos de fecha están en hora universal coordinada (UTC).
** Esto se refiere a datos de información de identificación personal (PII). Asegúrate de gestionarlo correctamente siguiendo las directrices de tu empresa. Inclúyelo solo cuando sea absolutamente necesario.
Detalles de la API
Te hemos facilitado un resumen del esquema y las configuraciones de la API, teniendo en cuenta cómo utilizaría tu empresa los datos de la API de itinerarios. Puedes descargar las especificaciones de OpenAPI y usar una herramienta de pruebas de API para ver c ómo se comparan los ejemplos y las definiciones de esquemas con los resultados reales.
Plataforma de viajes de marca blanca
Los campos, incluidos los objetos anidados, a los que tienen acceso nuestros socios de la plataforma de viajes de marca blanca a través de nuestros métodos de entrega «push» y «pull» son:
TAP
Los campos, incluidos los objetos anidados, a los que pueden acceder nuestros socios de TAAP a través de nuestro método de envío «push» son: