Get Booking#
The following sections describe how to retrieve a specific booking from his code.
The input parameter “supplierReference” is the code of the booking
Path
GET admin/house-of-travel-portal/booking
Input parameters
Field |
Mandatory |
Type |
Description |
Example |
|---|---|---|---|---|
supplierReference |
Y |
string |
Code of the booking |
VWPCGZ |
currencyOf |
N |
string |
Currency type, default value: PARTNER_CHANNEL. Possible values: BASE, SUPPLIER, CONSUMER, PARTNER, PARTNER_CHANNEL |
PARTNER_CHANNEL |
exchangeRateFrom |
N |
string |
Currency from which we convert, default value: PARTNER_CHANNEL. Possible values: BASE, SUPPLIER, CONSUMER, PARTNER, PARTNER_CHANNEL |
PARTNER_CHANNEL |
exchangeRateTo |
N |
string |
Currency to which we convert, default value: CONSUMER. Possible values: BASE, SUPPLIER, CONSUMER, PARTNER, PARTNER_CHANNEL |
PARTNER_CHANNEL |
valueCurrencyOf |
N |
string |
Currency type of the finance value, default value: PARTNER_CHANNEL. Possible values: BASE, SUPPLIER, CONSUMER, PARTNER, PARTNER_CHANNEL |
PARTNER_CHANNEL |
valueType |
N |
string |
Finance value type: default value: CONSUMER_TRANSACTION. Possible values: SUPPLIER_TRANSACTION, CONSUMER_TRANSACTION, PARTNER_TRANSACTION, PARTNER_COMMISSION |
CONSUMER_TRANSACTION |
Output
Field |
Type |
Description |
Example |
|---|---|---|---|
isSandboxed |
Boolean |
Indicates whether the booking is in sandbox mode or not. |
TRUE |
supplierReference |
String |
Supplier reference for the booking. |
“VWPCGZ” |
status |
String |
Current status of the booking. |
“CONFIRMED” |
leadPassengerName |
String |
Name of the lead passenger. |
“POTTER Harry” |
utcCreatedAt |
String |
Creation date and time of the booking in UTC timezone. |
“2023-04-19T14:00:32Z” |
utcConfirmedAt |
String |
Confirmation date and time of the booking in UTC timezone. |
“2023-04-19T14:00:32Z” |
utcCancelledAt |
String |
Cancellation date and time of the booking in UTC timezone. |
“2023-04-19T14:00:32Z” |
utcDateTimeStart |
String |
Start date time of the availability in UTC timezone. |
“2023-05-31T19:00:00Z” |
utcDateTimeEnd |
String |
End time of the availability in UTC timezone. |
“2023-05-31T19:00:00Z” |
utcVoucherCreatedAt |
String |
Date & time when the voucher is created by the booking system in UTC timezone. |
“2023-06-19T14:00:32Z” |
localDateTimeStart |
String |
Start date and time of the booking in local timezone. |
“2023-05-17T11:30:00” |
localDateEnd |
String |
End date of the booking in local timezone. |
“2023-05-17” |
price.commission |
Float |
Commission amount for the booking. |
188.7084 |
price.gross |
Float |
Gross amount for the booking. |
2450.8 |
price.net |
Float |
Net amount for the booking. |
2181.2 |
price.currency |
String |
Currency used for the booking. |
AUD |
price.supplier.formattedText |
String |
formatted text of the supplier price |
FJD 3,219.98 |
price.supplier.amount |
Float |
Price from the supplier |
3219.9844 |
price.supplier.currency |
String |
Cuurency of the supplier |
AUD |
partnerAgentName |
String |
Name of the partner agent who made the booking. |
“houseoftravel-admin” |
partnerExternalReference |
String |
Partner reference for the booking. |
“12121212REF” |
canCancel |
Boolean |
Indicates whether the booking can be cancelled or not. |
TRUE |
questions.type |
String |
Type of question asked during booking. |
“NAME_GIVEN”, “NAME_FAMILY”, “EMAIL_ADDRESS”, “PHONE_MAIN” |
questions.answerFormattedText |
String |
The answer to the question. |
“Harry”, “Potter”, “eric.fontaine@amadeus.com”, “+33620000000” |
options.value |
String |
The value of the option selected during booking. |
“Trekking experience” |
options.type |
String |
The type of option selected during booking. |
“START_TIME” |
options.label |
String |
The label of the option selected during booking. |
“Ticket Type”, “Time Slot” |
product.abstract |
String |
Brief description of the product. |
“Join an excursion to Bali’s highest and holiest mountain on an early morning hike up Mount Agung to watch the sun rise over the mountain.” |
product.code |
String |
Unique code for the product. |
“UY33Y9” |
product.internalName |
String |
Internal name of the product. |
“Mount Agung sunrise trekking from Pasar Agung Temple” |
product.duration |
String |
Duration of the product. |
“P0D” |
product.attributes.name |
String |
Name of the attribute of the product. |
“Good To Know”, “Tour Type”, “Added Extras”, “Food and Drink Included” |
product.attributes.value |
String |
Value of the attribute of the product. |
“E-Voucher”, “Private”, “Guided”, “Skip-The-Line”, “Entrance Fees Included”, “Free Cancellation”, “Fast Track”, “Local |
product.contentList.type |
string |
type of content |
NOTE, EXCLUSION, INCLUSION, MEETING POINT |
product.contentList.description |
string |
value for this content |
Please bring hiking boots, long pants, a warm jacket, and a camera |
product.description |
string |
description of the product |
Join an excursion to Bali’s highest and holiest mountain on an early morning hike up Mount Agung to watch the sun rise over the mountain. |
product.categories.name |
string |
name of the categorie |
walking |
product.categorie.level1 |
string |
name of the level 1 categorie |
Tours & Sightseeing |
product.categorie.level2 |
string |
name of the level 2 categorie |
General |
product.location.cityName |
string |
name of the city where the activity takes place |
Bali |
product.location.countryName |
string |
name of the country where the activity takes place |
Indonesia |
product.images.fileName |
string |
name of the image |
thumb_15512576_cover_header.jpg |
product.images.url |
string |
url of the image |
|
product.supplierID |
string |
Supplier reference of the product |
3715ad4c-9e7e-11ea-b3d6-06b40dd1ea60 |
product.supplierName |
string |
Supplier name of the product |
Musement |
product.cancellationPolicy.refundPercentage |
string |
percentage of refund |
100 |
product.cancellationPolicy.type |
string |
type of the refund |
percentage |
product.formattedText |
string |
explanation of the conditon for the refund |
A full refund will apply if you cancel more than 48 hours before the activity start time. |
product.guideLanguages.name |
string |
name of the language |
English |
product.startPlace |
Place |
The nearest city for the start location |
|
product.endPlace |
Place |
The nearest city for the end location |
|
product.geoCoordinate |
GeoCoordinate |
latitude and longitude of the product |
|
product.geoName |
String |
The geo name of the product |
|
paxNumber |
string |
number of people in this booking |
6 |
voucherURL |
string |
URL of the voucher |
|
personList.pricingCategoryLabel |
string |
category of the person |
Adult |
personList.netPrice |
float |
net price paid by this person |
545.3 |
personList.grossPrice |
float |
gross price paid by this person |
612.7 |
personList.currency |
string |
Currency used for the booking. |
AUD |
personList.supplier.formattedText |
String |
formatted text of the supplier price |
FJD 805.0 |
personList.supplier.amount |
Float |
Price from the supplier |
804.9961 |
personList.supplier.currency |
String |
Cuurency of the supplier |
FJD |
questionListAvailability.type |
string |
type of information |
PHONE_NUMBER |
questionListAvailability.label |
string |
text in the question |
Please provide a phone number and email for contact |
questionListAvailability.answerValue |
string |
answer given by the user |
33629678459 |
owningSecurityPrincipal.name |
string |
name of the security principal that created the booking |
HouseofTravel |
owningSecurityPrincipal.type |
string |
type of the security principal that created the booking |
PARTNER_CHANNEL |
owningSecurityPrincipalUser.firstName |
string |
firstName of the security principal user that created the booking |
|
owningSecurityPrincipalUser.lastName |
string |
lastName of the security principal user that created the booking |
|
owningSecurityPrincipalUser.email |
string |
email of the security principal user that created the booking |
|
owningSecurityPrincipalUser.name |
string |
name of the security principal user that created the booking |
|
partnerChannelName |
string |
The name of the partnerChannel that this booking is attributed to |
|
finance.currency |
string |
The finance currency. |
NZD |
finance.exchangeRate |
string |
The exchange rate from exchangeRateFrom to exchangeRateTo. |
0.925411486908813 |
finance.value.amount |
float |
The finance amount in currencyOf currency. |
1026.246176360225 |
finance.value.currency |
string |
The selected currency for finance value. |
NZD |
finance.value.formattedText |
string |
The amount in text format with currency symbol. |
NZ$ 1,026.25 |
Response Body
{
"isSandboxed": true,
"supplierReference": "SDCDH4",
"status": "CONFIRMED",
"leadPassengerName": "EXTERNALPRODUCTSKYDIVE Eric FONTAINE",
"utcCreatedAt": "2023-05-17T11:21:34Z",
"utcVoucherCreatedAt": "2023-05-17T11:26:08Z",
"utcConfirmedAt": "2023-05-17T12:21:34Z",
"utcCancelledAt": "2023-05-20T14:25:07Z",
"utcDateTimeStart": "2023-05-31T19:00:00Z",
"utcDateTimeEnd": "2023-05-31T19:00:00Z",
"localDateTimeStart": "2023-06-01T07:00:00",
"localDateEnd": "2023-06-01",
"price": {
"commission": 188.7084,
"gross": 2450.8,
"net": 2181.2,
"currency": "AUD",
"supplier": {
"formattedText": "FJD 3,219.98",
"amount": 3219.9844,
"currency": "FJD"
}
},
"partnerAgentName": "houseoftravel-admin",
"partnerChannelName": "HouseofTravel",
"partnerExternalReference": "1234ABCD",
"canCancel": true,
"questions": [
{
"type": "OPTIONS",
"answerFormattedText": "Mercure Nadi"
},
{
"type": "NAME_GIVEN",
"answerFormattedText": "Eric FONTAINE"
},
{
"type": "NAME_FAMILY",
"answerFormattedText": "ExternalProductSkydive"
},
{
"type": "EMAIL_ADDRESS",
"answerFormattedText": "eric.fontaine@amadeus.com"
},
{
"type": "PHONE_MAIN",
"answerFormattedText": "+33454545454"
}
],
"options": [
{
"type": "START_TIME",
"value": "07:00",
"label": "Start Time"
},
{
"value": "EN - GUIDE",
"label": "Guide language"
}
],
"product": {
"abstract": "THE HIGHER YOU GO, THE LONGER THE RUSH!Skydive Fiji is operating from Nadi and jumping on to Denarau Island. We are the most experienced skydiving operation in Fiji.",
"code": "2NTVL1",
"internalName": "Skydive Fiji Legend 13000ft Tandem Jump (60 seconds free fall)",
"duration": "PT120M",
"attributes": [
{
"name": "Good To Know",
"value": "E-Voucher"
}
],
"contentList": [
{
"type": "EXCLUSION",
"description": "DVD (available to purchase)"
},
{
"type": "HIGHLIGHT",
"description": "Hotel pickup and drop-off in the Denarau and and Nadi areas"
},
{
"type": "NOTE",
"description": "Public transportation options are available nearby"
},
{
"type": "INCLUSION",
"description": "Personalised instruction & safety briefing video"
},
{
"type": "EXCLUSION",
"description": "Souvenir photos (available to purchase)"
},
{
"type": "NOTE",
"description": "Travelers should have at least a moderate level of physical fitness"
},
{
"type": "INCLUSION",
"description": "Refreshments"
},
{
"type": "HIGHLIGHT",
"description": "Scenic flight leading up to the jump"
},
{
"type": "INCLUSION",
"description": "Denarau and Nadi Area Hotel return transfers"
},
{
"type": "HIGHLIGHT",
"description": "Jump from a variety of heights in tandem with a guide, free-falling for up to a minute"
},
{
"type": "NOTE",
"description": "Children ages 6-18 years require written consent from their parents or guardian and their jump is subject to Instructors Safety Assessment"
},
{
"type": "HIGHLIGHT",
"description": "Enjoy a peaceful parachute ride down to the ground"
},
{
"type": "INCLUSION",
"description": "Epic freefall up to one minute"
},
{
"type": "NOTE",
"description": "If you are over 95kg conditions and surcharge may apply."
},
{
"type": "NOTE",
"description": "F$220.00 VIP - Hand Cam: Video OR Stills Only on USB"
},
{
"type": "NOTE",
"description": "F$285.00 VIP - Hand Cam: Combo Video AND Stills on USB"
},
{
"type": "NOTE",
"description": "F$510.00 VIP - Ultimate Camera Package: Outside Camera and Hand Cam Combo on USB (Includes the handycam video & photos combo taken by your tandem master and video and photos taken by another camera man flying around you. So you get 2 beautiful views of your skydive!)"
},
{
"type": "NOTE",
"description": "Face masks provided for travellers"
},
{
"type": "NOTE",
"description": "Hand sanitiser available to travellers and staff"
},
{
"type": "NOTE",
"description": "Regularly sanitised high-traffic areas"
},
{
"type": "NOTE",
"description": "Gear/equipment sanitised between use"
},
{
"type": "NOTE",
"description": "Transportation vehicles regularly sanitised"
},
{
"type": "NOTE",
"description": "Guides required to regularly wash hands"
},
{
"type": "NOTE",
"description": "Regular temperature checks for staff"
},
{
"type": "ROOT",
"name": "Skydive Fiji Legend 13000ft Tandem Jump (60 seconds free fall)",
"description": "THE HIGHER YOU GO, THE LONGER THE RUSH!Skydive Fiji is operating from Nadi and jumping on to Denarau Island. We are the most experienced skydiving operation in Fiji. Tandem Skydiving is the best way to introduce yourself to the world of skydiving. It is the safest, easiest and most enjoyable way to do your first skydive. Almost anyone can skydive however you will need parental consent if you are under 18 yrs.\n\n Freefall Time\n\n You can jump from 8,000 feet, go 'radical' to 10,000 and double your freefall time, 'extreme' at 12,000, else become a legend' on your very first jump at 14,000 feet!\n\n Going Higher isn't Scarier, It's more Fun! \n\nVideo/Photo Package\n\n Let us make sure you don't forget a moment of this once-in-a-lifetime experience. At an additional cost we offer High Definition Hand-Camera Photo/Video options and Dedicated Camera Flyer packages."
}
],
"description": "THE HIGHER YOU GO, THE LONGER THE RUSH!Skydive Fiji is operating from Nadi and jumping on to Denarau Island. We are the most experienced skydiving operation in Fiji. Tandem Skydiving is the best way to introduce yourself to the world of skydiving. It is the safest, easiest and most enjoyable way to do your first skydive. Almost anyone can skydive however you will need parental consent if you are under 18 yrs.\n\n Freefall Time\n\n You can jump from 8,000 feet, go 'radical' to 10,000 and double your freefall time, 'extreme' at 12,000, else become a legend' on your very first jump at 14,000 feet!\n\n Going Higher isn't Scarier, It's more Fun! \n\nVideo/Photo Package\n\n Let us make sure you don't forget a moment of this once-in-a-lifetime experience. At an additional cost we offer High Definition Hand-Camera Photo/Video options and Dedicated Camera Flyer packages.",
"categories": [],
"location": {
"cityName": "Nadi",
"countryName": "Fiji"
},
"images": [
{
"fileName": "04.jpg",
"url": "https://images.holibob.tech/eyJrZXkiOiJwcm9kdWN0SW1hZ2VzLzNlM2ZhNjA2LTEyYzQtNGYwMi1hZWQ2LWZkYWI2ZDY3OWMzNSIsImVkaXRzIjp7InJlc2l6ZSI6eyJmaXQiOiJjb3ZlciIsIndpZHRoIjoxOTIwLCJoZWlnaHQiOjEwODB9fX0="
},
{
"fileName": "e2.jpg",
"url": "https://images.holibob.tech/eyJrZXkiOiJwcm9kdWN0SW1hZ2VzL2FlOGE1ZmRlLTRmZmYtNDRlNS05NjhkLWM3M2Q0M2NmYjRlOSIsImVkaXRzIjp7InJlc2l6ZSI6eyJmaXQiOiJjb3ZlciIsIndpZHRoIjoxOTIwLCJoZWlnaHQiOjEwODB9fX0="
},
{
"fileName": "fb.jpg",
"url": "https://images.holibob.tech/eyJrZXkiOiJwcm9kdWN0SW1hZ2VzLzgyNDQ5NDMxLTNkYTMtNDA5Ny1iNTUzLWNiYzNjMWU1ODBmYyIsImVkaXRzIjp7InJlc2l6ZSI6eyJmaXQiOiJjb3ZlciIsIndpZHRoIjoxOTIwLCJoZWlnaHQiOjEwODB9fX0="
},
{
"fileName": "e4.jpg",
"url": "https://images.holibob.tech/eyJrZXkiOiJwcm9kdWN0SW1hZ2VzL2E2NzA5Mjc1LThhNWUtNGI2Zi1iMTYyLTA3YmE2NDkxYWFhMCIsImVkaXRzIjp7InJlc2l6ZSI6eyJmaXQiOiJjb3ZlciIsIndpZHRoIjoxOTIwLCJoZWlnaHQiOjEwODB9fX0="
},
{
"fileName": "ff.jpg",
"url": "https://images.holibob.tech/eyJrZXkiOiJwcm9kdWN0SW1hZ2VzLzI0NDBmZTU4LTk4MDItNGQyNi05NmMxLTRjNjMxYTUyYWEzNyIsImVkaXRzIjp7InJlc2l6ZSI6eyJmaXQiOiJjb3ZlciIsIndpZHRoIjoxOTIwLCJoZWlnaHQiOjEwODB9fX0="
},
{
"fileName": "e5.jpg",
"url": "https://images.holibob.tech/eyJrZXkiOiJwcm9kdWN0SW1hZ2VzLzY5MmQ2ZTAxLWI1OGUtNDVlYy1iZDQ4LWQ5ZWFiY2NmZmU0YiIsImVkaXRzIjp7InJlc2l6ZSI6eyJmaXQiOiJjb3ZlciIsIndpZHRoIjoxOTIwLCJoZWlnaHQiOjEwODB9fX0="
},
{
"fileName": "d0.jpg",
"url": "https://images.holibob.tech/eyJrZXkiOiJwcm9kdWN0SW1hZ2VzL2YwMGI5NzZjLTJiNDktNDc0Mi1hMjUzLWQwN2FiMmUzMmM1OCIsImVkaXRzIjp7InJlc2l6ZSI6eyJmaXQiOiJjb3ZlciIsIndpZHRoIjoxOTIwLCJoZWlnaHQiOjEwODB9fX0="
},
{
"fileName": "75.jpg",
"url": "https://images.holibob.tech/eyJrZXkiOiJwcm9kdWN0SW1hZ2VzLzEzZjkxMjczLTIyZGYtNDE3NS1iY2JjLTAwZTVlOTY2Y2IyNyIsImVkaXRzIjp7InJlc2l6ZSI6eyJmaXQiOiJjb3ZlciIsIndpZHRoIjoxOTIwLCJoZWlnaHQiOjEwODB9fX0="
},
{
"fileName": "64.jpg",
"url": "https://images.holibob.tech/eyJrZXkiOiJwcm9kdWN0SW1hZ2VzL2Q5M2NmNjdiLTgxOTUtNGQzMy1iYzczLTA3NjUyYmY2M2U0YSIsImVkaXRzIjp7InJlc2l6ZSI6eyJmaXQiOiJjb3ZlciIsIndpZHRoIjoxOTIwLCJoZWlnaHQiOjEwODB9fX0="
}
],
"supplierID": "9bd1d20b-a17b-4377-92b0-967266f93b9d",
"supplierName": "VIATOR",
"cancellationPolicy": [
{
"refundPercentage": 100,
"type": "PERCENTAGE",
"formattedText": "A full refund will apply if you cancel more than 24 hours before the activity start time."
},
{
"refundPercentage": 0,
"type": "PERCENTAGE",
"formattedText": "No refund is possible if you cancel less than 24 hours before the activity start time."
}
],
"guideLanguages": [
{
"name": "English"
},
{},
{}
],
"geoCoordinate": {
"latitude": -17.7798614,
"longitude": 177.3847809
},
"startPlace": {
"formattedAddress": "Denarau Road, Nadi, Fiji",
"name": "Skydive Fiji",
"googlePlaceId": "ChIJT-_YLbtbF24R244TeQUnIc8",
"geoCoordinate": {
"latitude": -17.7798614,
"longitude": 177.3847809
}
},
"geoName": "Denarau Road, Nadi, Fiji"
},
"paxNumber": 4,
"voucherURL": "https://s3.eu-west-1.amazonaws.com/tech.holibob.files/bookingVouchers/fc56efa9-9a82-488d-a23e-40af19b40e12/voucher.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA4H5CGSAPISTGYLFI%2F20230525%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20230525T090522Z&X-Amz-Expires=10000&X-Amz-Signature=7f3c109ac9ead5fc7f8d89f29e37a21eba372daf6936b846d6061a4b0f2e599f&X-Amz-SignedHeaders=host",
"finance": {
"currency": "GBP",
"exchangeRate": "1.87201",
"value": {
"amount": 1309.1810406995692,
"currency": "GBP",
"formattedText": "£ 1,309.18"
}
},
"personList": [
{
"pricingCategoryLabel": "Adult",
"netPrice": 545.3,
"grossPrice": 612.7,
"currency": "AUD",
"supplier": {
"formattedText": "FJD 805.00",
"amount": 804.9961,
"currency": "FJD"
}
},
{
"pricingCategoryLabel": "Child",
"netPrice": 545.3,
"grossPrice": 612.7,
"currency": "AUD",
"supplier": {
"formattedText": "FJD 805.00",
"amount": 804.9961,
"currency": "FJD"
}
},
{
"pricingCategoryLabel": "Child",
"netPrice": 545.3,
"grossPrice": 612.7,
"currency": "AUD",
"supplier": {
"formattedText": "FJD 805.00",
"amount": 804.9961,
"currency": "FJD"
}
},
{
"pricingCategoryLabel": "Adult",
"netPrice": 545.3,
"grossPrice": 612.7,
"currency": "AUD",
"supplier": {
"formattedText": "FJD 805.00",
"amount": 804.9961,
"currency": "FJD"
}
}
],
"questionListAvailability": [],
"owningSecurityPrincipal": {
"name": "HouseofTravel",
"type": "PARTNER_CHANNEL"
}
}
Status code
Code |
Description |
|---|---|
200 |
Organization retrieved successfully |
400 |
Bad Request |
401 |
Unauthorized |
403 |
Forbidden |
500 |
Internal server error |