Developer Hub
Esta é uma tradução automática

Visão geral

Aproveite a nova API de Merchandising para identificar ofertas com mais facilidade e se beneficiar das recomendações automatizadas learning-powered

A API de Merchandising oferece acesso direto a descontos Expedia-sourced propriedade, suas campanhas e recursos associados, além de rankings personalizados de ofertas, destinos e propriedade, com tecnologia de aprendizado de máquina. Use a API de Merchandising para criar experiências de marketing para viajantes ou para a agent-facing, como e-mails promocionais, widgets de aplicativos, banners de sites e experiências em carrossel — e execute uma estratégia de merchandising vencedora para a year-long.

Você também tem acesso a uma seção Marketing em seu Portal de parceiros Conta onde você pode navegar pelas próximas campanhas, exportar listas de ofertas personalizadas, selecionar textos e imagens para usar nas campanhas e acompanhar as tendências de viagens e o desempenho das campanhas. Se você não estiver visualizando a seção Marketing no seu Portal, envie um Ticket de suporte.

Ponto final do conteúdo da campanha

O endpoint de conteúdo da campanha fornece detalhes da campanha futura, incluindo o ID da campanha, as datas de início e término da reserva e da estadia, e o número de propriedades participantes. Você terá acesso direto aos recursos da campanha Expedia-curated, como imagens temáticas, fotos do destino e sugestões de texto para criar experiências de merchandising com traveler-facing ou agent-facing, incluindo e-mails promocionais, widgets de aplicativos e banners para sites. Além disso, você recebe informações sobre campanhas de oferta por tempo limitado (LTO) com período de reserva nos próximos seis meses, bem como campanhas permanentes disponíveis durante todo o ano.

Você pode usar o endpoint de Conteúdo da Campanha para pesquisar campanhas futuras usando parâmetros de solicitação, incluindo:

  • Intervalo de datas reserváveis
  • Período de estadia
  • Valores iguais ou superiores a zero para obter o desconto mínimo.
  • Ofertas de longo prazo versus ofertas permanentes

Para campanhas LTO com período de reserva superior a seis meses, os seguintes campos serão excluídos:

  • Reserva e datas da viagem
  • Desconto mínimo e máximo em porcentagem

Outros detalhes

Você pode usar o campo property_countna resposta do Conteúdo da Campanha para determinar o maior número de propriedades que oferecem ofertas dentro de uma campanha. Recomendamos que você verifique o property_countpróximo à data de início da reserva da campanha, pois a participação de propriedade em campanhas de merchandising é dinâmica e a participação das propriedades tende a ser mais completa e confiável à medida que o lançamento da campanha se aproxima.

Você pode usar os campos min_discounte max_discountna resposta do Conteúdo da Campanha para determinar o desconto percentual mínimo e máximo disponível nessa campanha. Por exemplo, se o maior desconto oferecido por um propriedade nessa campanha for de 60%, o valor do campo max_discountna resposta da API será 60%, enquanto que, se o menor desconto oferecido por um propriedade nessa campanha for de 4%, o campo min_discountserá 4%.

Information

Você continua responsável pelo marketing e pelas mensagens das campanhas em seus sites criados usando a API de Merchandising ou a API de Compras, e por garantir que todo esse marketing e essas mensagens estejam em conformidade com as leis e regulamentações aplicáveis.

Fim das promoções

Você pode facilmente pesquisar e filtrar os resultados de Promoções para encontrar ofertas mais específicas, tendo assim controle total sobre quais ofertas apresenta aos viajantes. Você também pode selecionar essas ofertas para criar seus próprios temas de campanha, em vez de usar as campanhas Expedia-defined e os recursos associados.

Com o endpoint de Promoções, você pode:

  • Pesquise ofertas e descontos associados a uma campanha específica.
  • Ofertas e descontos de busca não associados a uma campanha
  • Pesquise e filtre ofertas com a ajuda de vários parâmetros de pesquisa, incluindo a possibilidade de pesquisar ofertas para uma campanha específica ou em várias campanhas.
  • Descubra as ofertas mais atraentes e com maior número de up-to-date para construir uma campanha high-converting.

Buscar e filtrar

Você pode usar o endpoint de Promoções para filtrar e pesquisar ofertas facilmente usando parâmetros de solicitação como:

  • ID da campanha e/ou ID propriedade
  • Intervalo de datas reserváveis
  • Período de estadia
  • Valores iguais ou superiores à pontuação mínima de avaliação, à classificação mínima por estrelas e/ou ao desconto mínimo.
  • Distinção entre tempo limitado e permanente
  • Member-only e mobile-only bandeiras de acordo
  • Super-região ou destinos específicos
  • Ordem de classificação de relevância de aprendizado de máquina

Detalhes da resposta

Os detalhes abaixo serão retornados na resposta da API de Promoções:

  • ID da promoção, ID da campanha correspondente e ID propriedade
  • Período de reservas, período de estadia, datas indisponíveis e janela de compra antecipada.
  • Distinção entre tempo limitado e permanente
  • Classificações de relevância da máquina learning-powered exclusivas para o seu negócio, referentes às ofertas, propriedades e destinos retornados na resposta.
  • Informações específicas sobre destinos e identificação da cadeia de lojas
  • Link tokenizado para a API de conteúdo Rapid propriedade existente para extrair imagens property-level e apresentá-las em suas experiências de merchandising.
  • Link de compras tokenizado para realizar merchandising deal-specific. Chamada à API de compras para receber preços e disponibilidade em tempo real.

Outros detalhes

  • Se você quiser pesquisar ofertas para um período de reserva específico, pode passar valores para as datas bookable_starte bookable_end. Por exemplo, ao inserir 2027-10-15 (15 de outubro de 2027) no campo bookable_starte 2027-10-30 (30 de outubro de 2027) no campo bookable_end, você receberá todas as ofertas que podem ser reservadas entre 15 e 30 de outubro, inclusive. No entanto, se você quiser ver um conjunto maior de ofertas, pode usar a data bookable_startou bookable_end. Por exemplo:
    • Ao inserir 2027-10-15 (15 de outubro de 2027) no campo bookable_start, você receberá todas as ofertas que podem ser reservadas a partir de 15 de outubro. Isso proporcionará uma gama maior de ofertas.
    • Ao inserir apenas 2027-10-30 (30 de outubro de 2027) no campo bookable_end, você receberá todas as ofertas que podem ser reservadas até 30 de outubro. Novamente, isso proporcionará um leque maior de ofertas.
  • As ofertas ficam disponíveis para reserva de acordo com o fuso horário de propriedade. Portanto, se uma oferta para um propriedade em Sydney, Austrália, começar no dia 21 de março, ela ficará disponível para reservas à 0h01, horário de Sydney, para todos os parceiros do mundo.
  • Você pode usar o parâmetro de solicitação includeno endpoint de Promoções para personalizar o tamanho da resposta que você recebe. Portanto, em vez de receber todos os campos de resposta, se você precisar apenas de alguns campos retornados, você pode adicionar esses nomes de campo específicos no parâmetro include.
  • As ofertas não associadas a uma campanha são exatamente iguais às ofertas associadas a uma campanha, mas com algumas diferenças importantes:
    • Ofertas não associadas a uma campanha não possuem um ID de campanha associado a elas.
    • A maioria possui um desconto mínimo de 10% e data limite para reservas em 2079. Ofertas com data de término para reservas em 2079 são consideradas permanentes, enquanto aquelas com datas de reserva anteriores a 2079 são consideradas ofertas por tempo limitado.
  • Você pode começar a fazer solicitações à API de promoções com antecedência, mas também deve solicitá-las o mais próximo possível da data de início da campanha de reservas para obter a representação mais precisa e atualizada das ofertas das propriedades. Sugerimos que o faça aproximadamente duas semanas antes do início da campanha. Isso ocorre porque a participação das propriedades tende a ser mais completa e confiável à medida que a data de lançamento da campanha se aproxima.
    • Sugerimos também que solicite as promoções alguns dias após o início da campanha, para que receba sempre a lista de ofertas mais recente e atualizada. Além disso, sugerimos que você solicite a API de promoções diariamente para obter uma lista atualizada das ofertas fornecidas pelos imóveis.
  • Se você estiver interessado em criar campanhas de merchandising destination-based, você pode fazer uma solicitação à API de Promoções region-specific usando o region_idrelevante da API Rapid Geography. O único tipo de região aceito pelo endpoint de promoções é city. Outros tipos de região, como multi_city_vicinity, point_of_interest, neighbourhood, etc., retornarão uma resposta em branco.

API de disponibilidade de compras

Quando você quiser informações em tempo real sobre disponibilidade, preços, reembolso e comissões para um produto propriedade promovido, o próximo passo é chamar a API de Disponibilidade de Compras Rápidas.

Cada resposta promocional inclui um token de link da loja contendo detalhes essenciais sobre as ofertas e dados propriedade, sendo único para cada oferta. O token de link da loja facilita a transição da descoberta de promoções para a compra de produtos.

Exemplo de resposta a promoções

[
  {
    "promotion_id": "123456",
    "campaign_id": "12345",
    "property_id": "123456",
    ...
    "links": {
      "content": {
        "method": "GET",
        "href": "/v3/properties/content?property_id=123456&language=en-US&supply_source=expedia"
      },
      "shop": {
        "method": "GET",
        "href": "/v3/properties/availability?token=XFleAkNUU1YKACg5HcAtdVw8SQVUPUApTAF0CAApdBg==",
        "required_parameters": [
          "checkin",
          "checkout",
          "currency",
          "country_code",
          "occupancy",
          "rate_plan_count",
          "sales_channel",
          "sales_environment"
        ]
      }
    }
  }
]

Ao escolher uma oferta para promover, basta usar o token do link da loja para fazer uma chamada à API de Disponibilidade com os parâmetros necessários. A resposta da API de Disponibilidade mostrará todos os detalhes regulares sobre a oferta que você escolheu, o que permitirá que você faça uma chamada direcionada à API de Compras deal-specific de forma automatizada. Juntamente com esse token, você tem a flexibilidade de pesquisar outras propriedades na mesma solicitação da API Shopping (o limite normal de 250 propriedades em uma chamada da Shopping ainda se aplica), expandindo ainda mais sua busca.

Ao fazer várias solicitações à API de Disponibilidade, solicitamos que você use o token do link da loja em cada chamada. Cada vez que você faz uma solicitação à API de Promoções, um novo token é gerado para cada um dos links da loja. Isso ocorre porque cada token é único e pode ser rastreado até uma chamada específica da API de Promoções. Portanto, se você realiza uma atualização diária dos dados de Promoções, é importante que utilize o token gerado mais recentemente.

Exemplo de solicitação à API de compras usando o token

curl -X GET "https://test.ean.com/v3/properties/availability\
?token=XFleAkNUU1YKACg5HcAtdVw8SQVUPUApTAF0CAApdBg==\
&checkin=2026-06-01\
&checkout=2026-06-03\
&currency=USD\
&country_code=US\
&occupancy=2\
&rate_plan_count=1\
&sales_channel=website\
&sales_environment=hotel_only" \
 -H "accept: application/json"\
 -H "accept-encoding: gzip"\
 -H "authorization: EAN apikey=abcd1234,signature=090a77e7ddd7779980231,timestamp=1697664047"\
 -H "user-agent: TravelNow/3.30.112"

Além disso, use o novo filtro dealdisponível no endpoint de Disponibilidade de Compras Rápidas para receber apenas tarifas que apresentem promoções ativas. Isso lhe dá a flexibilidade de criar uma solicitação de compras com foco exclusivo em merchandising e garantir que todas as taxas retornadas tenham um atributodeal.

Exemplo de resposta

"promotions": {
. "deal": {
.   "id": "999abc",
.   "description": "Book early and save 15%"
. }
}

Nota: Os ide descriptiondisponíveis na resposta da API de Merchandising são diferentes daqueles retornados na resposta da API de Compras. Recomendamos vivamente que utilize os ide descriptionretornados pela API de Merchandising.

Information

O desconto mínimo proposto é calculado excluindo impostos e taxas. É da sua responsabilidade garantir que o desconto a ser anunciado esteja em conformidade com as leis de publicidade de preços necessárias.

Recomendações com aprendizado de máquina

As classificações de relevância da máquina learning-powered fornecidas na resposta de Promoções são exclusivas para cada parceiro, portanto, as classificações que você recebe serão diferentes das que qualquer outra pessoa recebe. Você pode usar as recomendações de aprendizado de máquina para identificar as melhores ofertas, propriedades e destinos para promover em suas campanhas de merchandising. Ofertas, propriedades e destinos com a hashtag Higher-scoring podem ter uma probabilidade maior de gerar reservas entre sua base de viajantes exclusiva.

  • Atualmente, você receberá classificações de relevância para as 10 mil melhores ofertas. Em nossos testes, descobrimos que o valor e o impacto dessa classificação se tornaram insignificantes após as primeiras 10 mil transações.
  • Com base no seu caso de uso, você pode usar o parâmetro sort_bypara definir a ordem de classificação da resposta de Promoções, optando por ordenar com base na oferta, propriedade ou relevância do destino, conforme determinado pelo nosso modelo de aprendizado de máquina, para que você obtenha o máximo valor do merchandising em termos de visibilidade e reservas dos viajantes.
    • Se você passar sort_by = promotion, receberá todos os resultados de ofertas classificados por high-to-low (de 1 a 10.000) de acordo com nosso algoritmo proprietário de aprendizado de máquina. Você pode usar essa opção de classificação para obter as melhores ofertas recomendadas, que nosso modelo prevê que terão maior taxa de conversão.
    • Se você clicar em sort_by = property, receberá todos os resultados de negócios das propriedades classificadas com high-to-low de acordo com nosso algoritmo proprietário de aprendizado de máquina.
    • Se você passar por sort_by = destination, receberá todos os resultados de ofertas dos destinos classificados por high-to-low de acordo com nosso algoritmo proprietário de aprendizado de máquina.

Nota: As recomendações de aprendizado de máquina também estão disponíveis na seção Marketing no Portal. Para mais detalhes, entre em contato com seu gerente de conta.

Requisitos de lançamento

Responsabilidade de conformidade

Você é o único responsável por garantir a conformidade com todas as diretrizes legais e de marketing aplicáveis ​​ao executar campanhas.

Integridade do conteúdo

As imagens Expedia-provided não devem ser modificadas. Você pode usar seus próprios recursos criativos, se preferir; no entanto, você é o único responsável por garantir a conformidade com todas as leis de direitos autorais e de propriedade intelectual aplicáveis.

Detalhes da API

Explore as configurações de endpoint merchandising-related nesta página e, em seguida, use o API Explorer ou outro software de teste para entender como os exemplos e as configurações de esquema se comparam à saída real.


Recursos adicionais

Não importa se deseja testar todos os pontos de extremidade da Rapid API, ou baixar a especificação OpenAPI ou a nossa coleção Postman Collection, você pode contar conosco.



Esta página foi útil?
Como podemos melhorar esse conteúdo?
Agradecemos por nos ajudar a melhorar.