Entrega de API para Itinerários
Com os Itinerários, você pode exibir as informações de reserva dos seus clientes e ajudá-los a encontrar produtos ou serviços booking-related, como passeios ou experiências. Você também pode usar os dados para analisar tendências de reservas e criar relatórios para suas partes interessadas.
Opções de entrega
A entrega de dados de itinerários pela API pode usar um mecanismo push ou pull.
Mecanismo push
O serviço push foi projetado para enviar atualizações de itinerário assim que estiverem disponíveis no horário near-real, com foco nos principais detalhes do transaction-level. Esta opção permite que você:
- Exiba as informações de reserva dos clientes em seu site ou aplicativo
- Ofereça aos seus clientes produtos e serviços adicionais para comprar durante a viagem
Os eventos push serão entregues por meio de um Webhook para o URL fornecido, no formato de uma mensagemHTTP POST
. Essas mensagens podem chegar desordenadas, portanto, consulte os elementos creation_date
e update_date_time
para determinar a ordem.
Para obter detalhes sobre como adotar essa opção de entrega, consulte Configuração da API.
Mecanismo pull
O serviço pull fornece dados detalhados do itinerário para dar suporte a:
- Análise de dados
- Recuperação de dados para janelas de tempo em que a entrega push falhou
- Investigações do help desk
Este serviço consiste em dois pontos de extremidade HTTP GET
que permitem que você:
- Crie uma lista de itinerários criados ou atualizados em um intervalo de tempo especificado usando as variáveis
creation_date_start
,creation_date_end
,update_date_time_start
eupdate_date_time_end
- Recuperar itinerários específicos por seus
itinerary_id
Para obter detalhes sobre o processo de autenticação, consulte Configuração da API.
Campos disponíveis
As tabelas abaixo listam os campos, incluindo quaisquer objetos aninhados, disponíveis por meio dos nossos métodos de entrega push e pull.
Nomes de campo que começam com um nome seguido por um ponto (por exemplo, <variável>.<variável aninhada>) indicam uma relação de aninhamento.
Modelo sem marca
Nome do campo | Definição | Exemplo |
---|---|---|
itinerary_id | O número do itinerário ou número de referência do pedido do ponto de venda. | 72622069245694 |
status | O status do itinerário e dos seus itens individuais. | Valores possíveis: confirmado cancelado |
creation_date * | Data em que uma reserva foi feita inicialmente, representada no formato de data ISO 8601 (YYYY-MM-DD). | 2023-02-05 |
update_date_time * | A última data e hora de atualização do itinerário, representadas no formato de data ISO 8601 (YYYY-MM-dd'T"HH:mm:ss.SSSZ). | 2023-10-21T00:00:00.000Z |
online | Indica se o itinerário foi reservado on-line (verdadeiro) ou por meio de um agente (falso). Representado como um booleano. | true |
package | Indica se o itinerário faz parte de um pacote ou de uma reserva independente. Representado como um booleano. | false |
payment_type | A forma de pagamento usada na compra. | Valores possíveis: credit card points split pay |
point_of_sale_country_code | O código do país do ponto de venda em que o cliente fez a reserva. Representado com duas letras, no formato ISO 3166-1 alpha-2. | GB |
purchaser | Identificação da pessoa que fez a reserva. Consulte a tabela purchaser para ver uma lista dos itens aninhados. | |
property_booking_items | Componentes de acomodação reservados como parte do itinerário. Consulte a tabela property_booking_items para ver uma lista dos itens aninhados. | |
flight_booking_items | Componentes aéreos reservados como parte do itinerário. Consulte a tabela flight_booking_items para ver uma lista dos itens aninhados. | |
car_booking_items | Carros reservados como parte do itinerário. Consulte a tabela car_booking_items para ver uma lista dos itens aninhados. | |
activity_booking_items | Atividades reservadas como parte do itinerário. Consulte a tabela activity_booking_items para ver uma lista dos itens aninhados. | |
insurance_booking_items | Seguro reservado como parte do itinerário. Consulte a tabela insurance_booking_items para ver uma lista dos itens aninhados. | |
rate | Os detalhes do preço e da tarifa de um item da reserva ou de todo o itinerário. Consulte a tabela rate para ver uma lista dos itens aninhados. | |
coupon | O cupom aplicado ao itinerário, quando aplicável. Consulte a tabela coupon para ver uma lista dos itens aninhados. |
Notas para todos os campos do modelo de marca branca
* Os campos de data estão em Tempo Universal Coordenado (UTC).
** Isto representa dados de Informações Pessoais Identificáveis (PII). Lide com isso da maneira correta, conforme as diretrizes da sua empresa. Inclua apenas quando for necessário.
*** Os dados para esses campos estarão disponíveis entre 18h e 20h UTC do dia seguinte à criação ou atualização da reserva. Não está disponível quase em tempo real.
Programa de Afiliados de Agentes de Viagens (TAAP)
Nome do campo | Definição | Exemplo |
---|---|---|
itinerary_id | O número do itinerário ou número de referência do pedido do ponto de venda. | 72622069245694 |
status | O status do itinerário e dos seus itens individuais. | Valores possíveis: confirmado cancelado |
creation_date * | Data em que uma reserva foi feita inicialmente, representada no formato de data ISO 8601 (YYYY-MM-DD). | 2023-02-05 |
update_date_time * | A última data e hora de atualização do itinerário, representadas no formato de data ISO 8601 (YYYY-MM-dd'T"HH:mm:ss.SSSZ). | 2023-10-21T00:00:00.000Z |
online | Indica se o itinerário foi reservado on-line (verdadeiro) ou por meio de um agente (falso). Representado como um booleano. | true |
point_of_sale_country_code | O código do país em que o cliente fez a reserva. Representado com duas letras, no formato ISO 3166-1 alpha-2. | GB |
purchaser | Identificação da pessoa que fez a reserva. Consulte a tabela purchaser para ver uma lista dos itens aninhados. | |
agency | Identificação da agência TAAP e do agente que fez a reserva. Consulte a tabela agency para ver uma lista dos itens aninhados. | |
payment | Informações de pagamento do itinerário. Consulte a tabela payment para ver uma lista dos itens aninhados. | |
property_booking_items | Componentes de acomodação reservados como parte do itinerário. Consulte a tabela property_booking_items para ver uma lista dos itens aninhados. | |
flight_booking_items | Componentes aéreos reservados como parte do itinerário. Consulte a tabela flight_booking_items para ver uma lista dos itens aninhados. | |
car_booking_items | Carros reservados como parte do itinerário. Consulte a tabela car_booking_items para ver uma lista dos itens aninhados. | |
activity_booking_items | Atividades reservadas como parte do itinerário. Consulte a tabela activity_booking_items para ver uma lista dos itens aninhados. | |
rate | Os detalhes do preço e da tarifa de um item da reserva ou de todo o itinerário. Consulte a tabela rate para ver uma lista dos itens aninhados. | |
earnings | Os detalhes da comissão de um item de reserva ou de todo o itinerário. Consulte a tabela earnings para ver uma lista dos itens aninhados. |
Notas para todos os campos TAAP
* Os campos de data estão em Tempo Universal Coordenado (UTC). ** Isso representa dados de Informações Pessoais Identificáveis (PII). Lide com isso da maneira correta, conforme as diretrizes da sua empresa. Inclua somente quando for absolutamente necessário. *** Os dados para esses campos serão disponibilizados entre 18h e 20h UTC no dia seguinte à criação ou atualização da reserva. Não está disponível quase em tempo real.
Detalhes da API
Fornecemos um instantâneo do esquema e das configurações da API com base em como sua empresa usaria os dados da API de itinerários. Você pode baixar as especificações do OpenAPI e usar um software de teste de API para entender como os exemplos e definições de esquema se comparam à saída real.
Modelo sem marca
Os campos, incluindo quaisquer objetos aninhados, disponíveis para nossos parceiros de modelos de marca branca por meio de nossos métodos de entrega push e pull são:
TAAP
Os campos, incluindo quaisquer objetos aninhados, disponíveis para nossos parceiros TAAP por meio de nossos métodos de entrega push e pull são: