Ir al contenido principal

Entradas de configuración y funciones del checkout

Las entradas de configuración y las funciones del checkout son ajustes que definen cómo se comporta el checkout de Ventrata y qué muestra.

Las entradas de configuración y las funciones del checkout te permiten controlar cómo funciona el checkout de Ventrata y qué muestra a los clientes. Ambas se establecen en el atributo data-config de tu script o botón, pero se añaden en lugares distintos:

  • Entradas de configuración: se colocan directamente en data-config, junto a tu apiKey.

  • Funciones del checkout: se colocan dentro de un objeto "features" en data-config.


Añadir entradas y funciones

Añade las entradas y funciones al atributo data-config de tu script o botón con el siguiente formato.

Sustituye input y featureName por los nombres de las entradas y funciones compatibles, y especifica sus valores. Separa varias entradas con una coma ,.

<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

Los valores de las entradas de configuración se pasan como cadenas entre comillas, por ejemplo "lang": "en".

Los valores de las funciones suelen ser true / false sin comillas, por ejemplo "bottomBar": false. Consulta la columna Valores disponibles de cada función.

📗 CONSEJO
Usa el Checkout Configurator para crear y probar tu configuración antes de añadirla a tu sitio web. Cada ajuste que añadas aparece en la etiqueta de script generada, que puedes copiar y pegar en tu página. Mantén el configurador en modo TEST mientras haces pruebas.


Entradas de configuración

Añádelas directamente al atributo data-config.

Configuración básica

Entrada

Predeterminado

Descripción

"apiKey"

Obligatorio: debe definirse al menos una vez por importación de script

Tu apiKey se encuentra en tu panel de Ventrata.

"env"

No establecido

"live" O "test". Si se deja vacío, el checkout usa por defecto test.


Idioma y moneda

Entrada

Predeterminado

Descripción

"lang"

No establecido

Opcional, en minúsculas, por ejemplo, en, cs.

"currency"

No establecido

Opcional, en mayúsculas, por ejemplo, USD, EUR, CZK

📒 NOTA

Si se especifican tanto "lang" como "currency" en el data-config, el icono del globo utilizado para seleccionar el idioma y la moneda en el checkout se oculta, ya que estos parámetros están predefinidos. Esto se usa normalmente con la función de multireserva.


Modo de visualización y carrito

Entrada

Predeterminado

Descripción

"embedded"

false

Permite el uso del modo integrado (embedded).

La página requiere la presencia de un elemento HTML con el atributo ventrata-embedded-widget.

Para personalizar el modo integrado, consulta las funciones viewModeMap y embeddedTitle.

"multibooking"

false

Permite el uso de un carrito (varias reservas en el mismo pedido).

Activa la barra inferior, que informa a los usuarios sobre el contenido actual del pedido. Para ocultarla, consulta la función bottomBar.


Producto, pedidos y páginas

Entrada

Predeterminado

Descripción

"productID"

No establecido

ID del producto.

Si no se establece, se muestra la lista de productos.

"optionID"

No establecido

ID de la opción.

Si se establece, la opción se preselecciona.

"bookingID"

No establecido

ID de la reserva (se usa solo para multibooking)

Debe ir acompañado de orderID.

"orderID"

No establecido

ID del pedido.

Obligatorio siempre que abras un pedido predefinido, por ejemplo con bookingID (multireserva) o con page; consulta Cómo activar el checkout con una página específica. bookingID es obligatorio junto con este parámetro cuando se dirige a una reserva concreta dentro de un pedido de multireserva.

"recoveryToken"

No establecido

Token que se devuelve al crear un pedido, junto con su orderID. Es obligatorio junto con orderID al abrir un pedido en una sesión del navegador distinta de la que lo creó, por ejemplo, un pedido que tu propio backend creó mediante la API, o un pedido que estás reabriendo en una nueva pestaña o tras recargar la página.

No es necesario para un pedido que el propio widget de checkout creó en la sesión actual del cliente, ya que este ya lo tiene internamente.

"page"

No establecido

Valor de cadena.

Activa el checkout en una página específica del proceso de checkout, como Tickets o Checkout. Úsalo solo en combinación con orderID.

Valores compatibles:

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

Ejemplo: {"page": "checkout"}

📒 NOTA

Si el pedido se creó fuera de la sesión del navegador que está a punto de abrirlo, pasa también recoveryToken. orderID por sí solo no basta para demostrar que tu sesión puede abrirlo.

‼️ IMPORTANTE

Trata recoveryToken como una credencial: cualquiera que lo tenga puede abrir ese pedido y actuar sobre él. Pásalo por HTTPS y evita registrarlo en logs.


Preselección de fecha y hora

Entrada

Predeterminado

Descripción

"dateToPreselect"

No establecido

Activa el checkout con una fecha de tour específica. Usa el formato ISO 8601 (AAAA-MM-DD). Úsalo en combinación con productID.

"timeslotToPreselect"

No establecido

Activa el checkout con una hora de tour específica. Úsalo en combinación con productID.

📗 CONSEJO

Para preseleccionar automáticamente la fecha disponible más temprana, consulta la función preselectFirstAvailableDateModalCalendar.


Marketing y promociones

Entrada

Predeterminado

Descripción

"checkMarketingConsent"

No establecido

Si se establece en true, el consentimiento de marketing estará preseleccionado para los usuarios en Contact Details (Datos de contacto) de la página Checkout.

"referrer"

No establecido

Valor de cadena, por ejemplo, hilton.com.

"promoCode"

No establecido

Valor de cadena, un código promocional existente. Aplica el código automáticamente.

Para permitir que los clientes introduzcan un código ellos mismos, consulta la función promoAndGiftCardInput.


Funciones del checkout

Añade estas funciones dentro del objeto "features" en el atributo data-config.

📒 NOTA

Los estados predeterminados de la mayoría de las funciones ya están implementados. Solo necesitas añadir una función al data-config si quieres cambiar su valor predeterminado o usar una función marcada como No establecido.

Selección de producto y unidad

Función

Predeterminado

Valores disponibles

Descripción

preselectFirstUnit

No establecido

true / false o número

Selecciona automáticamente la primera unidad del producto con un recuento predeterminado de 1 (true) o el recuento especificado (número).

enableMoreDetailsToggle

No establecido

true / false

Añade un enlace More Details (Más detalles) para ampliar la información del producto, como la descripción general, los puntos destacados y las preguntas frecuentes.

showSkipOffersButton

false

true / false

Permite a los clientes omitir las ofertas de mejora y de combinación.


Fechas, horas y disponibilidad

Función

Predeterminado

Valores disponibles

Descripción

calendarFirst

No establecido

"enabled": true / false

Permite a los clientes seleccionar la fecha del tour antes de la selección del producto.

preselectFirstAvailableDateModalCalendar

false

true / false

Selecciona automáticamente la fecha disponible más temprana.

restrictedTicketType

No establecido

fixed / flexible

Controla qué tipo de fecha de entrada se muestra a los clientes.

timePickerType

No establecido

"select"

Cambia la interfaz de selección de hora de botones individuales a un menú desplegable.

Esta función es un requisito previo para la función showTourGroupsHeadlines.

showTourGroupsHeadlines

false

true / false

Organiza los intervalos de tiempo en grupos de tours distintos, cada uno con su propio encabezado.

Para usar esta función, incluye primero "timePickerType": "select".

showRemainingSeats

false

true / false

Muestra el número de asientos restantes para el tour.


Promociones y tarjetas regalo

Función

Predeterminado

Valores disponibles

Descripción

promoAndGiftCardInput

true

true / false

Muestra un campo para introducir un código promocional o de tarjeta regalo.

openGiftFlow

false

true / false

Permite la compra de tarjetas regalo a través del web checkout.

disableGiftAmountInput

false

true / false

Desactiva la posibilidad de ajustar el precio por unidad de la tarjeta regalo.


Listas de espera y cotizaciones

Función

Predeterminado

Valores disponibles

Descripción

waitlistsAllowed

false

true / false

Activa la funcionalidad Listas de espera, que permite a los clientes expresar interés en reservar un tour en fechas que actualmente están agotadas.

quotesAllowed

false

true / false

Activa la funcionalidad Cotizaciones, que permite a los clientes posponer el pago y revisar una reserva sin compromiso.


Diseño y visualización

Función

Predeterminado

Valores disponibles

Descripción

bottomBar

true

true / false

Muestra una barra en la parte inferior de la pantalla cuando se realizan varias reservas en un solo pedido (consulta la entrada multibooking).

viewModeMap

No establecido

"cross-sell": "popup" /
​"upgrade": "popup" /
​"questions": "popup" /
​"pickups": "popup"

Cambia la página especificada del modo integrado al modo pop-up (consulta la entrada embedded).

embeddedTitle

No establecido

"buy-tickets"

Sustituye el nombre del producto en el título del widget por la llamada a la acción universal Buy Tickets (Comprar entradas) en modo integrado.

¿Ha quedado contestada tu pregunta?