Entrega de API para itinerários

Com o recurso Itinerários, você pode exibir as informações de reserva dos clientes e ajudá-los a encontrar produtos ou serviços da 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 seus stakeholders.

Opções de entrega

A entrega de dados de itinerários pela sua API pode usar um mecanismo de envio (push) ou de solicitação (pull).

Mecanismo push

O serviço push envia atualizações de itinerário à medida que elas ocorrem. Os campos principais de reserva ficam disponíveis poucos minutos após a transação, e os campos auxiliares e de enriquecimento surgem em 2 a 4 horas. Esta opção permite que você:

Exiba as informações de reserva dos clientes em seu site ou aplicativo.
Ofereça aos viajantes produtos e serviços adicionais para compra durante a viagem.

Os eventos push serão entregues via Webhook para o URL que você fornecer, no formato de uma mensagemHTTP POST. Essas mensagens podem chegar sem ordem, portanto, consulte os elementos creation_datee update_date_timepara determinar a ordem.

Para obter detalhes sobre como adotar essa opção de entrega, consulte Configuração da API.

Trabalhando com eventos push

Como os dados do itinerário são entregues à medida que ficam disponíveis, você pode receber vários eventos para o mesmo itinerário — um evento inicial com os campos principais, seguido por eventos subsequentes conforme os dados auxiliares são enriquecidos ou o itinerário é atualizado. Consulte Campos disponíveis para obter uma descrição completa de quais campos chegam em tempo real e quais chegam dentro de 2 a 4 horas.

Faça:

**Espere vários eventos por itinerário: use **para correlacionar eventos e sempre considere o evento com o itinerary_idmais recente como o mais importante.update_date_time
Escolha como lidar com as atualizações: ao receber um novo evento para um itinerário existente, você pode sobrescrever o registro anterior com os dados mais recentes ou adicionar cada evento para manter um histórico de alterações.
Lidar com campos ausentes de forma adequada: campos auxiliares podem estar ausentes dos eventos iniciais; verifique a presença do campo antes do processamento.

Não:

Suponha que o primeiro evento contenha a carga útil completa: campos auxiliares seguem em eventos posteriores.
Tratar múltiplos eventos para o mesmo itinerário como erros: este é o comportamento esperado
Considere os valores financeiros de real-time como finais: eles podem ser refinados em até 24 horas.

Mecanismo pull

Observação

O serviço de entrega sob demanda está disponível apenas para parceiros da Plataforma de Viagens White Label.

O serviço de consulta fornece dados detalhados de itinerário para auxiliar em:

Análise de dados
Conciliando registros de reservas com os dados Expedia Group
Recuperação de dados para janelas de tempo em que a entrega push falhou.
Investigações do help desk

Assim como na entrega push, os dados do itinerário estão disponíveis em dois níveis para entrega pull: os campos principais (itinerary_ID, status, gross_booking_value, checkin_datee checkout_date) ficam acessíveis em minutos após uma reserva ou atualização, com os campos auxiliares e de enriquecimento sendo disponibilizados em 2 a 4 horas. Consulte Campos disponíveis para obter uma descrição completa por campo.

Este serviço consiste em dois endpoints que permitem:HTTP GET

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_starteupdate_date_time_end.
Recupere itinerários específicos por meio deles. itinerary_id

Para obter detalhes sobre o processo de autenticação, consulte Configuração da API.

Recuperação de dados de itinerário por janela de tempo

Para recuperar dados de itinerário para um determinado intervalo de tempo, consulte o endpoint GET /itinerariesusando update_date_time_starte update_date_time_endcomo sua janela de consulta.

Abordagem recomendada:

Use os campos update_date_time para a janela de consulta: Use update_date_time_starte update_date_time_endcomo sua janela de consulta para recuperar itinerários criados ou atualizados em um determinado período. Usar apenas creation_dateresultará na perda de atualizações de itinerário.
Persista o carimbo de data/hora da sua última pesquisa bem-sucedida: Use isso como seu próximo update_date_time_start, avançando a janela incrementalmente.
Remover duplicados: Use itinerary_id + update_date_timeem suas consultas. O mesmo itinerário pode aparecer em várias janelas de votação à medida que os campos auxiliares são enriquecidos. Considere sempre o registro com a versão mais recente como o mais autorizado.update_date_time

Se o seu caso de uso exigir dados de itinerário mais completos e atualizados, recomenda-se o envio por push.

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. A coluna Disponibilidade indica quando cada campo normalmente fica acessível após uma reserva ou atualização:

Em tempo real: Disponível em poucos minutos após a reserva ou atualização.
Near-real-time: Disponível em 2 a 4 horas após a reserva ou atualização

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.

Plataforma de viagens sem marca

Nome do campo	Definição	Exemplo	Disponibilidade
`itinerary_id`	O número do itinerário ou número de referência do pedido do ponto de venda.	72622069245694	Tempo real
`status`	O status do itinerário e dos seus itens individuais.	Valores possíveis: confirmado cancelado	Tempo real
`creation_date`*	A data em que uma reserva foi feita inicialmente, representada no formato de data ISO 8601 (YYYY-MM-DD).	2023-02-05	Tempo real
`update_date_time`*	A data e hora da última 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	Tempo real
`online`	Indica se o itinerário foi reservado online (verdadeiro) ou por meio de um agente (falso). Representado como um booleano.	true	Near-real-time
`package`	Indica se o itinerário faz parte de um pacote ou se é uma reserva independente. Representado como um booleano.	false	Near-real-time
`payment_type`	A forma de pagamento usada na compra.	Valores possíveis: credit card points split pay	Tempo real
`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	Near-real-time
`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.

purchaser

Estes campos identificam a pessoa que fez a reserva.

Nome do campo	Definição	Exemplo	Disponibilidade
`purchaser.email`**	Endereço de e-mail da pessoa que fez a reserva.	smith@exemplo.com	Tempo real
`purchaser.loyalty_id`**	Identificador da associação ao programa de fidelidade.	12345678	Near-real-time
`purchaser.first_name`**	Primeiro nome da pessoa que fez a reserva.	Jane	Tempo real
`purchaser.last_name`**	Sobrenome da pessoa que fez a reserva.	Smith	Tempo real

property_booking_items

Estes campos listam os componentes de acomodação reservados como parte do itinerário.

Nome do campo	Definição	Exemplo	Disponibilidade
`booking_item_id`	Identificador de um item específico reservado como parte de um itinerário.	1400882912	Tempo real
`status`	Status do item de acomodação específico.	Valores possíveis: confirmado cancelado	Tempo real
`checkin_date`*	Data de check-in do item de acomodação correspondente. Representado no formato de data ISO 8601 (YYYY-MM-DD).	2023-02-01	Tempo real
`checkout_date`*	Data de check-out do item de acomodação correspondente. Representado no formato de data ISO 8601 (YYYY-MM-DD).	2023-02-05	Tempo real
`property.id`	Expedia Group é o identificador único do hotel ou aluguel de temporada propriedade.	1400882912	Near-real-time
`property.chain_name`	Nome da rede à qual a propriedade pertence, quando aplicável.	Independent	Near-real-time
`property.brand_name`	Nome da marca à qual a propriedade pertence, quando aplicável. Uma rede pode ter várias marcas.	Savoy Signature	Near-real-time
`property.name`	Nome do hotel ou aluguel por temporada.	Hotel 1	Tempo real
`property.city`	Nome da cidade onde está a propriedade.	Toronto	Tempo real
`property.state_province_name`	Nome do estado ou província onde está a propriedade.	Ontário	Near-real-time
`property.country_code`	Código do país onde está a propriedade. Representado com duas letras, no formato ISO 3166-1 alpha-2.	CA	Tempo real
`property.star_rating`	Classificação por estrelas da propriedade.	3.0	Near-real-time
`room_name`	O tipo de quarto reservado, conforme definido pelo hotel ou pela empresa de aluguel de temporada.	Quarto duplo confortável com banheiro privativo.	Near-real-time
`adult_count`	Número de adultos incluídos na reserva correspondente.	2	Tempo real
`child_count`	Número de crianças incluídas na reserva correspondente.	0	Tempo real
`expedia_collect`	Valor booleano que indica se a reserva foi paga no momento em que foi feita (true) ou se deve ser paga direto ao fornecedor (false).	true	Near-real-time
`property_confirmation_id`	Número de confirmação fornecido pelo hotel ou pela empresa de aluguel de temporada.	1516171819	Near-real-time
`rate`	Os detalhes do preço e da tarifa da reserva de acomodação. Consulte a tabela `rate` para ver uma lista dos itens aninhados.

flight_booking_items

Estes campos listam os componentes aéreos reservados como parte do itinerário.

Nome do campo	Definição	Exemplo	Disponibilidade
`booking_item_id`	Identificador de um item específico reservado como parte de um itinerário.	1400882911	Tempo real
`status`	Status do item de viagem aérea específico.	Valores possíveis: confirmado cancelado	Tempo real
`departure_date`*	Data de início do item de viagem aérea correspondente. Representado no formato de data ISO 8601 (YYYY-MM-DD).	2023-02-01	Tempo real
`arrival_date`*	Data de término do item de viagem aérea correspondente. Representado no formato de data ISO 8601 (YYYY-MM-DD).	2023-02-02	Tempo real
`airline.plating_carrier_name`	Nome da companhia aérea que emitiu a passagem.	Air Canada	Near-real-time
`airline.plating_carrier_code`	Código da Associação Internacional de Transporte Aéreo (IATA) da companhia aérea que emitiu a passagem.	AC	Tempo real
`carrier_pnr`	Nome do passageiro registrado junto à companhia aérea que emitiu a passagem.	SMITH	Near-real-time
`trip_type`	O tipo de viagem reservada.	Valores possíveis: one way round trip multiple destinations	Near-real-time
`fare_class`	A classe de tarifa do bilhete.	Econômica	Near-real-time
`airport_origin_code`	O código IATA corresponde ao aeroporto de origem.	LHR	Tempo real
`airport_origin_location`	A localização do aeroporto de origem.	Londres, GB (LHR-Heathrow)	Near-real-time
`airport_destination_code`	O código do aeroporto de destino. Representado no formato IATA.	YYZ	Tempo real
`airport_destination_location`	A localização do aeroporto de destino.	Toronto, ON (YYZ-Aeroporto Int. Lester B. Pearson)	Near-real-time
`ticket_number`	Número do bilhete do voo.	123456789	Near-real-time
`expedia_collect`	Valor booleano que indica se a reserva foi paga no momento em que foi feita (true) ou se deve ser paga direto ao fornecedor (false).	true	Near-real-time
`segment_count`	O número de segmentos de voo da passagem aérea.	1	Near-real-time
`rate`	Os detalhes do preço e da tarifa da reserva de voo. Consulte a tabela `rate` para ver uma lista dos itens aninhados.

car_booking_items

Estes campos listam os carros reservados como parte do itinerário.

Nome do campo	Definição	Exemplo	Disponibilidade
`booking_item_id`	Identificador de um item específico reservado como parte de um itinerário.	1400882910	Tempo real
`status`	Status do item de viagem carro específico.	Valores possíveis: confirmado cancelado	Tempo real
`pickup_date`*	Data de início do item de viagem carro. Representado no formato de data ISO 8601 (YYYY-MM-DD).	2023-02-02	Tempo real
`return_date`*	Data de término do item de viagem carro. Representado no formato de data ISO 8601 (YYYY-MM-DD).	2023-02-05	Tempo real
`rental_company.name`	Nome da locadora de carros.	Hertz	Tempo real
`car_type`	Tipo de carro alugado.	Compacto de 2/4 portas	Near-real-time
`pickup_location`	Local de retirada do carro.	Deer Lake, NL (YDF-Aeroporto Regional de Deer Lake)	Tempo real
`pickup_country_code`	Código do país do local de retirada do carro. Representado com duas letras, no formato ISO 3166-1 alpha-2.	CA	Tempo real
`return_location`	Local de devolução do carro.	Deer Lake, NL (YDF-Aeroporto Regional de Deer Lake)	Tempo real
`return_country_code`	Código do país do local de devolução do carro. Representado com duas letras, no formato ISO 3166-1 alpha-2.	CA	Tempo real
`trip_type`	O tipo de viagem reservada.	Valores possíveis: one way round trip multiple destinations	Near-real-time
`rental_company_confirmation_id`	Número de confirmação fornecido pela locadora de veículos.	ABC1234	Near-real-time
`expedia_collect`	Valor booleano que indica se a reserva foi paga no momento em que foi feita (true) ou se deve ser paga direto ao fornecedor (false).	false	Near-real-time
`rate`	Os detalhes do preço e da tarifa da reserva de carro. Consulte a tabela `rate` para ver uma lista dos itens aninhados.

activity_booking_items

Estes campos listam as atividades reservadas como parte do itinerário.

Nome do campo	Definição	Exemplo	Disponibilidade
`booking_item_id`	Identificador de um item específico reservado como parte de um itinerário.	1400882910	Tempo real
`status`	Status da atividade específica.	Valores possíveis: confirmado cancelado	Tempo real
`activity_start_date`*	Data de início da atividade. Representado no formato de data ISO 8601 (YYYY-MM-DD).	2023-02-03	Tempo real
`activity_end_date`*	Data de término da atividade. Representado no formato de data ISO 8601 (YYYY-MM-DD).	2023-02-03	Tempo real
`vendor.name`	Nome do fornecedor que oferece a atividade.	Excursões da Olivia	Tempo real
`vendor.city`	Cidade onde está o fornecedor da atividade.	Deer Lake, NL (YDF-Aeroporto Regional de Deer Lake)	Tempo real
`vendor.country_code`	Código do país onde está o fornecedor da atividade. Representado com duas letras, no formato ISO 3166-1 alpha-2.	CA	Tempo real
`offering_name`	Nome da atividade.	Passions of Paradise Great Barrier Reef	Near-real-time
`expedia_collect`	Valor booleano que indica se a reserva foi paga no momento em que foi feita (true) ou se deve ser paga direto ao fornecedor (false).	true	Near-real-time
`rate`	Os detalhes do preço e da tarifa da reserva de atividade. Consulte a tabela `rate` para ver uma lista dos itens aninhados.

insurance_booking_items

Estes campos listam os seguros reservados como parte do itinerário.

Nome do campo	Definição	Exemplo	Disponibilidade
`booking_item_id`	Identificador de um item específico reservado como parte de um itinerário.	1400882610	Tempo real
`status`	Status do seguro específico selecionado.	Valores possíveis: confirmado cancelado	Tempo real
`rate`	Detalhes do preço e da tarifa do seguro selecionado. Consulte a tabela `rate` para ver uma lista dos itens aninhados.

rate

Estes campos listam os detalhes do preço e da tarifa de um item da reserva ou de todo o itinerário. Incluem valores aninhados que descrevem o valor monetário da reserva, discriminado pelo valor bruto da reserva, impostos e taxas.

Nome do campo	Definição	Exemplo	Disponibilidade
`rate_plan_name`	O nome do plano tarifário usado para definir o preço do item. Disponível apenas para itens reservados com o código propriedade.	Somente quarto	Near-real-time
`rate_plan_type`	O tipo de tarifa usada para a reserva. Disponível apenas para itens reservados com o código propriedade.	Tarifa de distribuição	Near-real-time
`refundable`	Se o componente da reserva correspondente é reembolsável (verdadeiro) ou não (falso).	true	Near-real-time
`pricing`	Objeto que captura o valor monetário da reserva, discriminado pelo valor bruto da reserva, impostos e taxas.
`pricing.gross_booking_value`	Objeto que captura o valor monetário da reserva.
`pricing.gross_booking_value.billable_currency`	Objeto que representa o valor monetário da reserva na moeda utilizada para o pagamento.
`pricing.gross_booking_value.billable_currency.currency`	Moeda em que a reserva é paga pelo cliente. Representada no formato ISO 4217.	GBP	Tempo real
`pricing.gross_booking_value.billable_currency.value`	O valor bruto da reserva.	2.520,80	Tempo real
`pricing.taxes_and_fees`	O valor e a moeda dos impostos e taxas da reserva.
`pricing.taxes_and_fees.billable_currency`	O valor monetário dos impostos e taxas da reserva, na moeda utilizada para o pagamento.
`pricing.taxes_and_fees.billable_currency.currency`	Moeda em que a reserva é paga pelo cliente. Representada no formato ISO 4217.	GBP	Tempo real
`pricing.taxes_and_fees.billable.currency.value`	O valor bruto da reserva.	491,10	Tempo real

coupon

Nome do campo	Definição	Exemplo	Disponibilidade
`code`	O código de cupom usado para a reserva.	ABCD	Near-real-time
`name`	O nome do cupom.	PRIME	Near-real-time
`description`	A descrição do cupom.	BoGo 5%	Near-real-time
`currency`	A moeda na qual o valor do cupom foi aplicado. Representada no formato ISO 4217.	GBP	Near-real-time
`value`	O valor monetário do cupom.	126,04	Near-real-time

Observações para todos os campos da Plataforma de Viagens White Label

Os campos de data estão em Tempo Universal Coordenado (UTC).
** Isto representa dados de Informação de Identificação Pessoal (PII). Certifique-se de lidar com isso corretamente, seguindo as diretrizes da sua empresa. Incluir somente quando absolutamente necessário.

Programa de Afiliados para Agentes de Viagens (TAAP)

Nome do campo	Definição	Exemplo	Disponibilidade
`itinerary_id`	O número do itinerário ou número de referência do pedido do ponto de venda.	72622069245694	Tempo real
`agency_reference_code`	Um itinerário personalizado fornecido pela agência no momento do pagamento.	86549B_GB	Tempo real
`status`	O status do itinerário e dos seus itens individuais.	Valores possíveis: confirmado cancelado	Near-real-time
`creation_date`*	A data em que uma reserva foi feita inicialmente, representada no formato de data ISO 8601 (YYYY-MM-DD).	2023-02-05	Tempo real
`update_date_time`*	A data e hora da última 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	Tempo real
`online`	Indica se o itinerário foi reservado online (verdadeiro) ou por meio de um agente (falso). Representado como um booleano.	true	Near-real-time
`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	Near-real-time
`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 para o 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`	Detalhes da comissão referente a um item da reserva ou ao itinerário completo. Consulte a tabela `earnings` para ver uma lista dos itens aninhados.

purchaser

Esses campos identificam a pessoa que vai viajar.

Nome do campo	Definição	Exemplo	Disponibilidade
`purchaser.email`**	Endereço de e-mail do viajante.	smith@exemplo.com	Tempo real
`purchaser.first_name`**	Primeiro nome do viajante.	Jane	Tempo real
`purchaser.last_name`**	Sobrenome do viajante.	Smith	Tempo real

agência

Esses campos identificam a agência TAAP e o agente que fez a reserva.

Nome do campo	Definição	Exemplo	Disponibilidade
`agency.name`	Nome da agência TAAP que fez a reserva.	Viagens pelo mundo	Near-real-time
`agency.id`	Código de rastreamento da agência TAAP que fez a reserva.	WS02555	Tempo real
`agency.agent.first_name`**	Primeiro nome do agente da TAAP que fez a reserva.	Bob	Tempo real
`agency.agent.last_name`**	Sobrenome do agente da TAAP que fez a reserva.	Jones	Tempo real
`agency.agent.email`**	Endereço de e-mail do agente da TAAP que fez a reserva.	bjones@worldtravel.com	Tempo real

pagamento

Esses campos contêm os detalhes de pagamento do itinerário.

Nome do campo	Definição	Exemplo	Disponibilidade
`payment_type`	A forma de pagamento usada na compra.	Valores possíveis: cartão de crédito pontos Pagamento dividido	Tempo real
`status`	Indica se o itinerário já foi pago.	Valores possíveis: pago Não remunerado	Near-real-time
`deferred`	Se o pagamento do itinerário foi adiado (verdadeiro) ou pago (falso). Representado como um booleano.	true	Near-real-time
`payment_due_date`	A data de vencimento do pagamento está no formato de data ISO 8601 (YYYY-MM-DD). Aplicável somente a pagamentos diferidos.	2023-02-05	Near-real-time
`payee`	Indica quem é o responsável pelo pagamento do itinerário.	Valores possíveis: agência cliente	Near-real-time

property_booking_items

Estes campos listam os componentes de acomodação reservados como parte do itinerário.

Nome do campo	Definição	Exemplo	Disponibilidade
`booking_item_id`	Identificador de um item específico reservado como parte de um itinerário.	1400882912	Tempo real
`status`	Status do item de acomodação específico.	Valores possíveis: confirmado cancelado	Tempo real
`checkin_date`*	Data de check-in do item de acomodação correspondente. Representado no formato de data ISO 8601 (YYYY-MM-DD).	2023-02-01	Tempo real
`checkout_date`*	Data de check-out do item de acomodação correspondente. Representado no formato de data ISO 8601 (YYYY-MM-DD).	2023-02-05	Tempo real
`property.id`	Expedia Group é o identificador único do hotel ou aluguel de temporada propriedade	1400882912	Near-real-time
`property.chain_name`	Nome da rede à qual a propriedade pertence, quando aplicável.	Independent	Near-real-time
`property.brand_name`	Nome da marca à qual a propriedade pertence, quando aplicável. Uma rede pode ter várias marcas.	Savoy Signature	Near-real-time
`property.name`	Nome do hotel ou aluguel por temporada.	Hotel 1	Tempo real
`property.city`	Nome da cidade onde está a propriedade.	Toronto	Tempo real
`property.state_province_name`	Nome do estado ou província onde está a propriedade.	Ontário	Near-real-time
`property.country_code`	Código do país onde está a propriedade. Representado com duas letras, no formato ISO 3166-1 alpha-2.	CA	Tempo real
`property.star_rating`	Classificação por estrelas da propriedade.	3.0	Near-real-time
`room_name`	O tipo de quarto reservado, conforme definido pelo hotel ou pela empresa de aluguel de temporada.	Quarto duplo confortável com banheiro privativo.	Near-real-time
`adult_count`	Número de adultos incluídos na reserva.	2	Tempo real
`child_count`	Número de crianças incluídas na reserva.	0	Tempo real
`expedia_collect`	Valor booleano que indica se a reserva foi paga no momento em que foi feita (true) ou se deve ser paga direto ao fornecedor (false).	true	Near-real-time
`property_confirmation_id`	Número de confirmação fornecido pelo hotel ou pela empresa de aluguel de temporada.	1516171819	Near-real-time
`rate`	Os detalhes do preço e da tarifa da reserva de acomodação. Consulte a tabela `rate` para ver uma lista dos itens aninhados.
`earnings`	Detalhes da comissão referente à reserva de hospedagem. Consulte a tabela `earnings` para ver uma lista dos itens aninhados.

flight_booking_items

Estes campos listam os componentes aéreos reservados como parte do itinerário.

Nome do campo	Definição	Exemplo	Disponibilidade
`booking_item_id`	Identificador de um item específico reservado como parte de um itinerário.	1400882911	Tempo real
`status`	Status do item de viagem aérea específico.	Valores possíveis: confirmado cancelado	Tempo real
`departure_date`*	Data de início do item de viagem aérea correspondente. Representado no formato de data ISO 8601 (YYYY-MM-DD).	2023-02-01	Tempo real
`arrival_date`*	Data de término do item de viagem aérea correspondente. Representado no formato de data ISO 8601 (YYYY-MM-DD).	2023-02-02	Tempo real
`airline.plating_carrier_name`	Nome da companhia aérea que emitiu a passagem.	Air Canada	Near-real-time
`airline.plating_carrier_code`	IATA é o código da companhia aérea que emitiu a passagem.	AC	Tempo real
`carrier_pnr`	Nome do passageiro registrado junto à companhia aérea que emitiu a passagem.	SMITH	Near-real-time
`trip_type`	O tipo de viagem reservada.	Valores possíveis: one way round trip multiple destinations	Near-real-time
`fare_class`	A classe de tarifa do bilhete.	Econômica	Near-real-time
`airport_origin_code`	O código IATA corresponde ao aeroporto de origem.	LHR	Tempo real
`airport_origin_location`	A localização do aeroporto de origem.	Londres, GB (LHR-Heathrow)	Near-real-time
`airport_destination_code`	O código do aeroporto de destino. Representado no formato IATA.	YYZ	Tempo real
`airport_destination_location`	A localização do aeroporto de destino.	Toronto, ON (YYZ-Aeroporto Int. Lester B. Pearson)	Near-real-time
`ticket_number`	Número do bilhete do voo.	123456789101	Near-real-time
`expedia_collect`	Valor booleano que indica se a reserva foi paga no momento em que foi feita (true) ou se deve ser paga direto ao fornecedor (false).	true	Near-real-time
`segment_count`	O número de trechos de voo do bilhete.	1	Near-real-time
`rate`	Os detalhes do preço e da tarifa da reserva de voo. Consulte a tabela `rate` para ver uma lista dos itens aninhados.
`earnings`	Detalhes da comissão referente à reserva do voo. Consulte a tabela `earnings` para ver uma lista dos itens aninhados.

car_booking_items

Estes campos listam os carros reservados como parte do itinerário.

Nome do campo	Definição	Exemplo	Disponibilidade
`booking_item_id`	Identificador de um item específico reservado como parte de um itinerário.	1400882910	Tempo real
`status`	Status do item de viagem carro específico.	Valores possíveis: confirmado cancelado	Tempo real
`pickup_date`*	Data de início do item de viagem carro. Representado no formato de data ISO 8601 (YYYY-MM-DD).	2023-02-02	Tempo real
`return_date`*	Data de término do item de viagem carro. Representado no formato de data ISO 8601 (YYYY-MM-DD).	2023-02-05	Tempo real
`rental_company.name`	Nome da locadora de carros.	Hertz	Tempo real
`car_type`	Tipo de carro alugado.	Compacto de 2/4 portas	Near-real-time
`pickup_location`	Local de retirada do carro.	Deer Lake, NL (YDF-Aeroporto Regional de Deer Lake)	Tempo real
`pickup_country_code`	Código do país do local de retirada do carro. Representado com duas letras, no formato ISO 3166-1 alpha-2.	CA	Tempo real
`return_location`	Local de devolução do carro.	Deer Lake, NL (YDF-Aeroporto Regional de Deer Lake)	Tempo real
`return_country_code`	Código do país do local de devolução do carro. Representado com duas letras, no formato ISO 3166-1 alpha-2.	CA	Tempo real
`trip_type`	O tipo de viagem reservada.	Valores possíveis: one way round trip multiple destinations	Near-real-time
`rental_company_confirmation_id`	Número de confirmação fornecido pela locadora de veículos.	ABC1234	Near-real-time
`expedia_collect`	Valor booleano que indica se a reserva foi paga no momento em que foi feita (true) ou se deve ser paga direto ao fornecedor (false).	false	Near-real-time
`rate`	Os detalhes do preço e da tarifa da reserva de carro. Consulte a tabela `rate` para ver uma lista dos itens aninhados.
`earnings`	Detalhes da comissão referente à reserva do carro. Consulte a tabela `earnings` para ver uma lista dos itens aninhados.

activity_booking_items

Estes campos listam as atividades reservadas como parte do itinerário.

Nome do campo	Definição	Exemplo	Disponibilidade
`booking_item_id`	Identificador de um item específico reservado como parte de um itinerário.	1400882910	Tempo real
`status`	Status da atividade específica.	Valores possíveis: confirmado cancelado	Tempo real
`activity_start_date`*	Data de início da atividade. Representado no formato de data ISO 8601 (YYYY-MM-DD).	2023-02-03	Tempo real
`activity_end_date`*	Data de término da atividade. Representado no formato de data ISO 8601 (YYYY-MM-DD).	2023-02-03	Tempo real
`vendor.name`	Nome do fornecedor que oferece a atividade.	Excursões da Olivia	Tempo real
`vendor.city`	Cidade onde está o fornecedor da atividade.	Deer Lake, NL (YDF-Aeroporto Regional de Deer Lake)	Tempo real
`vendor.country_code`	Código do país onde está o fornecedor da atividade. Representado com duas letras, no formato ISO 3166-1 alpha-2.	CA	Tempo real
`offering_name`	Nome da atividade.	Caminhada pela trilha do rio Humber	Near-real-time
`expedia_collect`	Valor booleano que indica se a reserva foi paga no momento em que foi feita (true) ou se deve ser paga direto ao fornecedor (false).	true	Near-real-time
`rate`	Os detalhes do preço e da tarifa da reserva de atividade. Consulte a tabela `rate` para ver uma lista dos itens aninhados.
`earnings`	Detalhes da comissão referente à reserva da atividade. Consulte a tabela `earnings` para ver uma lista dos itens aninhados.

rate

Nome do campo	Definição	Exemplo	Disponibilidade
`refundable`	Se o componente da reserva correspondente é reembolsável (verdadeiro) ou não (falso).	true	Near-real-time
`pricing`	Objeto que captura o valor monetário da reserva, discriminado pelo valor bruto da reserva, impostos e taxas.
`pricing.gross_booking_value`	O valor monetário da reserva, incluindo impostos e taxas.
`pricing.gross_booking_value.billable_currency`	O valor monetário da reserva, na moeda utilizada para o pagamento.
`pricing.gross_booking_value.billable_currency.currency`	Moeda em que a reserva é paga pelo cliente. Representada no formato ISO 4217.	GBP	Tempo real
`pricing.gross_booking_value.billable_currency.value`	O valor bruto da reserva.	2.520,80	Tempo real
`pricing.taxes_and_fees`	O valor e a moeda dos impostos e taxas da reserva.
`pricing.taxes_and_fees.billable_currency`	O valor monetário dos impostos e taxas da reserva, na moeda utilizada para o pagamento.
`pricing.taxes_and_fees.billable_currency.currency`	Moeda em que a reserva é paga pelo cliente. Representada no formato ISO 4217.	GBP	Tempo real
`pricing.taxes_and_fees.billable.currency.value`	O valor bruto da reserva.	491,10	Tempo real

ganhos

Nome do campo	Definição	Exemplo	Disponibilidade
`commission`	Objeto que representa o valor da comissão da reserva ou do item, incluído no valor bruto da reserva.
`commission.billable_currency`	Objeto que representa o valor da comissão na moeda de pagamento.
`commission.billable_currency.currency`	Moeda do valor da comissão, representada no formato ISO 4217.	US$	Tempo real
`commission.billable_currency.value`	Valor monetário da comissão.	100.25	Tempo real
`service_charge`	Objeto que representa as taxas de serviço aplicadas por uma agência TAAP ao itinerário.
`service_charge.amount`	Objeto que representa o valor monetário da taxa de serviço aplicada por uma agência TAAP ao itinerário.
`service_charge.amount.billable_currency`	Objeto que representa o valor da taxa de serviço na moeda de pagamento.
`service_charge.amount.billable_currency.currency`	Moeda do valor da taxa de serviço, representada no formato ISO 4217.	US$	Tempo real
`service_charge.amount.billable_currency.value`	Valor monetário das taxas de serviço aplicadas pela agência TAAP ao itinerário.	50,50	Tempo real
`service_charge.taxes_and_fees`	Objeto que representa o valor e a moeda dos impostos e taxas referentes à taxa de serviço.
`service_charge.taxes_and_fees.billable_currency`	Objeto que representa o valor monetário dos impostos e taxas referentes à taxa de serviço, na moeda de pagamento.
`service_charge.taxes_and_fees.billable_currency.currency`	Moeda de pagamento, representada no formato ISO 4217.	US$	Tempo real
`service_charge.taxes_and_fees.billable_currency.value`	Valor dos impostos e taxas pagos pelo cliente, na moeda de cobrança.	5,25	Tempo real

Notas para todos os campos TAAP

Os campos de data estão em Tempo Universal Coordenado (UTC).
** Isto representa dados de Informação de Identificação Pessoal (PII). Certifique-se de lidar com isso corretamente, seguindo as diretrizes da sua empresa. Incluir somente quando absolutamente necessário.

Detalhes da API

Fornecemos um resumo 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 OpenAPI e usar uma ferramenta de teste de API para entender como os exemplos e as configurações de esquema se comparam à saída real.

Plataforma de viagens sem marca

Os campos, incluindo quaisquer objetos aninhados, disponíveis para nossos parceiros da Plataforma de Viagens White Label 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 nosso método de entrega push são: