Recupere uma lista de hotéis por localização ou uma lista de hotelIds.

específicas. Esse método pode ser usado para retornar hotéis com quartos disponíveis em um intervalo de datas fornecido ou uma lista de todos os estabelecimentos ativos no local especificado sem informações de disponibilidade.

Esse método oferece suporte a vários filtros e métodos de especificação do local desejado para permitir uma variedade de opções de busca inicial, como a busca por código de aeroporto ou por visualização em um mapa.

Formatos de solicitação
URL em XML/REST: GET http://api.ean.com/ean-services/rs/hotel/v3/list?
Elemento pai XML: <HotelListRequest>

Requisitos exclusivos de protocolo
REST
Parâmetros de solicitação
Toda busca por hotéis disponíveis requer um intervalo de datas mínimo, contagem de quartos e de hóspedes adultos e um local ou uma lista de hotelId.

Para obter uma "lista sem data" ou uma lista de todos os estabelecimentos ativos em um local sem informações de disponibilidade específicas, basta omitir os parâmetros arrivalDate, departureDate e RoomGroup da sua solicitação.

Parâmetros base
Nome Valor Obrigatório Descrição
apiExperience string sim

Use esse atributo para identificar a origem de sua solicitação. Selecione um valor aplicável do conjunto fornecido abaixo para cada solicitação enviada.

Valores:
PARTNER_CALL_CENTER - solicitação de um agente na central de atendimento
PARTNER_WEBSITE - solicitação de um site direcionado aos clientes
PARTNER_MOBILE_WEB - solicitação de um site formatado para dispositivos móveis
PARTNER_MOBILE_APP - solicitação de um app para dispositivo móvel
PARTNER_BOT_CACHE - solicitação de um robô de cache
PARTNER_BOT_REPORTING - solicitação de um robô de relatório
PARTNER_AFFILIATE - solicitação de uma API/plataforma usada por sua própria base de afiliados

arrivalDate string sim para disponibilidade

Data do check-in, no formato MM/DD/AAAA.

Inclua a data de hoje para solicitar disponibilidade no mesmo dia. As reservas podem ser feitas até 23h59 do horário local do hotel (21h59 para PST e Ilhas do Pacífico).

departureDate string sim para disponibilidade Data do check-out, no formato MM/DD/AAAA.

A disponibilidade pode ser pesquisada com até 500 dias de antecedência dessa data.

O tempo total de estadia não pode ultrapassar 28 noites.
numberOfResults int não Número máximo de hotéis a ser retornado por resposta (antes de ser necessário localizar resultados adicionais). O intervalo de valores aceitável é de 1 a 200. Padrão: 20

Não limita resultados para uma solicitação de lista sem data.
RoomGroup object sim para disponibilidade Contêiner para as matrizes Room que definem a contagem de quartos e de hóspedes. Para REST, consulte a seção abaixo.
RoomGroup.Room array sim para disponibilidade O número de nós Room define o número de quartos solicitados. Cada nó tem sua própria contagem de hóspedes adultos/crianças.

Os estabelecimentos permitem até 8 quartos por reserva.
Room.numberOfAdults int sim para disponibilidade Contagem de hóspedes adultos para o quarto.

Os estabelecimentos normalmente acomodam no máximo 4 hóspedes antes de incorrer taxas extras por pessoa.

Não ofereça mais do que 8 hóspedes por quarto porque não haverá resultados acima dessa quantidade de hóspedes na a maioria dos mercados.
Room.numberOfChildren int sim se > 0 Contagem de hóspedes crianças para o quarto. Obrigatório para todos os estabelecimentos. Usado em combinação com childAges para determinar disponibilidade e tarifas.
Room.childAges lista separada por vírgulas
ou matriz de int
sim se a contagem de crianças > 0 Envie as idades individuais das crianças no quarto como uma lista separada por vírgulas para XML e REST e como uma matriz de valores individuais de childAges para SOAP.

Sempre solicite essas informações dos clientes quando hóspedes crianças forem especificados. Pode haver taxas extras inesperadas por pessoa se as idades das crianças não forem fornecidas antes da reserva.
includeDetails boolean não

Retorna as políticas de cancelamento, tipos de cama e preferências de fumante/não fumante por quarto, quando disponíveis.

Retorna elementos adicionais somente com minorRev=22 ou superior.

includeHotelFeeBreakdown boolean não Retorna o elemento HotelFeeBreakdown, que contém uma estrutura de resposta mais detalhada para a matriz HotelFees, que inclui a frequência com que cada taxa é aplicada e como é aplicada. Disponível com minorRev=24 e superior.
Formato de quartos para REST
O formato REST compacta os valores dos elementos anteriores em uma lista separada por vírgulas. Para declarar um quarto e seus ocupantes, use o seguinte formato:

&room[room number, starting with 1]=
[number of adults],
[comma-delimited list of children's ages]


Por exemplo, para declarar que um quarto tem um adulto e duas crianças com 5 e 12 anos, você enviaria &room1=1,5,12. Não há nenhuma declaração separada para o número de crianças; pressupõe-se que cada valor de idade pertence a uma criança.


Principais métodos de busca
Existem quatro principais métodos de busca disponíveis para limitar a seleção de hotéis retornados em uma solicitação, apresentados abaixo em ordem aleatória.
Três deles limitam a seleção por um local definido, e um deles permite que um conjunto explícito de hotéis seja retornado em uma lista de hotelIds específicas.
Use somente um método de cada vez.


Método 1: busca por cidade/estado/país
Nome Valor Obrigatório para o método de pesquisa Descrição
city string sim
Cidade na qual buscar. Use somente nomes completos de cidade.
stateProvinceCode string sim para Estados Unidos,
Canadá e Austrália
Código de dois caracteres do estado/província que contém a cidade especificada. No caso da Austrália, você deverá usar os códigos especiais fornecidos abaixo.

Referências:
Códigos de estado nos EUA
Códigos de província/território no Canadá
Códigos de província/território na Austrália
  • Capital da Austrália - AC
  • Nova Gales do Sul - NW
  • Território do Norte - NO
  • Queensland - QL
  • Austrália Meridional - SA
  • Tasmânia - TS
  • Victoria - VC
  • Austrália Ocidental - WT
countryCode string sim
Código de dois caracteres ISO-3166 do país que contém a cidade especificada. Use somente códigos de país designados como "oficialmente atribuídos" na tabela de decodificação ISO-3166.


Método 2: uso de cadeia de caracteres de destino de texto livre
Nome Valor Obrigatório para o método de pesquisa Descrição
destinationString string sim Uma cadeia de caracteres contendo pelo menos um nome de cidade. Também é possível enviar cidade e estado, cidade e país, cidade/estado/país, etc.

Este parâmetro é a melhor opção para obter informações diretas do cliente.

As entradas ambíguas retornarão um erro contendo uma lista de possíveis localizações desejadas.


Método 3: uso de uma lista de hotelIds
Nome Valor Obrigatório para o método de pesquisa Descrição
hotelIdList lista separada por vírgulas
de long
sim Verifique a disponibilidade em um conjunto fixo de hotéis. Envie os valores de hotelId desejados em uma lista delimitada por vírgulas.

Se uma ordem de classificação não for especificada, os hotéis serão ordenados de acordo com o algoritmo otimizado padrão da EAN. Use a opção de classificação NO_SORT para manter a ordem da lista.

Qualquer valor hotelId inválido será retornado sob o cabeçalho de resposta Invalid-Hotel-Ids como uma lista separada por vírgulas:
Vary: Accept-Encoding 
Content-Length: 1562
Avail-Source: 1
Invalid-Hotel-Ids: 1234,6645353
Transaction-Id: d85a243e-b61d-11e5-a89b-0b34b1565000
Ao usar listas longas, esteja ciente de que os tempos de resposta podem aumentar visivelmente em comparação com listas menores com várias solicitações. Use POST em vez de GET ao enviar listas longas via REST. O limite máximo é de 2.500 IDs de hotel por solicitação.


Método 4: busca em uma área geográfica
Nota: este método também pode ser usado para procurar aeroportos em conjunto com o arquivo de coordenadas de aeroportos
Nome Valor Obrigatório para o método de pesquisa Descrição
latitude string sim Coordenada de latitude referente ao ponto de origem da busca, no formato DD.MMmmm.
longitude string sim Coordenada de longitude referente ao ponto de origem da busca, no formato DDD.MMmmm.
searchRadius int não Define o raio de uma área de pesquisa circular, com os valores de latitude e longitude fornecidos definindo o centro.
Mínimo de 1 MI ou 2 KM, máximo de 50 MI ou 80 KM. Os valores excedendo o limite máximo serão reduzidos automaticamente antes que os resultados sejam retornados.
O padrão é 20 MI.
searchRadiusUnit string não Define a unidade de distância para o raio da pesquisa. Envie
MI ou KM. O padrão é MI se vazio ou não incluído.
sort string não Você deverá enviar um valor PROXIMITY se quiser que os resultados sejam classificados pela distância do ponto de origem. Caso contrário, será aplicada a ordem de classificação padrão a qualquer hotel que esteja dentro do raio da pesquisa.

Consulte a definição completa deste elemento na próxima seção para todos os valores disponíveis.

Não se aplica a resultados para uma solicitação de lista sem data.
Métodos de pesquisa adicionais
Ofereça estes métodos de pesquisa como opções secundárias para permitir que os clientes façam buscas através de um endereço nas proximidades ou de um hotel específico.


Nome Valor Requer outros parâmetros Descrição
address string sim Procure um endereço próximo ao local. A resposta conterá as proximidades de cada estabelecimento para o endereço fornecido.

Mesmo que o endereço de um determinado hotel seja inserido, seu lugar na ordem de classificação padrão não será substituído se ele ainda não estiver no topo.

Requer que os parâmetros city e countryCode sejam definidos.
postalCode string sim Como alternativa, inclua o código postal de um endereço.

Requer que os parâmetros city e countryCode sejam definidos.
propertyName string sim Forneça um nome para pesquisar a disponibilidade. O valor pode ser um nome exato ou parte de um nome. Por exemplo, "Holiday" ou "Best".

A resposta conterá os estabelecimentos cujos nomes possuem o valor incluído neste parâmetro.

Se um nome de estabelecimento específico for enviado, uma resposta vazia poderá ser retornada se não houver disponibilidade para as datas de estadia fornecidas.

Requer que os parâmetros city e countryCode sejam definidos.

Métodos de filtragem
Estes métodos filtram resultados por comodidades, preço, classificações por estrelas e outros critérios típicos. Eles podem ser oferecidos antes da pesquisa inicial, junto com um método principal, ou usados para atualizar dinamicamente uma página de resultados de busca já existente. Também podem ser utilizados internamente para limitar os resultados disponíveis para clientes. Por exemplo, restringir os estabelecimentos a um nível de estrelas igual ou superior ao determinado.

Nome Valor Obrigatório Descrição
includeSurrounding boolean não Quando enviado como false, esse parâmetro excluirá hotéis de fora da área definida nos seu parâmetros de pesquisa.
Use se desejar impedir que hotéis de outra cidades próximas ou áreas remotas apareçam nos resultados.
propertyCategory int ou lista separada por vírgulas de int não

Filtra resultados por categoria de estabelecimento. Envia um único valor ou uma lista de valores para retornar uma combinação de categorias de estabelecimento.

Nota:
esses valores não correspondem às categorizações nos nossos arquivos de banco de dados estáticos e nem nos outros dados fornecidos pela Expedia.

Valores:
1: hotel
2: suíte
3: resort
4: condo/aluguel para temporada
5: bed & breakfast
6: tudo incluído

amenities int ou lista separada por vírgulas de int não

Não é mais recomendado o uso desse elemento. Os valores desse elemento não coincidem com as comodidades da Expedia nem com os nossos próprios arquivos de banco de dados de comodidades.

Em vez disso, você pode aplicar a filtragem de comodidades após receber uma resposta de uma destas duas maneiras:

1. Decodifique o bitmask do valor amenityMask nos resultados para obter as comodidades discretas de cada estabelecimento. Você pode usar este utilitário de exemplo para verificar o seu código de remoção de máscara: http://sandbox.ean.so/amenity/amenity.php

2. Baixe o arquivo de banco de dados AttributeList localmente e use-o para filtrar hotéis que estejam no local solicitado e que tenham as comodidades filtradas.

maxStarRating float não Filtra resultados por uma classificação máxima por estrelas.
Os valores válidos são 1.0 - 5.0, com acréscimos de 0.5.
minStarRating float não Filtra resultados por uma classificação mínima por estrelas.
Os valores válidos são 1.0 - 5.0, com acréscimos de 0.5.
minRate float não Filtra resultados por estabelecimentos com tarifas iguais ou superiores ao valor fornecido.
Pesquisa em relação ao valor de resposta averageRate (o preço médio das diárias individuais durante as datas de estadia). Válido somente para pesquisas de disponibilidade.
maxRate float não Filtra resultados por estabelecimentos com tarifas iguais ou inferiores ao valor fornecido.
Pesquisa em relação ao valor de resposta averageRate (o preço médio das diárias individuais durante as datas de estadia). Válido somente para pesquisas de disponibilidade.
numberOfBedRooms int não Este parâmetro é válido somente para condos/aluguéis para temporada. Especifica o número de quartos solicitados (4 é o máximo).
maxRatePlanCount int não Define o número de tipos de quarto a retornar com cada estabelecimento.

A definição de um valor maior tentará retornar o número correspondente de tipos de quarto em cada estabelecimento na resposta, dependendo das disponibilidades individuais dos estabelecimentos.

O padrão é 1, no qual é retornado apenas o primeiro tipo de quarto em cada estabelecimento. Em testes para clientes da Expedia, esse valor provou fornecer as melhores taxas de conversão e é recomendável que seja deixado assim como está, poupando a exibição de quartos adicionais durante a fase de seleção do quarto.

Opções de classificação
Recomendamos enviar pesquisas iniciais sem uma ordem de classificação especificada, já que a ordem de classificação padrão é calculada para posicionar no topo os estabelecimentos preferidos e com melhor conversão. Em vez disso, permita que os clientes escolham uma ordem de classificação diferente depois que a lista inicial for retornada.
Nome Valor Obrigatório Descrição
sort string não Preferência de classificação para estabelecimentos retornados.

Valores:
BUDGET

Classifica por lucratividade, dando preferência aos hotéis econômicos de cada mercado. Coloca os hotéis econômicos com a taxa de conversão de visitas em reservas mais favorável no topo.

CHAMPION

Classifica por lucratividade, dando preferência aos hotéis intermediários de cada mercado. Coloca os hotéis intermediários com a taxa de conversão de visitas em reservas mais favorável no topo.

PREMIUM

Classifica por lucratividade, dando preferência aos hotéis de luxo de cada mercado. Coloca os hotéis mais sofisticados com a taxa de conversão de visitas em reservas mais favorável no topo.

HIGH_MARGIN

Com base na classificação CHAMPION, a classificação HIGH_MARGIN dá um passo além, dando preferência a estabelecimentos com o maior percentual de margem, garantindo que os estabelecimentos com alta taxa conversão e grandes margens apareçam próximos ao topo. A classificação HIGH_MARGIN considera custos adicionais no nível do estabelecimento, dando preferência ao percentual de margem do parceiro.

NO_SORT Usado somente em conjunto com hotelIdList. Retorna hotéis na ordem exata listada na solicitação.
CITY_VALUE A ordem de classificação padrão retorna hotéis na mesma ordem como se sort fosse omitido totalmente. Os estabelecimentos na cidade especificada são posicionados acima dos estabelecimentos nas redondezas.
OVERALL_VALUE Posiciona no topo estabelecimentos preferidos e com melhor conversão.
PROMO Posiciona estabelecimentos com tarifa promocional ou valor agregado acima de estabelecimentos que não estão fazendo promoções.
PRICE Classifica os estabelecimentos por diária em ordem crescente. A classificação não é perfeita devido a algoritmos comerciais/de marketing aplicados a listas de estabelecimentos acessadas pela API. A precisão na classificação de preços é melhor obtida no seu próprio código, após o recebimentos dos resultados.
PRICE_REVERSE Classifica os estabelecimentos por diária em ordem decrescente. Conforme detalhado acima, é esperada uma classificação imperfeita.
PRICE_AVERAGE Classifica os estabelecimentos por preço médio de diária em ordem crescente. Conforme detalhado acima, é esperada uma classificação imperfeita.
QUALITY Classifica pelo número de estrelas dos estabelecimentos em ordem decrescente.
QUALITY_REVERSE Classifica pelo número de estrelas dos estabelecimentos em ordem crescente.
ALPHA Classifica os estabelecimentos em ordem alfabética
PROXIMITY Classifica com base na proximidade ao ponto de origem definido por meio dos parâmetros latitude & longitude.
POSTAL_CODE Classifica por código postal, desde códigos com menor valor alfanumérico até os com maior valor.
TRIP_ADVISOR Se você tiver uma integração com o TripAdvisor, aprovada, esse valor classificará os resultados em ordem decrescente de classificação do hóspede.
Solicitação de dados adicionais

Use este parâmetro para limitar a resposta a tipos específicos de dados dinâmicos. Normalmente usado em conjunto com nossos arquivos de banco de dados de hotéis como fontes de informações estáticas fornecidas pela API. As integrações que usam este parâmetro em conjunto com bancos de dados off-line poderão desfrutar de tempos de resposta consideravelmente mais rápidos do que aquelas que se baseiam unicamente em respostas da API.

Nome Valor Obrigatório Descrição
options string ou lista separada por vírgulas
de string
não Define o tipo de dados limitados a retornar. Envie um único valor ou uma combinação em uma lista separada por vírgulas.

Valores:
DEFAULT Retorna todos os três tipos de dados abaixo. A resposta será a mesma como se options fosse omitido totalmente.
HOTEL_SUMMARY

Retorna informações dinâmicas de hotéis com uma quantidade pequena de informações estáticas de identificação (nome e endereço do hotel, descrição do local, hotelId, etc).
Não contém informações dinâmicas de tarifas. A menor resposta de disponibilidade possível.

ROOM_RATE_DETAILS Retorna informações dinâmicas de tarifas de quartos e um mínimo de informações estáticas através de hotelId e roomDescription.
Localização de mais hotéis

Se a resposta inicial retornar moreResultsAvailable como true, a próxima página de resultados poderá ser solicitada através do processo abaixo.

Para localizar mais resultados, apenas supplierType, cacheLocation e cacheKey poderão ser enviados na solicitação de disponibilidade subsequente. Todos os outros parâmetros incomuns deverão ser omitidos.

É necessário incluir o valor supplierType=E na sua solicitação. Caso você não inclua esse valor, moreResultsAvailable poderá retornar erroneamente como true quando a lista já tiver sido esgotada.

Por último, se for retornado um erro informando "cacheLocation cannot be found", significa que o cache expirou e a pesquisa original deverá ser solicitada novamente. As respostas armazenadas no cache duram normalmente de 15 a 30 minutos.

Consulte Localização de mais resultados para ver exemplos.


Nome Tipo Obrigatório para o método Descrição
supplierType string sim Deve enviar com o valor E para permitir que o sistema de localização indique os resultados adicionais de forma precisa.
cacheKey string sim A chave para a resposta armazenada no cache que foi solicitada. Use o valor retornado na resposta da lista de hotéis anterior.
cacheLocation string sim Define o local do servidor da EAN do cache solicitado. Use o valor retornado na resposta da lista de hotéis anterior.
Resposta da lista de hotéis
Retorna hotéis no local especificado com quartos disponíveis para a contagem de hóspedes e as datas de estadia fornecidas.

Se uma "lista sem data" tiver sido solicitada por meio da omissão de arrivalDate, departureDate e RoomGroup, a resposta conterá todos os hotéis ativos no local determinado sem informações de disponibilidade específicas.

Conteúdo da resposta
Elemento pai: HotelListResponse


Nome Valor Descrição
moreResultsAvailable boolean Indica se há mais resultados de estabelecimentos disponíveis para a página.

Se for true, mais resultados poderão ser obtidos por meio do processo de localização.
numberOfRoomsRequested int Confirma o número de quartos solicitados originalmente (número de nós Room)
cacheKey string A chave para o cache da resposta atual retornada. Use este valor na sua próxima solicitação de localização.
cacheLocation string Define o local do servidor da EAN do cache para a resposta atual retornada. Use este valor na sua próxima solicitação de localização.
HotelList contêiner para a matriz HotelSummary

Contém atributos size, para indicar o número de estabelecimentos individuais na resposta, e activePropertyCount, para indicar o total de estabelecimentos ativos (não necessariamente disponíveis) no local especificado.

HotelList.HotelSummary object Matriz de hotéis individuais. As informações para cada resultado de hotéis estão contidas em seu próprio nó HotelSummary.
Contém o atributo order, que indica a ordem numérica original de cada hotel para ajudar a restaurar com base na reclassificação dinâmica (a sequência começa em 0, e não em 1).
HotelSummary.hotelId long ID do estabelecimento. Essa mesma ID será usada em qualquer solicitação de reserva ou quarto subsequente.
HotelSummary.name string Nome do hotel
HotelSummary.address1 string Endereço do hotel
HotelSummary.city string Cidade do hotel
HotelSummary.stateProvinceCode string Código de dois caracteres do estado/província que contém a cidade especificada. Retorna códigos de país somente para EUA, Canadá e Austrália.

Referências:
Códigos de estado nos EUA
Códigos de província/território no Canadá
Códigos de província/território na Austrália
HotelSummary.countryCode string Código de dois caracteres ISO-3166 do país no qual o hotel está localizado
HotelSummary.postalCode string Código postal do hotel
HotelSummary.airportCode string Código do aeroporto associado ao hotel
HotelSummary.supplierType string Fornecedor do hotel. Esse mesmo fornecedor será usado para processar as reservas feitas.

Valores:
E: Expedia Collect
HotelSummary.propertyCategory string A categoria do estabelecimento retornado.

Valores:
1: hotel
2: suíte
3: resort
4: condo/aluguel para temporada
5: bed & breakfast
6: tudo incluído
HotelSummary.hotelRating float Classificação por estrelas (0 a 5) do hotel. Um valor 0.0 ou em branco indica que ele não tem nenhuma estrela.
HotelSummary.hotelRatingDisplay string Retorna Star ou Alternate para indicar a fonte e o tipo de exibição obrigatória do valor de hotelRating.

Atualmente, apenas os pontos de venda na Austrália devem seguir os indicadores de exibição fornecidos. Futuramente, outras jurisdições serão adicionadas.

Star indica que a classificação é fornecida pela autoridade de classificação por estrelas na localidade do hotel. Use as estrelas para exibir a hotelRating.

Alternate indica que hotelRating é um valor designado pela Expedia e que não há classificação oficial disponível. Use uma exibição alternativa (por exemplo, círculos ou quadrados) para indicar que não é uma classificação oficial da autoridade local.

Retornado somente para minorRev=30 e superior.
HotelSummary.shortDescription string Breve texto de descrição inserido pelo estabelecimento. Truncado se a entrada ultrapassar 200 caracteres.
Para um melhor desempenho, adicione reticências (…) ao final desse valor e defina-o para que se vincule à página de disponibilidade de quartos do estabelecimento.
HotelSummary.locationDescription string Local geral inserido pelo estabelecimento (por exemplo, "perto do mercado Pike Place")
HotelSummary.lowRate string Menor tarifa retornada pelo hotel em consultas recentes. Trata-se de um número estatístico e não é necessariamente a tarifa para a disponibilidade atual.
Os valores sempre são retornados em dólar americano.
HotelSummary.highRate string Maior tarifa retornada pelo hotel em consultas recentes. Trata-se de um número estatístico e não é necessariamente a tarifa para a disponibilidade atual.
Os valores sempre são retornados em dólar americano.
HotelSummary.rateCurrencyCode string Código da moeda das tarifas altas ou baixas retornadas.
HotelSummary.latitude float Coordenada de latitude do hotel.
HotelSummary.longitude float Coordenada de longitude do hotel.
HotelSummary.proximityDistance float A distância do hotel em relação às coordenadas de origem especificadas originalmente, se esse método de pesquisa tiver sido usado.
HotelSummary.proximityUnit string Unidade para a distância fornecida por proximityDistance. MI ou KM.
HotelSummary.hotelInDestination boolean Indica se o estabelecimento está na cidade especificada originalmente ou em uma área expandida, ou seja, no subúrbio ou em outra cidade vizinha.

Os hotéis fora do destino são agrupados por distância da área original, por exemplo, a menos de 16 km de distância, 20 km de distância, etc.
HotelSummary.thumbNailUrl string Caminho de URL de uma imagem em miniatura do estabelecimento, se fornecido.

URLs completos não são retornados. Anexe esse valor a http://images.travelnow.com ou ao subdomínio da sua própria imagem configurando um CNAME com origin-images.travelnow.com como destino. Há suporte para HTTPS com SSL.
string Coloque um link direto na página do hotel correspondente em seu modelo. O formato retornado só é compatível com contas de modelo herdadas.
HotelSummary.RoomRateDetailsList contêiner para a matriz RoomRate
Details
Somente contêiner; nenhum atributo. Retém todos os dados de elemento específico de quarto.
RoomRateDetailsList.RoomRateDetails array Contém os detalhes do primeiro quarto retornado pelo hotel. Serão retornados nós adicionais para cada quarto extra se o valor de maxRatePlanCount >1 tiver sido enviado
RoomRateDetails.roomTypeCode string Código de tipo de quarto referente ao quarto.
RoomRateDetails.rateCode string Código referente à tarifa exibida.
RoomRateDetails.maxRoomOccupancy int O número máximo de hóspedes que o quarto pode acomodar, incluindo hóspedes que poderão gerar cobranças de taxa extra por pessoa.
RoomRateDetails.quotedRoomOccupancy int O número máximo de hóspedes que o quarto pode acomodar sem haver cobrança de taxa extra por pessoa.
RoomRateDetails.minGuestAge int Idade mínima de hóspedes permitida no quarto
RoomRateDetails.roomDescription string Descrição do quarto associado ao roomTypeCode retornado
RoomRateDetails.promoId string ID da oferta promocional retornada, se houver. Em REST, esse valor é retornado como um inteiro.
RoomRateDetails.promoDescription string Descrição da promoção retornada, se houver. Será retornado um máximo de 255 caracteres.
RoomRateDetails.promoDetailText string Detalhes adicionais da promoção retornada, se houver.
RoomRateDetails.currentAllotment int O número de quartos que ainda podem ser reservados no estabelecimento. Use esse valor para criar regras para mensagens urgentes que alertem os clientes da baixa disponibilidade em datas concorridas ou em estabelecimentos populares.

Se o valor retornar 0, não significa falta de quartos no estabelecimento. As regras necessárias para calcular o valor simplesmente não foram atendidas. Esse valor não indica disponibilidade absoluta.
RoomRateDetails.propertyAvailable boolean Somente para referência interna de inventário.
Apenas inventários disponíveis retornarão em solicitações padrão.
RoomRateDetails.propertyRestricted boolean Somente para referência interna de inventário. Consulte a política de cancelamento sobre restrições específicas.
RoomRateDetails.expediaPropertyId string ID da Expedia para o hotel. Use este valor para mapear para um hotelId ao fazer referência cruzada com a Expedia.
RoomRateDetails.BedTypes array As escolhas de tipo de cama para o quarto individual. Pode retornar um tipo de cama Solteiro ou uma escolha a ser incluída no momento da reserva. Reveja detalhes sobre tipos de cama
Disponível com minorRev=22 ou superior. Retorna somente se includeDetails=true tiver sido enviado na solicitação.
RoomRateDetails.smokingPreferences lista separada por vírgulas de string Preferências de fumante/não fumante disponíveis para o quarto, se houver.

Valores:
NS: não fumante
S: fumante
E: sem preferência

Disponível com minorRev=22 ou superior. Retorna somente se includeDetails=true tiver sido enviado na solicitação.
RoomRateDetails.ValueAdds contêiner para ValueAdd Contém uma matriz de elementos ValueAdd, se disponível, para a tarifa e o quarto fornecidos. Tem um atributo size para indicar o número de valores agregados retornados.
ValueAdds.ValueAdd array

Contém um elemento description para um serviço gratuito oferecido com o quarto e a tarifa fornecidos, como café da manhã ou internet sem fio gratuitos.

Para minorRev=28 e 29, o atributo id numérico não retornará – somente description é fornecido.

Para minorRev=30, o atributo id numérico retorna com um conjunto de valores diferente do retornado para 26 e abaixo. Ambos os conjuntos de valores estão disponíveis em nossa página de referência extras.

RoomRateDetails.RateInfos contêiner para RateInfo Contém uma matriz de elementos RateInfo que fornecem informações de tarifa detalhadas para quartos individuais.

Se você estiver usando uma integração mais antiga executada em minorRev=6 ou anterior, RateInfo retornará sem o contêiner RateInfos.

RateInfos.RateInfo object Contém todas as informações de tarifa para um quarto Solteiro em vários objetos diferentes e valores individuais.

Atributos:
priceBreakdownboolean Indica se uma nota discriminada de preço completa, incluindo impostos, e o preço total a serem cobrados estão incluídos.
promo boolean Indica se a tarifa retornada é promocional.
rateChange boolean Indica se a tarifa é diferente para pelo menos uma das noites durante a estadia.
RateInfo.promoId string ID da oferta promocional retornada, se houver.
RateInfo.promoDescription string Descrição da promoção retornada, se houver. Será retornado um máximo de 255 caracteres.
RateInfo.promoDetailText string Detalhes adicionais da promoção retornada, se houver.
RateInfo.currentAllotment int O número de quartos que ainda podem ser reservados no estabelecimento. Use esse valor para criar regras para mensagens urgentes que alertem os clientes da baixa disponibilidade em datas concorridas ou em estabelecimentos populares.

Se o valor retornar 0, não significa falta de quartos no estabelecimento. As regras necessárias para calcular o valor simplesmente não foram atendidas. Esse valor não indica disponibilidade absoluta.
RateInfo.cancellationPolicy string Política de cancelamento do hotel para este quarto. Deve ser exibida tanto em páginas de quartos individuais como em páginas de reserva e de confirmação de reserva.
Retorna somente se includeDetails=true tiver sido enviado na solicitação.
RateInfo.CancelPolicyInfoList contêiner para Cancel
PolicyInfo
Detalha pormenores da política de cancelamento, geralmente determinando o período de multa e as sanções decorrentes do cancelamento.
Retorna somente se includeDetails=true tiver sido enviado na solicitação.
RateInfo.rateType string Indica se a tarifa retornada é pré-paga pela EAN ou pós-paga no hotel. Retorna com um valor MerchantStandard para disponibilidade pré-paga ou não retorna nada para pós-paga.
RateInfo.nonRefundable boolean Indica explicitamente se a reserva pode ser reembolsada ou não após a reserva. Também deve ser indicado na política de cancelamento retornada. Esse valor sempre prevalece sobre quaisquer dados de políticas diferentes.
Retorna somente com disponibilidade.
RateInfo.promoType string Indica se as promoções retornadas são específicas para dispositivos móveis ou padrão. Retorna Mobile para promoções para dispositivos móveis e Standard para todas as outras.
Para retornar promoções para dispositivos móveis, você deve identificar o app ou o site do seu dispositivo móvel por meio da cadeia de caracteres customerUserAgent apropriada.
RateInfo.ChargeableRateInfo object Os atributos deste objeto contêm o total absoluto a ser cobrado para a reserva, bem como os totais e as tarifas médias. Os nós dentro do objeto fornecem detalhes sobre o preço da diária e as sobretaxas.

Atributos:
total string O total de diárias, impostos e sobretaxas a ser cobrado para a reserva. Esse é o valor total que deverá ser exibido para o cliente e incluído na solicitação de reserva.
surchargeTotal string Total de TaxAndServiceFee e ExtraPersonFee da matriz de Surcharges.
nightlyRateTotal string Total de valores na matriz nightlyRatesPerRoom contidos neste objeto.
maxNightlyRate string Preço da diária mais alta de todas as tarifas retornadas
currencyCode string Código de moeda das tarifas retornadas
commissionableUsdTotal string Quantia usada para calcular comissões de parceiros, em USD. Total de diárias menos sobretaxas.
averageRate string O preço médio de todas as diárias com os valores promocionais aplicados, sem sobretaxas.
averageBaseRate string O preço médio de todas as diárias sem os valores promocionais aplicados, sem sobretaxas. Retornará o mesmo que o valor anterior se não houver nenhuma promoção.
ChargeableRateInfo.
nightlyRatesPerRoom
array Contêiner para a matriz NightlyRate. Tem o atributo size para indicar número de nós na matriz, o que corresponderá ao número de noites na solicitação. As tarifas retornam em ordem sequencial em toda a duração da estadia.
nightlyRatesPerRoom.
NightlyRate
n/a

Fornece a tarifa para uma única noite dentro do intervalo da estadia solicitada.

Indica a presença de uma tarifa promocional, da tarifa base e da tarifa após a aplicação da promoção (se for o caso). Contém somente atributos.

No caso de solicitações de vários quartos, esse valor corresponde ao custo médio por noite considerando todos os quartos. A EAN recomenda o uso da nova matriz ChargeableNightlyRates por noite para a exibição de preços de vários quartos.

Para solicitações de vários quartos com minorRev=28 ou inferior, esse elemento fornece tarifas apenas para o primeiro quarto, em vez do valor médio de tarifa.

Atributos:

promo boolean Indica se uma tarifa promocional é aplicada à tarifa desta noite.
rate string A diária após a promoção, se houver, é aplicada.
baseRate string A diária antes da promoção, se houver, é aplicada.
ChargeableRateInfo.Surcharges array Contêiner para a matriz Surcharge. Esta matriz relaciona as sobretaxas individuais que compõem o valor retornado por surchargeTotal. Tem o atributo size para indicar o número de nós na matriz.
Surcharges.Surcharge n/a Detalha o tipo e a quantidade de uma única sobretaxa. Contém somente atributos.

Atributos:
amount float Quantia da sobretaxa específica
type string Nome da sobretaxa.
Valores possíveis:
  • TaxAndServiceFee
  • ExtraPersonFee
  • Tax
  • ServiceFee
  • SalesTax
  • HotelOccupancyTax

Somente TaxAndServiceFee e ExtraPersonFee contam para surchargeTotal. Todos os outros valores são componentes individuais do valor TaxAndServiceFee.


Nota: os tipos de sobretaxa SalesTax (Imposto de vendas) e HotelOccupancyTax (Imposto de ocupação do hotel) devem ser exibidos conforme a lei estadual em Nova York. Certifique-se de esperar e capturar esses valores para exibir como "Ocupação do hotel e imposto de vendas" na nota discriminada do preço final.
RateInfo.rateType string Indica se a tarifa retornada é pré-paga pela EAN ou pós-paga no hotel. Retorna com um valor MerchantStandard para disponibilidade pré-paga ou não retorna nada para pós-paga.
Disponível com minorRev=18 ou superior.
RateInfo.HotelFees array

Este elemento discrimina certos impostos e taxas cobrados pelo hotel que, caso contrário, não seriam detalhados especificamente na matriz Surcharges.

Todos os valores neste elemento são cobrados pelo hotel no check-in ou check-out. Eles não fazem parte de nenhuma taxa cobrada no momento da reserva.

Quando preenchido, use esse elemento para atender ao formato de exibição de tarifas/impostos/taxas exigido pelos principais agregadores e mecanismos de busca.

Contém o atributo size para indicar o número de cobranças contido.
Disponível com minorRev=19 ou superior.

Observe que o elemento filho HotelFeeBreakdown deve ser solicitado especificadamente e exige minorRev=24 ou superior.

HotelFees.HotelFee none Contém atributos para a descrição, a quantia e a moeda de uma única taxa. Detalha qualquer imposto VAT, imposto estadual ou taxa de turismo, taxa de resort ou outras taxas cobradas que não possam ser razoavelmente evitadas.
As cobranças retornam na moeda reservável indicada pelo atributo currencyCode de ChargeableRateInfo.

Atributos:
description string O tipo de taxa. Valores possíveis:
  • MandatoryFee
  • MandatoryTax
  • ResortFee
amount string Valor total da taxa.
HotelFee.HotelFeeBreakdown none Retorna se includeHotelFeeBreakdown tiver sido enviado na solicitação. Detalha como a taxa fornecida em HotelFee é aplicada e com que frequência.

Nota: Todos os valores de HotelFee amount são totais. Não os multiplique por nenhuma frequency fornecida aqui.

Você pode dividir pelo amount conforme indicado pela frequency para obter os preços da diária/por semana, se desejado.

Disponível com minorRev=24 ou superior.

Atributos:
unit string Como a taxa é distribuída. Valores possíveis:
  • Per Person
  • Per Room
  • Per accommodation
  • Per house
  • Per apartment
  • Per adult
frequency string Frequência da taxa. Valores possíveis:
  • Per Night
  • Per Day
  • Per Stay
  • Per week
ConvertedRateInfo object Informações de tarifas convertidas para a moeda solicitada pelo cliente. Retornadas apenas se o hotel não emitir faturas na moeda solicitada ou se a mesma não é utilizada pelo mercado da localidade do cliente. Contém os mesmos atributos que ChargeableRateInfo.
RoomGroup object Confirma o conteúdo do mesmo objeto RoomGroup enviado na solicitação, que se aplica às tarifas fornecidas.

Para minorRev=29 e superior, contém os detalhes do preço de diária por quarto.
RoomGroup.Room array Confirma os valores do quarto para numberOfAdults, numberOfChildren e childAges, conforme fornecido na solicitação original.
Room.rateKey string Fundamental para a taxa e os parâmetros que determinam a tarifa.

Toda vez que os parâmetros de pesquisa são alterados (mudança na contagem de hóspedes, diferentes datas de estadia, acréscimo de crianças, etc), uma nova solicitação deve ser enviada para obter um novo valor para esse parâmetro.
Room.ChargeableNightlyRates array Contêiner para a matriz NightlyRate do quarto. As tarifas retornadas são específicas para o quarto individual e aparecem em ordem sequencial por toda a duração da estadia.

Para obter o custo médio por noite para vários quartos, use os valores fornecidos por nightlyRatesPerRoom.

Retorna para minorRev=29 e superior.
ChargeableNightlyRates.
NightlyRate
object Fornece a tarifa para uma única noite dentro do intervalo da estadia solicitada. Quando retornado neste local, as tarifas sempre serão específicas para o Room.

Indica a presença de uma tarifa promocional, da tarifa base e da tarifa após a aplicação da promoção (se for o caso). Contém somente atributos.

Retorna para minorRev=29 e superior.

Atributos:
promo boolean Indica se uma tarifa promocional é aplicada à tarifa desta noite.
rate string A diária após a promoção, se houver, é aplicada.
baseRate string A diária antes da promoção, se houver, é aplicada.
ChargeableNightlyRates.
ConvertedNightlyRates
object Informações de tarifas convertidas para a moeda solicitada pelo cliente. Retornadas apenas se o hotel não emitir faturas na moeda solicitada ou se a mesma não é utilizada pelo mercado da localidade do cliente. Contém os mesmos atributos que ChargeableNightyRates. Retorna para minorRev=29 e superior.
CachedSupplierResponse


O elemento CachedSupplierResponse é retornado quando uma resposta da lista de hotéis armazenada no cache é fornecida.

Atributos para o elemento CachedSupplierResponse:
Nome Valor Descrição
cachedSupplierResponse object Contém informações sobre dados armazenados no cache (uso interno). Retornado somente com respostas em cache.
cacheEntryHitNum int Interno
cacheEntryMissNum int Interno
cacheEntryExpiredNum int Interno
cacheRetrievalTime long Tempo de recuperação do cache.
supplierRequestNum int Número de resultados solicitados do fornecedor
supplierResponseNum int Número de resultados retornados do fornecedor
supplierResponseTime long A rapidez com que o fornecedor retornou os resultados
candidatePrepTime long Tempo para determinar ou preparar a lista de estabelecimentos solicitada.
tpidUsed int Identificador interno baseado em moeda e local.
matchedCurrency boolean Retorna dados correspondentes ou convertidos (extrapolados) do cache.
matchedLocale boolean Retorna dados correspondentes ou convertidos do cache.
extrapolatedCurrency boolean Retorna dados correspondentes ou convertidos (extrapolados) do cache. (Os resultados são armazenados no cache em inglês e em USD no fornecedor, mas convertidos para o idioma e a moeda solicitados no momento da solicitação)
extrapolatedLocale boolean Retorna dados correspondentes ou convertidos do cache.