Ir al contenido principal

Entradas de configuración compatibles

Las entradas de configuración son ajustes y parámetros que definen cómo funciona y se comporta el proceso de checkout.

Las entradas de configuración se pueden establecer en su solución de checkout de Ventrata de dos maneras:

  • Actualizar atributo Data-Config - añadiendo el siguiente fragmento de código, reemplazando el input con el nombre de una de las entradas compatibles y especificando su valor, consulta la tabla de configuración a continuación. Incluye varias entradas separadas por comas , .

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

  • Agregar entrada al Script o Botón - agrega la entrada a tu data-config para script o botón en el siguiente formato. Incluye varias entradas separadas por comas , .

    <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>

El sistema de checkout de Ventrata admite las siguientes entradas de configuración:

Entrada

Predeterminado

Descripción

"lang"

no establecido por defecto

opcional, en minúsculas, por ejemplo, en, cs

📒 NOTA

Si ambos "lang" y "currency" están especificados en el data-config, el icono del globo utilizado para seleccionar el idioma y la moneda en el proceso de checkout se oculta ya que estos parámetros están predefinidos. Esto se usa típicamente con la función de multi-reserva.

"currency"

no establecido por defecto

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

📒 NOTA

Si ambos "lang" y "currency" están especificados en el data-config, el icono del globo utilizado para seleccionar el idioma y la moneda en el proceso de checkout se oculta ya que estos parámetros están predefinidos. Esto se usa típicamente con la función de multi-reserva.

"env"

no establecido por defecto

"live" O "test" ; si se deja vacío, el checkout usa por defecto test

"apiKey"

su apiKey DEBE definirse al menos una vez por importación de script

su apiKey se encuentra en su panel de Ventrata

"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.

"multibooking"

false

Permite el uso de un carrito (con múltiples reservas para la misma orden).

Esto activará la barra inferior, que informa a los usuarios sobre el contenido actual del pedido.

"productID"

no establecido por defecto

ID del producto

Si no se establece, se mostrará la lista de productos.

"optionID"

no establecido por defecto

ID de la opción

si se establece, la opción está preseleccionada

"bookingID"

no establecido por defecto

ID de la reserva (usado solo para multibooking)

Su presencia debe ir acompañada por el orderID.

"orderID"

no establecido por defecto

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.

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

"recoveryToken"

no establecido por defecto

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.

‼️ 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.

"checkMarketingConsent"

no establecido por defecto

si se establece en true, el consentimiento de marketing estará preseleccionado para los usuarios en Datos de contacto del Checkout

"referrer"

no establecido por defecto

valor de cadena, por ejemplo, hilton.com

"promoCode"

no establecido por defecto

valor de cadena, código promocional

existente

"page"

no establecido por defecto

valor de cadena; activar el checkout con una página específica en el proceso de checkout como Tickets o Checkout; usar solo en combinación con orderID,

valores soportados: [

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

] > {"page": "checkout"}

"dateToPreselect"

no establecido por defecto

activar el checkout con una fecha de tour específica

usar el formato ISO 8601 (AAAA-MM-DD); incluir este parámetro en el data-config, junto a apiKey y productID

"timeslotToPreselect"

no establecido por defecto

activar el checkout con una hora de tour específica;

incluir este parámetro en el data-config, junto a apiKey y productID

¿Ha quedado contestada tu pregunta?