Entrega API para Itinerarios
Con Itinerarios, puedes mostrar la información de reserva de los clientes y ayudarles a encontrar productos o servicios de booking-related, como excursiones o experiencias. También puedes utilizar los datos para analizar las tendencias de las reservas y crear informes para las partes interesadas.
Opciones de entrega
Tu API de entrega de datos de Itinerarios puede utilizar un mecanismo push o pull.
Mecanismo push
El servicio push envía actualizaciones del itinerario a medida que se producen. Los campos principales de la reserva están disponibles a los pocos minutos de una transacción, y los campos auxiliares y de enriquecimiento a las 2-4 horas. Esta opción te permite
- Muestra la información de las reservas de tus clientes en tu web o app
- Ofrecer a los viajeros productos y servicios adicionales para su viaje
Los eventos push se enviarán a través de un Webhook a la URL que proporciones, en formato de mensajeHTTP POST. Estos mensajes pueden llegar desordenados, así que consulta los elementos creation_datey update_date_timepara determinar el orden.
Para más detalles sobre cómo adoptar esta opción de entrega, consulta Configuración de la API.
Trabajar con eventos push
Como los datos del itinerario se entregan a medida que están disponibles, puedes recibir varios eventos para el mismo itinerario: un evento inicial con los campos principales, seguido de eventos posteriores a medida que se enriquecen los datos auxiliares o se actualiza el itinerario. Consulta Campos disponibles para ver un desglose completo de los campos que llegan en tiempo real y los que lo hacen en un plazo de 2 a 4 horas.
Qué hacer:
- Espera múltiples eventos por itinerario: utiliza
itinerary_idpara correlacionar eventos y trata siempre el evento con la últimaupdate_date_timecomo autoritativo - Elige cómo gestionar las actualizaciones: cuando recibas un nuevo evento para un itinerario existente, puedes sobrescribir el registro anterior con los datos más recientes, o anexar cada evento para mantener un historial de cambios.
- Maneja los campos ausentes con elegancia: los campos auxiliares pueden estar ausentes en los primeros eventos; comprueba la presencia de campos antes de procesarlos
Evita lo siguiente:
- Supongamos que el primer evento contiene la carga útil completa: los campos auxiliares siguen en eventos posteriores
- Tratar como errores los eventos múltiples de un mismo itinerario: este es el comportamiento esperado
- Trata los valores financieros de real-time como definitivos: pueden refinarse en 24 horas
Mecanismo pull
El servicio pull proporciona datos detallados del itinerario como apoyo:
- Análisis de datos
- Conciliación de los registros de reservas con los datos de Expedia Group
- Recuperación de datos para ventanas de tiempo en las que falló la entrega push
- Investigaciones del servicio de asistencia
Al igual que con la entrega push, los datos del itinerario están disponibles en dos niveles para la entrega pull: los campos principales (itinerary_ID, status, gross_booking_value, checkin_date, y checkout_date) están accesibles a los pocos minutos de una reserva o actualización, y los campos auxiliares y de enriquecimiento a las 2-4 horas. Consulta Campos disponibles para ver un desglose completo por campos.
Este servicio consta de dos extremos HTTP GETque te permiten:
- Crea una lista de itinerarios creados o actualizados en un intervalo de tiempo especificado utilizando las variables
creation_date_start,creation_date_end,update_date_time_start, yupdate_date_time_end - Recuperar itinerarios específicos por su
itinerary_id
Para más detalles sobre el proceso de autenticación, consulta Configuración de la API.
Recuperar datos del itinerario por ventana temporal
Para recuperar los datos del itinerario de una ventana de tiempo determinada, sondea el punto final GET /itinerariesutilizando update_date_time_starty update_date_time_endcomo ventana de consulta.
Enfoque recomendado:
- Utiliza los campos update_date_time para la ventana de consulta: Utiliza
update_date_time_startyupdate_date_time_endcomo ventana de consulta para recuperar itinerarios creados o actualizados en un periodo determinado. Si sólo utilizascreation_date, te perderás las actualizaciones del itinerario. - Persiste tu última marca de tiempo de sondeo con éxito: Utilízala como tu siguiente
update_date_time_start, avanzando la ventana de forma incremental. - Deduplica: Utiliza
itinerary_id+update_date_timeen tus consultas. El mismo itinerario puede aparecer en varias ventanas de sondeo a medida que se enriquecen los campos auxiliares. Trata siempre como fidedigno el registro con la últimaupdate_date_time.
Si tu caso de uso requiere los datos de itinerario más completos y puntuales, se recomienda la entrega 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 se puede acceder normalmente a cada campo tras un evento de reserva o una actualización:
- En tiempo real: Disponible a los pocos minutos de una reserva o actualización
- Near-real-time: Disponible entre 2 y 4 horas después de una reserva o actualizació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 que se hizo inicialmente una reserva, representada en formato de fecha ISO 8601 (YYYY-MM-DD). | 2023-02-05 | En tiempo real |
update_date_time* | La fecha y hora de la última actualización del itinerario, representada en 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ó online (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 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 para todos los campos de la Plataforma de Viajes Marca Blanca
- Los campos de fecha están en Tiempo Universal Coordinado (UTC).
** Esto representa datos de Información Personal Identificable (IPI). Asegúrate de manejarlo correctamente según las directrices de tu empresa. Inclúyelo sólo cuando sea absolutamente necesario.
Programa de Afiliación de Agentes 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 de itinerario personalizado proporcionada por la agencia en el momento de 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 que se hizo inicialmente una reserva, representada en formato de fecha ISO 8601 (YYYY-MM-DD). | 2023-02-05 | En tiempo real |
update_date_time* | La fecha y hora de la última actualización del itinerario, representada en 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ó online (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 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. | ||
agency | Identificación de la agencia TAAP y del agente que hizo 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 un elemento de la reserva o de todo el itinerario. Consulta la tabla earnings para ver la lista de elementos anidados. |
Notas para todos los campos TAAP
- Los campos de fecha están en Tiempo Universal Coordinado (UTC).
** Esto representa datos de Información Personal Identificable (IPI). Asegúrate de manejarlo correctamente según las directrices de tu empresa. Inclúyelo sólo cuando sea absolutamente necesario.
Detalles de la API
Hemos proporcionado una instantánea del esquema y las configuraciones de la API en función de cómo utilizaría tu empresa los datos de la API de Itinerarios. Puedes descargar las especificaciones OpenAPI y utilizar una herramienta de prueba de API para comprender cómo se comparan los ejemplos y las definiciones de esquema con la salida real.
Plataforma de viajes de marca blanca
Los campos, incluidos los objetos anidados, disponibles para 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, disponibles para nuestros socios TAAP a través de nuestro método de entrega push son: