Embed.js

Embed.js is a JavaScript library that enables you to embed the vivenu checkout flow right into your website. With Embed.js, you can sell tickets to any event (that's handled by vivenu) on your website without having to write any code.

Setup Embed.js

You need to include Embed.js on your page by adding the script tag at the end of body of your HTML.

<script type="text/javascript" src="https://vivenu.com/web/deliver/js/v1/embed.js"></script>

Next, Embed.js will automatically be initialized and become available as a global variable called VIVENU.

<html>
    <body>
        ...

        <script type="text/javascript" src="https://vivenu.com/web/deliver/js/v1/embed.js" />
    </body>
</html>

Usage

To simply get started, add useEmbed=true to your event url:

<a href="https://vivenu.com/event/[your-event-id]?useEmbed=true">Buy Tickets</a>

What's happening here?

Once you add useEmbed=true to your event link, Embed.js assigns a click event handler to that link.

This link will open up a checkout modal window where your buyers can safely book tickets through our checkout flow without leaving your website. And the rest of the checkout process will be handled automatically by Embed.js.

Methods

Embed.js exposes some useful methods that you can use to programmatically manage the differents modals.

Method	Description
.showCheckoutModal	A method that opens the checkout modal.
.showTicketModal	A method that opens the ticket modal.
.presenter.show	A deprecat method that opens the checkout modal.

.showCheckoutModal

A method that opens the checkout modal.

/**
 * @param {object} checkoutParams - An object that contains information about the event
 */
VIVENU.showCheckoutModal(checkoutParams)

checkoutParams

Required

string

Event ID

lang

Optional

enum

If set, the automatically detected language of the checkout will be overridden.

endefrlvhethnles-MX

baseUrl

Optional

string

shop

Optional

string

Undershop ID

channel

Optional

string

Channel ID

preselect

Optional

array<string>

List of ticket types to be preselected

testing

Optional

boolean

If true, the checkout modal will open in testing mode. The testing mode can be used to emulate how events that are not on sale look like before they go live.

embedded

Optional

boolean

cookieConsent

Optional

object

Pre-set the cookie consent in the modal. Will prevent the cookie banner from showing up. Providing an invalid object will disable all non-functional tracking but still hide the cookie banner.

cookieConsent.marketing

Optional

boolean

Enable or disable consent to marketing categorized trackers. Those trackers are helping to deliver personalized content as well as offers that are relevant to the customer.

cookieConsent.performance

Optional

boolean

Enable or disable consent to performance categorized trackers. Those trackers allow us to gather data about how customers interact with the website. This information helps to improve the website's functionality and performance, as well as identify areas that may require improvement.

VIVENU.showCheckoutModal({
   id: 'your-event-id',
   lang: 'de'
})

.showTicketModal

A method that opens the ticket modal.

/**
 * @param {object} ticketParams - An object that contains information about the ticket
 */
VIVENU.showTicketModal(ticketParams)

ticketParams

Required

string

Ticket ID

secret

Required

string

The ticket's secret value

lang

Optional

enum

If set, the automatically detected language of the checkout will be overridden.

endefrlv

baseUrl

Optional

string

config

Optional

object

Configuration for the modal

config.hideWallet

Optional

boolean

Hides the Apple and Google Wallet button

config.hideTicketDownload

Optional

boolean

Hides the Ticket Download button

config.hideBarcode

Optional

boolean

Hides the Barcode

config.hideAppleWallet

Optional

Deprecated

boolean

Hides the Apple Wallet button

cookieConsent

Optional

object

Rather than displaying a cookie consent banner, the cookie consent settings can be managed externally and passed along to avoid prompting the user twice.

cookieConsent.marketing

Optional

boolean

Enable or disable consent to marketing categorized trackers. Those trackers are helping to deliver personalized content as well as offers that are relevant to the customer.

cookieConsent.performance

Optional

boolean

VIVENU.showTicketModal({
   id: 'your-ticket-id',
   secret: 'the-secret-value-for-your-ticket',
   config: {
       hideWallet: true
       hideTicketDownload: true,
       hideBarcode: true,
   }
})

DEPRECATED

.presenter.show

A method that opens the checkout modal.

/**
 * @param {object} checkoutParams - An object that contains information about the event
 */
VIVENU.presenter.show(checkoutParams)

checkoutParams

Required

string

Event ID

lang

Optional

enum

If set, the automatically detected language of the checkout will be overridden.

endefrlvhethnles-MX

baseUrl

Optional

string

shop

Optional

string

Undershop ID

channel

Optional

string

Channel ID

preselect

Optional

array<string>

List of ticket types to be preselected

testing

Optional

boolean

If true, the checkout modal will open in testing mode. The testing mode can be used to emulate how events that are not on sale look like before they go live.

embedded

Optional

boolean

VIVENU.presenter.show({
   id: 'your-event-id',
   lang: 'de'
})

Callbacks

Event	Trigger
onCheckoutCompleted	A callback that will fire when a checkout process is completed successfully.
onTicketPersonalized	A callback that will fire when a ticket was successfully personalized.
onTicketCancelled	A callback that will fire when a ticket was successfully cancelled (invalidated).

onCheckoutCompleted

A callback that will fire when a checkout process is completed successfully.

/**
 * @param {object} checkout - An object that contains information about the completed checkout process
 */
VIVENU.onCheckoutCompleted = (checkout) => {
  console.log(checkout)
}

Parameters

checkout

Required

object

The associated checkout

checkout._id

Required

string

The ID of the checkout.

checkout.secret

Required

string

The secret token of the checkout.

checkout.status

Required

string

The status of the checkout.

NEWABORTEDCOMPLETE

checkout.type

Required

string

The type of the checkout.

transactionupgraderebookingpurchaseintentsubscription

checkout.sellerId

Required

string

The ID of the seller of the checkout.

checkout.items

Required

array

An array of checkout items each representing the 'bag' of one shop.

checkout.items[]._id

Required

string

The ID of the checkout item.

checkout.items[].eventId

Required

string

The ID of the event containing the item.

checkout.items[].regularPrice

Required

number float

The regular price of the checkout item.

checkout.items[].realPrice

Required

number float

The calculated price of the checkout item.

checkout.items[].outerCharge

Required

number float

The outer charge of the checkout item.

Optional Attributes

Collapse all

checkout.items[].shopId

Optional

string

The ID of the under shop this item originated from.

checkout.items[].channelId

Optional

string

The ID of the channel this item originated from.

checkout.items[].redeemedVouchers

Optional

object

An object including information on all redeemed vouchers within the checkout item.

checkout.items[].redeemedVouchers.totalRedeemedAmount

Required

number float

The sum of all vouchers applied.

Optional Attributes

Collapse all

checkout.items[].redeemedVouchers.vouchers

Optional

array

An array of all redeemed vouchers of the checkout item.

checkout.items[].redeemedVouchers.vouchers[]._id

Required

string

The ID of the voucher.

checkout.items[].redeemedVouchers.vouchers[].code

Required

string

The Code of the voucher.

checkout.items[].redeemedVouchers.vouchers[].redeemedAmount

Required

number float

The applied value of the voucher.

checkout.items[].appliedCoupons

Optional

array

An array including information on all applied coupons within the checkout item.

Optional Attributes

Collapse all

checkout.items[].appliedCoupons[]._id

Optional

string

The ID of the applied coupon.

checkout.items[].appliedCoupons[].code

Optional

string

The code of the applied coupon.

checkout.items[].appliedDiscountInfo

Optional

object

Applied discountInfo of the checkout item.

Optional Attributes

Collapse all

checkout.items[].appliedDiscountInfo.items

Optional

array

An array of applied discount info items.

checkout.items[].appliedDiscountInfo.items[]._id

Required

string

The ID of the applied discount info item.

Optional Attributes

Collapse all

checkout.items[].appliedDiscountInfo.items[].itemId

Optional

string

The ID of the item on which the discount is applied.

checkout.items[].appliedDiscountInfo.items[].amount

Optional

number float

The amount of applied discounts.

checkout.items[].appliedDiscountInfo.items[].regularPrice

Optional

number float

The regular price before applying the discount.

checkout.items[].appliedDiscountInfo.items[].price

Optional

number float

The price after applying the discount.

checkout.items[].appliedDiscountInfo.items[].varDiscounts

Optional

array

An array of var discounts of the applied discount info item.

checkout.items[].appliedDiscountInfo.items[].varDiscounts[]._id

Required

string

The ID of the discount info.

checkout.items[].appliedDiscountInfo.items[].varDiscounts[].type

Required

string

The type of the discount.

fixvarfixPerItem

Optional Attributes

Collapse all

checkout.items[].appliedDiscountInfo.items[].varDiscounts[].discountId

Optional

string

The ID of the discount of the discount info.

checkout.items[].appliedDiscountInfo.items[].varDiscounts[].category

Optional

string

The category of the discount.

coupongroupDiscountposDiscountvoucher

checkout.items[].appliedDiscountInfo.items[].varDiscounts[].name

Optional

string

The name of the discount.

checkout.items[].appliedDiscountInfo.items[].varDiscounts[].value

Optional

number float

The value of the discount.

checkout.items[].appliedDiscountInfo.items[].varDiscounts[].allowedItems

Optional

array<string>

An array of the IDs of allowed items of the discount.

checkout.items[].appliedDiscountInfo.items[].fixDiscounts

Optional

array

An array of fix discounts of the applied discount info item.

checkout.items[].appliedDiscountInfo.items[].fixDiscounts[]._id

Required

string

The ID of the discount info.

checkout.items[].appliedDiscountInfo.items[].fixDiscounts[].type

Required

string

The type of the discount.

fixvarfixPerItem

Optional Attributes

Collapse all

checkout.items[].appliedDiscountInfo.items[].fixDiscounts[].discountId

Optional

string

The ID of the discount of the discount info.

checkout.items[].appliedDiscountInfo.items[].fixDiscounts[].category

Optional

string

The category of the discount.

coupongroupDiscountposDiscountvoucher

checkout.items[].appliedDiscountInfo.items[].fixDiscounts[].name

Optional

string

The name of the discount.

checkout.items[].appliedDiscountInfo.items[].fixDiscounts[].value

Optional

number float

The value of the discount.

checkout.items[].appliedDiscountInfo.items[].fixDiscounts[].allowedItems

Optional

array<string>

An array of the IDs of allowed items of the discount.

checkout.items[].appliedDiscountInfo.discounts

Optional

array

An array of extended discount info items.

checkout.items[].appliedDiscountInfo.discounts[]._id

Required

string

The ID of the discount info.

checkout.items[].appliedDiscountInfo.discounts[].type

Required

string

The type of the discount.

fixvarfixPerItem

Optional Attributes

Collapse all

checkout.items[].appliedDiscountInfo.discounts[].discountId

Optional

string

The ID of the discount of the discount info.

checkout.items[].appliedDiscountInfo.discounts[].category

Optional

string

The category of the discount.

coupongroupDiscountposDiscountvoucher

checkout.items[].appliedDiscountInfo.discounts[].name

Optional

string

The name of the discount.

checkout.items[].appliedDiscountInfo.discounts[].value

Optional

number float

The value of the discount.

checkout.items[].appliedDiscountInfo.discounts[].allowedItems

Optional

array<string>

An array of the IDs of allowed items of the discount.

checkout.items[].appliedDiscountInfo.discounts[].maxItemsInCart

Optional

number float

The maximum amount of items the discount will be applied towards.

checkout.items[].appliedDiscountInfo.discounts[].maxAbsoluteValue

Optional

number float

The maximum absolute value of the discount.

checkout.items[].appliedDiscountInfo.discounts[].absoluteDiscountValue

Optional

number float

The absolute value of the discount.

checkout.items[].innerFeeComponents

Optional

object

The inner fee of the transaction as a result of the checkout item including fix and var fees.

checkout.items[].innerFeeComponents._id

Required

string

The ID of the fee composition.

Optional Attributes

Collapse all

checkout.items[].innerFeeComponents.fix

Optional

array

An array of fee components for the fix fee.

checkout.items[].innerFeeComponents.fix[]._id

Required

string

The ID of the fee component.

Optional Attributes

Collapse all

checkout.items[].innerFeeComponents.fix[].amount

Optional

number float

The fee amount.

checkout.items[].innerFeeComponents.fix[].value

Optional

number float

The fee value.

checkout.items[].innerFeeComponents.fix[].total

Optional

number float

The fee total. Calculated with amount and value.

checkout.items[].innerFeeComponents.fix[].type

Optional

string

The fee type of the fee component.

onTicketonHardTicketonCart

checkout.items[].innerFeeComponents.fix[].name

Optional

string

The name of the fee.

checkout.items[].innerFeeComponents.fix[].exposed

Optional

boolean

Whether this fee will be exposed to the ticket buyer.

checkout.items[].innerFeeComponents.fix[].scheme

Optional

object

The fee scheme of the fee component.

Optional Attributes

Collapse all

checkout.items[].innerFeeComponents.fix[].scheme.schemeId

Optional

string

The ID of the fee scheme.

checkout.items[].innerFeeComponents.fix[].scheme.feeId

Optional

string

The ID of the fee scheme fee.

checkout.items[].innerFeeComponents.var

Optional

array

An array of fee components for the var fee.

checkout.items[].innerFeeComponents.var[]._id

Required

string

The ID of the fee component.

Optional Attributes

Collapse all

checkout.items[].innerFeeComponents.var[].amount

Optional

number float

The fee amount.

checkout.items[].innerFeeComponents.var[].value

Optional

number float

The fee value.

checkout.items[].innerFeeComponents.var[].total

Optional

number float

The fee total. Calculated with amount and value.

checkout.items[].innerFeeComponents.var[].type

Optional

string

The fee type of the fee component.

onTicketonHardTicketonCart

checkout.items[].innerFeeComponents.var[].name

Optional

string

The name of the fee.

checkout.items[].innerFeeComponents.var[].exposed

Optional

boolean

Whether this fee will be exposed to the ticket buyer.

checkout.items[].innerFeeComponents.var[].scheme

Optional

object

The fee scheme of the fee component.

Optional Attributes

Collapse all

checkout.items[].innerFeeComponents.var[].scheme.schemeId

Optional

string

The ID of the fee scheme.

checkout.items[].innerFeeComponents.var[].scheme.feeId

Optional

string

The ID of the fee scheme fee.

checkout.items[].innerCharge

Optional

number float

The inner charge of the checkout item.

checkout.items[].outerFeeComponents

Optional

object

The outer fee of the transaction as a result of the checkout item including fix and var fees.

checkout.items[].outerFeeComponents._id

Required

string

The ID of the fee composition.

Optional Attributes

Collapse all

checkout.items[].outerFeeComponents.fix

Optional

array

An array of fee components for the fix fee.

checkout.items[].outerFeeComponents.fix[]._id

Required

string

The ID of the fee component.

Optional Attributes

Collapse all

checkout.items[].outerFeeComponents.fix[].amount

Optional

number float

The fee amount.

checkout.items[].outerFeeComponents.fix[].value

Optional

number float

The fee value.

checkout.items[].outerFeeComponents.fix[].total

Optional

number float

The fee total. Calculated with amount and value.

checkout.items[].outerFeeComponents.fix[].type

Optional

string

The fee type of the fee component.

onTicketonHardTicketonCart

checkout.items[].outerFeeComponents.fix[].name

Optional

string

The name of the fee.

checkout.items[].outerFeeComponents.fix[].exposed

Optional

boolean

Whether this fee will be exposed to the ticket buyer.

checkout.items[].outerFeeComponents.fix[].scheme

Optional

object

The fee scheme of the fee component.

Optional Attributes

Collapse all

checkout.items[].outerFeeComponents.fix[].scheme.schemeId

Optional

string

The ID of the fee scheme.

checkout.items[].outerFeeComponents.fix[].scheme.feeId

Optional

string

The ID of the fee scheme fee.

checkout.items[].outerFeeComponents.var

Optional

array

An array of fee components for the var fee.

checkout.items[].outerFeeComponents.var[]._id

Required

string

The ID of the fee component.

Optional Attributes

Collapse all

checkout.items[].outerFeeComponents.var[].amount

Optional

number float

The fee amount.

checkout.items[].outerFeeComponents.var[].value

Optional

number float

The fee value.

checkout.items[].outerFeeComponents.var[].total

Optional

number float

The fee total. Calculated with amount and value.

checkout.items[].outerFeeComponents.var[].type

Optional

string

The fee type of the fee component.

onTicketonHardTicketonCart

checkout.items[].outerFeeComponents.var[].name

Optional

string

The name of the fee.

checkout.items[].outerFeeComponents.var[].exposed

Optional

boolean

Whether this fee will be exposed to the ticket buyer.

checkout.items[].outerFeeComponents.var[].scheme

Optional

object

The fee scheme of the fee component.

Optional Attributes

Collapse all

checkout.items[].outerFeeComponents.var[].scheme.schemeId

Optional

string

The ID of the fee scheme.

checkout.items[].outerFeeComponents.var[].scheme.feeId

Optional

string

The ID of the fee scheme fee.

checkout.items[].tickets

Optional

array

An array containing all ticket cart items.

checkout.items[].tickets[].amount

Required

integer

The amount of the cart item.

checkout.items[].tickets[].price

Required

number float

The single piece price of the cart item.

checkout.items[].tickets[].ticketTypeId

Required

string

The ID of the ticket type of the cart item.

Optional Attributes

Collapse all

checkout.items[].tickets[].type

Optional

string

The type of the cart item.

ticket

checkout.items[].tickets[]._id

Optional

string

The ID of the cart item.

checkout.items[].tickets[].name

Optional

string

The name of the cart item.

checkout.items[].tickets[].netPrice

Optional

number float

The single piece net price of the cart item.

checkout.items[].tickets[].taxRate

Optional

number float

The tax rate to be applied to this cart item. If not present the tax rate of the transaction is taken.

checkout.items[].tickets[].triggeredBy

Optional

An ID or an array of IDs of other cart items which triggered the buy action of the cart item.

One of

Only one of the following types

checkout.items[].tickets[].bundleInfo

Optional

object

Optional Attributes

Collapse all

checkout.items[].tickets[].bundleInfo.bundleId

Optional

string

checkout.items[].tickets[].bundleInfo.componentId

Optional

string

checkout.items[].tickets[].bundleInfo.optionId

Optional

string

checkout.items[].tickets[].categoryRef

Optional

string

The category reference of the ticket type.

checkout.items[].tickets[].seatingInfo

Optional

object

The associated seating object.

checkout.items[].tickets[].seatingInfo._type

Required

number float

Indicates the type of seating object. Seat = 6, General Admission = 7.

67

checkout.items[].tickets[].seatingInfo.statusId

Required

string

The ID of a container holding information about the seating status of the seating object.

Optional Attributes

Collapse all

checkout.items[].tickets[].seatingInfo._id

Optional

string

The ID of the seating object.

checkout.items[].tickets[].seatingInfo.categoryId

Optional

string

The ID of the category containing the seating object.

checkout.items[].tickets[].seatingInfo.name

Optional

string

If _type == 7. The name of the general admission.

checkout.items[].tickets[].seatingInfo.seatType

Optional

string

If _type == 6. The type of the seat. null = normal.

handicapped

checkout.items[].tickets[].seatingInfo.sectionName

Optional

string

If _type == 6. The name of the section where the seat is located.

checkout.items[].tickets[].seatingInfo.groupName

Optional

string

If _type == 6. The name of the row group where the seat is located.

checkout.items[].tickets[].seatingInfo.rowName

Optional

string

If _type == 6. The name of the row where the seat is located.

checkout.items[].tickets[].seatingInfo.seatName

Optional

string

If _type == 6. The seat name.

checkout.items[].tickets[].seatingInfo.gate

Optional

string

The entry gate associated with the seating object.

checkout.items[].tickets[].asHardTicket

Optional

boolean

Whether this ticket is a hard ticket.

checkout.items[].tickets[].triggeredAutomations

Optional

boolean

Whether the cart item triggered automations.

checkout.items[].tickets[].meta

Optional

object

Meta data which is propagated to the ticket.

checkout.items[].products

Optional

array

An array containing all product cart items.

checkout.items[].products[].type

Required

string

The type of the cart item.

product

checkout.items[].products[].amount

Required

integer

The amount of the cart item.

checkout.items[].products[].price

Required

number float

The single piece price of the cart item.

checkout.items[].products[].productVariantId

Required

string

The ID of the product variant.

Optional Attributes

Collapse all

checkout.items[].products[]._id

Optional

string

The ID of the cart item.

checkout.items[].products[].name

Optional

string

The name of the cart item.

checkout.items[].products[].netPrice

Optional

number float

The single piece net price of the cart item.

checkout.items[].products[].taxRate

Optional

number float

The tax rate to be applied to this cart item. If not present the tax rate of the transaction is taken.

checkout.items[].products[].triggeredBy

Optional

An ID or an array of IDs of other cart items which triggered the buy action of the cart item.

One of

Only one of the following types

checkout.items[].products[].bundleInfo

Optional

object

Optional Attributes

Collapse all

checkout.items[].products[].bundleInfo.bundleId

Optional

string

checkout.items[].products[].bundleInfo.componentId

Optional

string

checkout.items[].products[].bundleInfo.optionId

Optional

string

checkout.items[].products[].isFulfillable

Optional

boolean

Whether the product can be delivered

checkout.items[].additionalItems

Optional

array

An array of additional price items of the checkout itemt.

One of

Only one of the following types

checkout.items[].additionalItems[].itemId

Required

string

The ID of the item.

checkout.items[].additionalItems[].type

Required

string

The type of the additional item.

bundle

checkout.items[].additionalItems[].netPrice

Required

number float

The single piece net price of the additional item.

checkout.items[].additionalItems[].price

Required

number float

The single piece price of the additional item.

checkout.items[].additionalItems[].taxRate

Required

number float

The tax rate to be applied to this additional item.

Optional Attributes

Collapse all

checkout.items[].additionalItems[].taxInfo

Optional

object

The tax info details.

Optional Attributes

Collapse all

checkout.items[].additionalItems[].taxInfo.serviceTypeId

Optional

string

The ID of the service type.

checkout.items[].additionalItems[].taxInfo.exceptionId

Optional

string

The ID of the exception.

checkout.items[].additionalItems[].taxInfo.proceedsAccountId

Optional

string

The ID of the proceeds account.

checkout.items[].additionalItems[].taxInfo.proceedsAccountCode

Optional

string

The code of the proceeds account.

checkout.items[].additionalItems[].taxInfo.taxItems

Optional

array

The array of tax items.

checkout.items[].additionalItems[].taxInfo.taxItems[].taxTypeId

Required

string

checkout.items[].additionalItems[].taxInfo.taxItems[].rate

Required

number float

checkout.items[].additionalItems[].taxInfo.taxItems[].perUnit

Required

number float

checkout.items[].additionalItems[].taxInfo.taxItems[].total

Required

number float

Optional Attributes

Collapse all

checkout.items[].additionalItems[].taxInfo.taxItems[].name

Optional

string

checkout.items[].additionalItems[].taxInfo.taxItems[].taxPayableAccountId

Optional

string

checkout.items[].additionalItems[].taxInfo.taxItems[].taxPayableAccountCode

Optional

string

checkout.items[].additionalItems[].data

Optional

object

checkout.items[].additionalItems[].data.bundleId

Required

string

The ID of the bundle.

checkout.items[].seatingReservationToken

Optional

string

The reservation token of the selected seats.

checkout.items[].subscriptionId

Optional

string

The ID of the subscription if this item triggered one.

checkout.realPrice

Required

number float

The calculated real price of the checkout.

checkout.id

Required

Deprecated

string

ID of the completed checkout.

checkout.value

Required

Deprecated

number

Amount of money that was handled through this checkout.

Optional Attributes

Collapse all

checkout.company

Optional

string

The company name of the checkout's customer.

checkout.firstname

Optional

string

The first name of the checkout's customer.

checkout.lastname

Optional

string

The last name of the checkout's customer.

checkout.name

Optional

string

The full name of the checkout's customer.

checkout.email

Optional

string email

The email of the checkout's customer.

checkout.phone

Optional

string

The phone number of the checkout's customer.

checkout.customerId

Optional

string

The ID of the customer.

checkout.address

Optional

object

The address of the checkout.

Optional Attributes

Collapse all

checkout.address.street

Optional

string

The street of the address. Street name including number.

checkout.address.line2

Optional

string

The additional field of the address.

checkout.address.postal

Optional

string

The postal code of the address.

checkout.address.city

Optional

string

The city of the address.

checkout.address.country

Optional

string

The country of the address. An ISO 3166 country code.

checkout.address.state

Optional

string

The state of the address. If applicable

checkout.deliveryAddress

Optional

object

The delivery address of the checkout.

Optional Attributes

Collapse all

checkout.deliveryAddress.street

Optional

string

The street of the address. Street name including number.

checkout.deliveryAddress.line2

Optional

string

The additional field of the address.

checkout.deliveryAddress.postal

Optional

string

The postal code of the address.

checkout.deliveryAddress.city

Optional

string

The city of the address.

checkout.deliveryAddress.country

Optional

string

The country of the address. An ISO 3166 country code.

checkout.deliveryAddress.state

Optional

string

The state of the address. If applicable

checkout.deliveryAddress.name

Optional

string

The name of the person receiving delivery.

checkout.currency

Optional

string

An ISO 4217 3-character code of the currency.

EURUSDGBPAUDCHFTHBILSCOPMXNDKKNOKSEKQARCADISKGTQINRDOPSGDPLNSARTTDZARKYDHKDCZKKRWJPYNZDAEDMADTWD

checkout.redeemedVouchers

Optional

object

An object including information on all redeemed vouchers of the checkout.

checkout.redeemedVouchers.totalRedeemedAmount

Required

number float

The sum of all vouchers applied.

Optional Attributes

Collapse all

checkout.redeemedVouchers.vouchers

Optional

array

An array of all redeemed vouchers of the checkout.

checkout.redeemedVouchers.vouchers[]._id

Required

string

The ID of the voucher.

checkout.redeemedVouchers.vouchers[].code

Required

string

The Code of the voucher.

checkout.redeemedVouchers.vouchers[].redeemedAmount

Required

number float

The applied value of the voucher.

checkout.preferredLanguage

Optional

string

The prefered language of the checkout.

deenen-GBen-AUfreses-MXnllvhearthrutritpldakojazh-TW

checkout.origin

Optional

string

The origin of the checkout.

yourticketposrebookingupgrade

checkout.channel

Optional

string

The channel of the checkout.

onlineinternalpos

checkout.salesChannelId

Optional

string

The ID of the sales channel of the checkout.

checkout.posId

Optional

string

The ID of the POS which created the checkout.

checkout.userId

Optional

string

The ID of the user who created the checkout.

checkout.extraFields

Optional

object

An object containing key-value information.

checkout.expiresAt

Optional

string date-time

An ISO Timestamp indicating when the checkout will expire.

checkout.createdAt

Optional

string date-time

An ISO timestamp indicating when the checkout was created.

checkout.updatedAt

Optional

string date-time

An ISO timestamp indicating when the checkout was last updated.

onTicketPersonalized

A callback that will fire when a ticket was successfully personalized.

/**
 * @param {object} ticketInfo - An object that contains information about the completed checkout process
 */
VIVENU.onTicketPersonalized = (ticketInfo) => {
  console.log(ticketInfo)
}

Parameters

ticketInfo

Required

object

ticketInfo.id

Required

string

ID of the personalized ticket.

ticketInfo.name

Required

string

The entered name during personalization.

ticketInfo.extraFields

Required

object

Additional information entered during personalization.

onTicketCancelled

A callback that will fire when a ticket was successfully cancelled (invalidated).

/**
 * @param {string} ticketInfo - An object that contains information about the cancelled ticket
 */
VIVENU.onTicketCancelled = (ticketInfo) => {
  console.log(ticketInfo)
}

Parameters

ticketInfo

Required

object

ticketInfo.id

Required

string

ID of the personalized ticket.