Entrega API para Itinerarios
Con Itinerarios, puedes mostrar la información de reserva de tus 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 se ha diseñado para enviar actualizaciones del itinerario a medida que estén disponibles en near-real, centrándose en los detalles principales de transaction-level. Esta opción te permite
- Muestra la información de las reservas de tus clientes en tu web o app
- Ofrece a tus clientes 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_date
y update_date_time
para determinar el orden.
Para más detalles sobre cómo adoptar esta opción de entrega, consulta Configuración de la API.
Mecanismo pull
El servicio pull proporciona datos detallados del itinerario como apoyo:
- Análisis de datos
- Recuperación de datos para ventanas de tiempo en las que falló la entrega push
- Investigaciones del servicio de asistencia
Este servicio consta de dos extremos HTTP GET
que 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.
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.
Los nombres de campo que empiezan por un nombre seguido de un punto (por ejemplo, <variable>.<nested variable>) indican una relación de anidamiento.
Plantilla sin identificación de marca
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: confirmado cancelado |
creation_date * | La fecha en que se hizo inicialmente una reserva, representada en formato de fecha ISO 8601 (YYYY-MM-DD). | 2023-02-05 |
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 |
online | Indica si el itinerario se reservó online (verdadero) o a través de un agente (falso). Se representa con un valor booleano. | true |
package | Indica si el itinerario forma parte de un paquete o es una reserva independiente. 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. |
Notas para todos los campos de la Plantilla 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 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.
Programa de Afiliación de Agentes de Viajes (TAAP)
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: confirmado cancelado |
creation_date * | La fecha en que se hizo inicialmente una reserva, representada en formato de fecha ISO 8601 (YYYY-MM-DD). | 2023-02-05 |
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 |
online | Indica si el itinerario se reservó online (verdadero) o a través de un agente (falso). Se representa con un valor booleano. | true |
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 |
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 gestionar esta información correctamente según las directrices de tu empresa. Inclúyelos sólo 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.
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 descargarte las especificaciones OpenAPI y utilizar un software de pruebas de API para saber cómo se comparan los ejemplos y las definiciones de esquemas con la salida real.
Plantilla sin identificación de marca
Los campos, incluyendo cualquier objeto anidado, disponibles para nuestros socios de Plantillas Marca Blanca a través de nuestros métodos de entrega push y pull son:
TAAP
Los campos, incluidos los objetos anidados, disponibles para nuestros socios TAAP a través de nuestros métodos de entrega push y pull son: