As entradas de configuração e as funcionalidades do checkout permitem controlar como o checkout Ventrata funciona e o que mostra aos clientes. Ambas são definidas no atributo data-config do seu script ou botão, mas são adicionadas em locais diferentes:
Entradas de configuração ficam diretamente no
data-config, junto da suaapiKey.Funcionalidades do checkout ficam dentro de um objeto
"features"nodata-config.
Adicionar entradas e funcionalidades
Adicione as entradas e as funcionalidades ao atributo data-config do seu script ou botão no formato abaixo.
Substitua input e featureName pelos nomes das entradas e funcionalidades suportadas e especifique os respetivos valores. Separe várias entradas com uma vírgula ,.
<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",
"features": {
"featureName": value,
"featureName1": value
}
}'>
</script>
📒 NOTA
Os valores das entradas de configuração são passados como strings entre aspas, por exemplo "lang": "en".
Os valores das funcionalidades são, na sua maioria, true / false sem aspas, por exemplo "bottomBar": false. Consulte a coluna Valores disponíveis de cada funcionalidade.
📗 DICA
Utilize o Checkout Configurator para criar e testar a sua configuração antes de a adicionar ao seu website. Cada definição que adicionar aparece na tag de script gerada, que pode copiar e colar na sua página. Mantenha o configurador no modo TEST enquanto faz experiências.
Entradas de configuração
Adicione-as diretamente ao atributo data-config.
Configuração inicial
Entrada | Por defeito | Descrição |
| Obrigatório - tem de ser definida pelo menos uma vez por importação de script | A sua apiKey encontra-se no seu painel Ventrata.
|
| Não definido |
|
Idioma e moeda
Entrada | Por defeito | Descrição |
| Não definido | Opcional, em minúsculas, por exemplo, |
| Não definido | Opcional, em maiúsculas, por exemplo, |
📒 NOTA
Se "lang" e "currency" estiverem ambos especificados no data-config, o ícone do globo usado para selecionar o idioma e a moeda no checkout fica oculto, uma vez que estes parâmetros estão predefinidos. Normalmente, isto é usado com a funcionalidade de múltiplas reservas.
Modo de apresentação e carrinho
Entrada | Por defeito | Descrição |
|
| Permite a utilização do modo incorporado.
A página requer a presença de um elemento HTML com o atributo
Para personalizar o modo incorporado, consulte as funcionalidades
|
|
| Permite a utilização de um carrinho (várias reservas no mesmo pedido).
Ativa a barra inferior, que informa os utilizadores sobre o conteúdo atual do pedido. Para a ocultar, consulte a funcionalidade
|
Produto, pedidos e páginas
Entrada | Por defeito | Descrição |
| Não definido | ID do produto.
Se não for definido, é apresentada a lista de produtos. |
| Não definido | ID da opção.
Se for definido, a opção é pré-selecionada. |
| Não definido | ID da reserva (usado apenas para
Tem de ser combinado com
|
| Não definido | ID do pedido.
Obrigatório sempre que estiver a abrir um pedido predefinido, por exemplo com
|
| Não definido | Token devolvido quando um pedido é criado, juntamente com o respetivo
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.
|
| Não definido | Valor em string. Aciona o checkout numa página específica do processo de checkout, como Tickets (Bilhetes) ou Checkout. Utilize apenas em combinação com
Valores suportados:
Exemplo:
|
📒 NOTA
Se o pedido foi criado fora da sessão do navegador que está prestes a abri-lo, também deve passar o recoveryToken. O orderID por si só não é suficiente para comprovar que a sua sessão pode abri-lo.
‼️ 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.
Pré-seleção de data e hora
Entrada | Por defeito | Descrição |
| Não definido | Aciona o checkout com uma data de viagem específica. Utilize o formato ISO 8601 (AAAA-MM-DD). Utilize em combinação com |
| Não definido | Aciona o checkout com uma hora de viagem específica. Utilize em combinação com |
📗 DICA
Para, em alternativa, pré-selecionar automaticamente a data disponível mais próxima, consulte a funcionalidade preselectFirstAvailableDateModalCalendar.
Marketing e promoções
Entrada | Por defeito | Descrição |
| Não definido | Se for definido como |
| Não definido | Valor em string, por exemplo,
|
| Não definido | Valor em string, um código promocional existente. Aplica o código automaticamente.
Para permitir que os clientes introduzam um código, consulte a funcionalidade
|
Funcionalidades do checkout
Adicione estas funcionalidades dentro do objeto "features" no atributo data-config.
📒 NOTA
Os estados por defeito da maioria das funcionalidades já se encontram implementados. Só precisa de adicionar uma funcionalidade ao data-config se pretender alterar o respetivo valor por defeito ou utilizar uma funcionalidade marcada como Não definido.
Seleção de produto e unidade
Funcionalidade | Por defeito | Valores disponíveis | Descrição |
| Não definido |
| Seleciona automaticamente a primeira unidade do produto com uma quantidade por defeito de 1 (
|
| Não definido |
| Adicione um link More Details (Mais detalhes) para expandir as informações do produto, como visão geral, destaques e perguntas frequentes.
|
|
|
| Permite que os clientes ignorem ofertas de melhoria e de combinação.
|
Datas, horários e disponibilidade
Funcionalidade | Por defeito | Valores disponíveis | Descrição |
| Não definido |
| Permite que os clientes selecionem a data da viagem antes da seleção do produto.
|
|
|
| Seleciona automaticamente a data disponível mais próxima.
|
| Não definido |
| Controla que tipo de data do bilhete é exibido aos clientes.
|
| Não definido |
| Altera a interface de seleção de horários de botões individuais para um menu suspenso.
Esta funcionalidade é um pré-requisito para a funcionalidade
|
|
|
| Organiza os horários em grupos de viagens distintos, cada um com o seu próprio título.
Para usar esta funcionalidade, inclua primeiro
|
|
|
| Exibe o número de lugares disponíveis para a viagem.
|
Promoções e cartões-presente
Funcionalidade | Por defeito | Valores disponíveis | Descrição |
|
|
| Exibe um campo para introduzir o código promocional ou de cartão-presente.
|
|
|
| Permite a compra de cartões-presente através do checkout web.
|
|
|
| Desativa a possibilidade de ajustar o preço por unidade do cartão-presente.
|
Listas de espera e orçamentos
Funcionalidade | Por defeito | Valores disponíveis | Descrição |
|
|
| Ativa a funcionalidade Waitlists (Listas de espera), que permite aos clientes manifestar interesse em reservar uma viagem em datas atualmente esgotadas.
|
|
|
| Ativa a funcionalidade Quotes (Orçamentos), que permite aos clientes adiar o pagamento e rever uma reserva sem compromisso.
|
Layout e apresentação
Funcionalidade | Por defeito | Valores disponíveis | Descrição |
|
|
| Exibe uma barra na parte inferior do ecrã quando várias reservas são efetuadas num único pedido (consulte a entrada
|
| Não definido |
| Muda a página especificada do modo incorporado para o modo emergente (consulte a entrada
|
| Não definido |
| Substitui o nome do produto no título do widget por um apelo à ação universal Buy Tickets (Comprar bilhetes) no modo incorporado.
|