Variable

Description

Backoffice

Terminal

{supplier.telephone}

supplier phone number

Y

Y

{supplier.email}

supplier email address

Y

Y

{supplier.address}

supplier address

Y

Y

{supplier.name}

name of the supplier or their destination

Y

Y

Variable

Description

Backoffice

Terminal

{booking.adjustment_notes}

description and value of the price adjustment applied to the booking

Y

N

{adjustment_notes}

description and value of the price adjustment applied to the booking

Y

N

{booking.balance}

outstanding amount for the booking

Y

N

{booking.code}

imported booking code

Y

Y

{created_at}

date and time when the booking was created

Y

N

{booking.created_at}

date and time when the booking was created

Y

Y

{booking.created_at_dow}

day of the week when the booking was created

Y

Y

{booking.created_at_time}

time when the booking was created

Y

Y

{booking.date}

travel date

Y

Y

{booking.date_dmy}

booking date in DD-MM-YYYY format

Y

N

{booking.date_mdy}

booking date in MM-DD-YYYY format

Y

N

{booking.duration}

duration of the tour

Y

Y

{booking.notices}

notices set in the dashboard

Y

N

{product.operator_mobile}

operator phone number

Y

N

{booking.package}

name of the booked package

Y

Y

{booking.package_option}

name of the package option

Y

Y

{booking.paid}

amount paid for the booking

Y

N

{booking.primary}

indicates if it is the primary product in an order (Yes / No options)

Y

N

{booking.pass}

reference for products inside a pass

Y

N

{booking.purchases}

booking purchases

Y

N

{booking.redeemed_at}

redemption date

Y

Y

{booking.redeemed_at_dow}

day of the week for redemption

Y

Y

{booking.redeemed_at_time}

time of redemption

Y

Y

{booking.refunded}

amount refunded to the customer

Y

N

{booking.reference}

unique identifier for the booking

Y

Y

{booking.supplier_reference}

booking suppliers's unique identifier

Y

N

{booking.reseller_reference}

booking reseller's unique identifier

Y

Y

{booking.size}

number of adults, children, etc.

Y

Y

{booking.status}

booking status in the dashboard

Y

N

{booking.tickets}

number of tickets by tier

Y

Y

{booking.tiers}

ticket tiers

Y

N

{booking.units}

list of booked units

Y

N

{booking.upgrades}

booking upgrades (extras)

Y

N

Variable

Description

Backoffice

Terminal

{booking.cancelled_at}

date and time of booking cancellation

Y

N

{booking.updated_at}

date and time of the last update

Y

N

Variable

Description

Backoffice

Terminal

{booking.not_redeemed_warning}

prints the NOT REDEEMED / NOT A TICKET message on a printed ticket when the associated booking was not redeemed

Y

Y

Variable

Description

Backoffice

Terminal

{booking.charity_roundup}

charity roundup

Y

N

{booking.commission}

commission amount

Y

N

{booking.cost}

booking cost

Y

N

{booking.discount}

discount on the booking

Y

Y

{booking.margin}

margin on the booking

Y

N

{booking.tax}

tax amount (if set)

Y

Y

{booking.total}

total booking price

Y

Y

{booking.total_no_tax}

booking total without tax

Y

Y

Variable

Description

Backoffice

Terminal

{booking.meeting_point}

meeting location

Y

Y

{booking.meeting_point_coordinates}

GPS coordinates of the meeting point

Y

N

{booking.meeting_time}

meeting time

Y

Y

Variable

Description

Backoffice

Terminal

{booking.public_notes}

notes by concierge / reseller agents when booking on behalf of a client

Y

N

{booking.private_notes}

private notes by concierge / reseller agents

Y

N

{booking.pickup_notes}

pickup notes

Y

N

Variable

Description

Backoffice

Terminal

{booking.card_total}

value of card payment

Y

N

{booking.cash_total}

value of cash payment

Y

N

{booking.voucher_total}

value of voucher used as payment

Y

N

{booking.other_total}

value of other forms of payment, such as bank transfer

Y

N

Variable

Description

Backoffice

Terminal

{booking.question_answers}

question and answer(s) associated with the booking

Y

N

{booking.answers}

only answer(s) to the question associated with the booking

Y

N

{booking.all_answers}

answer(s) to the question(s) associated with every level of the order (order, booking, ticket)

Y

N

Variable

Description

Backoffice

Terminal

{booking.resource_allocations}

resources allocated to the tour

Y

N

{booking.guide}

guide assigned to the tour

Y

N

Variable

Description

Backoffice

Terminal

{booking.tour_group}

product tour group

Y

Y

{booking.opening_hours}

opening hours

Y

Y

{booking.pickup_time}

pickup time (if pickup is available)

Y

Y

{booking.pickup_requested}

customer requested pickup (YES / NO)

Y

Y

{booking.dropoff_time}

dropoff time

Y

Y

{booking.dropoff_requested}

customer requested dropoff (YES / NO)

Y

Y

Variable

Description

Backoffice

Terminal

{booking.active_from_iso8601}

date since when the booking is valid in YYYY-MM-DD format

Y

N

{booking.active_to_iso8601}

date when the booking expires in YYYY-MM-DD format

Y

N

{booking.expires_on}

booking expiry date

Y

N

{booking.open_dated}

open dated booking (YES / NO)

Y

Y

{booking.valid_from}

valid from date

Y

Y

{booking.valid_until_date}

valid until date

Y

Y

{booking.valid_from_date}

valid from date

Y

Y

{booking.valid_until_time}

valid until time

Y

Y

{booking.valid_from_time}

valid from time

Y

Y

{booking.valid_until_dow}

valid until day of week

Y

Y

{booking.valid_from_dow}

valid from day of week

Y

Y

{booking.valid_from_date_long}

valid from date in DOW DD MM, YYYY format

Y

Y

{booking.valid_until_date_long}

valid until date in DOW DD MM, YYYY format

Y

Y

Variable

Description

Backoffice

Terminal

{booking.pdf_url}

voucher URL to a PDF file

Y

N

{booking.pkpass_url}

voucher URL to a PKPASS file, which can be added to a digital wallet

Y

N

Variable

Description

Backoffice

Terminal

{customer.full_name}

customer's complete name

Y

N

{customer.first_name}

customer's first name

Y

N

{customer.last_name}

customer's last name

Y

N

{customer.email}

customer's email address

Y

N

{customer.mobile}

customer's mobile phone number

Y

N

{customer.company}

organisation where the customer is employed

Y

N

{customer.notes}

customer's notes added during checkout

Y

N

{customer.language}

customer's preferred language

Y

N

{customer.country}

customer's country of residence

Y

N

{customer.state}

state or province (in the USA or Canada) where the customer lives

Y

N

{customer.address}

street name and number of the customer's residence

Y

N

{customer.postal_code}

ZIP or postal code of customer's address

Y

N

{customer.tax_id}

customer’s tax identification number

Y

N

{customer.tax_office}

tax office where the customer files or reports their taxes

Y

N

Variable

Description

Backoffice

Terminal

{dropoff.name}

name of the dropoff

Y

Y

{dropoff.address}

address of a dropoff

Y

Y

{dropoff.directions}

directions to a dropoff

Y

Y

{pickup.name}

name of pickup

Y

Y

{pickup.address}

address of pickup

Y

Y

{pickup.directions}

directions to a pickup

Y

Y

{hotel.name}

hotel pickup name

Y

Y

Variable

Description

Backoffice

Terminal

{product.name}

product name

Y

Y

{product.title}

product title

Y

N

{product.code}

product code

Y

Y

{product.caption}

one sentence description

Y

Y

{product.description}

one paragraph description

Y

Y

{product.destination}

product destination

Y

Y

{product.exclusions}

things not included with the booking

Y

N

{product.inclusions}

things included in booking

Y

N

{product.long_description}

long product description

Y

N

{option.name}

option name

Y

Y

{option.description}

option summary

Y

Y

{option.code}

option code

Y

Y

{option.language}

option language

Y

Y

{option.meeting_point}

option meeting point

Y

N

{option.meeting_time}

option meeting time

Y

N

{product.booking_terms}

booking terms

Y

N

{product.usage_instructions}

voucher / ticket instructions

Y

Y

{product.redemption_instructions}

redemption instructions

Y

N

{product.meeting_point}

product meeting point

Y

N

{product.meeting_time}

product meeting time

Y

N

{tour.time}

tour time in 12-hour format

Y

Y

{tour.time_24hr}

tour time in 24-hour format

Y

N

{tour.code}

tour code, for example, flight number

Y

N

{date}

tour date

Y

N

{tour.meeting_point}

tour meeting point

Y

N

{tour.meeting_time}

tour meeting time

Y

N

{product.supplier_company}

supplier company name

Y

N

{product.supplier_contact}

supplier contact person

Y

N

{product.supplier_email}

supplier email

Y

N

{product.supplier_address}

supplier address

Y

N

{product.operator}

operator company name

Y

N

{product.operator_contact}

operator contact person

Y

N

{product.operator_email}

operator email

Y

N

{product.operator_address}

operator address

Y

N

{product.cancellation_policy}

booking cancellation policy

Y

N

{combination.product}

name of the combination product

Y

N

Variable

Description

Backoffice

Terminal

{combination.discount}

discount used for a combination product

Y

N

{promotion.name}

promotion name

Y

Y

{promotion.description}

promotion description

Y

Y

{promotion.code}

promotion code

Y

Y

{promotion.discount}

discounted value

Y

N

{option.from_point}

Point-to-Point start location

Y

Y

{option.to_point}

Point-to-Point end location

Y

Y

{option.from_point_group}

group (zone) of the Point-to-Point start location

Y

Y

{option.to_point_group}

group (zone) of the Point-to-Point end location

Y

Y

Variable

Description

Backoffice

Terminal

{item.name}

item name

Y

Y

{item.code}

item code

Y

Y

{item.destination}

item destination

Y

Y

{item.description}

item description

Y

Y

{item.category}

item category

Y

Y

{item.tax_label}

item tax label

Y

N

{item.tax_rate}

item tax rate

Y

N

Variable

Description

Backoffice

Terminal

{tickets}

quantity and name(s) of the ticket tier(s)

Y

N

{ticket.code}

ticket code (if imported)

Y

Y

{ticket.short_code}

ticket number available on the booking

Y

Y

{ticket.date_dmy}

travel date in DD-MM-YYYY format

Y

N

{ticket.date_mdy}

travel date in MM-DD-YYYY format

Y

N

{ticket.reference}

unique identifier for the ticket

Y

Y

{ticket.size}

number of PAX

Y

N

{ticket.tickets}

ticket tiers

Y

Y

{ticket.unit}

list of units

Y

Y

Variable

Description

Backoffice

Terminal

{ticket.commission}

sales commission on a ticket

Y

N

{ticket.cost}

cost per ticket

Y

N

{ticket.discount}

discount on a ticket

Y

Y

{ticket.margin}

margin per ticket

Y

N

{ticket.price}

price per ticket

Y

Y

{ticket.price_no_tax}

price per ticket without tax

Y

Y

{ticket.total}

total price per ticket

Y

N

{ticket.total_no_tax}

total price per ticket without tax

Y

N

{ticket.tax}

tax per ticket

Y

Y

Variable

Description

Backoffice

Terminal

{ticket.card_total}

value of card payment

Y

N

{ticket.cash_total}

value of cash payment

Y

N

{ticket.voucher_total}

value of voucher used as payment

Y

N

{ticket.other_total}

value of other forms of payment, such as bank transfer

Y

N

Variable

Description

Backoffice

Terminal

{ticket.created_at}

date when the ticket was created

Y

Y

{ticket.updated_at}

date when the ticket was updated

Y

Y

Variable

Description

Backoffice

Terminal

{ticket.not_redeemed_warning}

shows the NOT REDEEMED / NOT A TICKET message on a printed ticket when the associated ticket was not redeemed

Y

Y

Variable

Description

Backoffice

Terminal

{ticket.tier}

ticket type

Y

Y

{ticket.upgrades}

ticket upgrades (extras)

Y

N

Variable

Description

Backoffice

Terminal

{ticket.valid_from_dow}

valid from day of week

Y

Y

{ticket.valid_from_time}

valid from time

Y

Y

{ticket.valid_from_date}

valid from date

Y

Y

{ticket.valid_until_dow}

valid until day of week

Y

Y

{ticket.valid_until_date}

valid until date

Y

Y

{ticket.valid_until_time}

valid until time

Y

Y

{ticket.valid_from_date_long}

valid from date in DOW DD MM, YYYY format

Y

Y

{ticket.valid_until_date_long}

valid until date in DOW DD MM, YYYY format

Y

Y

Variable

Description

Backoffice

Terminal

{order.balance}

outstanding amount of an order

Y

N

{order.gratuity}

tip amount

Y

N

{order.paid}

amount paid for the booking

Y

N

{order.surcharge}

surcharge fee

Y

N

{order.tax}

order tax (if set)

Y

Y

{order.total}

order total

Y

Y

Variable

Description

Backoffice

Terminal

{order.cancelled_at}

date and time of order cancellation

Y

N

Variable

Description

Backoffice

Terminal

{order.checkout_url}

send Pay now links or confirm quotes

Y

N

{order.code}

order code (if imported)

Y

Y

{order.confirmed_at}

order date

Y

Y

{order.created_at}

date when the ticket was created

Y

Y

{order.currency}

currency in which the order was created

Y

Y

{order.reference}

unique identifier for the order

Y

Y

{order.shift_sequence}

shift sequence of the order

Y

Y

{order.source}

source of the order, for example web checkout, terminal, backoffice

Y

Y

{order.ip_address}

IP address of online bookings

Y

N

{order.latitude}

location coordinates where the order was made (street sales)

Y

Y

{order.longitude}

location coordinates where the order was made (street sales)

Y

Y

{order.notes}

notes added during checkout

Y

N

{order.test}

test order (YES / NO)

Y

N

{order.user_agent}

browser client (online sales)

Y

N

{order.voucher_code}

voucher code used to purchase the order

Y

N

Variable

Description

Backoffice

Terminal

{order.answers}

question and answer(s) associated with the order

Y

N

{order.question_answers}

only the answer(s) to the question associated with the order

Y

N

Variable

Description

Backoffice

Terminal

{gift.amount}

gift voucher value

Y

Y

{gift.code}

gift code

Y

Y

{gift.message}

message from the purchaser

Y

N

{recipient.full_name}

recipient of the gift voucher

Y

N

{customer.full_name}

purchaser of the gift voucher

Y

N

{gift.reference}

unique identifier for the gift voucher

Y

Y

{gift.instructions}

instructions associated with the gift voucher

Y

N

{gift.expires_at}

gift voucher expiry date

Y

N

{recipient.first_name}

first name of the gift voucher recipient

Y

N

{recipient.last_name}

last name of the gift voucher recipient

Y

N

{recipient.email}

email of the gift voucher recipient

Y

N

{recipient.mobile}

phone number of the gift voucher recipient

Y

N

{recipient.language}

language of the gift voucher recipient

Y

N

{recipient.country}

country of the gift voucher recipient

Y

N

{recipient.address}

address of the gift voucher recipient

Y

N

Variable

Description

Backoffice

Terminal

{location.name}

location name

Y

Y

{seller.name}

seller name (direct sales)

Y

Y

{shift.date}

shift date

Y

N

{shift.started_at}

shift start time

Y

N

{shift.ended_at}

shift end time

Y

N

{terminal.name}

terminal name

Y

Y

{user.name}

Ventrata dashboard user name (backoffice sales)

Y

N

Variable

Description

Backoffice

Terminal

{reseller.name}

reseller name

Y

Y

{reseller.code}

reseller code

Y

N

{reseller.band}

reseller band

Y

N

{reseller.address}

reseller address

Y

N

{reseller.directions}

directions to reseller address

Y

N

{agent.name}

concierge agent name (reseller sales)

Y

Y

{voucher.tier}

voucher ticket tier

Y

N

{voucher.unit}

list of units on the reseller voucher

Y

N

{voucher.quantity}

number of voucher tickets

Y

N

{outlet.name}

reseller sub brand

Y

Y

Variable

Description

Backoffice

Terminal

{purchase.reference}

unique identifier of the purchase

Y

Y

{purchase.total}

total purchase price

Y

Y

{purchase.total_no_tax}

purchase price without tax

Y

Y

{purchase.tax}

purchase price with tax

Y

Y

{purchase.updated_at}

date and time of the last update

Y

Y

{purchase.created_at}

date and time of when the purchase was created

Y

Y

{purchase.quantity}

number of purchases

Y

Y