Skip to main content
Supported Configuration Inputs

Configuration inputs are settings and parameters that define how checkout operates and behaves.

Lucia Burin Sestakova avatar
Written by Lucia Burin Sestakova
Updated over 2 months ago

Configuration inputs can be set in your Ventrata checkout solution by doing one of two things:

  • Update Data-Config Attribute - by adding the below piece of code, replacing the input with the name of one of the supported inputs and specifying its value, see the configuration table below. Include multiple inputs separated by a comma , .

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

  • Add input to Script or Button - add the input to your data-config for script or button in the below format. Include multiple inputs separated by a comma , .

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

Ventrata checkout support the following 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.


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


"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

"embedded"

false

Allows the usage of embedded mode.

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

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

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

"orderID"

by default not set

ID of the order (used only for multibooking)

Its presence needs to be paired with bookingID .

"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

"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: [โ€checkoutโ€] > {"page": "checkout"}

Did this answer your question?