API de itinerários

Acesse dados de reserva quase em tempo real para os seus clientes

Com a nossa API de itinerários, você pode exibir as informações de reserva dos seus clientes e ajudar essas pessoas a encontrar produtos ou serviços relacionados a reservas, como passeios ou experiências. Você também pode usar os dados dessa API para analisar tendências de reserva e criar relatórios para as partes interessadas.

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.

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: booked cancelled
`creation_date`*	A data em que a reserva foi feita de início, representada no formato de data ISO8601: AAAA-MM-DD.	2023-02-05
`update_date_time`*	A data e a hora da última atualização do itinerário, representadas no formato de data ISO8601 (AAAA-MM-dd'T"HH:mm:ss.SSSZ).	2023-10-21T00:00:00.000-08:00
`online`	Indica se o itinerário foi reservado on-line ou por meio de um agente. Representado como um booleano.	true
`package`	Indica se o itinerário foi reservado on-line ou por meio de um agente. 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.

purchaser

Estes campos identificam a pessoa que fez a reserva.

Nome do campo	Definição	Exemplo
`purchaser.email`**	Endereço de e-mail da pessoa que fez a reserva.	smith@exemplo.com
`purchaser.loyalty_id`**	Identificador da associação ao programa de fidelidade.	12345678

property_booking_items

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

Nome do campo	Definição	Exemplo
`booking_item_id`	Identificador de um item específico reservado como parte de um itinerário.	1400882912
`status`	Status do item de acomodação específico.	Valores possíveis: booked cancelled
`checkin_date`*	Data de check-in do item de acomodação correspondente. Representada no formato de data ISO8601: AAAA-MM-DD.	2023-02-01
`checkout_date`*	Data de check-out do item de acomodação correspondente. Representada no formato de data ISO8601: AAAA-MM-DD.	2023-02-05
`property.id`	Identificador exclusivo do Expedia Group para o hotel ou propriedade de aluguel por temporada.	1400882912
`property.chain_name`	Nome da rede à qual a propriedade pertence, quando aplicável.	Independent
`property.brand_name`	Nome da marca à qual a propriedade pertence, quando aplicável. Uma rede pode ter várias marcas.	Savoy Signature
`property.name`	Nome do hotel ou aluguel por temporada.	Hotel 1
`property.city`	Nome da cidade onde está a propriedade.	Toronto
`property.state_province_name`	Nome do estado ou província onde está a propriedade.	Ontário
`property.country_code`	Código do país onde está a propriedade. Representado com duas letras, no formato ISO 3166-1 alpha-2.	CA
`property.star_rating`	Classificação por estrelas da propriedade.	3
`room_name`	O tipo de quarto reservado.	Quarto de casal Conforto, banheiro privativo
`adult_count`	Número de adultos incluídos na reserva correspondente.	2
`child_count`	Número de crianças incluídas na reserva correspondente.	0
`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
`property_confirmation_id`***	O ID de confirmação fornecido pelo hotel ou empresa de aluguel por temporada.	1516171819
`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
`booking_item_id`	Identificador de um item específico reservado como parte de um itinerário.	1400882911
`status`	Status do item de viagem aérea específico.	Valores possíveis: booked cancelled
`departure_date`*	Data de início do item de viagem aérea correspondente. Representada no formato de data ISO8601: AAAA-MM-DD.	2023-02-01
`arrival_date`*	Data de término do item de viagem aérea correspondente. Representada no formato de data ISO8601: AAAA-MM-DD.	2023-02-02
`airline.plating_carrier`	Nome da companhia aérea em nome da qual o bilhete foi emitido.	Air Canada
`carrier_pnr`	Nome registrado do passageiro.	SMITH
`trip_type`	O tipo de viagem reservada.	Valores possíveis: one way round trip multiple destinations
`fare_class`	A classe de tarifa do bilhete.	Econômica
`airport_origin_code`	O código do aeroporto de origem. Representado no formato IATA (Associação Internacional de Transporte Aéreo)	LHR
`airport_origin_location`	A localização do aeroporto de origem.	Londres, GB (LHR-Heathrow)
`airport_destination_code`	O código do aeroporto de destino. Representado no formato IATA.	YYZ
`airport_destination_location`	A localização do aeroporto de destino.	Toronto, ON (YYZ-Aeroporto Int. Lester B. Pearson)
`ticket_number`	Número do bilhete do voo.	123456789101
`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
`segment_count`	O número de segmentos de voo da passagem aérea.	1
`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
`booking_item_id`	Identificador de um item específico reservado como parte de um itinerário.	1400882910
`status`	Status do item de viagem carro específico.	Valores possíveis: booked cancelled
`pickup_date`*	Data de início do item de viagem carro. Representada no formato de data ISO8601: AAAA-MM-DD.	2023-02-02
`return_date`*	Data de término do item de viagem carro. Representada no formato de data ISO8601: AAAA-MM-DD.	2023-02-05
`rental_company.name`***	Nome da locadora de carros.	Hertz
`car_type`***	Tipo de carro alugado.	Compacto de 2/4 portas
`pickup_location`	Local de retirada do carro.	Deer Lake, NL (YDF-Aeroporto Regional de Deer Lake)
`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
`return_location`	Local de devolução do carro.	Deer Lake, NL (YDF-Aeroporto Regional de Deer Lake)
`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
`trip_type`	O tipo de viagem reservada.	Valores possíveis: one way round trip multiple destinations
`rental_company_confirmation_id`***	O ID de confirmação fornecido pela locadora de carros.	ABC1234
`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
`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
`booking_item_id`	Identificador de um item específico reservado como parte de um itinerário.	1400882910
`status`	Status da atividade específica.	Valores possíveis: booked cancelled
`activity_start_date`*	Data de início da atividade. Representada no formato de data ISO8601: AAAA-MM-DD.	2023-02-03
`activity_end_date`*	Data de término da atividade. Representada no formato de data ISO8601: AAAA-MM-DD.	2023-02-03
`vendor.name`***	Nome do fornecedor que oferece a atividade.	Viator
`vendor.city`***	Cidade onde está o fornecedor da atividade.	Deer Lake, NL (YDF-Aeroporto Regional de Deer Lake)
`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
`offering_name`***	Nome da atividade.	Passions of Paradise Great Barrier Reef
`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
`booking_item_id`	Identificador de um item específico reservado como parte de um itinerário.	1400882610
`status`	Status do seguro específico selecionado.	Valores possíveis: booked cancelled
`rate`	Detalhes do preço e da tarifa do seguro selecionado. Consulte a tabela `rate` para ver uma lista dos itens aninhados.

rate e pricing

Estes campos listam os detalhes do preço e da tarifa de um item da reserva ou de todo o itinerário.

rate

Nome do campo	Definição	Exemplo
`rate_plan_name`	O nome do plano tarifário usado para definir o preço do item. Disponível somente para property_booking_items.	Somente quarto
`rate_plan_type`	O tipo de tarifa usada para a reserva. Disponível somente para property_booking_items.	Tarifa de distribuição
`refundable`	Se o componente de reserva correspondente é reembolsável.	true

pricing

Este campo tem valores aninhados que descrevem o valor monetário da reserva, detalhando o valor bruto da reserva e os impostos e taxas. Os campos também são aninhados para permitir flexibilidade.

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. Todos os campos nesta tabela estão aninhados na variável pricing.

Nome do campo	Definição	Exemplo
`taxes_and_fees`	O valor e a moeda dos impostos e taxas da reserva. Veja os itens aninhados abaixo.
`gross_booking_value`	O valor monetário da reserva, incluindo impostos e taxas.	2.523,00
`taxes_and_fees.billable_currency`	O valor monetário dos impostos e taxas da reserva, na moeda utilizada para o pagamento. Aninhado na variável `taxes_and_fees`. Veja os itens aninhados abaixo.
`gross_booking_value.billable_currency`	O valor monetário da reserva, na moeda utilizada para o pagamento. Aninhado na variável `gross_booking_value`. Veja os itens aninhados abaixo.
`billable_currency.currency`	Moeda em que a reserva é paga pelo cliente. Representada no formato ISO 4217. Aninhado na variável `billable_currency`.	GBP
`billable.currency.value`	O valor bruto da reserva. Aninhado na variável `billable_currency`.	2.520,80
`billable_currency.currency`	Moeda em que os impostos e taxas são pagos pelo cliente. Representada no formato ISO 4217. Aninhado na variável `billable_currency`.	GBP
`billable_currency.value`	Valor dos impostos e taxas pagos pelo cliente, na moeda de cobrança. Aninhado na variável `billable_currency`.	491,10

coupon

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

*Os campos de data estão no horário do Tempo Universal Coordenado (UTC).

**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 serão disponibilizados entre as 18h e as 20h (UTC) do dia seguinte à criação ou atualização da reserva. Não está disponível quase em tempo real.

Métodos de entrega

A API de itinerários fornece dados de duas maneiras: mecanismo push e mecanismo pull.

Mecanismo push

O serviço push foi criado para enviar atualizações de itinerário assim que elas estiverem disponíveis, quase em tempo real, com foco nos principais detalhes do itinerário. Esse serviço é para os seguintes casos de uso:

Permitir que parceiros exibam as informações de reserva dos clientes em seus sites ou aplicativos
Permitir que parceiros comercializem produtos e serviços relacionados às reservas

Os eventos serão entregues por meio de um Webhook para o URL fornecido, no formato de uma mensagem HTTP POST. Essas mensagens podem chegar fora de ordem. Consulte os itens creation_date e update_date_time para determinar a ordem.

Para saber detalhes sobre o processo de autenticação, consulte Introdução.

Mecanismo pull

O serviço pull fornece dados detalhados do itinerário para dar suporte a casos de uso, incluindo:

Permitir a análise de dados
Permitir a recuperação de dados dos períodos em que a entrega push falhou
Permitir o atendimento da equipe de suporte em tempo real

Este serviço consiste em dois pontos de extremidade HTTP GET: um disponibiliza uma lista de itinerários criados ou atualizados em um intervalo de tempo especificado, e o outro recupera itinerários específicos pelo seu ID. Os parâmetros da consulta são:

creation_date_start
creation_date_end
update_date_time_start
update_date_time_end
itinerary_id

Para saber detalhes sobre o processo de autenticação, consulte Introdução.

Detalhes da API

Explore as definições dos pontos de extremidade nesta página e use um software de teste de API para comparar os exemplos e as definições de esquemas com o resultado real.