Supported Configuration Inputs

Input

Default

Description

"lang"

by default not set

optional, lower case, for example, en, cs

📒 NOTE

If both "lang" and "currency" are specified in the data-config, the globe icon used to select the language and currency on the checkout is hidden as these parameters are predefined. This is typically used with the multi-booking feature.

Learn more

"currency"

by default not set

optional, upper case, for example, USD, EUR, CZK

📒 NOTE

If both "lang" and "currency" are specified in the data-config, the globe icon used to select the language and currency on the checkout is hidden as these parameters are predefined. This is typically used with the multi-booking feature.

Learn more

"env"

by default not set

"live" OR "test" ; if left empty checkout defaults to test

"apiKey"

your apiKey MUST be defined at least once per script import

your apiKey is located in your Ventrata dashboard

Locate apiKey

"embedded"

false

Allows the usage of embedded mode.

The page requires the presence of an HTML element with the ventrata-embedded-widget attribute.

Learn more

"multibooking"

false

Allows the usage of a cart (having multiple bookings for the same order).

It will trigger the bottom bar, which informs users about the current order content.

Learn more

"productID"

by default not set

ID of the product

If not set, product list will be shown.

"optionID"

by default not set

ID of the option

if set, the option is pre-selected

"bookingID"

by default not set

ID of the booking (used only for multibooking)

Its presence needs to be paired with orderID.

Learn more

"orderID"

by default not set

ID of the order. Required whenever you are opening a predefined order, for example with bookingID (multibooking) or with page, see How to Trigger Checkout with a Specific Page. bookingID is required alongside it when targeting a specific booking in a multibooking order.

Learn more

📒 NOTE

If the order was created outside the browser session that is about to open it, also pass recoveryToken (below). orderID alone is not enough to prove your session may open it.

"recoveryToken"

by default not set

Token returned when an order is created, alongside its orderID. Required together with orderID when opening an order in a browser session other than the one that created it, for example, an order your own backend created via the API, or an order you are reopening in a new tab or after a page reload.

Not needed for an order the Checkout Widget itself created in the customer's current session, as it already has this internally.

Learn more

‼️ IMPORTANT

Treat recoveryToken like a credential — anyone with it can open and act on that order. Pass it over HTTPS and avoid logging it.

"checkMarketingConsent"

by default not set

if set to true, marketing consent will be pre-selected for users on the Contact Details of the Checkout page

"referrer"

by default not set

string value, for example, hilton.com

Learn more

"promoCode"

by default not set

string value, existing promotional code

Learn more

"page"

by default not set

string value; trigger checkout with a specific page in the checkout process such as Tickets or Checkout; use only in combination with orderID,

supported values: [

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

] > {"page": "checkout"}

Learn more

"dateToPreselect"

by default not set

trigger checkout with a specific tour date

use the ISO 8601 format (YYYY-MM-DD); include this parameter in the data-config, next to apiKey and productID

"timeslotToPreselect"

by default not set

trigger checkout with a specific tour time;

include this parameter in the data-config, next to apiKey and productID