Ir para conteúdo principal

Entradas de configuração suportadas

→ As entradas de configuração são definições e parâmetros que determinam como o checkout funciona e se comporta.

As entradas de configuração podem ser definidas na sua solução de checkout Ventrata de duas formas:

  • Atualizar o atributo Data-Config - ao adicionar o código abaixo, substituindo o input pelo nome de uma das entradas suportadas e especificando o respetivo valor, consulte a tabela de configuração abaixo. Inclua várias entradas separadas por vírgulas , .

    "input1" : "value", "input2" : "value"

  • Adicionar entrada ao Script ou Botão - adicione a entrada ao data-config do script ou botão no formato abaixo. Inclua várias entradas separadas por vírgulas , .

    <script src="https://cdn.checkout.ventrata.com/v3/production/ventrata-checkout.min.js" type="module" data-config='{"apiKey":"<YOUR_API_TOKEN>", "input1": "value", "input2": "value" } }'></script>

O checkout Ventrata suporta as seguintes entradas de configuração:

Entrada

Por defeito

Descrição

"lang"

não definido por defeito

opcional, em minúsculas, por exemplo: en, cs

📒 NOTA

Se ambos "lang" e "currency" estiverem especificados no data-config, o ícone do globo usado para selecionar o idioma e a moeda no checkout é ocultado, pois esses parâmetros são predefinidos. Isso é normalmente usado com a funcionalidade de múltiplas reservas.

"currency"

não definido por defeito

opcional, em maiúsculas, por exemplo: USD, EUR, CZK

📒 NOTA

Se ambos "lang" e "currency" estiverem especificados no data-config, o ícone do globo usado para selecionar o idioma e a moeda no checkout é ocultado, pois esses parâmetros são predefinidos. Isso é normalmente usado com a funcionalidade de múltiplas reservas.

"env"

não definido por defeito

"live" OU "test" ; se não for definido, o checkout utiliza, por defeito, o ambiente de test

"apiKey"

a sua apiKey DEVE ser definida pelo menos uma vez por importação de script

a sua apiKey encontra-se no seu painel Ventrata

"embedded"

falso

Permite o utilização do modo incorporado.

A página requer a presença de um elemento HTML com o atributo ventrata-embedded-widget.

"multibooking"

falso

Permite o utilização de um carrinho (com várias reservas para o mesmo pedido).

Isto ativa a barra inferior, que informa os usuários sobre o conteúdo atual do pedido.

"productID"

não definido por defeito

ID do produto

Se não for definido, a lista de produtos será apresentada.

"optionID"

não definido por defeito

ID da opção

se for definido, a opção é pré-selecionada

"bookingID"

não definido por defeito

ID da reserva (usado apenas para multibooking)

A sua utilização deve ser combinada com o orderID.

"orderID"

não definido por defeito

ID do pedido

Obrigatório sempre que estiver a abrir um pedido predefinido, por exemplo com bookingID (multi-reserva) ou com page, ver Como acionar o checkout com uma página específica. O bookingID é obrigatório em conjunto quando se pretende visar uma reserva específica num pedido de multi-reserva.

📒 NOTA
Se o pedido foi criado fora da sessão do navegador que está prestes a abri-lo, também deve passar o recoveryToken (abaixo). O orderID por si só não é suficiente para comprovar que a sua sessão pode abri-lo.

"recoveryToken"

não definido por defeito

Token devolvido quando um pedido é criado, juntamente com o respetivo orderID.

Obrigatório em conjunto com o orderID ao abrir um pedido numa sessão do navegador diferente daquela que o criou — por exemplo, um pedido que o seu próprio backend criou através da API, ou um pedido que está a reabrir numa nova aba ou após recarregar a página.

Não é necessário para um pedido que o próprio Checkout Widget criou na sessão atual do cliente, uma vez que este já o tem internamente.

‼️ IMPORTANTE
Trate o recoveryToken como uma credencial — qualquer pessoa que o tenha pode abrir e atuar sobre esse pedido. Passe-o via HTTPS e evite registá-lo em logs.

"checkMarketingConsent"

não definido por defeito

se definido como true, o consentimento de marketing será pré-selecionado para os utilizadores na página Detalhes de contacto do Checkout

"referrer"

não definido por defeito

valor em string, por exemplo, hilton.com

"promoCode"

não definido por defeito

valor em string, código promocional existente

"page"

não definido por defeito

valor em string; ativar o checkout com uma página específica no processo de checkout, como Bilhetes ou Checkout; utilizar apenas em combinação com o orderID,

valores suportados: [

"upgrade"/ "cross-sell" / "pickups" / "dropoffs" / "questions" / "order-questions" / "cart-summary" / ”checkout” / "package-availability"

] > {"page": "checkout"}

"dateToPreselect"

não definido por defeito

ativar o checkout com uma data de viagem específica

usar o formato ISO 8601 (AAAA-MM-DD); incluir este parâmetro no data-config, junto da apiKey e do productID

"timeslotToPreselect"

não definido por defeito

ativar o checkout com uma hora de viagem específica;

incluir este parâmetro no data-config, junto da apiKey e do productID

Isto respondeu à sua pergunta?