https://api.holidayextras.co.uk/
+HELLO
+We anticipate that many application developers will want to cache the results to certain searches. For example, there is no need to request locations every time. Much better to store these locally and create a routine that calls the API at regular intervals to get the latest list.
diff --git a/docs/feed.xml b/docs/feed.xml index ba6cd536..5a9a1ca8 100644 --- a/docs/feed.xml +++ b/docs/feed.xml @@ -1,2 +1,2 @@ -Example request:
-https://api.holidayextras.co.uk/v1/sandbox/carHire/products?key=1&From=06NOV16&ArrivalTime=1200&To=13NOV&DepartTime=1600&PickupLocation=FL965&DropoffLocation=FL965&DateOfBirth=1990-10-13
diff --git a/docs/hxapi/parking/av/airport/index.html b/docs/hxapi/parking/av/airport/index.html
index 526fe7b5..75c6ad93 100644
--- a/docs/hxapi/parking/av/airport/index.html
+++ b/docs/hxapi/parking/av/airport/index.html
@@ -57,7 +57,7 @@ Endpoint
For example, for London Gatwick the endpoint is:
-
+
- XML
@@ -65,7 +65,7 @@ Endpoint
-
+
-
https://api.holidayextras.co.uk/v1/carpark/LGW
@@ -452,7 +452,7 @@ Worked Examples
UK Products Availability Request
-
+
- XML
@@ -460,7 +460,7 @@ UK Products Availability Request
-
+
-
https://api.holidayextras.co.uk/carpark/LGW?ABTANumber=YourABTANumber&Password=YourPassword&Initials=YourInitials&key=YourKey&token=YourToken&ArrivalDate=2020-01-07&ArrivalTime=1200&DepartDate=2020-01-08&DepartTime=1200&NumberOfPax=1
@@ -479,7 +479,7 @@ UK Products Availability Response
NB: This is a shortened example compiled from a full availability response.
-
+
- XML
@@ -487,7 +487,7 @@ UK Products Availability Response
-
+
-
<?xml version="1.0"?>
@@ -715,7 +715,7 @@ UK Products Availability Response
European Products Availability Request
-
+
- XML
@@ -723,7 +723,7 @@ European Products Availability R
-
+
-
https://api.holidayextras.co.uk/carpark/MUC?ABTANumber=YourABTANumber&Password=YourPassword&Initials=YourInitials&key=YourKey&token=YourToken&ArrivalDate=2017-12-01&ArrivalTime=1200&DepartDate=2017-12-08&DepartTime=1200&NumberOfPax=1&System=ABG&lang=en
@@ -742,7 +742,7 @@ European Products Availability
NB: This is a shortened example compiled from a full availability response.
-
+
- XML
@@ -750,7 +750,7 @@ European Products Availability
-
+
-
<?xml version="1.0"?>
diff --git a/docs/hxapi/productlibrary/index.html b/docs/hxapi/productlibrary/index.html
index 71c7eb87..cf571f1e 100644
--- a/docs/hxapi/productlibrary/index.html
+++ b/docs/hxapi/productlibrary/index.html
@@ -91,7 +91,7 @@ Available Fields
The available fields vary by product type. For each product type there is a recommended list of fields which should be requested to get the information required to effectively sell the product.
-
+
- Parking
@@ -105,7 +105,7 @@ Available Fields
-
+
-
Recommended
@@ -976,7 +976,7 @@ Example 1 - Default Response
Request
-
+
- Live (XML)
@@ -988,7 +988,7 @@ Request
-
+
-
https://api.holidayextras.co.uk/v1/product/LGW4/lite?token=000015778&key=mytestkey
@@ -1016,7 +1016,7 @@ Request
Response
-
+
- XML
@@ -1024,7 +1024,7 @@ Response
-
+
-
<?xml version="1.0"?>
@@ -1411,7 +1411,7 @@ Example 2 - Restricted field list
Request
-
+
- Live (XML)
@@ -1423,7 +1423,7 @@ Request
-
+
-
https://api.holidayextras.co.uk/v1/product/LGW4/lite?token=000015778&key=mytestkey&fields=name,longitude,latitude
@@ -1451,7 +1451,7 @@ Request
Response
-
+
- XML
@@ -1459,7 +1459,7 @@ Response
-
+
-
<?xml version="1.0"?>
@@ -1520,7 +1520,7 @@ Request
Requests for German products return a different set of fields. Explanation of fields not currently available.
-
+
- Live (XML)
@@ -1532,7 +1532,7 @@ Request
-
+
-
https://api.holidayextras.co.uk/v1/product/FRA0?key=mytestkey
@@ -1560,7 +1560,7 @@ Request
Response
-
+
- XML
@@ -1568,7 +1568,7 @@ Response
-
+
-
<?xml version="1.0"?>
diff --git a/docs/hxapi/transfers/av/index.html b/docs/hxapi/transfers/av/index.html
index 7bc7d44c..055cd51e 100644
--- a/docs/hxapi/transfers/av/index.html
+++ b/docs/hxapi/transfers/av/index.html
@@ -847,7 +847,7 @@ Worked Examples
Airport to TTI
Request
-
+
- XML
@@ -855,7 +855,7 @@ Request
-
+
-
https:///api.holidayextras.co.uk/v1/transfers/search?ABTANumber=YourABTANumber&Password=YourABTANumber&Initials=YourInitials&key=YourKey&token=YourToken&PickUp=ALC&PickUpType=IATA&DropOffType=TTI&DropOff=10147575&FromDate=2022-03-16&FromTime=1115&ReturnDate=2022-03-23&ReturnTime=1115&Adults=2&OutFlight=U28605&ReturnFlight=U28602
@@ -874,7 +874,7 @@ Response
NB: This is a shortened example compiled from a full availability response.
-
+
- XML
@@ -882,7 +882,7 @@ Response
-
+
-
<API_Reply Product="Transfers" RequestCode="1" Result="OK" cached="1" expires="2021-12-07 13:06:41">
@@ -1117,7 +1117,7 @@ Response
Airport to Postal Address
Request
-
+
- XML
@@ -1125,7 +1125,7 @@ Request
-
+
-
https:///api.holidayextras.co.uk/v1/transfers/search?ABTANumber=YourABTANumber&Password=YourABTANumber&Initials=YourInitials&key=YourKey&token=YourToken&PickUp=ALC&PickUpType=IATA&DropOffType=postal-address&DropOffName=Hotel%20Rural%20Castillo%20De%20Biar&DropOffAddress[0]=Carretera%20de%20Banyeres&DropOffAddress[1]=s/n&DropOffTown=%20Biar&DropOffCounty=Alicante&DropOffPostcode=03410&DropOffCountryCode=ES&DropOffLongitude=-0.76832006&DropOffLatitude=38.63852215&Adults=2&FromDate=2022-03-16&FromTime=1115&ReturnDate=2022-03-23&ReturnTime=1115&OutFlight=U28605&ReturnFlight=U28602
@@ -1144,7 +1144,7 @@ Response
NB: This is a shortened example compiled from a full availability response.
-
+
- XML
@@ -1152,7 +1152,7 @@ Response
-
+
-
<API_Reply Product="Transfers" RequestCode="1" Result="OK" cached="1" expires="2021-12-07 16:31:35">
diff --git a/docs/hxapi/upgrade/index.html b/docs/hxapi/upgrade/index.html
index e9db7fa8..8ecdcdf1 100644
--- a/docs/hxapi/upgrade/index.html
+++ b/docs/hxapi/upgrade/index.html
@@ -247,7 +247,7 @@ Example 1 - Carpark Upgrades
Request
-
+
- XML
@@ -255,7 +255,7 @@ Request
-
+
-
https://api.holidayextras.co.uk/v1/upgrade/STN5?ABTANumber=YourABTANumber&Password=YourPassword&key=YourKey&token=YourToken&ArrivalDate=2020-11-03&ArrivalTime=12:30&DepartDate=2020-11-11&DepartTime=13:45
@@ -273,7 +273,7 @@ Request
Response
-
+
- XML
@@ -281,7 +281,7 @@ Response
-
+
-
<?xml version="1.0"?>
@@ -618,7 +618,7 @@ Example 1 - Hotel Upgrades
Request
-
+
- XML
@@ -626,7 +626,7 @@ Request
-
+
-
https://api.holidayextras.co.uk/v1/upgrade/LGWSOF?ABTANumber=YourABTANumber&Password=YourPassword&key=YourKey&token=YourToken&ArrivalDate=2020-11-03&ArrivalTime=12:30&DepartDate=2020-11-11&DepartTime=13:45
@@ -642,7 +642,7 @@ Request
Response
-
+
- XML
@@ -650,7 +650,7 @@ Response
-
+
-
<?xml version="1.0"?>
diff --git a/docs/hxapi/viewamendcancel/view/index.html b/docs/hxapi/viewamendcancel/view/index.html
index 0c88f04b..70511fce 100644
--- a/docs/hxapi/viewamendcancel/view/index.html
+++ b/docs/hxapi/viewamendcancel/view/index.html
@@ -54,7 +54,7 @@ Endpoint
The endpoint to use is (where YourBookingRef is the Holiday Extras booking reference):
-
+
- XML
@@ -62,7 +62,7 @@ Endpoint
-
+
-
https://api.holidayextras.co.uk/v1/booking/YourBookingRef
@@ -368,7 +368,7 @@ UK Products View Booking (for a
Request
-
+
- XML
@@ -376,7 +376,7 @@ Request
-
+
-
https://api.holidayextras.co.uk/v1/booking/YourBookingRef?ABTANumber=YourABTANumber&Password=YourPassword&Initials=YourInitials&key=YourKey&Email=test@test.com
@@ -393,7 +393,7 @@ Request
Response
-
+
- XML
@@ -401,7 +401,7 @@ Response
-
+
-
<?xml version="1.0"?>
@@ -925,7 +925,7 @@ Response
UK Products View Booking (for a transfer)
Request
-
+
- XML
@@ -933,7 +933,7 @@ Request
-
+
-
https://api.holidayextras.co.uk/v1/booking/YourBookingRef?ABTANumber=YourABTANumber&Password=YourPassword&Initials=YourInitials&key=YourKey&Email=test@test.com
@@ -950,7 +950,7 @@ Request
Response
-
+
- XML
@@ -958,7 +958,7 @@ Response
-
+
-
<?xml version="1.0"?>
diff --git a/docs/search/index.html b/docs/search/index.html
index 009447ab..a13ea753 100644
--- a/docs/search/index.html
+++ b/docs/search/index.html
@@ -86,13 +86,6 @@
}
,
- "hxapi-carhire-availability": {
- "title": "Availability",
- "content": "AvailabilityAPI Docs > product:Car Hire > endpoint:availabilityGET: /carHire/productsRequestThe following GET parameters are mandatory:\"key\": 1,\"From\": \"YYYY-MM-DD\",\"ArrivalTime\": \"HHmm\", // 24 hour time format\"To\": \"YYYY-MM-DD\",\"DepartTime\": \"HHmm\", // 24 hour time format\"PickupLocation\": \"FL965\", // code from the locations request\"DropoffLocation\": \"FL965\", // code from the locations request\"DateOfBirth\": \"YYYY-MM-DD\",\"token\": \"123456789\" // user tokenExample request:\tXML\tJSON\thttps://api.holidayextras.co.uk/v1/sandbox/carHire/products?key=1&From=06NOV16&ArrivalTime=1200&To=13NOV&DepartTime=1600&PickupLocation=FL965&DropoffLocation=FL965&DateOfBirth=1990-10-13\thttps://api.holidayextras.co.uk/v1/sandbox/carHire/products.js?key=1&From=06NOV16&ArrivalTime=1200&To=13NOV&DepartTime=1600&PickupLocation=FL965&DropoffLocation=FL965&DateOfBirth=1990-10-13Note the .js extension.ResponseCar Hire returns all of each product’s content within the availability request (repeated elements omitted and represented by {…}).{ \"API_Reply\": { \"ATTRIBUTES\": { \"Product\": \"CarHire\", \"RequestCode\": 1, \"Result\": \"OK\", \"expires\": \"2016-11-03 12:53:25\" }, \"CarHire\": [ { \"ATTRIBUTES\": [], \"Name\": \"PEUGEOT 208 AC or Similar\", \"Code\": \"FLERECMR\", \"BookingURL\": \"/carHire/FLERECMR.js\", \"MoreInfoURL\": null, \"PackageName\": \"Inclusive\", \"VehicleType\": \"Car\", \"Surcharge\": { \"credit\": { \"calculated\": 400, \"total\": 26223, \"percent\": 2.5, \"min\": 150, \"max\": 400 }, \"debit\": { \"calculated\": 0, \"total\": 25823 } }, \"Passengers\": 4, \"Provider\": \"EuropCar\", \"TotalPrice\": 258.23, \"VehicleClass\": \"Economy\", \"LuggageCapacity\": 1, \"PickupLocation\": { \"name\": \"Amsterdam (Schipol) Airport\", \"willDeliverVehicle\": \"\", \"deliverySurcharge\": null, \"address1\": \"AANKOMSTPASSAGE 10\", \"address2\": \"ARRIVAL HALL WEST 3 'PLAZA'\", \"address3\": \"AMSTERDAM\", \"countryName\": \"Netherlands\", \"postcode\": \"1118 AX\", \"phone\": \"31 20 3164190\", \"locationType\": \"At the airport\", \"openingTimes\": { \"mon\": { \"open\": \"06:30\", \"close\": \"23:00\" }, \"tue\": { \"open\": \"06:30\", \"close\": \"23:00\" }, \"wed\": { \"open\": \"06:30\", \"close\": \"23:00\" }, \"thu\": { \"open\": \"06:30\", \"close\": \"23:00\" }, \"fri\": { \"open\": \"06:30\", \"close\": \"23:00\" }, \"sat\": { \"open\": \"07:00\", \"close\": \"23:00\" }, \"sun\": { \"open\": \"07:00\", \"close\": \"23:00\" } } }, \"Images\": [ { \"src\": \"//static.europcar.com/carvisuals/partners/600x350/ECMR_NL.jpeg\", \"alt\": \"PEUGEOT 208 AC or Similar\" } ], \"AllowNoContent\": null, \"Terms\": { \"url\": \"//www.flexibleautos.com/TandCs/ER%20NL.html\", \"complete\": [ { \"heading\": \"EXCESS\", \"text\": \"There is an insurance excess of between 440 EUR and 660 EUR depending on car group.\" }, { \"heading\": \"FUEL\", \"text\": \"Cars will be supplied with a full tank of fuel and should be returned full otherwise the client will be charged for missing fuel plus a refuelling charge of 20 EUR + tax.\" }, { \"heading\": \"DEPOSIT\", \"text\": \"The lead driver must have a credit card in their name. A deposit will be taken from the card to cover fuel and the insurance excess.\" }, { \"heading\": \"ADDITIONAL DRIVER\", \"text\": \"The cost for an additional driver is payable locally 4.2 EUR + tax per day, maximum charge 42 EUR + tax per rental.\" }, { \"heading\": \"DRIVING LICENCE REQUIREMENTS\", \"text\": \"All drivers must have held a full, valid national license. UK License for at least one year. Only the photo card part of the licence is required however if the driver also has a paper part, we recommend that they take this with them. The driver must also provide an additional form of photographic ID in the form of a Full Valid Passport.\\n\\nOverseas Licence: International driving permit is required with all non-European licences if the driving licence is written in a language or characters different to those of the renting country. Even when an International Driving License is required, a domestic licence must be provided.\" }, { \"heading\": \"BABY SEATS / BOOSTER SEATS\", \"text\": \"Child seats are available on request at a cost of 4.2 EUR + tax per day, maximum charge 42 EUR + tax per rental.\" }, { \"heading\": \"AGE RESTRICTIONS\", \"text\": \"Minimum rental age is 21 years. \\n\\nMinimum driving license period – 1 year.\" }, { \"heading\": \"GPS UNITS / NAVIGATION\", \"text\": \"GPS units are available from airport locations at a cost of 10.08 EUR + tax per day, maximum charge 100.84 EUR + tax per rental.\" }, { \"heading\": \"OUT OF HOURS\", \"text\": \"On a request basis only at a charge of 25 EUR + tax.\" }, { \"heading\": \"DRIVING RESTRICTIONS\", \"text\": \"The renter is allowed to drive in: Andorra, Austria, Belgium, France, Denmark, Finland, Germany, Ireland, Italy, Luxembourg, The Netherlands, Norway, Portugal, Spain (except Ceuta & Melilla), Sweden, Switzerland and the United Kingdom.\" }, { \"heading\": \"GRACE PERIOD\", \"text\": \"Europcar allows a grace period of 30 minutes.\" }, { \"heading\": \"WHATS NOT INCLUDED\", \"text\": \"Personal Accident Insurance \\nOptional extras signed for locally\\nOne Way Rental Charges \\nParking Fines, Toll charges, congestions charges, Key Replacement\\nTow Charges\" } ], \"fuelPolicy\": \"Cars will be supplied with a full tank of fuel and should be returned full otherwise the client will be charged for missing fuel plus a refuelling charge of 20 EUR + tax.<br>\", \"excessPolicy\": \"There is an insurance excess of between 440 EUR and 660 EUR depending on car group.<br>\", \"priceIncludes\": [ \"Unlimited Mileage\", \"Collision Damage Waiver (with Excess)\", \"Third Party Liability Insurance\", \"Theft Waiver (with Excess)\", \"Local Tax\", \"Airport Fee\" ] }, \"Price\": 25823, \"Doors\": 4, \"SellingTexts\": [ \"FUEL - Full to Full\", \"EXCESS - Standard Excess\" ], \"OnRequest\": \"\", \"NonDiscPrice\": 258.23, \"DropoffLocation\": { \"name\": \"Amsterdam (Schipol) Airport\", \"willDeliverVehicle\": \"\", \"deliverySurcharge\": null, \"address1\": \"AANKOMSTPASSAGE 10\", \"address2\": \"ARRIVAL HALL WEST 3 'PLAZA'\", \"address3\": \"AMSTERDAM\", \"countryName\": \"Netherlands\", \"postcode\": \"1118 AX\", \"phone\": \"31 20 3164190\", \"locationType\": \"At the airport\", \"openingTimes\": { \"mon\": { \"open\": \"06:30\", \"close\": \"23:00\" }, \"tue\": { \"open\": \"06:30\", \"close\": \"23:00\" }, \"wed\": { \"open\": \"06:30\", \"close\": \"23:00\" }, \"thu\": { \"open\": \"06:30\", \"close\": \"23:00\" }, \"fri\": { \"open\": \"06:30\", \"close\": \"23:00\" }, \"sat\": { \"open\": \"07:00\", \"close\": \"23:00\" }, \"sun\": { \"open\": \"07:00\", \"close\": \"23:00\" } } }, \"Features\": { \"airConditioning\": null, \"automaticTransmission\": \"\" }, \"Discount\": null, \"SupplierData\": { \"rateQualifier\": \"E162281612011054F0\", \"productId\": 1, \"baseProductCurrency\": \"GBP\", \"excessRefundPolicy\": { \"price\": 4193, \"discount\": null } } }, {...} ], \"Pricing\": { \"CCardSurchargePercent\": 2.5, \"CCardSurchargeMin\": 1.5, \"CCardSurchargeMax\": 4 }, \"API_Header\": { \"Request\": { \"key\": 1, \"From\": \"2016-11-06\", \"ArrivalTime\": 1200, \"To\": \"2016-11-13\", \"DepartTime\": 1600, \"PickupLocation\": \"FL965\", \"DropoffLocation\": \"FL965\", \"DateOfBirth\": \"1990-10-10\", \"format\": \"js\" } } }}",
- "url": "/hxapi/carhire/availability/"
- }
- ,
-
"hxapi-insurance-availability": {
"title": "Insurance Schemes Availability",
"content": "Insurance Schemes AvailabilityAPI Docs > product:InsuranceInsurance Schemes Availability RequestThis endpoint will respond with a quotation for a policy to be issued under an insurance scheme.MethodGETEndpointTo request the list of insurance schemes available, the endpoint to use is:https://api.holidayextras.co.uk/v1/insurancepolicy/RegionCodeFor example, to request a quote for a policy covering Europe (low risk), the endpoint is:https://api.holidayextras.co.uk/v1/insurancepolicy/EUROPELOWTo find the list of available regions, please refer to the section on insurance countries.Request ParametersNB: All parameter names are case sensitive. Name Data Type Format Mandatory? Additional Information ABTANumber String [A-Z0-9] 5 chars Y This is also known as an ‘agent code’. This will be confirmed to you by your Account Manager during set up. Password String [A-Z0-9] 5 chars Y Password required for retail agent requests - intermediaries do not require a password.This will be confirmed to you by your Account Manager during set up. key String [A-Z] Y This will be assigned to you by your Account Manager during set up. token String [0-9] 9 chars Y Please see user token endpoint for details of how to generate a token. StartDate Date YYYY-MM-DD Y Date customer wants policy to start (start date of trip if single trip, or up to 30 days from search date if annual trip) EndDate Date YYYY-MM-DD N* Date customer wants policy to end (return date of trip if single trip). NB: If no end date is provided, system will assume you are requesting an annual policy. birthDate[] Date YYYY-MM-DD Y Date of birth for customers. All customers requiring inclusion on this policy quote must provide their date of birth. You can add multiple people by ennumerating each date of birth in the format birthDate[0], birthDate[1], birthDate[2], and so on. title[] String [A-Z] 4 chars Y Title for customers. All customers requiring inclusion on this policy quote must provide their title. You can add multiple people by ennumerating each title in the format title[0], title[1], title[2], and so on. firstName[] String [A-Z] 15 chars Y First name for customers. All customers requiring inclusion on this policy quote must provide their first name. You can add multiple people by ennumerating each first name in the format firstName[0], firstName[1], firstName[2], and so on. lastName[] String [A-Z] 15 chars Y Last name for customers. All customers requiring inclusion on this policy quote must provide their last name. You can add multiple people by ennumerating each last name in the format lastName[0], lastName[1], lastName[2], and so on. Insurance Schemes Availability ResponseThe insurance schemes availability response will return all the products that are available on the requested dates for that region. A summary of the request received can be found in the header field at the end of the response.For a detailed explanation of the fields returned, please see below: Field Additional Information Itinerary/Destination Itinerary/DestNum Itinerary/StartDate Itinerary/EndDate Itinerary/AnnualStart Quote/SchemeCode Quote/SchemeDes Quote/PolicyEnd Quote/PolicyStart Quote/Annual Quote/SchemePrice Quote/SchemeName Quote/CancellationCover Quote/CancellationXS Quote/MedicalCover Quote/MedicalXS Quote/BaggageCover Quote/BaggageXS Quote/PolicyWording Quote/KeyFacts Quote/Wintersports Quote/Insolvency Quote/destinationID API_Header The API returns every parameter and value you sent in the previous request. Worked ExamplesBelow are worked examples of both the request and response for insurance quote.Insurance Schemes Availability Requesthttps://api.holidayextras.co.uk/v1/insurancepolicy/EUROPELOW?ABTANumber=YourABTANumber&Password=YourPassword&key=YourKey&token=YourToken&StartDate=2017-12-01&EndDate=2017-12-08&birthDate[0]=1982-06-26&title[0]=Mr&firstName[0]=TEST&lastName[0]=TESTInsurance Schemes Availability ResponseNB: This is a shortened example compiled from a full insurance quote response.<?xml version=\"1.0\" ?><API_Reply Product=\"Quote\"> <Itinerary> <Destination>Europelow</Destination> <DestNum>6</DestNum> <StartDate>2017-12-01</StartDate> <EndDate>2017-12-08</EndDate> <AnnualStart>30AUG17</AnnualStart> </Itinerary> <Quote> <SchemeCode>8673</SchemeCode> <SchemeDes></SchemeDes> <PolicyEnd>2017-12-08</PolicyEnd> <PolicyStart>2017-12-01</PolicyStart> <Annual>N</Annual> <SchemePrice>18.26</SchemePrice> <SchemeName>OTA</SchemeName> <CancellationCover>500</CancellationCover> <CancellationXS>75</CancellationXS> <MedicalCover>5000000</MedicalCover> <MedicalXS>100</MedicalXS> <BaggageCover></BaggageCover> <BaggageXS></BaggageXS> <PolicyWording>http://secure.holidayextras.co.uk/images/groups/insurancemagenta/policy_wording/HXMainAgent0317(HX001).pdf</PolicyWording> <KeyFacts>http://secure.holidayextras.co.uk/images/groups/insurancemagenta/policy_wording/</KeyFacts> <Wintersports>Y</Wintersports> <Insolvency>N</Insolvency> <destinationID>13</destinationID> </Quote> <API_Header> <Request> <ABTANumber>YourABTANumber</ABTANumber> <Password>YourPassword</Password> <key>YourKey</key> <token>YourToken</token> <StartDate>2017-12-01</StartDate> <EndDate>2017-12-08</EndDate> <birthDate>1982-06-26</birthDate> <title>Mr</title> <firstName>TEST</firstName> <lastName>TEST</lastName> <v>1</v> </Request> </API_Header></API_Reply>",
@@ -100,6 +93,13 @@
}
,
+ "hxapi-carhire-availability": {
+ "title": "Availability",
+ "content": "AvailabilityAPI Docs > product:Car Hire > endpoint:availabilityGET: /carHire/productsRequestThe following GET parameters are mandatory:\"key\": 1,\"From\": \"YYYY-MM-DD\",\"ArrivalTime\": \"HHmm\", // 24 hour time format\"To\": \"YYYY-MM-DD\",\"DepartTime\": \"HHmm\", // 24 hour time format\"PickupLocation\": \"FL965\", // code from the locations request\"DropoffLocation\": \"FL965\", // code from the locations request\"DateOfBirth\": \"YYYY-MM-DD\",\"token\": \"123456789\" // user tokenExample request:\tXML\tJSON\thttps://api.holidayextras.co.uk/v1/sandbox/carHire/products?key=1&From=06NOV16&ArrivalTime=1200&To=13NOV&DepartTime=1600&PickupLocation=FL965&DropoffLocation=FL965&DateOfBirth=1990-10-13\thttps://api.holidayextras.co.uk/v1/sandbox/carHire/products.js?key=1&From=06NOV16&ArrivalTime=1200&To=13NOV&DepartTime=1600&PickupLocation=FL965&DropoffLocation=FL965&DateOfBirth=1990-10-13Note the .js extension.ResponseCar Hire returns all of each product’s content within the availability request (repeated elements omitted and represented by {…}).{ \"API_Reply\": { \"ATTRIBUTES\": { \"Product\": \"CarHire\", \"RequestCode\": 1, \"Result\": \"OK\", \"expires\": \"2016-11-03 12:53:25\" }, \"CarHire\": [ { \"ATTRIBUTES\": [], \"Name\": \"PEUGEOT 208 AC or Similar\", \"Code\": \"FLERECMR\", \"BookingURL\": \"/carHire/FLERECMR.js\", \"MoreInfoURL\": null, \"PackageName\": \"Inclusive\", \"VehicleType\": \"Car\", \"Surcharge\": { \"credit\": { \"calculated\": 400, \"total\": 26223, \"percent\": 2.5, \"min\": 150, \"max\": 400 }, \"debit\": { \"calculated\": 0, \"total\": 25823 } }, \"Passengers\": 4, \"Provider\": \"EuropCar\", \"TotalPrice\": 258.23, \"VehicleClass\": \"Economy\", \"LuggageCapacity\": 1, \"PickupLocation\": { \"name\": \"Amsterdam (Schipol) Airport\", \"willDeliverVehicle\": \"\", \"deliverySurcharge\": null, \"address1\": \"AANKOMSTPASSAGE 10\", \"address2\": \"ARRIVAL HALL WEST 3 'PLAZA'\", \"address3\": \"AMSTERDAM\", \"countryName\": \"Netherlands\", \"postcode\": \"1118 AX\", \"phone\": \"31 20 3164190\", \"locationType\": \"At the airport\", \"openingTimes\": { \"mon\": { \"open\": \"06:30\", \"close\": \"23:00\" }, \"tue\": { \"open\": \"06:30\", \"close\": \"23:00\" }, \"wed\": { \"open\": \"06:30\", \"close\": \"23:00\" }, \"thu\": { \"open\": \"06:30\", \"close\": \"23:00\" }, \"fri\": { \"open\": \"06:30\", \"close\": \"23:00\" }, \"sat\": { \"open\": \"07:00\", \"close\": \"23:00\" }, \"sun\": { \"open\": \"07:00\", \"close\": \"23:00\" } } }, \"Images\": [ { \"src\": \"//static.europcar.com/carvisuals/partners/600x350/ECMR_NL.jpeg\", \"alt\": \"PEUGEOT 208 AC or Similar\" } ], \"AllowNoContent\": null, \"Terms\": { \"url\": \"//www.flexibleautos.com/TandCs/ER%20NL.html\", \"complete\": [ { \"heading\": \"EXCESS\", \"text\": \"There is an insurance excess of between 440 EUR and 660 EUR depending on car group.\" }, { \"heading\": \"FUEL\", \"text\": \"Cars will be supplied with a full tank of fuel and should be returned full otherwise the client will be charged for missing fuel plus a refuelling charge of 20 EUR + tax.\" }, { \"heading\": \"DEPOSIT\", \"text\": \"The lead driver must have a credit card in their name. A deposit will be taken from the card to cover fuel and the insurance excess.\" }, { \"heading\": \"ADDITIONAL DRIVER\", \"text\": \"The cost for an additional driver is payable locally 4.2 EUR + tax per day, maximum charge 42 EUR + tax per rental.\" }, { \"heading\": \"DRIVING LICENCE REQUIREMENTS\", \"text\": \"All drivers must have held a full, valid national license. UK License for at least one year. Only the photo card part of the licence is required however if the driver also has a paper part, we recommend that they take this with them. The driver must also provide an additional form of photographic ID in the form of a Full Valid Passport.\\n\\nOverseas Licence: International driving permit is required with all non-European licences if the driving licence is written in a language or characters different to those of the renting country. Even when an International Driving License is required, a domestic licence must be provided.\" }, { \"heading\": \"BABY SEATS / BOOSTER SEATS\", \"text\": \"Child seats are available on request at a cost of 4.2 EUR + tax per day, maximum charge 42 EUR + tax per rental.\" }, { \"heading\": \"AGE RESTRICTIONS\", \"text\": \"Minimum rental age is 21 years. \\n\\nMinimum driving license period – 1 year.\" }, { \"heading\": \"GPS UNITS / NAVIGATION\", \"text\": \"GPS units are available from airport locations at a cost of 10.08 EUR + tax per day, maximum charge 100.84 EUR + tax per rental.\" }, { \"heading\": \"OUT OF HOURS\", \"text\": \"On a request basis only at a charge of 25 EUR + tax.\" }, { \"heading\": \"DRIVING RESTRICTIONS\", \"text\": \"The renter is allowed to drive in: Andorra, Austria, Belgium, France, Denmark, Finland, Germany, Ireland, Italy, Luxembourg, The Netherlands, Norway, Portugal, Spain (except Ceuta & Melilla), Sweden, Switzerland and the United Kingdom.\" }, { \"heading\": \"GRACE PERIOD\", \"text\": \"Europcar allows a grace period of 30 minutes.\" }, { \"heading\": \"WHATS NOT INCLUDED\", \"text\": \"Personal Accident Insurance \\nOptional extras signed for locally\\nOne Way Rental Charges \\nParking Fines, Toll charges, congestions charges, Key Replacement\\nTow Charges\" } ], \"fuelPolicy\": \"Cars will be supplied with a full tank of fuel and should be returned full otherwise the client will be charged for missing fuel plus a refuelling charge of 20 EUR + tax.<br>\", \"excessPolicy\": \"There is an insurance excess of between 440 EUR and 660 EUR depending on car group.<br>\", \"priceIncludes\": [ \"Unlimited Mileage\", \"Collision Damage Waiver (with Excess)\", \"Third Party Liability Insurance\", \"Theft Waiver (with Excess)\", \"Local Tax\", \"Airport Fee\" ] }, \"Price\": 25823, \"Doors\": 4, \"SellingTexts\": [ \"FUEL - Full to Full\", \"EXCESS - Standard Excess\" ], \"OnRequest\": \"\", \"NonDiscPrice\": 258.23, \"DropoffLocation\": { \"name\": \"Amsterdam (Schipol) Airport\", \"willDeliverVehicle\": \"\", \"deliverySurcharge\": null, \"address1\": \"AANKOMSTPASSAGE 10\", \"address2\": \"ARRIVAL HALL WEST 3 'PLAZA'\", \"address3\": \"AMSTERDAM\", \"countryName\": \"Netherlands\", \"postcode\": \"1118 AX\", \"phone\": \"31 20 3164190\", \"locationType\": \"At the airport\", \"openingTimes\": { \"mon\": { \"open\": \"06:30\", \"close\": \"23:00\" }, \"tue\": { \"open\": \"06:30\", \"close\": \"23:00\" }, \"wed\": { \"open\": \"06:30\", \"close\": \"23:00\" }, \"thu\": { \"open\": \"06:30\", \"close\": \"23:00\" }, \"fri\": { \"open\": \"06:30\", \"close\": \"23:00\" }, \"sat\": { \"open\": \"07:00\", \"close\": \"23:00\" }, \"sun\": { \"open\": \"07:00\", \"close\": \"23:00\" } } }, \"Features\": { \"airConditioning\": null, \"automaticTransmission\": \"\" }, \"Discount\": null, \"SupplierData\": { \"rateQualifier\": \"E162281612011054F0\", \"productId\": 1, \"baseProductCurrency\": \"GBP\", \"excessRefundPolicy\": { \"price\": 4193, \"discount\": null } } }, {...} ], \"Pricing\": { \"CCardSurchargePercent\": 2.5, \"CCardSurchargeMin\": 1.5, \"CCardSurchargeMax\": 4 }, \"API_Header\": { \"Request\": { \"key\": 1, \"From\": \"2016-11-06\", \"ArrivalTime\": 1200, \"To\": \"2016-11-13\", \"DepartTime\": 1600, \"PickupLocation\": \"FL965\", \"DropoffLocation\": \"FL965\", \"DateOfBirth\": \"1990-10-10\", \"format\": \"js\" } } }}",
+ "url": "/hxapi/carhire/availability/"
+ }
+ ,
+
"hxapi-barcode": {
"title": "Barcode",
"content": "BarcodeAn increasing number of car parks, and other products, are updating the way they operate to introduce scanning systems in order to speed up arrival procedures. You will be required to include a 2D barcode on every customer confirmation. The only instance where you should not include a 2D barcode is when a car park stipulates that a QR code is required.This endpoint simply enables you to specify a booking reference and receive a Code128 barcode representation of that in return.In our experience, the size can be scaled down, but you must keep the proportions the same to prevent blurring.URL/barcode/{bookingRef}MethodGETParameters Name Data Type Format Required key Number Y angle Numeric Multiple of 90 N The file extension is also required, to tell the API to return the correct image headers.Requesthttps://api.holidayextras.co.uk/sandbox/v1/barcode/ABCDE.png?key=YourKeySo you can include it in your page as easily as…<img src=\"https://api.holidayextras.co.uk/sandbox/v1/barcode/ABCDE.png?key=YourKey\" />The image can be rotated to fit the side of a page:https://api.holidayextras.co.uk/sandbox/v1/barcode/ABCDE.png?key=YourKey&angle=90Orhttps://api.holidayextras.co.uk/sandbox/v1/barcode/ABCDE.png?key=YourKey&angle=270ReplyThe reply in this case will be an image, not XML.QR CodeYou can establish whether a car park requires a QR code by including the parameter ‘&fields=qr_code’ within your request. The response will either be ‘0’ or ‘1’.A QR code can be generated in the same fashion as a barcode, just call the /qrcode/ API.Requesthttps://api.holidayextras.co.uk/sandbox/v1/qrcode/ABCDE.png?key=YourKeySo you can include it in your page as easily as…<img src=\"https://api.holidayextras.co.uk/sandbox/v1/qrcode/ABCDE.png?key=YourKey\" />If the Response contains QRCodeValue propery, you can use HEX Barcode generator to create a QR codehttps://barcode-generator.dock-yard.io/?bcid=qrcode&text=ABCDE&eclevel=QYou can also include it in your page<img src=\"https://barcode-generator.dock-yard.io/?bcid=qrcode&text=ABCDE&eclevel=Q\" />",
@@ -107,13 +107,6 @@
}
,
- "hxapi-fasttrack-bkg": {
- "title": "Book FastTrack",
- "content": "Book FastTrackFastTrack Booking RequestMethodPOSTEndpointThe endpoint to use is:https://api.holidayextras.co.uk/v1/fastTrack/FastTrackCodeFor example, for FastTrack Terminal 1 at Manchester airport the endpoint is:https://api.holidayextras.co.uk/v1/fastTrack/APMANSF1Request ParametersThe parameters must be sent in the body of the request, as x-www-form-urlencoded data.NB: All parameter names are case sensitive. Name Data Type Format Mandatory? Additional Information ABTANumber String [A-Z0-9] 5 chars Y This is also known as an ‘agent code’. This will be confirmed to you by your Account Manager during set up. Password String [A-Z0-9] 5 chars N* Password required for retail agent requests - intermediaries do not require a password.This will be confirmed to you by your Account Manager during set up. Initials String [A-Z] 3 chars N The initials of the Operator / Agent. key String [A-Z] Y This will be assigned to you by your Account Manager during set up. token String [0-9] 9 chars Y This is the same token used in the availability request. ArrivalDate Date YYYY-MM-DD Y Date customer wishes to enter the fasttrack. ArrivalTime Time HHMM Y Time customer wishes to enter the fasttrack. Adults Integer [0-4] 1 char Y Number of adults requiring entry to the fasttrack. Children Integer [0-3] 1 char N Number of children requiring entry to the fasttrack. Infants Integer 1 char Y Number of infants requiring entry to the fasttrack. Title String [A-Z] 4 chars Y Title of lead passenger Initial String [A-Z] 1 chars Y Initial of lead passenger Surname String [A-Z] 20 chars Y Surname of lead passenger Address[] String [A-Z0-9] 25 chars Y First line of address (house name / number and road) of lead passenger If you require more than 1 address line, then you can replicate this field and increment the number in square brackets, i.e. “Address[1]” for address line 2, and so on.NB: This field can be set to NA Town String [A-Z] 20 chars Y Town of address NB: This field can be set to NA County String [A-Z] 20 chars Y County of address NB: This field can be set to NA PostCode String [A-Z0-9] 10 chars Y Post code of address NB: This field can be set to NA Email String [A-Z0-9] 50 chars Y Email of lead passenger MobileNum String [0-9] 20 char Y Mobile phone number of lead passenger. PriceCheckFlag String Y Y Indicates a price check will be carried out prior to booking. If the price is lower in the system the booking will be made as the customer will benefit from a saving. If the price has changed and is higher than the price stated on availability, an error will return to explain that the price has increased, the booking can still be made but the customer must confirm that they will pay the higher amount. You should then resubmit the request changing the PriceCheckPrice with the new price. PriceCheckPrice Float [0-9] 8 chars Y Price of the product, received from the availability request or price check. System String [A-Z] 3 chars Y* For European products, you need to pass in the value of System=ABG (the default is System=ABC, which is UK products only). Waiver Boolean\t[0,1] Y Defaults to 0 if not supplied. PaymentIn the UK, we are PCI DSS compliant and so we do not accept customers’ payment details being passed to us via the API. Further details can be found in our section on Payment.Please contact your Account Manager if you have any questions concerning payment.FastTrack Booking ResponseThe fasttrack booking response will confirm that a booking has been placed in our system.For a detailed explanation of the fields returned, please see below: Field Additional Information Booking/BookingRef This is the reference for this booking. It must be referred to in all communication with us concerning this booking. NB: Our booking references are up to 12 char alphanumeric (including 1/I and 0/O/Q). Booking/AgentComm Commission you have earned from this booking. Booking/MoreInfoURL The URL for viewing the booking. See view booking for more details. API_Header/Request A list of parameters that were sent in the booking request. Booking ConfirmationWe expect partners to create their own booking confirmations to send to customers, using the information provided in the booking response .Worked ExamplesBelow are worked examples of both the request and response for booking a fasttrack.UK Products Booking Requesthttps://api.holidayextras.co.uk/v1/fastTrack/APMANSF11 <Request> <ABTANumber>YourABTANumber</ABTANumber> <Password>YourPassword</Password> <Initials>YourInitials</Initials> <key>YourKey</key> <token>YourToken</token> <ArrivalDate>2018-12-01</ArrivalDate> <ArrivalTime>1200</ArrivalTime> <Adults>2</Adults> <Children>0</Children> <Infants>0</Infants> <Title>MR</Title> <Initial>T</Initial> <Surname>TEST</Surname> <Address>123 Test Street</Address> <Town>Testville</Town> <County>Testshire</County> <PostCode>TE12 3ST</PostCode> <Email>test@test.com</Email> <MobileNum>01234567890</MobileNum> <PriceCheckFlag>Y</PriceCheckFlag> <PriceCheckPrice>70.00</PriceCheckPrice> </Request>UK Products Booking Response<?xml version=\"1.0\"?><API_Reply Product=\"FastTrack\" RequestCode=\"5\" Result=\"OK\"> <Booking> <BookingRef>APBBFKBX</BookingRef> <AgentComm>1.25</AgentComm> <VATonComm>0.21</VATonComm> <MoreInfoURL>v1/booking/APBBFKBX</MoreInfoURL> <EmailConfirmationAttachments> <name>Fast Track Voucher</name> <source>https://voucher-staging.holidayextras.co.uk/voucher/fastTrack?email=dimitar.kod%40gmail.com&booking_ref=APBBFKBX&agent=TESTX&productType=fastTrack&productCode=MANSF1</source> <type>text/html</type> </EmailConfirmationAttachments> </Booking> <API_Header> <Request> <ABTANumber>YourABTANumber</ABTANumber> <Password>YourPassword</Password> <key>YourKey</key> <token>YourToken</token> <Initials>YourInitials</Initials> <ArrivalDate>2018-12-01</ArrivalDate> <ArrivalTime>1200</ArrivalTime> <Adults>2</Adults> <Children>0</Children> <Infants>0</Infants> <Title>Mr</Title> <Initial>T</Initial> <Surname>TEST</Surname> <Address>123 Test Street</Address> <Town>Testville</Town> <County>Testshire</County> <PostCode>TE12 3ST</PostCode> <Email>test@test.com</Email> <MobileNum>01234567890</MobileNum> <PriceCheckFlag>Y</PriceCheckFlag> <PriceCheckPrice>70.00</PriceCheckPrice> <v>1</v> </Request> </API_Header></API_Reply>",
- "url": "/hxapi/fasttrack/bkg/"
- }
- ,
-
"hxapi-de-start-bkg": {
"title": "Book Car Park - DE-Start method",
"content": "Book Car Park - DE-Start methodCar Park Booking RequestMethodPOSTEndpointThe endpoint to use is:https://payment.holidayextras.co.uk/legacy/carpark/CarParkCodeRequest ParametersThe parameters must be sent in the body of the request, as x-www-form-urlencoded data.NB: All parameter names are case sensitive. Name Data Type Format Mandatory? Additional Information StartCustomer String [0-9] 6 chars Y This will be assigned to you by your Account Manager during set up. BusinessUnit String [0-9] 3 chars Y This will be assigned to you by your Account Manager during set up. Operator String [A-Z] 3 chars Y This always defaults to BJT. key String [A-Z] 10 chars Y This will be assigned to you by your Account Manager during set up. token String [0-9] 9 chars Y This is the same token used in the availability request. ArrivalDate Date YYYY-MM-DD Y Date customer drops vehicle at car park. ArrivalTime Time HHMM Y Time customer drops vehicle at car park. DepartDate Date YYYY-MM-DD Y Date customer picks up vehicle from car park. DepartTime Time HHMM Y Time customer picks up vehicle from car park. Registration String [A-Z0-9] 20 chars N § Vehicle registration number. CarMake String [A-Z0-9] 20 chars N § The make of the car, e.g Audi. CarModel String [A-Z0-9] 20 chars N § The model of the car, e.g. A6. CarColour String [A-Z] 10 chars N § The colour of the car, e.g. black. Title String [0-9] 4 chars Y Title of lead passenger. Initial String [A-Z] 1 chars Y Initial of lead passenger. Surname String [A-Z] 20 chars Y Surname of lead passenger. NumberOfPax Integer [0-9] 2 chars Y Number of passengers. Remarks String [A-Z0-9] 60 chars N Any remarks the agent wishes to add to the booking. Please note, these are not passed through to the supplier. NB: The fields required by the carpark are returned in the availability request, in the <RequestFlags> element.Request flagsWhen you receive the availability response, it will indicate which request flags are required to be sent as part of the booking request.The request flags differ depending on the product’s region and the supplier’s requirements. A summary is below, but please see the relevant sections in the availability endpoint documentation.PaymentThis existing integration does support direct encashment from retail customers. For more information please see the section on Payment.Car Park Booking ResponseThe car park booking response will confirm that a booking has been placed in our system.For a detailed explanation of the fields returned, please see below: Booking/BookingRef This is the reference for this booking. It must be referred to in all communication with us concerning this booking. NB: Our booking references are up to 12 char alphanumeric (including 1/I and 0/O/Q). Booking/AgentComm Commission you have earned from this booking. CarDetails Confirmation of the vehicle details that were sent in the booking request. ClientDetails Confirmation of the lead passenger’s details that were sent in the booking request. HandlingFee Any booking fees that are applicable for processing this transaction. Currently, we do not charge for processing bookings, so this figure will be zero. MoreInfoURL The URL for viewing the booking. CarPark Details of the car park that were sent in the booking request. API_Header/Request A list of parameters that were sent in the booking request. Worked ExamplesBelow are worked examples of both the request and response for booking car parking using the DE-Start method.Car Park Booking Request - DE-Start methodhttps://payment.holidayextras.co.uk/legacy/carpark/FRA8 <Request> <StartCustomer>YourStartCustomer</StartCustomer> <BusinessUnit>YourBusinessUnit</BusinessUnit> <Operator>BJT</Operator> <Initials>YourInitials</Initials> <key>YourKey</key> <token>YourToken</token> <ArrivalDate>2017-12-01</ArrivalDate> <ArrivalTime>1200</ArrivalTime> <DepartDate>2017-12-08</DepartDate> <DepartTime>1200</DepartTime> <NumberOfPax>1</NumberOfPax> <Registration>TE17 STS</Registration> <CarMake>Range Rover</CarMake> <CarModel>Evoque</CarModel> <CarColour>White</CarColour> <Title>MR</Title> <Initial>T</Initial> <Surname>TEST</Surname> <Remarks>Car Park Test</Remarks> </Request>Car Park Booking Response - DE-Start method<?xml version=\"1.0\"?><API_Reply Product=\"CarPark\" RequestCode=\"5\" Result=\"OK\"> <Booking> <BookingRef>YourBookingRef</BookingRef> <AgentComm>5.47-</AgentComm> <VATonComm>0.87-</VATonComm> <StartRef>YourStartRef</StartRef> </Booking> <CarDetails> <Registration>TE17 STS</Registration> </CarDetails> <ClientDetails> <Title>MR</Title> <Initial>T</Initial> <Surname>TEST</Surname> <CustomerRef>N/A</CustomerRef> <Remarks>Car Park Test</Remarks> </ClientDetails> <API_Header> <Request> <StartCustomer>YourStartCustomer</StartCustomer> <BusinessUnit>YourBusinessUnit</BusinessUnit> <Operator>BJT</Operator> <Initials>YourInitials</Initials> <key>YourKey</key> <token>YourToken</token> <ArrivalDate>2017-12-01</ArrivalDate> <ArrivalTime>1200</ArrivalTime> <DepartDate>2017-12-08</DepartDate> <DepartTime>1200</DepartTime> <NumberOfPax>1</NumberOfPax> <Registration>TE17 STS</Registration> <CarMake>Range Rover</CarMake> <CarModel>Evoque</CarModel> <CarColour>White</CarColour> <Title>MR</Title> <Initial>T</Initial> <Surname>TEST</Surname> <Remarks>Car Park Test</Remarks> <debug>1</debug> <system>de</system> <System>ABG</System> </Request> </API_Header> <CarPark> <ArrivalDate>01DEC18</ArrivalDate> <DepartDate>08DEC18</DepartDate> <ArrivalTime>1200</ArrivalTime> <DepartTime>1200</DepartTime> <Duration>8</Duration> <NumberOfPax>1</NumberOfPax> <Code>FRA8</Code> <BookingURL>/api/carpark/FRA8/debug</BookingURL> <MoreInfoURL>/api/product/FRA8/debug</MoreInfoURL> </CarPark></API_Reply>",
@@ -121,13 +114,6 @@
}
,
- "hxapi-hotel-bkg": {
- "title": "Hotel Booking Request",
- "content": "Hotel Booking RequestMethodPOSTEndpointThe endpoint to use is:https://api.holidayextras.co.uk/v1/hotel/LocationCodeFor example, for Mercure at London Heathrow the endpoint is:https://api.holidayextras.co.uk/v1/hotel/LHRMEARequest ParametersThe parameters must be sent in the body of the request, as x-www-form-urlencoded data.NB: All parameter names are case sensitive. Name Data Type Format Mandatory? Additional Information ABTANumber String [A-Z0-9] 5 chars Y This is also known as an ‘agent code’. This will be confirmed to you by your Account Manager during set up. Password String [A-Z0-9] 5 chars N* Password required for retail agent requests - intermediaries do not require a password.This will be confirmed to you by your Account Manager during set up. Initials String [A-Z] 3 chars N The initials of the Operator / Agent. key String [A-Z] Y This will be assigned to you by your Account Manager during set up. token String [0-9] 9 chars Y This is the same token used in the availability request. ArrivalDate Date YYYY-MM-DD Y Date customer arrives at hotel. Nights Integer 1, 2, 3, etc Y Number of nights the customer wants to stay in the hotel. NB: For European products it is only possible to book one night stays. RoomCode String [A-Z0-9] 3 chars Y See RoomCodes for a list of valid codes. Adults Integer [1-5] 1 char Y The number of adults occupying the room. Children Integer [0-4] 1 char Y The number of children occupying the room. ParkingDays Integer [0-9] 2 chars Y NB: The maximum duration accepted for ParkingDays is 30. Title String [A-Z] 4 chars Y Title of lead passenger Initial String [A-Z] 1 chars Y Initial of lead passenger Surname String [A-Z] 20 chars Y Surname of lead passenger Address[] String [A-Z0-9] 25 chars Y First line of address (house name / number and road) of lead passenger. If you require more than 1 address line, then you can replicate this field and increment the number in square brackets, i.e. “Address[1]” for address line 2, and so on. NB: This field can be set to NA Town String [A-Z] 20 chars Y Town of address. NB: This field can be set to NA County String [A-Z] 20 chars Y County of address. NB: This field can be set to NA PostCode String [A-Z0-9] 10 chars Y Post code of address. NB: This field can be set to NA DayPhone Integer [0-9] 20 chars max N The customer’s telephone number. Email String [A-Z0-9] 50 chars Y The email address of customer. CustomerRef String [A-Z0-9] 20 chars N Enter your Customer Reference to help match bookings for accounting purposes. Remarks String [A-Z0-9] 60 chars N Pass in Remarks for notification such as COT REQUESTED in ROOM Waiver Boolean [0,1] Y Defaults to 0 if not supplied. DataProtection String [Y,N] N Does the customer consent to receiving offers from Holiday Extras? Y = Yes, will receive offers, N = No, customer data is protected. Defaults to No if not supplied. PriceCheckFlag String [Y] Y Indicates a price check will be carried out prior to booking. If the price is lower in the system the booking will be made as the customer will benefit from a saving. If the price has changed and is higher than the price stated on availability, an error will return to explain that the price has increased, the booking can still be made but the customer must confirm that they will pay the higher amount. You should then resubmit the request changing the PriceCheckPrice with the new price. PriceCheckPrice Float [0-9] Y Price of the product, received from the availability request or price check. System String [A-Z] 3 chars Y* For European products, you need to pass in the value of System=ABG (the default is System=ABC, which is UK products only). lang String [A-Z] 2 chars Y* Required for requests for European products. (Values available are en, de, it, es, pt and nl.) Supplements/Code String [A-Z0-9] 5 chars N Product code of the upgrade to book. See below for more info on booking upgrades Supplements/Date String YYYY-MM-DD Y The date to book the upgrade for. This should be brought forward from the upgrade availability request. Supplements/Quantity Integer [0-9]1 char Y* For per room/booking upgrades, specify the required quantity Supplements/Adults Integer [0-9]1 char Y* For per person upgrades, specify the number of adult passes Supplements/Children Integer [0-9]1 char Y* For per person upgrades, specify the number of child passes Supplements/TotalPrice Float [0-9] Y Mandatory for all upgrades. The total price of the upgrade, accounting for total quantity Supplements/LoungeArrival String YYYY-MM-DD HH:mm Y* Mandatory for Lounge upgrades. Specifies the time the client wishes to enter the lounge Booking UpgradesIt is possible to booking upgrade items at the same time as making a core product booking. Once the core product has been selected you must make an Upgrade availability request. Use the information in the response to pick the upgrades desired for the product. In the booking request any number of Supplements tags may be added but each must be for a unique upgrade. Multiple Supplements can be added in the request using the square bracket([]) notation e.g.POST /v1/hotel/LGWSOF HTTP/1.1Host: api.holidayextras.co.ukContent-Type: application/x-www-form-urlencodedABTANumber=YourABTANumber&Password=YourPassword&Initials=YourInitials&key=YourKey&token=YourToken&ArrivalDate=2020-11-09&ArrivalTime=12:30&DepartDate=2020-11-17&DepartTime=13:45&Title=Mr&Initial=T&Surname=Test&Address=Holiday Extras Ltd&Address=Ashford Road&Town=Hythe&County=Kent&PostCode=CT214JF&Email=test@test.com&PriceCheckFlag=Y&PriceCheckPrice=50.05&CarColour=White&CarMake=Range Rover&CarModel=Vogue&Registration=TE17 STS&ReturnFlight=VIR19&Supplements[0][Code]=HXOST1&Supplements[0][Quantity]=1&Supplements[0][Date]=2020-11-09&Supplements[0][TotalPrice]=1.99&Supplements[1][Code]=STNSFS&Supplements[1][Date]=2020-11-09&Supplements[1][Adults]=2&Supplements[1][Children]=1&Supplements[1][TotalPrice]=21.00For per Room or per Booking upgrades a Quantity must be supplied.For per Person upgrades the number of Adult and Children passes must be supplied. Depending on the upgrade it may also be necessary to supplier the number of Infants.PricingA TotalPrice must be included with each supplment node. This should be calculated as follows; Per Room or per Booking - Quantity x Price Per Person - (Adults x AdPrice) + (Chilren x ChPrice)*NOTE* When booking upgrades the cost of the upgrades should not be added to the PriceCheckPrice. This should only reflect the price of the core product.FastTrackWhen booking fast track passes you will receive links to the client’s fast track passes in the booking response. These can be added to your own confirmation emails and will be required by the client to use their passes.Multiple rooms on same bookingCurrently, we can only accept a maximum of 2 rooms per booking. If the customer needs more, you will need to make multiple requests. If an intermediary account, you should note that this would lead to multiple transactions on the credit card, and multiple charges, and therefore we advise against it.The additional parameters for including a second room are: Name Data Type Format Mandatory? Additional Information SecondRoomType String [A-Z0-9] 2 chars N* This parameter is mandatory if the customer wishes to book two rooms at the same time. The room codes are as per Room Codes. SecondRoomCode String Room Codes N NB: Please note that the room codes differ between availability and booking requests. SecondRoomAdults Integer [1-5] 1 char N The number of adults occupying the second room. SecondRoomChildren Integer [0-4] 1 char N The number of children occupying the second room. UK Hotels with parkingThe additional parameters for hotel with parking (where parking > 0 days) are: Name Data Type Format Mandatory? CarDropoffDate Date YYYY-MM-DD Y CarDropoffTime Time HHMM Y CarPickupDate Date YYYY-MM-DD Y CarPickupTime Time HHMM Y ReturnFlight String [A-Z0-9] 10 chars N TerminalCode String [A-Z0-9] 2 chars N Registration String [A-Z0-9] 20 chars N CarMake String [A-Z0-9] 20 chars N CarModel String [A-Z0-9] 20 chars N CarColour String [A-Z0-9] 20 chars N PaymentIn the UK, we are PCI DSS compliant and so we do not accept customers’ payment details being passed to us via the API. Further details can be found in our section on Payment.Please contact your Account Manager if you have any questions concerning payment.Booking Terms and ConditionsIt is important that the customer has access to the Terms and Conditions at the time of placing their booking and after. We highly recommend that these are made clear to the customer before booking.For European products, please use the following link:http://www.holidayextras.de/images/de-hx/pdf/agb.pdfIf you require translations of Terms and Conditions into other languages, you can simply change /de-hx/ (German) into nl-hx (Dutch), it-hex (Italian), pt-hx (Portuguese), fr-hx (French), es-hx (Spanish) or en-hx (English).Hotel Booking ResponseThe hotel booking response will confirm that a booking has been placed in our system.For a detailed explanation of the fields returned, please see below: Field Additional Information Booking/BookingRef This is the reference for this booking. It must be referred to in all communication with us concerning this booking. NB: Our booking references are up to 12 char alphanumeric (including 1/I and 0/O/Q). Booking/AgentComm Commission you have earned from this booking. Itinerary This section confirms details of the hotel on the booking. Room This section confirms details of the room booked at the hotel. ClientDetails Confirmation of the customer’s details that were sent in the booking request. Pricing Confirmation of the price paid by the customer for the hotel room. CurrentSupplements/Code Upgrade Code CurrentSupplements/Name Name of the upgrade CurrentSupplements/Price Price Paid for the upgrade CurrentSupplements/NonDiscPrice The original price of the upgrade before any discounts CurrentSupplements/Per The pricing basis for the product (booking/room/person) CurrentSupplements/Adults The number of adult passes purchased CurrentSupplements/Children The number of child passes purchased CurrentSupplements/Date The date the upgrade has been purchased for CurrentSupplements/Remarks Internal notes CurrentSupplements/Canx Whether the upgrade can be cancelled API_Header/Request A list of parameters that were sent in the booking request. Booking ConfirmationWe expect partners to create their own booking confirmations to send to customers, using the information provided in the booking response.However, we also have capability to send booking confirmation emails ourselves on behalf of partners. This feature is not available as standard, and so if you wish to enable this please speak to your Account Manager.PdfUrlThe PdfUrl field contains a URL that can be used to retrieve a PDF copy ofthe confirmation email. Note that you will need to append the fieldsABTANumber, Password and key to the link in order to authenticate.Example: https://api.holidayextras.co.uk/sandbox/v1/confirmation?email=test%40holidayextras.com&booking_ref=HPABCDE&product_type=hotels&ABTANumber=WT314&Password=redacted&key=YourKeyWorked ExamplesBelow are worked examples of both the request and response for booking hotels.UK Hotel Booking - Room OnlyRequesthttps://api.holidayextras.co.uk/v1/hotel/LHRMEA<Request> <ABTANumber>YourABTANumber</ABTANumber> <Password>YourPassword</Password> <key>YourKey</key> <token>YourToken</token> <ArrivalDate>2017-12-01</ArrivalDate> <Nights>1</Nights> <RoomCode>DBL</RoomCode> <ParkingDays>0</ParkingDays> <Adults>2</Adults> <Children>0</Children> <Title>Mr</Title> <Initial>T</Initial> <Surname>TEST</Surname> <Address >1 Test Street</Address > <Town>Testville</Town> <County>Testshire</County> <Postcode>TE1 STS</Postcode> <DayPhone>01234567890</DayPhone> <Email>test@test.com</Email> <DataProtection>N</DataProtection> <PriceCheckFlag>Y</PriceCheckFlag> <PriceCheckPrice>55.00</PriceCheckPrice> <v>1</v></Request>Response<?xml version=\"1.0\"?><API_Reply Product=\"HotelWithParking\" RequestCode=\"5\" Result=\"OK\"> <Booking> <BookingRef>YourBookingRef</BookingRef> <AgentComm>6.53</AgentComm> <VATonComm>0.00</VATonComm> <MoreInfoURL>/v1/booking/YourBookingRef</MoreInfoURL> <PdfUrl>/v1/confirmation?email=test@test.com&booking_ref=HPABCDE&product_type=hotels</PdfUrl> </Booking> <Hotel/> <Itinerary> <TotalPrice>55.00</TotalPrice> <ArrivalDate>2017-12-01</ArrivalDate> <Nights>1</Nights> <BoardBasis>RO</BoardBasis> <NonSmoking>N</NonSmoking> <ReturnFlight/> <TerminalCode/> <Code>LHRMEA</Code> <Name>Mercure</Name> <ParkingDays>0</ParkingDays> <ParkingSpaces>0</ParkingSpaces> </Itinerary> <Room> <Adults>2</Adults> <Children>0</Children> <Infants>0</Infants> <Code>DBL</Code> </Room> <CarDetails> <Registration/> <CarMake/> <CarModel/> <CarColour/> </CarDetails> <ClientDetails> <Title>MR</Title> <Initial>T</Initial> <Surname>TEST</Surname> <Email>test@test.com</Email> <Address/> <Town/> <County/> <Postcode/> <EvePhone/> </ClientDetails> <API_Header> <Request> <ABTANumber>YourABTANumber</ABTANumber> <Password>YourPassword</Password> <key>YourKey</key> <token>YourToken</token> <ArrivalDate>2017-12-01</ArrivalDate> <Nights>1</Nights> <RoomCode>DBL</RoomCode> <ParkingDays>0</ParkingDays> <Adults>2</Adults> <Children>0</Children> <Title>Mr</Title> <Initial>T</Initial> <Surname>TEST</Surname> <Address >1 Test Street</Address > <Town>Testville</Town> <County>Testshire</County> <Postcode>TE1 STS</Postcode> <DayPhone>01234567890</DayPhone> <Email>test@test.com</Email> <DataProtection>N</DataProtection> <PriceCheckFlag>Y</PriceCheckFlag> <PriceCheckPrice>55.00</PriceCheckPrice> <v>1</v> </Request> </API_Header></API_Reply>European Hotel BookingRequesthttps://api.holidayextras.co.uk/v1/hotel/MUCLAN<Request> <ABTANumber>YourABTANumber</ABTANumber> <Password>YourPassword</Password> <key>YourKey</key> <token>YourToken</token> <ArrivalDate>2017-12-01</ArrivalDate> <Nights>1</Nights> <RoomCode>DZ</RoomCode> <ParkingDays>0</ParkingDays> <Adults>2</Adults> <Children>0</Children> <Title>Mr</Title> <Initial>T</Initial> <Surname>TEST</Surname> <Address >1 Test Street</Address > <Town>Testville</Town> <County>Testshire</County> <Postcode>TE1 STS</Postcode> <DayPhone>01234567890</DayPhone> <Email>test@test.com</Email> <DataProtection>N</DataProtection> <PriceCheckFlag>Y</PriceCheckFlag> <PriceCheckPrice>120.00</PriceCheckPrice> <v>1</v></Request>Response<?xml version=\"1.0\"?><API_Reply Product=\"HotelWithParking\" RequestCode=\"4\" Result=\"OK\"> <Booking> <BookingRef>YourBookingRef</BookingRef> <MoreInfoURL>/v1/booking/YourBookingRef.de</MoreInfoURL> <PdfUrl>/v1/confirmation?email=test%40test.com&booking_ref=FRABCDE&product_type=hotels</PdfUrl> </Booking> <Hotel/> <Itinerary> <ArrivalDate>2017-12-01</ArrivalDate> <Nights>1</Nights> <BoardBasis>F</BoardBasis> <NonSmoking>N</NonSmoking> <ParkingDays>0</ParkingDays> <ParkingSpaces>0</ParkingSpaces> <Code>MUCLAN</Code> <Name>Schweigers Landgasthof</Name> </Itinerary> <Room> <Adults>2</Adults> <Children>0</Children> <Infants>0</Infants> <Code>DZ</Code> </Room> <ClientDetails> <Title>Herr</Title> <Initial>T</Initial> <Surname>TEST</Surname> <Email>TEST@TEST.COM</Email> <Town>TESTVILLE</Town> <Postcode>TE1 STS</Postcode> <DayPhone>01234567890</DayPhone> <Remarks/> <Address0>1 Test Street</Address0> <Address1>TBC</Address1> <DataProtection>N</DataProtection> <County>TESTSHIRE</County> </ClientDetails> <Pricing> <Price>120.00</Price> </Pricing> <API_Header> <Request> <ABTANumber>YourABTANumber</ABTANumber> <Password>YourPassword</Password> <key>YourKey</key> <token>YourToken</token> <ArrivalDate>2017-12-01</ArrivalDate> <Nights>1</Nights> <RoomCode>DBL</RoomCode> <ParkingDays>0</ParkingDays> <Adults>2</Adults> <Children>0</Children> <Title>Mr</Title> <Initial>T</Initial> <Surname>TEST</Surname> <Address0>1 Test Street</Address0> <Town>Testville</Town> <County>Testshire</County> <Postcode>TE1 STS</Postcode> <DayPhone>01234567890</DayPhone> <Email>test@test.com</Email> <DataProtection>N</DataProtection> <PriceCheckFlag>Y</PriceCheckFlag> <PriceCheckPrice>120.00</PriceCheckPrice> <System>ABG</System> <lang>de</lang> <v>1</v> </Request> </API_Header></API_Reply>UK Hotel booking with UpgradesRequesthttps://api.holidayextras.co.uk/v1/hotel/LGWSOF<Request> <ABTANumber>YourABTANumber</ABTANumber> <Password>YourPassword</Password> <key>YourKey</key> <token>YourToken</token> <ArrivalDate>2020-11-10</ArrivalDate> <Nights>1</Nights> <RoomCode>DBL</RoomCode> <ParkingDays>0</ParkingDays> <Adults>2</Adults> <Children>0</Children> <Title>Mr</Title> <Initial>T</Initial> <Surname>TEST</Surname> <Address >1 Test Street</Address > <Town>Testville</Town> <County>Testshire</County> <Postcode>TE1 STS</Postcode> <DayPhone>01234567890</DayPhone> <Email>test@test.com</Email> <DataProtection>N</DataProtection> <PriceCheckFlag>Y</PriceCheckFlag> <PriceCheckPrice>135.00</PriceCheckPrice> <Supplements> <Code>LGWSOE</Code> <Date>2020-11-10</Date> <Quantity>1</Quantity> </Adults> </Children> <TotalPrice>40.00</TotalPrice> </Supplements> <Supplements> <Code>LGWASC</Code> <Date>2020-11-11</Date> <LoungeArrival>2020-11-11 12:30</LoungeArrival> </Quantity> <Adults>2</Adults> <Children>0</Children> <TotalPrice>56.00</TotalPrice> </Supplements> <v>1</v></Request>Response<?xml version=\"1.0\"?><API_Reply Product=\"HotelWithParking\" RequestCode=\"5\" Result=\"OK\"> <Booking> <BookingRef>YourBookingRef</BookingRef> <AgentComm>13.45</AgentComm> <VATonComm>0.00</VATonComm> <MoreInfoURL>/v1/booking/YourBookingRef</MoreInfoURL> </Booking> <Hotel/> <Itinerary> <TotalPrice>255.55</TotalPrice> <ArrivalDate>2020-11-10</ArrivalDate> <Nights>1</Nights> <BoardBasis>RO</BoardBasis> <NonSmoking>N</NonSmoking> <ReturnFlight/> <TerminalCode/> <Code>LGWSOF</Code> <Name>Sofitel</Name> <ParkingDays>0</ParkingDays> <ParkingSpaces>0</ParkingSpaces> </Itinerary> <Room> <Adults>2</Adults> <Children>0</Children> <Infants>0</Infants> <Code>DBL</Code> </Room> <CarDetails> <Registration/> <CarMake/> <CarModel/> <CarColour/> </CarDetails> <ClientDetails> <Title>MR</Title> <Initial>T</Initial> <Surname>TEST</Surname> <Email>test@test.com</Email> <Address/> <Town/> <County/> <Postcode/> <EvePhone>01234567890</EvePhone> </ClientDetails> <CurrentSupplements> <Code>LGWSOE</Code> <Name>Luxury room upgrade</Name> <Price>66.50</Price> <NonDiscPrice>66.50</NonDiscPrice> <Per>room</Per> <Adults>0</Adults> <Children>0</Children> <Date>2020-11-10</Date> <Remarks/> <Canx>Y</Canx> </CurrentSupplements> <CurrentSupplements> <Code>LGWASC</Code> <Name>Club Aspire North Lounge</Name> <Price>47.50</Price> <NonDiscPrice>47.50</NonDiscPrice> <Per>person</Per> <Adults>2</Adults> <Children>0</Children> <Date>2020-11-11</Date> <Remarks/> <Canx>Y</Canx> </CurrentSupplements> <API_Header> <Request> <ABTANumber>YourABTANumber</ABTANumber> <Password>YourPassword</Password> <key>YourKey</key> <token>YourToken</token> <ArrivalDate>2020-11-10</ArrivalDate> <ArrivalTime>12:30</ArrivalTime> <Title>Mr</Title> <Initial>T</Initial> <Surname>Test</Surname> <Address>Holiday Extras Ltd</Address> <Address>Ashford Road</Address> <Town>Hythe</Town> <County>Kent</County> <PostCode>CT214JF</PostCode> <Email>test@test.com</Email> <PriceCheckFlag>Y</PriceCheckFlag> <PriceCheckPrice>135.00</PriceCheckPrice> <Adults>2</Adults> <Children>0</Children> <Nights>1</Nights> <RoomCode>DBL</RoomCode> <ParkingDays>0</ParkingDays> <Supplements> <Code>LGWSOE</Code> <Date>2020-11-10</Date> <Quantity>1</Quantity> <TotalPrice>70.00</TotalPrice> </Supplements> <Supplements> <Code>LGWASC</Code> <Date>2020-11-11</Date> <Adults>2</Adults> <Children>0</Children> <TotalPrice>56.00</TotalPrice> </Supplements> <v>1</v> </Request> </API_Header></API_Reply>",
- "url": "/hxapi/hotel/bkg/"
- }
- ,
-
"hxapi-parking-bkg": {
"title": "Book Car Park",
"content": "Book Car ParkAPI Docs > product:Parking > endpoint:carpark > Make BookingCar Park Booking RequestMethodPOSTEndpointThe endpoint to use is:https://api.holidayextras.co.uk/v1/carpark/CarParkCodeFor example, for Maple Manor Meet and Greet at London Gatwick North terminal the endpoint is:https://api.holidayextras.co.uk/v1/carpark/LGW4Request ParametersThe parameters must be sent in the body of the request, as x-www-form-urlencoded data.NB: All parameter names are case sensitive. Name Data Type Format Mandatory? Additional Information ABTANumber String [A-Z0-9] 5 chars Y This is also known as an ‘agent code’. This will be confirmed to you by your Account Manager during set up. Password String [A-Z0-9] 5 chars N* Password required for retail agent requests - intermediaries do not require a password.This will be confirmed to you by your Account Manager during set up. Initials String [A-Z] 3 chars N The initials of the Operator / Agent. key String [A-Z] Y This will be assigned to you by your Account Manager during set up. token String [0-9] 9 chars Y This is the same token used in the availability request. ArrivalDate Date YYYY-MM-DD Y Date customer drops vehicle at car park. ArrivalTime Time HHMM Y Time customer drops vehicle at car park. DepartDate Date YYYY-MM-DD Y Date customer picks up vehicle from car park. DepartTime Time HHMM Y Time customer picks up vehicle from car park. NumberOfPax Integer [0-9] 2 chars Y Number of passengers. Title String [A-Z] 4 chars Y Title of lead passenger Initial String [A-Z] 1 chars Y Initial of lead passenger Surname String [A-Z] 20 chars Y Surname of lead passenger Address[] String [A-Z0-9] 25 chars Y First line of address (house name / number and road) of lead passenger If you require more than 1 address line, then you can replicate this field and increment the number in square brackets, i.e. “Address[1]” for address line 2, and so on.NB: This field can be set to NA Town String [A-Z] 20 chars Y Town of address NB: This field can be set to NA County String [A-Z] 20 chars Y County of address NB: This field can be set to NA PostCode String [A-Z0-9] 10 chars Y Post code of address NB: This field can be set to NA Email String [A-Z0-9] 50 chars Y Email of lead passenger PriceCheckFlag String Y Y Indicates a price check will be carried out prior to booking. If the price is lower in the system the booking will be made as the customer will benefit from a saving. If the price has changed and is higher than the price stated on availability, an error will return to explain that the price has increased, the booking can still be made but the customer must confirm that they will pay the higher amount. You should then resubmit the request changing the PriceCheckPrice with the new price. PriceCheckPrice Float [0-9] Y Price of the product, received from the availability request or price check. System String [A-Z] 3 chars Y* For European products, you need to pass in the value of System=ABG (the default is System=ABC, which is UK products only). Supplements/Code String [A-Z0-9] 5 chars N Product code of the upgrade to book. See below for more info on booking upgrades Supplements/Date String YYYY-MM-DD Y The date to book the upgrade for. This should be brought forward from the upgrade availability request. Supplements/Quantity Integer [0-9]1 char Y* For per room/booking upgrades, specify the required quantity Supplements/Adults Integer [0-9]1 char Y* For per person upgrades, specify the number of adult passes Supplements/Children Integer [0-9]1 char Y* For per person upgrades, specify the number of child passes Supplements/TotalPrice Float [0-9] Y Mandatory for all upgrades. The total price of the upgrade, accounting for total quantity Supplements/LoungeArrival String YYYY-MM-DD HH:mm Y* Mandatory for Lounge upgrades. Specifies the time the client wishes to enter the lounge Booking UpgradesIt is possible to booking upgrade items at the same time as making a core product booking. Once the core product has been selected you must make an Upgrade availability request. Use the information in the response to pick the upgrades desired for the product. In the booking request any number of Supplements tags may be added but each must be for a unique upgrade. Multiple Supplements can be added in the request using the square bracket([]) notation e.g.POST /v1/carpark/STN5 HTTP/1.1Host: api.holidayextras.co.ukContent-Type: application/x-www-form-urlencodedABTANumber=YourABTANumber&Password=YourPassword&Initials=YourInitials&key=YourKey&token=YourToken&ArrivalDate=2020-11-09&ArrivalTime=12:30&DepartDate=2020-11-17&DepartTime=13:45&Title=Mr&Initial=T&Surname=Test&Address=Holiday Extras Ltd&Address=Ashford Road&Town=Hythe&County=Kent&PostCode=CT214JF&Email=test@test.com&PriceCheckFlag=Y&PriceCheckPrice=50.05&CarColour=White&CarMake=Range Rover&CarModel=Vogue&Registration=TE17 STS&ReturnFlight=VIR19&Supplements[0][Code]=HXOST1&Supplements[0][Quantity]=1&Supplements[0][Date]=2020-11-09&Supplements[0][TotalPrice]=1.99&Supplements[1][Code]=STNSFS&Supplements[1][Date]=2020-11-09&Supplements[1][Adults]=2&Supplements[1][Children]=1&Supplements[1][TotalPrice]=21.00For per Room or per Booking upgrades a Quantity must be supplied.For per Person upgrades the number of Adult and Children passes must be supplied. Depending on the upgrade it may also be necessary to supplier the number of Infants.PricingA TotalPrice must be included with each supplment node. This should be calculated as follows; Per Room or per Booking - Quantity x Price Per Person - (Adults x AdPrice) + (Chilren x ChPrice)*NOTE* When booking upgrades the cost of the upgrades should not be added to the PriceCheckPrice. This should only reflect the price of the core product.FastTrackWhen booking fast track passes you will receive links to the client’s fast track passes in the booking response. These can be added to your own confirmation emails and will be required by the client to use their passes.Request flagsWhen you receive the availability response, it will indicate which request flags are required to be sent as part of the booking request.The request flags differ depending on the product’s region and the supplier’s requirements. A summary is below, but please see the relevant sections in the availability endpoint documentation.UK ProductsThe <RequestFlags> field dictates which fields need to be sent as part of the booking request.European ProductsThe availability response will return a list of 18 flags in the <CarDetFlags> field with a yes/no response to indicate if required. The order of the flags is always the same.PaymentIn the UK, we are PCI DSS compliant and so we do not accept customers’ payment details being passed to us via the API. Further details can be found in our section on Payment.Please contact your Account Manager if you have any questions concerning payment.Booking Terms and ConditionsIt is important that the customer has access to the Terms and Conditions at the time of placing their booking and after. We highly recommend that these are made clear to the customer before booking.For European products, please use the following link:http://www.holidayextras.de/images/de-hx/pdf/agb.pdfIf you require translations of Terms and Conditions into other languages, you can simply change /de-hx/ (German) into nl-hx (Dutch), it-hex (Italian), pt-hx (Portuguese), fr-hx (French), es-hx (Spanish) or en-hx (English).Car Park Booking ResponseThe car park booking response will confirm that a booking has been placed in our system.For a detailed explanation of the fields returned, please see below: Field Additional Information Booking/BookingRef This is the reference for this booking. It must be referred to in all communication with us concerning this booking. NB: Our booking references are up to 12 char alphanumeric (including 1/I and 0/O/Q). Booking/AgentComm Commission you have earned from this booking. CarDetails Confirmation of the vehicle details that were sent in the booking request. CarDetails/Registration CarDetails/CarMake CarDetails/CarModel CarDetails/CarColour CarDetails/OutFlight CarDetails/Destination CarDetails/MobileNum ClientDetails Confirmation of the lead passenger’s details that were sent in the booking request. ClientDetails/Title ClientDetails/Initials ClientDetails/Surname ClientDetails/Email HandlingFee Any booking fees that are applicable for processing this transaction. Currently, we do not charge for processing bookings, so this figure will be zero. MoreInfoURL The URL for viewing the booking. See view booking for more details. CarPark Details of the car park that were sent in the booking request. CarPark/ArrivalDate CarPark/DepartDate CarPark/ArrivalTime CarPark/DepartTime CarPark/Duration CarPark/NumberOfPax CarPark/ReturnFlight CarPark/Code CarPark/TotalPrice CarPark/Name CarPark/introduction Production description text CarPark/logo Product logo. Prepend with https: CarPark/RequiresQRCode Whether the QR Code needs to be used for this carpark, instead of the barcode CarPark/BookingUrl Prepend with https://api.holidayextras.co.uk/ CarPark/MoreInfoUrl Prepend with https://api.holidayextras.co.uk/ BarCode URL to the barcode for the booking. Prepend with https://api.holidayextras.co.uk/ QRCode URL to the QR code for the booking. Prepend with https://api.holidayextras.co.uk/ FastTrackVouchers/Name Only present if Fast track products have been purchased - Name used to separate multiple voucher products FastTrackVouchers/Source Link to the voucher document to be embeded in the client email FastTrackVouchers/type Content type qualifier for the Source CurrentSupplements/Code Upgrade Code CurrentSupplements/Name Name of the upgrade CurrentSupplements/Price Price Paid for the upgrade CurrentSupplements/NonDiscPrice The original price of the upgrade before any discounts CurrentSupplements/Per The pricing basis for the product (booking/room/person) CurrentSupplements/Adults The number of adult passes purchased CurrentSupplements/Children The number of child passes purchased CurrentSupplements/Date The date the upgrade has been purchased for CurrentSupplements/Remarks Internal notes CurrentSupplements/Canx Whether the upgrade can be cancelled API_Header/Request A list of parameters that were sent in the booking request. Booking ConfirmationWe expect partners to create their own booking confirmations to send to customers, using the information provided in the booking response.However, we also have capability to send booking confirmation emails ourselves on behalf of partners. This feature is not available as standard, and so if you wish to enable this please speak to your Account Manager.PdfUrlThe PdfUrl field contains a URL that can be used to retrieve a PDF copy ofthe confirmation email. Note that you will need to append the fieldsABTANumber, Password and key to the link in order to authenticate.Example: https://api.holidayextras.co.uk/sandbox/v1/confirmation?email=test@holidayextras.com&booking_ref=HPABCDE&product_type=carparks&ABTANumber=WT314&Password=redacted&key=mytestkeyWorked ExamplesBelow are worked examples of both the request and response for booking car parking.UK Products BookingRequesthttps://api.holidayextras.co.uk/carpark/LGW4<Request> <ABTANumber>YourABTA</ABTANumber> <Password>YourPassword</Password> <Initials>YourInitials</Initials> <key>YourKey</key> <token>YourToken</token> <ArrivalDate>2017-12-01</ArrivalDate> <ArrivalTime>1200</ArrivalTime> <DepartDate>2017-12-08</DepartDate> <DepartTime>1200</DepartTime> <NumberOfPax>1</NumberOfPax> <Title>MR</Title> <Initial>T</Initial> <Surname>TEST</Surname> <Address>123 Test Street</Address> <Town>Testville</Town> <County>Testshire</County> <PostCode>TE12 3ST</PostCode> <Email>test@test.com</Email> <PriceCheckFlag>Y</PriceCheckFlag> <PriceCheckPrice>57.99</PriceCheckPrice> <CarColour>White</CarColour> <CarMake>Range Rover</CarMake> <CarModel>Evoque</CarModel> <Destination>Munich</Destination> <OutFlight>EZY8985</OutFlight> <OutTerminal>N</OutTerminal> <Registration>TE17 STS</Registration> <ReturnFlight>EZY8982</ReturnFlight> <ReturnTerminal>N</ReturnTerminal> <MobileNum>01234567890</MobileNum></Request>Response<?xml version=\"1.0\"?><API_Reply Product=\"CarPark\" RequestCode=\"5\" Result=\"OK\"> <Booking> <BookingRef>YourBookingRef</BookingRef> <AgentComm>7.25</AgentComm> <VATonComm>0.00</VATonComm> <PdfUrl>/v1/confirmation?email=test%40test.com&booking_ref=HPABCDE&product_type=carparks</PdfUrl> </Booking> <CarDetails> <Registration>TE17 STS</Registration> <CarMake>RANGE ROVER</CarMake> <CarModel>EVOQUE</CarModel> <CarColour>WHITE</CarColour> <OutFlight>EZY8985</OutFlight> <Destination>MUNICH</Destination> <MobileNum/> </CarDetails> <ClientDetails> <Title>MR</Title> <Initial>T</Initial> <Surname>TEST</Surname> <Email>test@test.com</Email> </ClientDetails> <HandlingFee>0.00</HandlingFee> <MoreInfoURL>/booking/YourBookingRef</MoreInfoURL> <CarPark> <ArrivalDate>2017-12-01</ArrivalDate> <DepartDate>2017-12-08</DepartDate> <ArrivalTime>1200</ArrivalTime> <DepartTime>1200</DepartTime> <Duration>7</Duration> <NumberOfPax>1</NumberOfPax> <ReturnFlight>EZY8982</ReturnFlight> <Code>LGW4</Code> <TotalPrice>57.99</TotalPrice> <Name>Maple Manor Meet and Greet North</Name> <introduction>With 20 years' experience in providing a great service, Maple Manor Meet and Greet parking is a firm favourite with our customers and it's easy to see why. One of their professional, insured chauffeurs will meet you at the North terminal and park your car for you in a secured car park while you catch your flight. It couldn't be simpler and all for this low price. We only sell airport-approved Meet and Greet services and Maple Manor is no exception.</introduction> <advance_purchase>1</advance_purchase> <logo>//d1xcii4rs5n6co.cloudfront.net/libraryimages/LGW4_LGV0_LGT9_LGY8_thumbnail_logo.png</logo> <BookingURL>/carpark/LGW4</BookingURL> <MoreInfoURL>/product/LGW4</MoreInfoURL> </CarPark> <API_Header> <Request> <ABTANumber>YourABTANumber</ABTANumber> <Password>YourPassword</Password> <Initials>YourInitials</Initials> <key>YourKey</key> <token>YourToken</token> <ArrivalDate>2017-12-01</ArrivalDate> <ArrivalTime>1200</ArrivalTime> <DepartDate>2017-12-08</DepartDate> <DepartTime>1200</DepartTime> <NumberOfPax>1</NumberOfPax> <Title>MR</Title> <Initial>T</Initial> <Surname>TEST</Surname> <Address>123 Test Street</Address> <Town>Testville</Town> <County>Testshire</County> <PostCode>TE12 3ST</PostCode> <Email>test@test.com</Email> <PriceCheckFlag>Y</PriceCheckFlag> <PriceCheckPrice>57.99</PriceCheckPrice> <CarColour>White</CarColour> <CarMake>Range Rover</CarMake> <CarModel>Evoque</CarModel> <Registration>TE17 STS</Registration> <Destination>Munich</Destination> <OutFlight>EZY8985</OutFlight> <OutTerminal>N</OutTerminal> <ReturnFlight>EZY8982</ReturnFlight> <ReturnTerminal>N</ReturnTerminal> <MobileNum>01234567890</MobileNum> </Request> </API_Header></API_Reply>European Products BookingRequesthttps://api.holidayextras.co.uk/carpark/MU01<Request> <ABTANumber>YourABTANumber</ABTANumber> <Password>YourPassword</Password> <Initials>YourInitials</Initials> <key>YourKey</key> <token>YourToken</token> <ArrivalDate>2017-12-01</ArrivalDate> <ArrivalTime>1200</ArrivalTime> <DepartDate>2017-12-08</DepartDate> <DepartTime>1200</DepartTime> <NumberOfPax>1</NumberOfPax> <Title>HERR</Title> <Initial>T</Initial> <Surname>TEST</Surname> <Address>123 Test Street</Address> <Town>Testville</Town> <County>Testshire</County> <PostCode>TE12 3ST</PostCode> <Email>test@test.com</Email> <PriceCheckFlag>Y</PriceCheckFlag> <PriceCheckPrice>35.00</PriceCheckPrice> <System>ABG</System> <OutFltNo>EZY8982</OutFltNo> <InFltNo>EZY8985</InFltNo> <InFltTime>1130</InFltTime></Request>Response<?xml version=\"1.0\"?><API_Reply Product=\"CarPark\" RequestCode=\"4\" Result=\"OK\"> <Booking> <BookingRef>YourBookingRef</BookingRef> <PdfUrl>/v1/confirmation?email=test%40test.com&booking_ref=FRABCDE&product_type=carparks</PdfUrl> </Booking> <MoreInfoURL>/carpark/YourBookingRef.de</MoreInfoURL> <CarPark> <ArrivalDate>2017-12-01</ArrivalDate> <DepartDate>2017-12-08</DepartDate> <ArrivalTime>1200</ArrivalTime> <DepartTime>1200</DepartTime> <Duration>7</Duration> <NumberOfPax>1</NumberOfPax> <ReturnFlight/> <CarDetFlags>NNNNNNNNYYNYNNNNNN</CarDetFlags> <Code>MU01</Code> <Name>Parkservice Sky München</Name> <BookingURL>/carpark/MU01.de</BookingURL> <MoreInfoURL>/product/MU01.de</MoreInfoURL> <TotalPrice>35.00</TotalPrice> <GatePrice>0.00</GatePrice> </CarPark> <BarCode>/barcode/YourBookingRef.png?key=YourKey</BarCode> <ClientDetails> <Title>HERR</Title> <Initial>T</Initial> <Surname>TEST</Surname> <Email>TEST@TEST.COM</Email> <Town>TESTVILLE</Town> <Postcode>TE12 3ST</Postcode> <DayPhone>TBC</DayPhone> <Remarks/> <Address0>123 TEST STREET</Address0> <DataProtection>Y</DataProtection> <County>TESTSHIRE</County> <Confirmation>Y</Confirmation> </ClientDetails> <Pricing> <TotalPrice>35.00</TotalPrice> </Pricing> <API_Header> <Request> <ABTANumber>YourABTANumber</ABTANumber> <Password>YourPassword</Password> <Initials>YourInitials</Initials> <key>YourKey</key> <token>YourToken</token> <ArrivalDate>2017-12-01</ArrivalDate> <ArrivalTime>1200</ArrivalTime> <DepartDate>2017-12-08</DepartDate> <DepartTime>1200</DepartTime> <NumberOfPax>1</NumberOfPax> <Title>HERR</Title> <Initial>T</Initial> <Surname>TEST</Surname> <Address>123 Test Street</Address> <Town>Testville</Town> <County>Testshire</County> <PostCode>TE12 3ST</PostCode> <Email>test@test.com</Email> <PriceCheckFlag>Y</PriceCheckFlag> <PriceCheckPrice>35.00</PriceCheckPrice> <System>ABG</System> <OutFltNo>EZY8982</OutFltNo> <InFltNo>EZY8985</InFltNo> <InFltTime>1130</InFltTime> </Request> </API_Header></API_Reply>UK Product booking With UpgradesRequesthttps://api.holidayextras.co.uk/carpark/STN5<Request> <ABTANumber>YourABTA</ABTANumber> <Password>YourPassword</Password> <Initials>YourInitials</Initials> <key>YourKey</key> <token>YourToken</token> <ArrivalDate>2020-11-08</ArrivalDate> <ArrivalTime>1230</ArrivalTime> <ArrivalDate>2020-11-06</ArrivalDate> <DepartTime>1345</DepartTime> <NumberOfPax>1</NumberOfPax> <Title>MR</Title> <Initial>T</Initial> <Surname>TEST</Surname> <Address>123 Test Street</Address> <Town>Testville</Town> <County>Testshire</County> <PostCode>TE12 3ST</PostCode> <Email>test@test.com</Email> <PriceCheckFlag>Y</PriceCheckFlag> <PriceCheckPrice>57.99</PriceCheckPrice> <CarColour>White</CarColour> <CarMake>Range Rover</CarMake> <CarModel>Evoque</CarModel> <Destination>Munich</Destination> <OutFlight>EZY8985</OutFlight> <OutTerminal>N</OutTerminal> <Registration>TE17 STS</Registration> <ReturnFlight>EZY8982</ReturnFlight> <ReturnTerminal>N</ReturnTerminal> <MobileNum>01234567890</MobileNum> <Supplements> <Code>HXOST1</Code> <Date>2020-11-08</Date> <Quantity>1</Quantity> </Adults> </Children> <TotalPrice>1.99</TotalPrice> </Supplements> <Supplements> <Code>STNSFS</Code> <Date>2020-11-08</Date> </Quantity> <Adults>2</Adults> <Children>1</Children> <TotalPrice>15.00</TotalPrice> </Supplements></Request>Response<?xml version=\"1.0\"?><API_Reply Product=\"CarPark\" RequestCode=\"5\" Result=\"OK\"> <Booking> <BookingRef>YourBookingRef</BookingRef> <AgentComm>3.75</AgentComm> <VATonComm>0.00</VATonComm> </Booking> <CarDetails> <Registration>TE17 STS</Registration> <CarMake>RANGE ROVER</CarMake> <CarModel>EVOQUE</CarModel> <CarColour>WHITE</CarColour> <OutFlight/> <Destination>-</Destination> <MobileNum>01234567890</MobileNum> </CarDetails> <ClientDetails> <Title>MR</Title> <Initial>T</Initial> <Surname>Test</Surname> <Email>test@test.com</Email> </ClientDetails> <HandlingFee>0.00</HandlingFee> <MoreInfoURL>/v1/booking/YourBookingRef</MoreInfoURL> <CarPark> <ArrivalDate>2020-11-08</ArrivalDate> <DepartDate>2020-11-16</DepartDate> <ArrivalTime>1230</ArrivalTime> <DepartTime>1345</DepartTime> <Duration>8</Duration> <NumberOfPax>1</NumberOfPax> <ReturnFlight>VIR19</ReturnFlight> <Code>STN5</Code> <TotalPrice>49.99</TotalPrice> <Name>Long Stay</Name> <introduction>We didn't think people thought about their airport parking before booking their holiday. But Stansted Long Stay is so smooth, so efficient, so easy to use, that one customer actually told us she might fly from Stansted just to use it again. Maybe she loved the great prices - it's almost always our best value car park at Stansted - or maybe the award-winning security. Or maybe, like most of our Stansted Long Stay customers, she was just happy with everything.</introduction> <advance_purchase>1</advance_purchase> <logo>//d1xcii4rs5n6co.cloudfront.net/libraryimages/85730-official-stansted-airport-parking-long-stay.png</logo> <RequiresQRCode>0</RequiresQRCode> <BookingURL>/v1/carpark/STN5</BookingURL> <MoreInfoURL>/v1/product/STN5</MoreInfoURL> </CarPark> <BarCode>/v1/barcode/YourBookingRef.png?key=ONLIN</BarCode> <QRCode>/v1/qrcode/YourBookingRef.png?key=ONLIN</QRCode> <FastTrackVouchers> <name>Fast Track Voucher</name> <source>https://voucher.holidayextras.co.uk/voucher/fastTrack?email=YourEmail&booking_ref=YourBookingRef&agent=YourABTANumber&productType=carparks&productCode=STNSFS</source> <type>text/html</type> </FastTrackVouchers> <API_Header> <Request> <ABTANumber>YourABTANumber</ABTANumber> <Password>YourPassword</Password> <Initials>YourInitials</Initials> <key>YourKey</key> <token>YourToken</token> <ArrivalDate>2020-11-08</ArrivalDate> <ArrivalTime>12:30</ArrivalTime> <DepartDate>2020-11-16</DepartDate> <DepartTime>13:45</DepartTime> <Title>MR</Title> <Initial>T</Initial> <Surname>TEST</Surname> <Address>123 Test Street</Address> <Town>Testville</Town> <County>Testshire</County> <PostCode>TE12 3ST</PostCode> <Email>test@test.com</Email> <PriceCheckFlag>Y</PriceCheckFlag> <PriceCheckPrice>50.05</PriceCheckPrice> <CarColour>White</CarColour> <CarMake>Range Rover</CarMake> <CarModel>Evoque</CarModel> <Registration>TE17 STS</Registration> <ReturnFlight>VIR19</ReturnFlight> <Supplement> <Code>HXOST1</Code> <Date>2017-12-01</Date> <Quantity>1</Quantity> </Supplement> <Supplement> <Code>STNSFS</Code> <Date>2017-12-01</Date> <Adults>2</Adults> <Children>1</Children> </Supplement> <v>1</v> </Request> </API_Header></API_Reply>",
@@ -142,6 +128,20 @@
}
,
+ "hxapi-fasttrack-bkg": {
+ "title": "Book FastTrack",
+ "content": "Book FastTrackFastTrack Booking RequestMethodPOSTEndpointThe endpoint to use is:https://api.holidayextras.co.uk/v1/fastTrack/FastTrackCodeFor example, for FastTrack Terminal 1 at Manchester airport the endpoint is:https://api.holidayextras.co.uk/v1/fastTrack/APMANSF1Request ParametersThe parameters must be sent in the body of the request, as x-www-form-urlencoded data.NB: All parameter names are case sensitive. Name Data Type Format Mandatory? Additional Information ABTANumber String [A-Z0-9] 5 chars Y This is also known as an ‘agent code’. This will be confirmed to you by your Account Manager during set up. Password String [A-Z0-9] 5 chars N* Password required for retail agent requests - intermediaries do not require a password.This will be confirmed to you by your Account Manager during set up. Initials String [A-Z] 3 chars N The initials of the Operator / Agent. key String [A-Z] Y This will be assigned to you by your Account Manager during set up. token String [0-9] 9 chars Y This is the same token used in the availability request. ArrivalDate Date YYYY-MM-DD Y Date customer wishes to enter the fasttrack. ArrivalTime Time HHMM Y Time customer wishes to enter the fasttrack. Adults Integer [0-4] 1 char Y Number of adults requiring entry to the fasttrack. Children Integer [0-3] 1 char N Number of children requiring entry to the fasttrack. Infants Integer 1 char Y Number of infants requiring entry to the fasttrack. Title String [A-Z] 4 chars Y Title of lead passenger Initial String [A-Z] 1 chars Y Initial of lead passenger Surname String [A-Z] 20 chars Y Surname of lead passenger Address[] String [A-Z0-9] 25 chars Y First line of address (house name / number and road) of lead passenger If you require more than 1 address line, then you can replicate this field and increment the number in square brackets, i.e. “Address[1]” for address line 2, and so on.NB: This field can be set to NA Town String [A-Z] 20 chars Y Town of address NB: This field can be set to NA County String [A-Z] 20 chars Y County of address NB: This field can be set to NA PostCode String [A-Z0-9] 10 chars Y Post code of address NB: This field can be set to NA Email String [A-Z0-9] 50 chars Y Email of lead passenger MobileNum String [0-9] 20 char Y Mobile phone number of lead passenger. PriceCheckFlag String Y Y Indicates a price check will be carried out prior to booking. If the price is lower in the system the booking will be made as the customer will benefit from a saving. If the price has changed and is higher than the price stated on availability, an error will return to explain that the price has increased, the booking can still be made but the customer must confirm that they will pay the higher amount. You should then resubmit the request changing the PriceCheckPrice with the new price. PriceCheckPrice Float [0-9] 8 chars Y Price of the product, received from the availability request or price check. System String [A-Z] 3 chars Y* For European products, you need to pass in the value of System=ABG (the default is System=ABC, which is UK products only). Waiver Boolean\t[0,1] Y Defaults to 0 if not supplied. PaymentIn the UK, we are PCI DSS compliant and so we do not accept customers’ payment details being passed to us via the API. Further details can be found in our section on Payment.Please contact your Account Manager if you have any questions concerning payment.FastTrack Booking ResponseThe fasttrack booking response will confirm that a booking has been placed in our system.For a detailed explanation of the fields returned, please see below: Field Additional Information Booking/BookingRef This is the reference for this booking. It must be referred to in all communication with us concerning this booking. NB: Our booking references are up to 12 char alphanumeric (including 1/I and 0/O/Q). Booking/AgentComm Commission you have earned from this booking. Booking/MoreInfoURL The URL for viewing the booking. See view booking for more details. API_Header/Request A list of parameters that were sent in the booking request. Booking ConfirmationWe expect partners to create their own booking confirmations to send to customers, using the information provided in the booking response .Worked ExamplesBelow are worked examples of both the request and response for booking a fasttrack.UK Products Booking Requesthttps://api.holidayextras.co.uk/v1/fastTrack/APMANSF11 <Request> <ABTANumber>YourABTANumber</ABTANumber> <Password>YourPassword</Password> <Initials>YourInitials</Initials> <key>YourKey</key> <token>YourToken</token> <ArrivalDate>2018-12-01</ArrivalDate> <ArrivalTime>1200</ArrivalTime> <Adults>2</Adults> <Children>0</Children> <Infants>0</Infants> <Title>MR</Title> <Initial>T</Initial> <Surname>TEST</Surname> <Address>123 Test Street</Address> <Town>Testville</Town> <County>Testshire</County> <PostCode>TE12 3ST</PostCode> <Email>test@test.com</Email> <MobileNum>01234567890</MobileNum> <PriceCheckFlag>Y</PriceCheckFlag> <PriceCheckPrice>70.00</PriceCheckPrice> </Request>UK Products Booking Response<?xml version=\"1.0\"?><API_Reply Product=\"FastTrack\" RequestCode=\"5\" Result=\"OK\"> <Booking> <BookingRef>APBBFKBX</BookingRef> <AgentComm>1.25</AgentComm> <VATonComm>0.21</VATonComm> <MoreInfoURL>v1/booking/APBBFKBX</MoreInfoURL> <EmailConfirmationAttachments> <name>Fast Track Voucher</name> <source>https://voucher-staging.holidayextras.co.uk/voucher/fastTrack?email=dimitar.kod%40gmail.com&booking_ref=APBBFKBX&agent=TESTX&productType=fastTrack&productCode=MANSF1</source> <type>text/html</type> </EmailConfirmationAttachments> </Booking> <API_Header> <Request> <ABTANumber>YourABTANumber</ABTANumber> <Password>YourPassword</Password> <key>YourKey</key> <token>YourToken</token> <Initials>YourInitials</Initials> <ArrivalDate>2018-12-01</ArrivalDate> <ArrivalTime>1200</ArrivalTime> <Adults>2</Adults> <Children>0</Children> <Infants>0</Infants> <Title>Mr</Title> <Initial>T</Initial> <Surname>TEST</Surname> <Address>123 Test Street</Address> <Town>Testville</Town> <County>Testshire</County> <PostCode>TE12 3ST</PostCode> <Email>test@test.com</Email> <MobileNum>01234567890</MobileNum> <PriceCheckFlag>Y</PriceCheckFlag> <PriceCheckPrice>70.00</PriceCheckPrice> <v>1</v> </Request> </API_Header></API_Reply>",
+ "url": "/hxapi/fasttrack/bkg/"
+ }
+ ,
+
+ "hxapi-hotel-bkg": {
+ "title": "Hotel Booking Request",
+ "content": "Hotel Booking RequestMethodPOSTEndpointThe endpoint to use is:https://api.holidayextras.co.uk/v1/hotel/LocationCodeFor example, for Mercure at London Heathrow the endpoint is:https://api.holidayextras.co.uk/v1/hotel/LHRMEARequest ParametersThe parameters must be sent in the body of the request, as x-www-form-urlencoded data.NB: All parameter names are case sensitive. Name Data Type Format Mandatory? Additional Information ABTANumber String [A-Z0-9] 5 chars Y This is also known as an ‘agent code’. This will be confirmed to you by your Account Manager during set up. Password String [A-Z0-9] 5 chars N* Password required for retail agent requests - intermediaries do not require a password.This will be confirmed to you by your Account Manager during set up. Initials String [A-Z] 3 chars N The initials of the Operator / Agent. key String [A-Z] Y This will be assigned to you by your Account Manager during set up. token String [0-9] 9 chars Y This is the same token used in the availability request. ArrivalDate Date YYYY-MM-DD Y Date customer arrives at hotel. Nights Integer 1, 2, 3, etc Y Number of nights the customer wants to stay in the hotel. NB: For European products it is only possible to book one night stays. RoomCode String [A-Z0-9] 3 chars Y See RoomCodes for a list of valid codes. Adults Integer [1-5] 1 char Y The number of adults occupying the room. Children Integer [0-4] 1 char Y The number of children occupying the room. ParkingDays Integer [0-9] 2 chars Y NB: The maximum duration accepted for ParkingDays is 30. Title String [A-Z] 4 chars Y Title of lead passenger Initial String [A-Z] 1 chars Y Initial of lead passenger Surname String [A-Z] 20 chars Y Surname of lead passenger Address[] String [A-Z0-9] 25 chars Y First line of address (house name / number and road) of lead passenger. If you require more than 1 address line, then you can replicate this field and increment the number in square brackets, i.e. “Address[1]” for address line 2, and so on. NB: This field can be set to NA Town String [A-Z] 20 chars Y Town of address. NB: This field can be set to NA County String [A-Z] 20 chars Y County of address. NB: This field can be set to NA PostCode String [A-Z0-9] 10 chars Y Post code of address. NB: This field can be set to NA DayPhone Integer [0-9] 20 chars max N The customer’s telephone number. Email String [A-Z0-9] 50 chars Y The email address of customer. CustomerRef String [A-Z0-9] 20 chars N Enter your Customer Reference to help match bookings for accounting purposes. Remarks String [A-Z0-9] 60 chars N Pass in Remarks for notification such as COT REQUESTED in ROOM Waiver Boolean [0,1] Y Defaults to 0 if not supplied. DataProtection String [Y,N] N Does the customer consent to receiving offers from Holiday Extras? Y = Yes, will receive offers, N = No, customer data is protected. Defaults to No if not supplied. PriceCheckFlag String [Y] Y Indicates a price check will be carried out prior to booking. If the price is lower in the system the booking will be made as the customer will benefit from a saving. If the price has changed and is higher than the price stated on availability, an error will return to explain that the price has increased, the booking can still be made but the customer must confirm that they will pay the higher amount. You should then resubmit the request changing the PriceCheckPrice with the new price. PriceCheckPrice Float [0-9] Y Price of the product, received from the availability request or price check. System String [A-Z] 3 chars Y* For European products, you need to pass in the value of System=ABG (the default is System=ABC, which is UK products only). lang String [A-Z] 2 chars Y* Required for requests for European products. (Values available are en, de, it, es, pt and nl.) Supplements/Code String [A-Z0-9] 5 chars N Product code of the upgrade to book. See below for more info on booking upgrades Supplements/Date String YYYY-MM-DD Y The date to book the upgrade for. This should be brought forward from the upgrade availability request. Supplements/Quantity Integer [0-9]1 char Y* For per room/booking upgrades, specify the required quantity Supplements/Adults Integer [0-9]1 char Y* For per person upgrades, specify the number of adult passes Supplements/Children Integer [0-9]1 char Y* For per person upgrades, specify the number of child passes Supplements/TotalPrice Float [0-9] Y Mandatory for all upgrades. The total price of the upgrade, accounting for total quantity Supplements/LoungeArrival String YYYY-MM-DD HH:mm Y* Mandatory for Lounge upgrades. Specifies the time the client wishes to enter the lounge Booking UpgradesIt is possible to booking upgrade items at the same time as making a core product booking. Once the core product has been selected you must make an Upgrade availability request. Use the information in the response to pick the upgrades desired for the product. In the booking request any number of Supplements tags may be added but each must be for a unique upgrade. Multiple Supplements can be added in the request using the square bracket([]) notation e.g.POST /v1/hotel/LGWSOF HTTP/1.1Host: api.holidayextras.co.ukContent-Type: application/x-www-form-urlencodedABTANumber=YourABTANumber&Password=YourPassword&Initials=YourInitials&key=YourKey&token=YourToken&ArrivalDate=2020-11-09&ArrivalTime=12:30&DepartDate=2020-11-17&DepartTime=13:45&Title=Mr&Initial=T&Surname=Test&Address=Holiday Extras Ltd&Address=Ashford Road&Town=Hythe&County=Kent&PostCode=CT214JF&Email=test@test.com&PriceCheckFlag=Y&PriceCheckPrice=50.05&CarColour=White&CarMake=Range Rover&CarModel=Vogue&Registration=TE17 STS&ReturnFlight=VIR19&Supplements[0][Code]=HXOST1&Supplements[0][Quantity]=1&Supplements[0][Date]=2020-11-09&Supplements[0][TotalPrice]=1.99&Supplements[1][Code]=STNSFS&Supplements[1][Date]=2020-11-09&Supplements[1][Adults]=2&Supplements[1][Children]=1&Supplements[1][TotalPrice]=21.00For per Room or per Booking upgrades a Quantity must be supplied.For per Person upgrades the number of Adult and Children passes must be supplied. Depending on the upgrade it may also be necessary to supplier the number of Infants.PricingA TotalPrice must be included with each supplment node. This should be calculated as follows; Per Room or per Booking - Quantity x Price Per Person - (Adults x AdPrice) + (Chilren x ChPrice)*NOTE* When booking upgrades the cost of the upgrades should not be added to the PriceCheckPrice. This should only reflect the price of the core product.FastTrackWhen booking fast track passes you will receive links to the client’s fast track passes in the booking response. These can be added to your own confirmation emails and will be required by the client to use their passes.Multiple rooms on same bookingCurrently, we can only accept a maximum of 2 rooms per booking. If the customer needs more, you will need to make multiple requests. If an intermediary account, you should note that this would lead to multiple transactions on the credit card, and multiple charges, and therefore we advise against it.The additional parameters for including a second room are: Name Data Type Format Mandatory? Additional Information SecondRoomType String [A-Z0-9] 2 chars N* This parameter is mandatory if the customer wishes to book two rooms at the same time. The room codes are as per Room Codes. SecondRoomCode String Room Codes N NB: Please note that the room codes differ between availability and booking requests. SecondRoomAdults Integer [1-5] 1 char N The number of adults occupying the second room. SecondRoomChildren Integer [0-4] 1 char N The number of children occupying the second room. UK Hotels with parkingThe additional parameters for hotel with parking (where parking > 0 days) are: Name Data Type Format Mandatory? CarDropoffDate Date YYYY-MM-DD Y CarDropoffTime Time HHMM Y CarPickupDate Date YYYY-MM-DD Y CarPickupTime Time HHMM Y ReturnFlight String [A-Z0-9] 10 chars N TerminalCode String [A-Z0-9] 2 chars N Registration String [A-Z0-9] 20 chars N CarMake String [A-Z0-9] 20 chars N CarModel String [A-Z0-9] 20 chars N CarColour String [A-Z0-9] 20 chars N PaymentIn the UK, we are PCI DSS compliant and so we do not accept customers’ payment details being passed to us via the API. Further details can be found in our section on Payment.Please contact your Account Manager if you have any questions concerning payment.Booking Terms and ConditionsIt is important that the customer has access to the Terms and Conditions at the time of placing their booking and after. We highly recommend that these are made clear to the customer before booking.For European products, please use the following link:http://www.holidayextras.de/images/de-hx/pdf/agb.pdfIf you require translations of Terms and Conditions into other languages, you can simply change /de-hx/ (German) into nl-hx (Dutch), it-hex (Italian), pt-hx (Portuguese), fr-hx (French), es-hx (Spanish) or en-hx (English).Hotel Booking ResponseThe hotel booking response will confirm that a booking has been placed in our system.For a detailed explanation of the fields returned, please see below: Field Additional Information Booking/BookingRef This is the reference for this booking. It must be referred to in all communication with us concerning this booking. NB: Our booking references are up to 12 char alphanumeric (including 1/I and 0/O/Q). Booking/AgentComm Commission you have earned from this booking. Itinerary This section confirms details of the hotel on the booking. Room This section confirms details of the room booked at the hotel. ClientDetails Confirmation of the customer’s details that were sent in the booking request. Pricing Confirmation of the price paid by the customer for the hotel room. CurrentSupplements/Code Upgrade Code CurrentSupplements/Name Name of the upgrade CurrentSupplements/Price Price Paid for the upgrade CurrentSupplements/NonDiscPrice The original price of the upgrade before any discounts CurrentSupplements/Per The pricing basis for the product (booking/room/person) CurrentSupplements/Adults The number of adult passes purchased CurrentSupplements/Children The number of child passes purchased CurrentSupplements/Date The date the upgrade has been purchased for CurrentSupplements/Remarks Internal notes CurrentSupplements/Canx Whether the upgrade can be cancelled API_Header/Request A list of parameters that were sent in the booking request. Booking ConfirmationWe expect partners to create their own booking confirmations to send to customers, using the information provided in the booking response.However, we also have capability to send booking confirmation emails ourselves on behalf of partners. This feature is not available as standard, and so if you wish to enable this please speak to your Account Manager.PdfUrlThe PdfUrl field contains a URL that can be used to retrieve a PDF copy ofthe confirmation email. Note that you will need to append the fieldsABTANumber, Password and key to the link in order to authenticate.Example: https://api.holidayextras.co.uk/sandbox/v1/confirmation?email=test%40holidayextras.com&booking_ref=HPABCDE&product_type=hotels&ABTANumber=WT314&Password=redacted&key=YourKeyWorked ExamplesBelow are worked examples of both the request and response for booking hotels.UK Hotel Booking - Room OnlyRequesthttps://api.holidayextras.co.uk/v1/hotel/LHRMEA<Request> <ABTANumber>YourABTANumber</ABTANumber> <Password>YourPassword</Password> <key>YourKey</key> <token>YourToken</token> <ArrivalDate>2017-12-01</ArrivalDate> <Nights>1</Nights> <RoomCode>DBL</RoomCode> <ParkingDays>0</ParkingDays> <Adults>2</Adults> <Children>0</Children> <Title>Mr</Title> <Initial>T</Initial> <Surname>TEST</Surname> <Address >1 Test Street</Address > <Town>Testville</Town> <County>Testshire</County> <Postcode>TE1 STS</Postcode> <DayPhone>01234567890</DayPhone> <Email>test@test.com</Email> <DataProtection>N</DataProtection> <PriceCheckFlag>Y</PriceCheckFlag> <PriceCheckPrice>55.00</PriceCheckPrice> <v>1</v></Request>Response<?xml version=\"1.0\"?><API_Reply Product=\"HotelWithParking\" RequestCode=\"5\" Result=\"OK\"> <Booking> <BookingRef>YourBookingRef</BookingRef> <AgentComm>6.53</AgentComm> <VATonComm>0.00</VATonComm> <MoreInfoURL>/v1/booking/YourBookingRef</MoreInfoURL> <PdfUrl>/v1/confirmation?email=test@test.com&booking_ref=HPABCDE&product_type=hotels</PdfUrl> </Booking> <Hotel/> <Itinerary> <TotalPrice>55.00</TotalPrice> <ArrivalDate>2017-12-01</ArrivalDate> <Nights>1</Nights> <BoardBasis>RO</BoardBasis> <NonSmoking>N</NonSmoking> <ReturnFlight/> <TerminalCode/> <Code>LHRMEA</Code> <Name>Mercure</Name> <ParkingDays>0</ParkingDays> <ParkingSpaces>0</ParkingSpaces> </Itinerary> <Room> <Adults>2</Adults> <Children>0</Children> <Infants>0</Infants> <Code>DBL</Code> </Room> <CarDetails> <Registration/> <CarMake/> <CarModel/> <CarColour/> </CarDetails> <ClientDetails> <Title>MR</Title> <Initial>T</Initial> <Surname>TEST</Surname> <Email>test@test.com</Email> <Address/> <Town/> <County/> <Postcode/> <EvePhone/> </ClientDetails> <API_Header> <Request> <ABTANumber>YourABTANumber</ABTANumber> <Password>YourPassword</Password> <key>YourKey</key> <token>YourToken</token> <ArrivalDate>2017-12-01</ArrivalDate> <Nights>1</Nights> <RoomCode>DBL</RoomCode> <ParkingDays>0</ParkingDays> <Adults>2</Adults> <Children>0</Children> <Title>Mr</Title> <Initial>T</Initial> <Surname>TEST</Surname> <Address >1 Test Street</Address > <Town>Testville</Town> <County>Testshire</County> <Postcode>TE1 STS</Postcode> <DayPhone>01234567890</DayPhone> <Email>test@test.com</Email> <DataProtection>N</DataProtection> <PriceCheckFlag>Y</PriceCheckFlag> <PriceCheckPrice>55.00</PriceCheckPrice> <v>1</v> </Request> </API_Header></API_Reply>European Hotel BookingRequesthttps://api.holidayextras.co.uk/v1/hotel/MUCLAN<Request> <ABTANumber>YourABTANumber</ABTANumber> <Password>YourPassword</Password> <key>YourKey</key> <token>YourToken</token> <ArrivalDate>2017-12-01</ArrivalDate> <Nights>1</Nights> <RoomCode>DZ</RoomCode> <ParkingDays>0</ParkingDays> <Adults>2</Adults> <Children>0</Children> <Title>Mr</Title> <Initial>T</Initial> <Surname>TEST</Surname> <Address >1 Test Street</Address > <Town>Testville</Town> <County>Testshire</County> <Postcode>TE1 STS</Postcode> <DayPhone>01234567890</DayPhone> <Email>test@test.com</Email> <DataProtection>N</DataProtection> <PriceCheckFlag>Y</PriceCheckFlag> <PriceCheckPrice>120.00</PriceCheckPrice> <v>1</v></Request>Response<?xml version=\"1.0\"?><API_Reply Product=\"HotelWithParking\" RequestCode=\"4\" Result=\"OK\"> <Booking> <BookingRef>YourBookingRef</BookingRef> <MoreInfoURL>/v1/booking/YourBookingRef.de</MoreInfoURL> <PdfUrl>/v1/confirmation?email=test%40test.com&booking_ref=FRABCDE&product_type=hotels</PdfUrl> </Booking> <Hotel/> <Itinerary> <ArrivalDate>2017-12-01</ArrivalDate> <Nights>1</Nights> <BoardBasis>F</BoardBasis> <NonSmoking>N</NonSmoking> <ParkingDays>0</ParkingDays> <ParkingSpaces>0</ParkingSpaces> <Code>MUCLAN</Code> <Name>Schweigers Landgasthof</Name> </Itinerary> <Room> <Adults>2</Adults> <Children>0</Children> <Infants>0</Infants> <Code>DZ</Code> </Room> <ClientDetails> <Title>Herr</Title> <Initial>T</Initial> <Surname>TEST</Surname> <Email>TEST@TEST.COM</Email> <Town>TESTVILLE</Town> <Postcode>TE1 STS</Postcode> <DayPhone>01234567890</DayPhone> <Remarks/> <Address0>1 Test Street</Address0> <Address1>TBC</Address1> <DataProtection>N</DataProtection> <County>TESTSHIRE</County> </ClientDetails> <Pricing> <Price>120.00</Price> </Pricing> <API_Header> <Request> <ABTANumber>YourABTANumber</ABTANumber> <Password>YourPassword</Password> <key>YourKey</key> <token>YourToken</token> <ArrivalDate>2017-12-01</ArrivalDate> <Nights>1</Nights> <RoomCode>DBL</RoomCode> <ParkingDays>0</ParkingDays> <Adults>2</Adults> <Children>0</Children> <Title>Mr</Title> <Initial>T</Initial> <Surname>TEST</Surname> <Address0>1 Test Street</Address0> <Town>Testville</Town> <County>Testshire</County> <Postcode>TE1 STS</Postcode> <DayPhone>01234567890</DayPhone> <Email>test@test.com</Email> <DataProtection>N</DataProtection> <PriceCheckFlag>Y</PriceCheckFlag> <PriceCheckPrice>120.00</PriceCheckPrice> <System>ABG</System> <lang>de</lang> <v>1</v> </Request> </API_Header></API_Reply>UK Hotel booking with UpgradesRequesthttps://api.holidayextras.co.uk/v1/hotel/LGWSOF<Request> <ABTANumber>YourABTANumber</ABTANumber> <Password>YourPassword</Password> <key>YourKey</key> <token>YourToken</token> <ArrivalDate>2020-11-10</ArrivalDate> <Nights>1</Nights> <RoomCode>DBL</RoomCode> <ParkingDays>0</ParkingDays> <Adults>2</Adults> <Children>0</Children> <Title>Mr</Title> <Initial>T</Initial> <Surname>TEST</Surname> <Address >1 Test Street</Address > <Town>Testville</Town> <County>Testshire</County> <Postcode>TE1 STS</Postcode> <DayPhone>01234567890</DayPhone> <Email>test@test.com</Email> <DataProtection>N</DataProtection> <PriceCheckFlag>Y</PriceCheckFlag> <PriceCheckPrice>135.00</PriceCheckPrice> <Supplements> <Code>LGWSOE</Code> <Date>2020-11-10</Date> <Quantity>1</Quantity> </Adults> </Children> <TotalPrice>40.00</TotalPrice> </Supplements> <Supplements> <Code>LGWASC</Code> <Date>2020-11-11</Date> <LoungeArrival>2020-11-11 12:30</LoungeArrival> </Quantity> <Adults>2</Adults> <Children>0</Children> <TotalPrice>56.00</TotalPrice> </Supplements> <v>1</v></Request>Response<?xml version=\"1.0\"?><API_Reply Product=\"HotelWithParking\" RequestCode=\"5\" Result=\"OK\"> <Booking> <BookingRef>YourBookingRef</BookingRef> <AgentComm>13.45</AgentComm> <VATonComm>0.00</VATonComm> <MoreInfoURL>/v1/booking/YourBookingRef</MoreInfoURL> </Booking> <Hotel/> <Itinerary> <TotalPrice>255.55</TotalPrice> <ArrivalDate>2020-11-10</ArrivalDate> <Nights>1</Nights> <BoardBasis>RO</BoardBasis> <NonSmoking>N</NonSmoking> <ReturnFlight/> <TerminalCode/> <Code>LGWSOF</Code> <Name>Sofitel</Name> <ParkingDays>0</ParkingDays> <ParkingSpaces>0</ParkingSpaces> </Itinerary> <Room> <Adults>2</Adults> <Children>0</Children> <Infants>0</Infants> <Code>DBL</Code> </Room> <CarDetails> <Registration/> <CarMake/> <CarModel/> <CarColour/> </CarDetails> <ClientDetails> <Title>MR</Title> <Initial>T</Initial> <Surname>TEST</Surname> <Email>test@test.com</Email> <Address/> <Town/> <County/> <Postcode/> <EvePhone>01234567890</EvePhone> </ClientDetails> <CurrentSupplements> <Code>LGWSOE</Code> <Name>Luxury room upgrade</Name> <Price>66.50</Price> <NonDiscPrice>66.50</NonDiscPrice> <Per>room</Per> <Adults>0</Adults> <Children>0</Children> <Date>2020-11-10</Date> <Remarks/> <Canx>Y</Canx> </CurrentSupplements> <CurrentSupplements> <Code>LGWASC</Code> <Name>Club Aspire North Lounge</Name> <Price>47.50</Price> <NonDiscPrice>47.50</NonDiscPrice> <Per>person</Per> <Adults>2</Adults> <Children>0</Children> <Date>2020-11-11</Date> <Remarks/> <Canx>Y</Canx> </CurrentSupplements> <API_Header> <Request> <ABTANumber>YourABTANumber</ABTANumber> <Password>YourPassword</Password> <key>YourKey</key> <token>YourToken</token> <ArrivalDate>2020-11-10</ArrivalDate> <ArrivalTime>12:30</ArrivalTime> <Title>Mr</Title> <Initial>T</Initial> <Surname>Test</Surname> <Address>Holiday Extras Ltd</Address> <Address>Ashford Road</Address> <Town>Hythe</Town> <County>Kent</County> <PostCode>CT214JF</PostCode> <Email>test@test.com</Email> <PriceCheckFlag>Y</PriceCheckFlag> <PriceCheckPrice>135.00</PriceCheckPrice> <Adults>2</Adults> <Children>0</Children> <Nights>1</Nights> <RoomCode>DBL</RoomCode> <ParkingDays>0</ParkingDays> <Supplements> <Code>LGWSOE</Code> <Date>2020-11-10</Date> <Quantity>1</Quantity> <TotalPrice>70.00</TotalPrice> </Supplements> <Supplements> <Code>LGWASC</Code> <Date>2020-11-11</Date> <Adults>2</Adults> <Children>0</Children> <TotalPrice>56.00</TotalPrice> </Supplements> <v>1</v> </Request> </API_Header></API_Reply>",
+ "url": "/hxapi/hotel/bkg/"
+ }
+ ,
+
"hxapi-bundles": {
"title": "Bundles",
"content": "BundlesSome results that are returned from availability on the API will be what we call bundles, these consist of a main product, such as a hotel, bundled together with an additional supplement, like a dinner.Bundles are currently only available on hotel searches.AvailabilityBundles can be identified by their product code, which has an additional element preceding the main product code joined by a +.E.g...<Name>Cresta Court with 2-course dinner</Name><Code>MANCCT+B519</Code><BookingURL>/v1/hotel/HPMANCCT+B519</BookingURL><Price>110.65</Price>...The price given will be for the entire bundle including the supplement with the current passenger quantity ( determined by the given room code ).A product library request can be made with the complete bundle product code to get content related to the package as a whole instead of simply the main product. E.g /v1/product/MANCCT+B519BookingThe BookingURL element will contain the full product code, including prefix, that must be supplied when a bundle is to be booked, this will ensure that system books the main product as well as the appropriate supplement. When booking a bundle on a hotel search the quantity of the supplement will be determined by the given room occupancy in the Adults and Children fields.The booking response for a bundle booking will show the main product and the booked supplement as seperate elements. The TotalPrice field will contain the full price of the booking, but the supplement price will also be shown separately under the CurrentSupplements block.E.g...<Booking><BookingRef>XXXXX</BookingRef><AgentComm>12.41</AgentComm><VATonComm>2.07</VATonComm><MoreInfoURL>/v1/booking/XXXXX</MoreInfoURL></Booking><Hotel/><Itinerary><TotalPrice>110.65</TotalPrice><ArrivalDate>2019-03-10</ArrivalDate><Nights>1</Nights><BoardBasis>RO</BoardBasis><NonSmoking>N</NonSmoking><ReturnFlight/><TerminalCode/><Code>MANCCT</Code><Name/><ParkingDays>0</ParkingDays><ParkingSpaces>0</ParkingSpaces></Itinerary><Room><Adults>2</Adults><Children>1</Children><Infants>0</Infants><Code>TRL</Code></Room><CurrentSupplements><Code>MANCDI</Code><Name>2-course dinner</Name><Price>29.90</Price><NonDiscPrice>29.90</NonDiscPrice><Per>person</Per><Adults>2</Adults><Children>1</Children><Date>2019-03-10</Date><Canx>Y</Canx><Remarks/></CurrentSupplements>...The product code of the supplement will also be returned in the booking response which can be used to retrieve product specific content in the product library request that can be displayed on booking confirmations. When creating confirmation emails be sure to highlight that the supplement has been added as a part of this booking.Post BookingA bundle booking can be amended or cancelled following the same rules as a general product. The supplement has a Canx field in the booking response that will define if that particular add-on can be cancelled as part of the booking. It is not currently possible to amend the quantity of the supplement or remove it from the booking using the API.",
@@ -149,13 +149,6 @@
}
,
- "hxapi-de-start-cancel": {
- "title": "Cancel Booking - DE Start Method",
- "content": "Cancel Booking - DE Start MethodCancel Booking RequestCancelling a booking is a two-stage process: Check if the booking is cancellable, and any charges for doing so, using the GET method outlined below; Cancel the booking using the POST method outlined below.MethodGET / POSTEndpointThe endpoint to use is (where YourBookingRef is the Holiday Extras booking reference):https://payment.holidayextras.co.uk/legacy/booking/YourBookingRefRequest ParametersStep 1: Check if booking is cancellable (GET)NB: All parameter names are case sensitive. Name Data Type Format Mandatory? Additional Information StartCustomer String [0-9] 6 chars Y This will be assigned to you by your Account Manager during set up. BusinessUnit String [0-9] 3 chars Y This will be assigned to you by your Account Manager during set up. Operator String [A-Z] 3 chars Y This always defaults to BJT. key String [A-Z] Y This will be assigned to you by your Account Manager during set up. token String [0-9] 9 chars Y This is the same token used in the availability request. ConfirmCancel String 1 chars Y Set this to N for this initial step. CancelRef String [A-Z] 10 chars Y The reference for the cancellation, e.g. agent’s initials. Step 2: Cancel booking (POST)NB: All parameter names are case sensitive. Name Data Type Format Mandatory? Additional Information StartCustomer String [0-9] 6 chars Y This will be assigned to you by your Account Manager during set up. BusinessUnit String 0-9] 3 chars Y This will be assigned to you by your Account Manager during set up. Operator String [A-Z] 3 chars Y This always defaults to BJT. key String [A-Z] Y This will be assigned to you by your Account Manager during set up. token String [0-9] 9 chars Y This is the same token used in the availability request. ConfirmCancel String 1 chars Y Set this to N for this initial step. CancelRef String [A-Z0-9] 10 chars Y The reference for the cancellation, e.g. agent’s initials. Cancel Booking Response - DE-Start MethodThe cancel booking response will confirm that a booking has been cancelled in our system.For a detailed explanation of the fields returned, please see below: Field Additional Information Booking/BookingRef This is the reference for this booking. It must be referred to in all communication with us concerning this booking. NB: Our booking references are up to 12 char alphanumeric (including 1/I and 0/O/Q). Cancel/RefundAmount This shows the amount to be refunded to the customer. API_Header/Request A list of parameters that were sent in the booking request. Credit Card FeesAs of 12th January 2018 we no longer charge credit card fees, in line with the Payment Services Directive (PSD2). This applies to both UK and EU products.Worked examplesBelow are worked examples of both the request and response for cancelling a booking.Cancel Booking Request - Step 1https://payment.holidayextras.co.uk/legacy/booking/YourBookingRef?BusinessUnit=YourBusinessUnit&ConfirmCancel=N&Operator=BJT&SStartCustomer=YourStartCustomer&key=YourKey&token=YourToken&CancelRef=YourCancelRefCancel Booking Response - Step 1<?xml version=\"1.0\" ?><API_Reply System=\"ABG\" Version=\"1.0\" Product=\"Cancel\" Customer=\"A\" Session=\"123456789\" RequestCode=\"9\" Result=\"OK\"> <Booking> <BookingRef>YourBookingRef</BookingRef> <StartRef>YourStartRef</StartRef> </Booking> <Cancel> <CancelFee>0.00</CancelFee> <CancelInfo>Es gibt keine Gebühr für die Stornierung dieser Buchung</CancelInfo> </Cancel> <API_Header> <Request> <BusinessUnit>YourBusinessUnit</BusinessUnit> <ConfirmCancel>N</ConfirmCancel> <Operator>BJT</Operator> <StartCustomer>YourStartCustomer</StartCustomer> <key>YourKey</key> <token>YourToken</token> <CancelRef>YourCancelRef</CancelRef> <system>de</system> <System>ABG</System> </Request> </API_Header></API_Reply>Cancel Booking Request - Step 2https://payment.holidayextras.co.uk/legacy/booking/YourBookingRef <Request> <BusinessUnit>YourBusinessUnit</BusinessUnit> <ConfirmCancel>Y</ConfirmCancel> <Operator>BJT</Operator> <StartCustomer>YourStartCustomer</StartCustomer> <key>YourKey</key> <token>YourToken</token> <CancelRef>YourCancelRef</CancelRef> </Request>Cancel Booking Response - Step 2<?xml version=\"1.0\" ?><API_Reply System=\"ABG\" Version=\"1.0\" Product=\"Cancel\" Customer=\"A\" Session=\"123456789\" RequestCode=\"9\" Result=\"OK\"> <Booking> <BookingRef>YourBookingRef</BookingRef> <StartRef>YourStartRef</StartRef> </Booking> <Cancel> <CancelFee>0.00</CancelFee> <CancelRef>YourCancelRef</CancelRef> <CancelInfo>Bitten Sie um Rückgabe des Kundenvouchers, da er seine Gültigkeit nicht verliert</CancelInfo> </Cancel> <API_Header> <Request> <BusinessUnit>YourBusinessUnit</BusinessUnit> <CancelRef>YourCancelRef</CancelRef> <ConfirmCancel>Y</ConfirmCancel> <Operator>BJT</Operator> <StartCustomer>YourStartCustomer</StartCustomer> <key>YourKey</key> <token>YourToken</token> <system>de</system> <System>ABG</System> </Request> </API_Header></API_Reply>",
- "url": "/hxapi/de-start/cancel/"
- }
- ,
-
"hxapi-viewamendcancel-cancel": {
"title": "Cancel Booking",
"content": "Cancel BookingAPI Docs > product:cancelCancel Booking RequestCancelling a booking is a two-stage process: Check if the booking is cancellable, and any charges for doing so, using the GET method outlined below; Cancel the booking using the POST method outlined below.MethodGET / POSTEndpointThe endpoint to use is (where YourBookingRef is the Holiday Extras booking reference):https://api.holidayextras.co.uk/v1/booking/YourBookingRefRequest ParametersStep 1: Check if booking is cancellable (GET)NB: All parameter names are case sensitive. Name Data Type Format Mandatory? Additional Information ABTANumber String [A-Z0-9] 5 chars Y This is also known as an ‘agent code’. This will be confirmed to you by your Account Manager during set up. Password String [A-Z0-9] 5 chars N* Password required for retail agent requests - intermediaries do not require a password.This will be confirmed to you by your Account Manager during set up. Initials String [A-Z] 3 chars N The initials of the Operator / Agent. key String [A-Z] Y This will be assigned to you by your Account Manager during set up. System String [A-Z] 3 chars Y* For European products, you need to pass in the value of System=ABG (the default is System=ABC, which is UK products only). ConfirmCancel String 1 chars Y Set this to N for this initial step. CancelRef String [A-Z0-9] 10 chars Y The reference for the cancellation, e.g. agent’s initials. Step 2: Cancel booking (POST)NB: All parameter names are case sensitive. Name Data Type Format Mandatory? Additional Information ABTANumber String [A-Z0-9] 5 chars Y This is also known as an ‘agent code’. This will be confirmed to you by your Account Manager during set up. Password String [A-Z0-9] 5 chars N* Password required for retail agent requests - intermediaries do not require a password.This will be confirmed to you by your Account Manager during set up. Initials String [A-Z] 3 chars N The initials of the Operator / Agent. key String [A-Z] Y This will be assigned to you by your Account Manager during set up. System String [A-Z] 3 chars Y* For European products, you need to pass in the value of System=ABG (the default is System=ABC, which is UK products only). ConfirmCancel String 1 chars Y Set this to Y for the cancellation step. CancelRef String [A-Z0-9] 10 chars Y The reference for the cancellation, e.g. agent’s initials. Cancel Booking ResponseThe cancel booking response will confirm that a booking has been cancelled in our system.For a detailed explanation of the fields returned, please see below: Field Additional Information Booking/BookingRef This is the reference for this booking. It must be referred to in all communication with us concerning this booking. NB: Our booking references are up to 12 char alphanumeric (including 1/I and 0/O/Q). Cancel/RefundAmount This shows the amount to be refunded to the customer. API_Header/Request A list of parameters that were sent in the booking request. Credit Card FeesAs of 12th January 2018 we no longer charge credit card fees, in line with the Payment Services Directive (PSD2). This applies to both UK and EU products.Worked examplesBelow are worked examples of both the request and response for cancelling a booking.Cancel Booking Request - Step 1https://api.holidayextras.co.uk/v1/booking/YourBookingRef?ABTANumber=YourABTANumber&Password=YourPassword&key=YourKey&ConfirmCancel=N&CancelRef=YourCancelRefCancel Booking Response - Step 1<?xml version=\"1.0\"?><API_Reply Result=\"OK\"> <Booking> <BookingRef>YourBookingRef</BookingRef> </Booking> <Cancel> <CancelFee>0.00</CancelFee> <CancelRef/> <CancelInfo>There is no charge for cancelling this booking</CancelInfo> <RefundAmount>35.92</RefundAmount> </Cancel> <API_Header> <Request> <ABTANumber>YourABTANumber</ABTANumber> <Password>YourPassword</Password> <key>YourKey</key> <ConfirmCancel>N</ConfirmCancel> <CancelRef>YourCancelRef</CancelRef> <v>1</v> </Request> </API_Header></API_Reply>Cancel Booking Request - Step 2https://api.holidayextras.co.uk/v1/booking/YourBookingRef <Request> <ABTANumber>YourABTA</ABTANumber> <Password>YourPassword</Password> <Initials>YourInitials</Initials> <key>YourKey</key> <ConfirmCancel>Y</ConfirmCancel> <CancelRef>YourCancelRef</CancelRef> </Request>Cancel Booking Response - Step 2<?xml version=\"1.0\"?><API_Reply Result=\"OK\"> <Booking> <BookingRef>YourBookingRef</BookingRef> </Booking> <Cancel> <CancelFee>0.00</CancelFee> <CancelRef>06684</CancelRef> <CancelInfo>Please retrieve your client's copy of voucher as booking will be reinstated if used</CancelInfo> <RefundAmount>35.92</RefundAmount> </Cancel> <API_Header> <Request> <ABTANumber>YourABTANumber</ABTANumber> <Password>YourPassword</Password> <key>YourKey</key> <ConfirmCancel>Y</ConfirmCancel> <CancelRef>YourCancelRef</CancelRef> <v>1</v> </Request> </API_Header></API_Reply>Cancelling bookings made with a credit or debit cardA small number of agents in Europe pass through payment details in our API (for historic reasons). The method for cancelling these products differs slightly in that an extra parameter is required to authenticate against the booking. The extra parameter is identified below. Name Data Type Format Mandatory? Additional Information CreditCardLast4 Integer [0-9] 4 chars Y These are the last 4 digits on the card that the customer used to make payment. The cancellation request must be POSTed against the following endpoint:https://payment.holidayextras.co.uk/legacy/",
@@ -163,6 +156,13 @@
}
,
+ "hxapi-de-start-cancel": {
+ "title": "Cancel Booking - DE Start Method",
+ "content": "Cancel Booking - DE Start MethodCancel Booking RequestCancelling a booking is a two-stage process: Check if the booking is cancellable, and any charges for doing so, using the GET method outlined below; Cancel the booking using the POST method outlined below.MethodGET / POSTEndpointThe endpoint to use is (where YourBookingRef is the Holiday Extras booking reference):https://payment.holidayextras.co.uk/legacy/booking/YourBookingRefRequest ParametersStep 1: Check if booking is cancellable (GET)NB: All parameter names are case sensitive. Name Data Type Format Mandatory? Additional Information StartCustomer String [0-9] 6 chars Y This will be assigned to you by your Account Manager during set up. BusinessUnit String [0-9] 3 chars Y This will be assigned to you by your Account Manager during set up. Operator String [A-Z] 3 chars Y This always defaults to BJT. key String [A-Z] Y This will be assigned to you by your Account Manager during set up. token String [0-9] 9 chars Y This is the same token used in the availability request. ConfirmCancel String 1 chars Y Set this to N for this initial step. CancelRef String [A-Z] 10 chars Y The reference for the cancellation, e.g. agent’s initials. Step 2: Cancel booking (POST)NB: All parameter names are case sensitive. Name Data Type Format Mandatory? Additional Information StartCustomer String [0-9] 6 chars Y This will be assigned to you by your Account Manager during set up. BusinessUnit String 0-9] 3 chars Y This will be assigned to you by your Account Manager during set up. Operator String [A-Z] 3 chars Y This always defaults to BJT. key String [A-Z] Y This will be assigned to you by your Account Manager during set up. token String [0-9] 9 chars Y This is the same token used in the availability request. ConfirmCancel String 1 chars Y Set this to N for this initial step. CancelRef String [A-Z0-9] 10 chars Y The reference for the cancellation, e.g. agent’s initials. Cancel Booking Response - DE-Start MethodThe cancel booking response will confirm that a booking has been cancelled in our system.For a detailed explanation of the fields returned, please see below: Field Additional Information Booking/BookingRef This is the reference for this booking. It must be referred to in all communication with us concerning this booking. NB: Our booking references are up to 12 char alphanumeric (including 1/I and 0/O/Q). Cancel/RefundAmount This shows the amount to be refunded to the customer. API_Header/Request A list of parameters that were sent in the booking request. Credit Card FeesAs of 12th January 2018 we no longer charge credit card fees, in line with the Payment Services Directive (PSD2). This applies to both UK and EU products.Worked examplesBelow are worked examples of both the request and response for cancelling a booking.Cancel Booking Request - Step 1https://payment.holidayextras.co.uk/legacy/booking/YourBookingRef?BusinessUnit=YourBusinessUnit&ConfirmCancel=N&Operator=BJT&SStartCustomer=YourStartCustomer&key=YourKey&token=YourToken&CancelRef=YourCancelRefCancel Booking Response - Step 1<?xml version=\"1.0\" ?><API_Reply System=\"ABG\" Version=\"1.0\" Product=\"Cancel\" Customer=\"A\" Session=\"123456789\" RequestCode=\"9\" Result=\"OK\"> <Booking> <BookingRef>YourBookingRef</BookingRef> <StartRef>YourStartRef</StartRef> </Booking> <Cancel> <CancelFee>0.00</CancelFee> <CancelInfo>Es gibt keine Gebühr für die Stornierung dieser Buchung</CancelInfo> </Cancel> <API_Header> <Request> <BusinessUnit>YourBusinessUnit</BusinessUnit> <ConfirmCancel>N</ConfirmCancel> <Operator>BJT</Operator> <StartCustomer>YourStartCustomer</StartCustomer> <key>YourKey</key> <token>YourToken</token> <CancelRef>YourCancelRef</CancelRef> <system>de</system> <System>ABG</System> </Request> </API_Header></API_Reply>Cancel Booking Request - Step 2https://payment.holidayextras.co.uk/legacy/booking/YourBookingRef <Request> <BusinessUnit>YourBusinessUnit</BusinessUnit> <ConfirmCancel>Y</ConfirmCancel> <Operator>BJT</Operator> <StartCustomer>YourStartCustomer</StartCustomer> <key>YourKey</key> <token>YourToken</token> <CancelRef>YourCancelRef</CancelRef> </Request>Cancel Booking Response - Step 2<?xml version=\"1.0\" ?><API_Reply System=\"ABG\" Version=\"1.0\" Product=\"Cancel\" Customer=\"A\" Session=\"123456789\" RequestCode=\"9\" Result=\"OK\"> <Booking> <BookingRef>YourBookingRef</BookingRef> <StartRef>YourStartRef</StartRef> </Booking> <Cancel> <CancelFee>0.00</CancelFee> <CancelRef>YourCancelRef</CancelRef> <CancelInfo>Bitten Sie um Rückgabe des Kundenvouchers, da er seine Gültigkeit nicht verliert</CancelInfo> </Cancel> <API_Header> <Request> <BusinessUnit>YourBusinessUnit</BusinessUnit> <CancelRef>YourCancelRef</CancelRef> <ConfirmCancel>Y</ConfirmCancel> <Operator>BJT</Operator> <StartCustomer>YourStartCustomer</StartCustomer> <key>YourKey</key> <token>YourToken</token> <system>de</system> <System>ABG</System> </Request> </API_Header></API_Reply>",
+ "url": "/hxapi/de-start/cancel/"
+ }
+ ,
+
"hxapi-parking-av-carpark": {
"title": "Availability At Car Park",
"content": "Availability At Car ParkAPI Docs > product:Parking > endpoint:carpark > Availability by CarparkCar Park Availability RequestMethodGETEndpointThe endpoint to use is:https://api.holidayextras.co.uk/v1/carpark/CarParkCodeFor example, for Purple Parking Park and Ride T2 at London Heathrow the endpoint is:https://api.holidayextras.co.uk/v1/carpark/LHH6To find the airport locations available for car parking, please refer to the locations endpoint.Request ParametersNB: All parameter names are case sensitive. Name Data Type Format Mandatory? Additional Information ABTANumber String [A-Z0-9] 5 chars Y This is also known as an ‘agent code’. This will be confirmed to you by your Account Manager during set up. Password String [A-Z0-9] 5 chars Y* Password required for retail agent requests - intermediaries do not require a password.This will be confirmed to you by your Account Manager during set up. Initials String [A-Z] 3 chars N The initials of the Operator / Agent. key String [A-Z] Y This will be assigned to you by your Account Manager during set up. token String [0-9] 9 chars Y Please see user token endpoint for details of how to generate a token. ArrivalDate Date YYYY-MM-DD Y Date customer drops vehicle at car park. ArrivalTime Time HHMM Y Time customer drops vehicle at car park. DepartDate Date YYYY-MM-DD Y Date customer picks up vehicle from car park. DepartTime Time HHMM Y Time customer picks up vehicle from car park. NumberOfPax Integer [0-9] 2 chars N Number of passengers. OutFlight String [A-Z0-9] 9 chars N This is also known as an ‘flight number’. Used to establish which terminal the customer is flying from using our look up tool and return products specific to that terminal. filter String [A-Z] N Pass in values filter=on_airport, filter=recommended or filter=meet_and_greet to only show car parks meeting those criteria. You can filter by any field that comes back in the filter section of the API. Only a single filter can be used at once. fields String [A-Z] a csv list of product info fields N A list of product info fields can be passed in to return configurable product information e.g. fields=name,address,latitude,sellingpoint. top3 Boolean [0,1] N If a value of 1 is passed in for the top3 param, then a maximum of three car parks will be returned, one on airport, one park and ride, and one meet and greet. System String [A-Z] 3 chars Y* For European products, you need to pass in the value of System=ABG (the default is System=ABC, which is UK products only). lang String [A-Z] 2 chars Y* Required for requests for European products. (Values available are en, de, it, es, pt and nl.) Car Park Availability ResponseThe car park availability response will return the specific product requested, so long as it has availability on the specific dates and durations. A summary of the request received can be found in the header field at the end of the response.For a detailed explanation of the fields returned, please see below: Field Additional Information CarPark/Name The name of the product CarPark/Code The product code CarPark/BookingURL The URL to POST the booking request to for this particular product. Note: The product code includes prefix. CarPark/MoreInfoURL The link to more information about this product, sourced from the Product Library. Note: The product code doesn’t include prefix. CarPark/RequestFlags _NB. In Europe this will be replaced with <CarDetFlags>, see below for more info on these.These flags list which details the car park operator requires from the customer. If a flag is returned with a ‘Y’ your application should send the corresponding field/value in the booking request.Flags are only returned when required. The flags which can be returned are: Registration, CarMake, CarModel, CarColour, OutFlight, ReturnFlight, OutTerminal, ReturnTerminal, Destination, MobileNum. CarPark/NonDiscPrice The non discounted price. Some agent codes apply a discount so we return this field to enable a comparison. CarPark/TotalPrice The price of product without any surcharges/fees added. CarPark/GatePrice If available, the price of product if you were to turn up on the day. CarPark/CanAmendCantCancel Whether the product can be amend but not cancelled. CarPark/CancellationFeeExceptions If the carpark has non-standard cancellation fees. CarPark/AmendmentFeeExceptions If the carpark has non-standard amendment fees. CarPark/Filter We have a filter mechanism on our site, to show particular types of product, such as Meet and Greet. The filters that apply to a product are returned here. Possible values are: meet_and_greet, recommended, on_airport, terminal, valet_included, car_parked_for_you. Pricing/CreditCardSurcharge NB: This is only relevant for Intermediary Agents in Europe, where Holiday Extras is responsible for processing the payment, not the Agent. The first step in the calculation is to determine the credit card surcharge payable (x), based on the value of the booking, using this formula: x = (TotalPrice + the CanxWaiver) / 100 x CCardSurchargePercent Second, to prevent the surcharge from exceeding certain boundaries we have min and max thresholds, which can be calculated as follows: if x < CCardSurchargeMin; x = CCardSurchargeMin else if x > CCardSurchargeMax; x = CCardSurchargeMax Pricing/CancellationWaiver/Waiver We provide an optional cancellation waiver. If this is not added then cancellation will incur a fee. This returns the cancellation fee cost. API_Header/Request The API returns every parameter and value you sent in the previous request. CarDetFlags (Europe Only)For European products only, the availability response will return a field called <CarDetFlags>, which identifies the fields required when making a booking. (This is instead of the <RequestFlags> field which is returned for UK products only).For example: <CarDetFlags> NNNNNNNNNNNNNNNNNN </CarDetFlags>The order of the flags is always the same, and refers to these parameters respectively: Position Parameter Data Type Format Additional Information 1 Registration String [A-Z0-9] 20 chars Vehicle registration number NB: This field is not validated through the API. 2 CarMake String [A-Z0-9] 20 chars Make of vehicle, e.g. Audi. 3 CarModel String [A-Z0-9] 20 chars Model of vehicle, e.g. A6. 4 CarColour String [A-Z0-9] 20 chars Colour of vehicle, e.g. White. 5 NumberOfPax Integer [0-9] Number of passengers in the vehicle. 6 CarDropoffTime Time HHMM Arrival time when you drop the vehicle off at the car park e.g 1000. 7 CarPickupTime Time HHMM Return time, when you pick the vehicle up from the car park, e.g. 1600. 8 OutTerminal String [A-Z0-9] 2 chars Single letter or number representation of the terminal e.g N or S or 4 9 OutFltNo String [A-Z0-9] 10 chars Outbound flight number e.g. EZY123. 10 InFltNo String [A-Z0-9] 10 chars Return flight number e.g. EZY124. 11 OutFltTime Time HHMM Departure time of the outbound flight e.g. 1200. 12 InFltTime Time HHMM Arrival time of the inbound flight e.g. 1500. 13 MobileNum String [A-Z0-9] 15 chars Customer’s mobile number. 14 ShipName String [A-Z0-9] 20 chars Name of the ship, e.g. AIDA 15 PierName String [A-Z0-9] 20 chars Name of the pier or port where the ship is departing from 16 ChildSeat String Y/N Is a child car seat needed? 17 AddlServices String [A-Z0-9] 50 chars In this parameter you may add additional remarks regarding the booking. 18 RetTerminal String [A-Z0-9] 2 chars Single letter or number representation of the terminal e.g N or S or 4 Worked ExamplesBelow are worked examples of both the request and response for availability at an airport.UK Products Availability Requesthttps://api.holidayextras.co.uk/carpark/LHH6?ABTANumber=YourABTANumber&Password=YourPassword&Initials=YourInitials&key=YourKey&token=YourToken&ArrivalDate=2017-12-01&ArrivalTime=1200&DepartDate=2017-12-08&DepartTime=1200&NumberOfPax=1UK Products Availability Response<?xml version=\"1.0\"?><API_Reply Product=\"CarPark\" RequestCode=\"3\" Result=\"OK\"> <CarPark> <Name>Purple Parking Park and Ride T2</Name> <Code>LHH6</Code> <BookingURL>/carpark/HPLHH6</BookingURL> <MoreInfoURL>/product/LHH6</MoreInfoURL> <RequestFlags> <CarColour>1</CarColour> <CarMake>1</CarMake> <CarModel>1</CarModel> <Destination>1</Destination> <MobileNum>1</MobileNum> <OutFlight>1</OutFlight> <OutTerminal>1</OutTerminal> <Registration>1</Registration> <ReturnFlight>1</ReturnFlight> <ReturnTerminal>1</ReturnTerminal> </RequestFlags> <TotalPrice>85.95</TotalPrice> <GatePrice>89.99</GatePrice> <Filter> <terminal>2</terminal> <meet_and_greet>0</meet_and_greet> <park_and_ride>1</park_and_ride> <car_parked_for_you>1</car_parked_for_you> </Filter> </CarPark> <Pricing> <CCardSurchargePercent>2.20</CCardSurchargePercent> <TotalPrice>85.95</TotalPrice> <CCardSurchargeAmount>0.00</CCardSurchargeAmount> <CancellationWaiver> <Waiver>1.99</Waiver> </CancellationWaiver> </Pricing> <SepaID/> <API_Header> <Request> <ABTANumber>YourABTANumber</ABTANumber> <Password>YourPassword</Password> <Initials>YourInitials</Initials> <key>YourKey</key> <token>YourToken</token> <ArrivalDate>2017-12-01</ArrivalDate> <ArrivalTime>1200</ArrivalTime> <DepartDate>2017-12-08</DepartDate> <DepartTime>1200</DepartTime> <NumberOfPax>1</NumberOfPax> </Request> </API_Header></API_Reply>European Products Availability Requesthttps://api.holidayextras.co.uk/carpark/MU01?ABTANumber=YourABTANumber&Password=YourPassword&Initials=YourInitials&key=YourKey&token=YourToken&ArrivalDate=2017-12-01&ArrivalTime=1200&DepartDate=2017-12-08&DepartTime=1200&NumberOfPax=1&System=ABGEuropean Products Availability Response<?xml version=\"1.0\"?><API_Reply Product=\"CarPark\" RequestCode=\"3\" Result=\"OK\"> <CarPark> <Name>Parkservice Sky München</Name> <Code>MU01</Code> <BookingURL>/carpark/FRMU01</BookingURL> <MoreInfoURL>/product/MU01</MoreInfoURL> <RequestFlags/> <TotalPrice>35.00</TotalPrice> <GatePrice>0.00</GatePrice> <CancellationRule>0</CancellationRule> <CarDetFlags>NNNNNNNNYYNYNNNNNN</CarDetFlags> <CarDetails>Y</CarDetails> <DiscDates/> <QRCodeProduct>N</QRCodeProduct> <Filter> <car_parked_for_you>1</car_parked_for_you> <meet_and_greet>0</meet_and_greet> <on_airport/> <recommended/> <special_offer_text>1</special_offer_text> <valet_included>0</valet_included> </Filter> </CarPark> <Pricing> <CCardSurchargePercent>0.00</CCardSurchargePercent> <TotalPrice>35.00</TotalPrice> <CCardSurchargeAmount>0.00</CCardSurchargeAmount> </Pricing> <SepaID>DE11ZZZ00000633860</SepaID> <API_Header> <Request> <ABTANumber>YourABTANumber</ABTANumber> <Password>YourPassword</Password> <Initials>YourInitials</Initials> <key>YourKey</key> <token>YourToken</token> <ArrivalDate>2017-12-01</ArrivalDate> <ArrivalTime>1200</ArrivalTime> <DepartDate>2017-12-08</DepartDate> <DepartTime>1200</DepartTime> <NumberOfPax>1</NumberOfPax> <System>ABG</System> <lang>de</lang> </Request> </API_Header></API_Reply>",
@@ -193,7 +193,7 @@
"faq": {
"title": "FAQ",
- "content": "FAQWhat is the development server address?https://api.holidayextras.co.uk/sandbox/Whenever writing new code or altering existing functionality, you must use the development server (sandbox). The data returned is not ‘as live’, but the format and structure are the same. If you do not, you will affect metrics such as conversion rates, and any bookings made will be live.What is the live server address?https://api.holidayextras.co.uk/What about caching?We anticipate that many application developers will want to cache the results to certain searches. For example, there is no need to request locations every time. Much better to store these locally and create a routine that calls the API at regular intervals to get the latest list.We suggest that you do not cache availability requests though. Prices can change without notice and allocation can run out.H00x product codesThese are sometimes returned at the end of car parking requests. They represent hotels with parking to be offered as an upsell to customers taking early morning flights. You should ignore these or contact sales@holidayextras.com, tell us your agent code and we will disable them.Test Credit CardsIn order to make card bookings through our development server (sandbox) one of the following test cards must be used to process the transaction, with the correct CV2 and expiry date as shown below:Visa Credit Card - 4715059999000437CV2 - 222Expiry - 05/17Visa Debit Card - 4508750015741019CV2 - 222Expiry - 05/17Amex - 345678000000007CV2 - 2222Expiry - 05/17Credit card surchargesAgents should ignore the credit card surcharge elements. Any processing or handling fees charged on your customers’ bookings are under your control.Intermediaries must calculate the credit card surcharge using the logic below.x = ((TotalPrice + CanxWaiver) / 100 ) * CCardSurchargePercentif( x < CCardSurchargeMin) x = CCardSurchargeMinelse if x > CCardSurchargeMax x = CCardSurchargeMaxThe prices returned, are they net or with markup already added?Markup already added.How is the “Total Price” for Parking calculated?The cost of the Credit Card surcharge applies to the price of parking + cancellation waiver (if taken).So in the reply for a booking request you may see something like this:<AmountPaid>43.56</AmountPaid><TotalPrice>42.06</TotalPrice><CCSurchargeAmount>1.50</CCSurchargeAmount><CanxWaiver>0.50</CanxWaiver>You may expect <AmountPaid> to total £44.06 (because 42.06 + 1.50 + 0.50 = 44.06). This is not an error, the <CanxWaiver> amount has already been added to the parking price of £41.56 to create <TotalPrice>, and the credit card surcharge is then applied to that value, giving <AmountPaid>.Does Holiday Extras need my IP address?No. We use a blacklist for unwelcome traffic, otherwise anyone can make requests to HXAPI as long as they use a valid key.How do I cancel a test booking?You only need to cancel bookings made to the live server. You do not need to cancel bookings made on the development server, no payment is actually taken.Please do not cancel bookings by ringing our call centre or using the online cancellation interface at www.holidayextras.com. Credit card charges will not be refunded to your card if you use either of these methods. Send the booking references to sales@holidayextras.com and all charges will be refunded.FAQ Germany/European product specific (System=ABG)Currency - Right now and for the near future there’s only EUR and GBP. All European products, accessed through System=ABG are returned in EUR and all UK products in GBP.Number of Pax - is actually required, as the car parks need to plan their shuttle capacities.Cancellation Process - Car parks can be cancelled free of charge until 24h before the beginning of the arrival day (basically two days before arrival). If cancelled between 24h before arrival day and arrival day, the charge is 50%. Later than that bookings can only be cancelled by our service team. Customers need to be aware of our terms and conditions, so it would be needed to show the link to our terms and conditions them during booking process (please see section booking parking, booking hotel). Easiest solution for after booking would be to offer the customer a form or/and phone number for cancellations or ammendmends. We do have our own inhouse call center, which handles requests quickly.QR code - is not needed for Germany/European products.shuttle time = 24 hours calculation? - No, they are on a daily basis, but we need the shuttle times for a better planning on the parking space regarding shuttle.Availability test/live system - The status of the data in the test system is December 2015Car park details - We are asked to collect them in the name of the parking provider. They need them to organize their services.Error messages - we can provide you a list of error messages. It is planned to provide them in different languages.Booking number/ABTA number - the combination of both is always unique",
+ "content": "FAQWhat is the development server address?https://api.holidayextras.co.uk/sandbox/Whenever writing new code or altering existing functionality, you must use the development server (sandbox). The data returned is not ‘as live’, but the format and structure are the same. If you do not, you will affect metrics such as conversion rates, and any bookings made will be live.What is the live server address?https://api.holidayextras.co.uk/HELLOWhat about caching?We anticipate that many application developers will want to cache the results to certain searches. For example, there is no need to request locations every time. Much better to store these locally and create a routine that calls the API at regular intervals to get the latest list.We suggest that you do not cache availability requests though. Prices can change without notice and allocation can run out.H00x product codesThese are sometimes returned at the end of car parking requests. They represent hotels with parking to be offered as an upsell to customers taking early morning flights. You should ignore these or contact sales@holidayextras.com, tell us your agent code and we will disable them.Test Credit CardsIn order to make card bookings through our development server (sandbox) one of the following test cards must be used to process the transaction, with the correct CV2 and expiry date as shown below:Visa Credit Card - 4715059999000437CV2 - 222Expiry - 05/17Visa Debit Card - 4508750015741019CV2 - 222Expiry - 05/17Amex - 345678000000007CV2 - 2222Expiry - 05/17Credit card surchargesAgents should ignore the credit card surcharge elements. Any processing or handling fees charged on your customers’ bookings are under your control.Intermediaries must calculate the credit card surcharge using the logic below.x = ((TotalPrice + CanxWaiver) / 100 ) * CCardSurchargePercentif( x < CCardSurchargeMin) x = CCardSurchargeMinelse if x > CCardSurchargeMax x = CCardSurchargeMaxThe prices returned, are they net or with markup already added?Markup already added.How is the “Total Price” for Parking calculated?The cost of the Credit Card surcharge applies to the price of parking + cancellation waiver (if taken).So in the reply for a booking request you may see something like this:<AmountPaid>43.56</AmountPaid><TotalPrice>42.06</TotalPrice><CCSurchargeAmount>1.50</CCSurchargeAmount><CanxWaiver>0.50</CanxWaiver>You may expect <AmountPaid> to total £44.06 (because 42.06 + 1.50 + 0.50 = 44.06). This is not an error, the <CanxWaiver> amount has already been added to the parking price of £41.56 to create <TotalPrice>, and the credit card surcharge is then applied to that value, giving <AmountPaid>.Does Holiday Extras need my IP address?No. We use a blacklist for unwelcome traffic, otherwise anyone can make requests to HXAPI as long as they use a valid key.How do I cancel a test booking?You only need to cancel bookings made to the live server. You do not need to cancel bookings made on the development server, no payment is actually taken.Please do not cancel bookings by ringing our call centre or using the online cancellation interface at www.holidayextras.com. Credit card charges will not be refunded to your card if you use either of these methods. Send the booking references to sales@holidayextras.com and all charges will be refunded.FAQ Germany/European product specific (System=ABG)Currency - Right now and for the near future there’s only EUR and GBP. All European products, accessed through System=ABG are returned in EUR and all UK products in GBP.Number of Pax - is actually required, as the car parks need to plan their shuttle capacities.Cancellation Process - Car parks can be cancelled free of charge until 24h before the beginning of the arrival day (basically two days before arrival). If cancelled between 24h before arrival day and arrival day, the charge is 50%. Later than that bookings can only be cancelled by our service team. Customers need to be aware of our terms and conditions, so it would be needed to show the link to our terms and conditions them during booking process (please see section booking parking, booking hotel). Easiest solution for after booking would be to offer the customer a form or/and phone number for cancellations or ammendmends. We do have our own inhouse call center, which handles requests quickly.QR code - is not needed for Germany/European products.shuttle time = 24 hours calculation? - No, they are on a daily basis, but we need the shuttle times for a better planning on the parking space regarding shuttle.Availability test/live system - The status of the data in the test system is December 2015Car park details - We are asked to collect them in the name of the parking provider. They need them to organize their services.Error messages - we can provide you a list of error messages. It is planned to provide them in different languages.Booking number/ABTA number - the combination of both is always unique",
"url": "/faq/"
}
,
@@ -212,24 +212,24 @@
}
,
- "hxapi-productlibrary": {
- "title": "Product Library",
- "content": "# Product LibraryThe data returned from a Product Library request depends on the type of product you ask for. A request for a car park returns different fields than a request for a hotel.By default, only fields that contain a value are returned.You can specify the fields you want returned. Simply add the parameter fields and specify the field names. An error/warning element will be returned for any fields which do not exist, but the request will still return those elements for which there is a value. If you request a valid field, but there is no value, it will not be returned.The purpose of most of the fields should be self-explanatory. If there is anything you do not understand, please email . There are no guarantees about the types of data returned, you should make no assumptions about a specific field being an integer etc.Data returned should not be cached locally for periods of time greater than one day (24 hours).### URL/product/{productCode}### MethodGET### Parameters| Name | Format | Required ||--------|--------|----------|| token | String | N || key | String | Y || fields | String | N |## Available FieldsThe available fields vary by product type. For each product type there is a recommended list of fields which should be requested to get the information required to effectively sell the product.{% codetabs %}{% codetab Parking %}{% include_relative _parkingFields.md %}{% endcodetab %}{% codetab Hotel room only %}{% include_relative _hotelOnlyFields.md %}{% endcodetab %}{% codetab Hotel with parking %}{% include_relative _hotelParkingFields.md %}{% endcodetab %}{% codetab Lounge %}{% include_relative _loungeFields.md %}{% endcodetab %}{% codetab Fast track %}{% include_relative _fastTrackFields.md %}{% endcodetab %}{% endcodetabs %}---## Examples### Example 1 - Default Response#### Request{% codetabs %}{% codetab Live (XML) %}```https://api.holidayextras.co.uk/v1/product/LGW4/lite?token=000015778&key=mytestkey```{% endcodetab %}{% codetab Live (JSON) %}```https://api.holidayextras.co.uk/v1/product/LGW4/lite.js?token=000015778&key=mytestkey```Note the `.js` extension.{% endcodetab %}{% codetab Sandbox (XML) %}```https://api.holidayextras.co.uk/sandbox/v1/product/LGW4/lite?token=000015778&key=mytestkey```{% endcodetab %}{% codetab Sandbox (JSON) %}```https://api.holidayextras.co.uk/sandbox/v1/product/LGW4/lite.js?token=000015778&key=mytestkey```Note the `.js` extension.{% endcodetab %}{% endcodetabs %}#### Response{% codetabs %}{% codetab XML %}```xml{% include_relative _examples/parking_reply_1.xml %}```{% endcodetab %}{% codetab JSON %}```json{% include_relative _examples/parking_reply_1.json %}```{% endcodetab %}{% endcodetabs %}---### Example 2 - Restricted field list#### Request{% codetabs %}{% codetab Live (XML) %}```https://api.holidayextras.co.uk/v1/product/LGW4/lite?token=000015778&key=mytestkey&fields=name,longitude,latitude```{% endcodetab %}{% codetab Live (JSON) %}```https://api.holidayextras.co.uk/v1/product/LGW4/lite.js?token=000015778&key=mytestkey&fields=name,longitude,latitude```Note the `.js` extension.{% endcodetab %}{% codetab Sandbox (XML) %}```https://api.holidayextras.co.uk/sandbox/v1/product/LGW4/lite?token=000015778&key=mytestkey&fields=name,longitude,latitude```{% endcodetab %}{% codetab Sandbox (JSON) %}```https://api.holidayextras.co.uk/sandbox/v1/product/LGW4/lite.js?token=000015778&key=mytestkey&fields=name,longitude,latitude```Note the `.js` extension.{% endcodetab %}{% endcodetabs %}#### Response{% codetabs %}{% codetab XML %}```xml{% include_relative _examples/parking_reply_2.xml %}```{% endcodetab %}{% codetab JSON %}```json{% include_relative _examples/parking_reply_2.json %}```{% endcodetab %}{% endcodetabs %}---### Example 3 - German Parking Request#### RequestRequests for German products return a different set of fields. Explanation of fields not currently available.{% codetabs %}{% codetab Live (XML) %}```https://api.holidayextras.co.uk/v1/product/FRA0?key=mytestkey```{% endcodetab %}{% codetab Live (JSON) %}```https://api.holidayextras.co.uk/v1/product/FRA0.js?key=mytestkey```Note the `.js` extension.{% endcodetab %}{% codetab Sandbox (XML) %}```https://api.holidayextras.co.uk/sandbox/v1/product/FRA0?key=mytestkey```{% endcodetab %}{% codetab Sandbox (JSON) %}```https://api.holidayextras.co.uk/sandbox/v1/product/FRA0.js?key=mytestkey```Note the `.js` extension.{% endcodetab %}{% endcodetabs %}#### Response{% codetabs %}{% codetab XML %}```xml{% include_relative _examples/parking_reply_3.xml %}```{% endcodetab %}{% codetab JSON %}```json{% include_relative _examples/parking_reply_3.json %}```{% endcodetab %}{% endcodetabs %}",
- "url": "/hxapi/productlibrary/"
+ "payment-gateway": {
+ "title": "Payment Gateway",
+ "content": "# Payment Gateway[API Docs](/index) > [Payment Gateway](index)## Integration guidePlease read the integration guide before attempting to make any requests to these endpoints. Without the appropriate setup, you will not be able to access any of the Payment Gateway functionality.The correct steps to get setup can be found in our [guide to getting setup.](integration)## VersioningThis API is versioned, a specific version can be targetted with an `Accept` header on the request with a value matching `application/vnd.holidayextras.v{VERSION_NUMBER}+json`.### Notice on sunset of v1As of September 16th 2022 v1 of the payment gateway API will not longer be supported. Clients should ensure they are migrated fully to v2 before this time to ensure that payments can still be taken.## Payment| Request | Endpoint | Method | Versions || ------- | -------- | ------ | -------- || Make Payment | https://payment-gateway.holidayextras.co.uk/pay | POST | [v1](v1/pay) [v2](v2/pay) |## Refund| Request | Endpoint | Method | Versions || ------- | -------- | ------ | -------- || Make Refund | https://payment-gateway.holidayextras.co.uk/refund | POST | [v1](v1/refund) [v2](v2/refund) |",
+ "url": "/payment-gateway/"
}
,
- "hxapi-carhire": {
- "title": "Car Hire",
- "content": "# Car Hire[API Docs](/hxapi/) > product:[Car Hire](index)These are the car hire requests.| Action | Endpoint | Method || --- | --- | --- || Lookup Locations | [https://api.holidayextras.co.uk/v1/carHire/locations](locations) | GET || Availability | [https://api.holidayextras.co.uk/v1/carHire/products](availability) | GET || Make Booking | [https://api.holidayextras.co.uk/v1/carHire/](booking/make) | POST || Lookup Booking | [https://api.holidayextras.co.uk/v1/carHire-booking/](booking/lookup) | GET |",
- "url": "/hxapi/carhire/"
+ "hxapi-upgrade": {
+ "title": "Product Upgrades",
+ "content": "# Product Upgrades[API Docs](/hxapi/) > [Product Upgrades](/hxapi/upgrade)## Upgrades Availability RequestUpgrades are currently only supported for parking, hotel and lounge bookings. Upgrades can be requested on a per product basis.#### MethodGET#### Endpoint/upgrade/{productCode}NB: Where `productCode` is the code of the base product i.e. the parking/hotel/lounge etc. product.```https://api.holidayextras.co.uk/v1/upgrade/LGV4```## Request Parameters| Name | Data Type | Format | Mandatory? | Additional Information ||-------------|-----------|------------------|------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------|| ABTANumber | String | [A-Z0-9] 5 chars | Y | This is also known as an 'agent code'. This will be confirmed to you by your Account Manager during set up. || Password | String | [A-Z0-9] 5 chars | Y* | Password required for retail agent requests - intermediaries do not require a password.This will be confirmed to you by your Account Manager during set up. || Initials | String | [A-Z] 3 chars | N | The initials of the Operator / Agent. || key | String | [A-Z] | Y | This will be assigned to you by your Account Manager during set up. || token | String | [0-9] 9 chars | Y | Please see [user token endpoint](/hxapi/usertoken) for details of how to generate a token. || ArrivalDate | String | YYYY-MM-DD | Y | This should be the same as the `ArrivalDate` from the base product request. || ArrivalTime | Time | HHMM | Y | This should be the same as the `ArrivalTime` from the base product request. || DepartDate | Date | YYYY-MM-DD | N | This should be the same as the `DepartDate` from the base product request. || DepartTime | Time | HHMM | N | This should be the same as the `DepartTime` from the base product request. || Adults | Integer | [0-9] | Y* | Mandatory for Lounge upgrade requests. Number of adults in the party || Children | Integer | [0-9] | Y* | Mandatory for Lounge upgrade requests. Number of children in the party |## Upgrade Availability ResponseThe response will return a list of available upgrades.Upgrades are sold on a per booking, per person, or per room basis.Upgrades can be for the day before travel, day of departure or day of return.| Field | Additional Information ||--------------------|---------------------------------------------------------------------------------------------|| Code | Product code for the upgrade || Name | Name of the upgrade || Per | Pricing basis, either per *P*erson, per *B*ooking, per *R*oom || Canx | Whether the upgrade is cancellable (Y/N) || description | || supplement_type | Type classification for the upgrade || Date | Date the upgrade is to be booked for. Format YYYY-MM-DD || only_for_adults | Upgrades restricted to adult only parties e.g. Adult only lounges || Price | The price of the upgrade minus any discounts. Only present for per booking upgrades || NonDiscPrice | The total price of the upgrade before discounts. Only present for per booking upgrades || DiscAmt | The amount of any discount applied. Only present for per booking upgrades || AdPrice | The per adult price minus any discounts. Only present for per person upgrades || NonDiscAdPrice | The per adult price before any discounts. Only present for per person upgrades || AdDiscAmt | The amount of discount applied to the per adult price. Only present for per person upgrades || ChPrice | The per child price minus any discounts. Only present for per person upgrades || NonDiscChPrice | The per child price before any discounts. Only present for per person upgrades || ChDiscAmt | The amount of discount applied to the child price. Only present for per person upgrades || API_Header/Request | The API returns every parameter and value you sent in the request. |## Examples### Example 1 - Carpark Upgrades#### Request{% codetabs %} {% codetab XML %} ```https://api.holidayextras.co.uk/v1/upgrade/STN5?ABTANumber=YourABTANumber&Password=YourPassword&key=YourKey&token=YourToken&ArrivalDate=2020-11-03&ArrivalTime=12:30&DepartDate=2020-11-11&DepartTime=13:45 ``` {% endcodetab %} {% codetab JSON %}```https://api.holidayextras.co.uk/v1/upgrade/STN5.js?ABTANumber=YourABTANumber&Password=YourPassword&key=YourKey&token=YourToken&ArrivalDate=2020-11-03&ArrivalTime=12:30&DepartDate=2020-11-11&DepartTime=13:45``` {% endcodetab %}{% endcodetabs %}#### Response{% codetabs %}{% codetab XML %}```xml{% include_relative examples/_example_1_response.xml %}```{% endcodetab %}{% codetab JSON %}```json{% include_relative examples/_example_1_response.json %}```{% endcodetab %}{% endcodetabs %}### Example 1 - Hotel Upgrades#### Request{% codetabs %}{% codetab XML %}```https://api.holidayextras.co.uk/v1/upgrade/LGWSOF?ABTANumber=YourABTANumber&Password=YourPassword&key=YourKey&token=YourToken&ArrivalDate=2020-11-03&ArrivalTime=12:30&DepartDate=2020-11-11&DepartTime=13:45```{% endcodetab %}{% codetab JSON %}```https://api.holidayextras.co.uk/v1/upgrade/LGWSOF.js?ABTANumber=YourABTANumber&Password=YourPassword&key=YourKey&token=YourToken&ArrivalDate=2020-11-03&ArrivalTime=12:30&DepartDate=2020-11-11&DepartTime=13:45```{% endcodetab %}{% endcodetabs %}#### Response{% codetabs %}{% codetab XML %}```xml{% include_relative examples/_example_2_response.xml %}```{% endcodetab %}{% codetab JSON %}```json{% include_relative examples/_example_2_response.json %}```{% endcodetab %}{% endcodetabs %}",
+ "url": "/hxapi/upgrade/"
}
,
- "hxapi-insurance": {
- "title": "Insurance",
- "content": "# Insurance[API Docs](/hxapi/) > product:[Insurance](index)## Insurance Endpoints | Request | Endpoint | Method | | ------- | -------- | ------ | | List all regions and / or countries | [https://api.holidayextras.co.uk/v1/insurancecountries](countries) | GET | | Request insurance schemes available | [https://api.holidayextras.co.uk/v1/insurancepolicy/RegionCode](availability) | GET | | Request options for insurance scheme | [https://api.holidayextras.co.uk/v1/insurancepolicy/SchemeCode](options) | GET | | Create insurance policy | [https://api.holidayextras.co.uk/v1/insurancepolicy/CertificateRef](createpolicy) | POST |## Insurance User JourneyBelow is a diagram detailing how the endpoints can be used to create an insurance user journey. More information on each endpoint can be found in the detailed guides listed above.",
- "url": "/hxapi/insurance/"
+ "hxapi-viewamendcancel": {
+ "title": "Manage A Booking",
+ "content": "# Manage A Booking[API Docs](/hxapi/) > product:[viewamendcancel](index)## Manage A Booking EndpointsHere are the endpoints for managing a booking:| View booking | [https://api.holidayextras.co.uk/v1/booking/YourBookingRef](view) | GET || Amend booking - Simple | [https://api.holidayextras.co.uk/v1/booking/YourBookingRef](amend_simple) | POST || Amend booking - Complex | [https://api.holidayextras.co.uk/v1/booking/YourBookingRef](amend_complex) | POST || Cancel booking | [https://api.holidayextras.co.uk/v1/booking/YourBookingRef](cancel) | POST |## Manage A Booking Top TipsThe three methods provided will enable your customers via your integration to manage their own booking online.### Amending a bookingWe allow both simple and complex amends:- A ***simple amend*** is where the booking details are updated, without affecting the price. This is also known as an \"amend no re-price\". For example, adding a car registration number to a parking booking.- A ***complex amend*** is where the booking details are updated and this does affect the price. This is also known as an \"amend re-price\". For example, changing the date of a booking.",
+ "url": "/hxapi/viewamendcancel/"
}
,
@@ -240,17 +240,10 @@
}
,
- "hxapi-fasttrack-av": {
- "title": "Availability At FastTrack",
- "content": "# Availability At FastTrack## FastTrack Availability Request### MethodGET### EndpointThe endpoint to use is:```https://api.holidayextras.co.uk/v1/fasttrack/AirportCode```For example, for fasttrack availability at Manchester the endpoint is:```https://api.holidayextras.co.uk/v1/fasttrack/MAN```To find the airport locations available for fasttrack, please refer to the [locations endpoint.](/hxapi/locations)### Request ParametersNB: All parameter names are case sensitive.| Name | Data Type | Format | Mandatory? | Additional Information ||-------------|-----------|------------------|------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|| ABTANumber | String | [A-Z0-9] 5 chars | Y | This is also known as an 'agent code'. This will be confirmed to you by your Account Manager during set up. || Password | String | [A-Z0-9] 5 chars | Y* | Password required for retail agent requests - intermediaries do not require a password.This will be confirmed to you by your Account Manager during set up. || Initials | String | [A-Z] 3 chars | N | The initials of the Operator / Agent. || key | String | [A-Z] | Y | This will be assigned to you by your Account Manager during set up. || token | String | [0-9] 9 chars | Y | Please see [user token endpoint](/hxapi/usertoken) for details of how to generate a token. || ArrivalDate | Date | YYYY-MM-DD | Y | Date customer enters the fasttrack. || ArrivalTime | Time | HHMM | Y | Time customer enters the fasttrack. || Adults | Integer | [0-4] 1 char | Y | Number of adults requiring entry to the fasttrack. || Children | Integer | [0-3] 1 char | N | Number of children requiring entry to the fasttrack. || OutFlight | String | [A-Z0-9] 9 chars | N | This is also known as an 'flight number'. Used to establish which terminal the customer is flying from using our look up tool and return products specific to that terminal. || Terminal | String | [A-Z1-9] 1 char | N | An optional field when requesting hotel and parking that will filter the availble results to those that serve the given terminal. Terminal options can be found using the [Terminal](/hxapi/terminal) request, where the name of the terminal is a word only the first character is needed for this request ( eg. N for the North terminal ). |## FastTrack Availability ResponseThe fasttrack availability response will return the specific product requested, so long as it has availability on the specific dates and times. A summary of the request received can be found in the header field at the end of the response.For a detailed explanation of the fields returned, please see below:| Field | Additional Information ||----------------------------|-------------------------------------------------------------------------------------------------------------|| FastTrack/Name | The name of the fasttrack. || FastTrack/Code | The product code for the fasttrack, which must be used in the booking request. || FastTrack/BookingURL | The URL to POST the booking request to for this particular product. || FastTrack/MoreInfoURL | The link to more information about this product, sourced from the Product Library. || FastTrack/Price | The price of product _without_ any surcharges/fees added. || FastTrack/NonDiscPrice | The non discounted price. Some agent codes apply a discount so we return this field to enable a comparison. || FastTrack/SalesCurrency | Three character identifier for the sale currency to qualify the price || FastTrack/Images/Src | Link to a image for the product. Prepend with `https:` || FastTrack/Description | Product description || FastTrack/Logo | Link to a logo for the product. Prepend with `https:` || FastTrack/ExtraInformation | Extended description of the product || IsRefundable | Whether the product can be refunded || AirportLocation | The location code for the product airport || Terminal | The airport terminal of the product |## Worked ExamplesBelow are worked examples of both the request and response for availability at an airport.### UK Products Availability Request```https://api.holidayextras.co.uk/v1/fasttrack/MAN/?ABTANumber=YourABTANumber&Password=YourPassword&Initials=YourInitials&key=YourKey&token=YourToken&ArrivalDate=2019-10-22&ArrivalTime=1200&Adults=2&Children=0```### UK Products Availability Response ```xml FastTrack Terminal 1 APMANSF1 /v1/fastTrack/APMANSF1 /v1/product/MANSF1 10.00 GBP //d1xcii4rs5n6co.cloudfront.net/libraryimages/85558-manchester-airport-security-fasttrack-T1.png Short on time? Take the fast track through security and you’ll fly through. //d1xcii4rs5n6co.cloudfront.net/libraryimages/81386-MAN-fasttrack-core.png What is it? The Security FastTrack pass gives you access to the priority lane at the airport’s security checks. You’ll whizz past the standard queue, giving you more time to relax in departures before your flight. Once you book we’ll email you the passes, so make sure you print them and take them with you, or have them ready on your mobile phone. There’ll be a voucher each with a barcode, which you’ll need to scan at the entrance before you go through. When can I use it? Available 2.30am - 11pm. Is it the same price for children? Yes, the pass is £5 per person. The small print: You won't need this service if you have mobility issues or small children with pushchairs as there's already a dedicated lane. Jet 2 passengers who have purchased FastTrack tickets must use the security lanes located on Departure level 5, in Terminal 1. Security FastTrack tickets can only be used once for the date you have booked. If you have booked more than one ticket the vouchers will all be in the lead passenger’s name. All FastTrack's terms and conditions will apply to you, so please read them here. 0 0 0 0 1000 0 0 0 0 1000 MAN Manchester airport 1 1 2 2 3 3 1 //d1xcii4rs5n6co.cloudfront.net/libraryimages/fasttrack.jpg With this special, VIP pass through security, you could be the first through the gate. We'll give you one voucher for all passengers, so make sure you hold the square, patterned barcode on your own voucher under the special camera at the entrance before you go through. You’ll then need to do the same with your boarding pass. You can only use the Fast Track once, on the day you’ve booked. Even though Fast Track customers get their own lane through security, all the normal airport security rules will still apply. Since the airport already has its own special lanes for customers with mobility issues or those with small children, they won't need to use this service. Jet 2 customers who have purchased Fast Track tickets must use the security lanes located on Departure level 5 in Terminal 1. Please ensure you have read the Airport's Terms and Conditions. Manchester 1 10.00 1 FastTrack Terminal 2 APMANSF2 /v1/fastTrack/APMANSF2 /v1/product/MANSF2 10.00 GBP //d1xcii4rs5n6co.cloudfront.net/libraryimages/85558-manchester-airport-security-fasttrack-T2.png Short on time? Take the fast track through security and you’ll fly through. //d1xcii4rs5n6co.cloudfront.net/libraryimages/81386-MAN-fasttrack-core.png <h2> What is it?</h2> <p>The Security FastTrack pass gives you access to the priority lane at the airport’s security checks. You’ll whizz past the standard queue, giving you more time to relax in departures before your flight. </p> <p> Once you book we’ll email you the passes, so make sure you print them and take them with you. There’ll be a voucher each with a barcode, which you’ll need to scan at the entrance before you go through. </p> <h2>When can I use it?</h2> <p>Available 2.30am - 11pm.</p> <h2> Is it the same price for children?</h2> <p>Yes, the pass is £5 per person.</p> <h2>The small print:</h2> <p>You won't need this service if you have mobility issues or small children with pushchairs as there's already a dedicated lane.</p><p>Security FastTrack tickets can only be used once for the date you have booked.</p> <p> If you have booked more than one ticket the vouchers will all be in the lead passenger’s name.</p> <p>All FastTrack's terms and conditions will apply to you, so please read them <a href=\"http://www.manchesterairport.co.uk/terms-and-conditions/fasttrack/\" target=\"_blank\">here.</a></p> 0 0 0 0 1000 0 0 0 0 1000 MAN Manchester airport 1 1 2 2 3 3 1 //d1xcii4rs5n6co.cloudfront.net/libraryimages/fasttrack.jpg With this special, VIP pass through security, you could be the first through the gate. We'll give you one voucher for all passengers, so make sure you hold the square, patterned barcode on your own voucher under the special camera at the entrance before you go through. You’ll then need to do the same with your boarding pass. You can only use the Fast Track once, on the day you’ve booked. Even though Fast Track customers get their own lane through security, all the normal airport security rules will still apply. Since the airport already has its own special lanes for customers with mobility issues or those with small children, they won't need to use this service. Jet 2 customers who have purchased Fast Track tickets must use the security lanes located on Departure level 5 in Terminal 1. Please ensure you have read the Airport's Terms and Conditions. Manchester 2 10.00 1 FastTrack Terminal 3 APMANSF3 /v1/fastTrack/APMANSF3 /v1/product/MANSF3 10.00 GBP //d1xcii4rs5n6co.cloudfront.net/libraryimages/85558-manchester-airport-security-fasttrack-T3.png Short on time? Take the fast track through security and you’ll fly through. //d1xcii4rs5n6co.cloudfront.net/libraryimages/81386-MAN-fasttrack-core.png <h2> What is it?</h2> <p>The Security FastTrack pass gives you access to the priority lane at the airport’s security checks. You’ll whizz past the standard queue, giving you more time to relax in departures before your flight. </p> <p> Once you book we’ll email you the passes, so make sure you print them and take them with you. There’ll be a voucher each with a barcode, which you’ll need to scan at the entrance before you go through. </p> <h2>When can I use it?</h2> <p>Available 2.30am - 11pm.</p> <h2> Is it the same price for children?</h2> <p>Yes, the pass is £5 per person.</p> <h2>The small print:</h2> <p>You won't need this service if you have mobility issues or small children with pushchairs as there's already a dedicated lane.</p> <p>Security FastTrack tickets can only be used once for the date you have booked.</p> <p> If you have booked more than one ticket the vouchers will all be in the lead passenger’s name.</p> <p>All FastTrack's terms and conditions will apply to you, so please read them <a href=\"http://www.manchesterairport.co.uk/terms-and-conditions/fasttrack/\" target=\"_blank\">here.</a></p> 0 0 0 0 1000 0 0 0 0 1000 MAN Manchester airport 1 1 2 2 3 3 1 //d1xcii4rs5n6co.cloudfront.net/libraryimages/fasttrack.jpg With this special, VIP pass through security, you could be the first through the gate. We'll give you one voucher for all passengers, so make sure you hold the square, patterned barcode on your own voucher under the special camera at the entrance before you go through. You’ll then need to do the same with your boarding pass. You can only use the Fast Track once, on the day you’ve booked. Even though Fast Track customers get their own lane through security, all the normal airport security rules will still apply. Since the airport already has its own special lanes for customers with mobility issues or those with small children, they won't need to use this service. Jet 2 customers who have purchased Fast Track tickets must use the security lanes located on Departure level 5 in Terminal 1. Please ensure you have read the Airport's Terms and Conditions. Manchester 3 10.00 1 0.00 0.00 0.00 0.00 0.00 0.00 TESTX Redacted partnerapitest generate 2019-10-22 1200 0 2 1 ```",
- "url": "/hxapi/fasttrack/av/"
- }
- ,
-
- "hxapi-fasttrack": {
- "title": "FastTrack",
- "content": "# FastTrackHere are the fasttrack specific endpoints:| Request | Endpoint | Method || --- | --- | --- || Availability of fasttrack at airport | [https://api.holidayextras.co.uk/v1/fasttrack/AirportCode](av) | GET || Make booking for fasttrack | [https://api.holidayextras.co.uk/v1/fastTrack/FastTrackCode](bkg) | POST |",
- "url": "/hxapi/fasttrack/"
+ "hxapi-productlibrary": {
+ "title": "Product Library",
+ "content": "# Product LibraryThe data returned from a Product Library request depends on the type of product you ask for. A request for a car park returns different fields than a request for a hotel.By default, only fields that contain a value are returned.You can specify the fields you want returned. Simply add the parameter fields and specify the field names. An error/warning element will be returned for any fields which do not exist, but the request will still return those elements for which there is a value. If you request a valid field, but there is no value, it will not be returned.The purpose of most of the fields should be self-explanatory. If there is anything you do not understand, please email . There are no guarantees about the types of data returned, you should make no assumptions about a specific field being an integer etc.Data returned should not be cached locally for periods of time greater than one day (24 hours).### URL/product/{productCode}### MethodGET### Parameters| Name | Format | Required ||--------|--------|----------|| token | String | N || key | String | Y || fields | String | N |## Available FieldsThe available fields vary by product type. For each product type there is a recommended list of fields which should be requested to get the information required to effectively sell the product.{% codetabs %}{% codetab Parking %}{% include_relative _parkingFields.md %}{% endcodetab %}{% codetab Hotel room only %}{% include_relative _hotelOnlyFields.md %}{% endcodetab %}{% codetab Hotel with parking %}{% include_relative _hotelParkingFields.md %}{% endcodetab %}{% codetab Lounge %}{% include_relative _loungeFields.md %}{% endcodetab %}{% codetab Fast track %}{% include_relative _fastTrackFields.md %}{% endcodetab %}{% endcodetabs %}---## Examples### Example 1 - Default Response#### Request{% codetabs %}{% codetab Live (XML) %}```https://api.holidayextras.co.uk/v1/product/LGW4/lite?token=000015778&key=mytestkey```{% endcodetab %}{% codetab Live (JSON) %}```https://api.holidayextras.co.uk/v1/product/LGW4/lite.js?token=000015778&key=mytestkey```Note the `.js` extension.{% endcodetab %}{% codetab Sandbox (XML) %}```https://api.holidayextras.co.uk/sandbox/v1/product/LGW4/lite?token=000015778&key=mytestkey```{% endcodetab %}{% codetab Sandbox (JSON) %}```https://api.holidayextras.co.uk/sandbox/v1/product/LGW4/lite.js?token=000015778&key=mytestkey```Note the `.js` extension.{% endcodetab %}{% endcodetabs %}#### Response{% codetabs %}{% codetab XML %}```xml{% include_relative _examples/parking_reply_1.xml %}```{% endcodetab %}{% codetab JSON %}```json{% include_relative _examples/parking_reply_1.json %}```{% endcodetab %}{% endcodetabs %}---### Example 2 - Restricted field list#### Request{% codetabs %}{% codetab Live (XML) %}```https://api.holidayextras.co.uk/v1/product/LGW4/lite?token=000015778&key=mytestkey&fields=name,longitude,latitude```{% endcodetab %}{% codetab Live (JSON) %}```https://api.holidayextras.co.uk/v1/product/LGW4/lite.js?token=000015778&key=mytestkey&fields=name,longitude,latitude```Note the `.js` extension.{% endcodetab %}{% codetab Sandbox (XML) %}```https://api.holidayextras.co.uk/sandbox/v1/product/LGW4/lite?token=000015778&key=mytestkey&fields=name,longitude,latitude```{% endcodetab %}{% codetab Sandbox (JSON) %}```https://api.holidayextras.co.uk/sandbox/v1/product/LGW4/lite.js?token=000015778&key=mytestkey&fields=name,longitude,latitude```Note the `.js` extension.{% endcodetab %}{% endcodetabs %}#### Response{% codetabs %}{% codetab XML %}```xml{% include_relative _examples/parking_reply_2.xml %}```{% endcodetab %}{% codetab JSON %}```json{% include_relative _examples/parking_reply_2.json %}```{% endcodetab %}{% endcodetabs %}---### Example 3 - German Parking Request#### RequestRequests for German products return a different set of fields. Explanation of fields not currently available.{% codetabs %}{% codetab Live (XML) %}```https://api.holidayextras.co.uk/v1/product/FRA0?key=mytestkey```{% endcodetab %}{% codetab Live (JSON) %}```https://api.holidayextras.co.uk/v1/product/FRA0.js?key=mytestkey```Note the `.js` extension.{% endcodetab %}{% codetab Sandbox (XML) %}```https://api.holidayextras.co.uk/sandbox/v1/product/FRA0?key=mytestkey```{% endcodetab %}{% codetab Sandbox (JSON) %}```https://api.holidayextras.co.uk/sandbox/v1/product/FRA0.js?key=mytestkey```Note the `.js` extension.{% endcodetab %}{% endcodetabs %}#### Response{% codetabs %}{% codetab XML %}```xml{% include_relative _examples/parking_reply_3.xml %}```{% endcodetab %}{% codetab JSON %}```json{% include_relative _examples/parking_reply_3.json %}```{% endcodetab %}{% endcodetabs %}",
+ "url": "/hxapi/productlibrary/"
}
,
@@ -261,24 +254,10 @@
}
,
- "hxapi-hotel-av": {
- "title": "Hotel Availability Request",
- "content": "## Hotel Availability Request### MethodGET### EndpointThe endpoint to use is:```https://api.holidayextras.co.uk/v1/hotel/LocationCode```For example, for London Heathrow the endpoint is:```https://api.holidayextras.co.uk/v1/hotel/LHR```If you know the specific hotel code, then you can request availability by entering that into the endpoint. For example, for the Hilton at London Heathrow the endpoint is:```https://api.holidayextras.co.uk/v1/hotel/LHRHIL```To find the airport locations available for hotels, please refer to the [locations endpoint.](/hxapi/locations)### Request ParametersNB: All parameter names are case sensitive.| Name | Data Type | Format | Mandatory? | Additional Information ||----------------|-----------|-----------------------------------------|------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|| ABTANumber | String | [A-Z0-9] 5 chars | Y | This is also known as an 'agent code'. This will be confirmed to you by your Account Manager during set up. || Password | String | [A-Z0-9] 5 chars | Y* | Password required for retail agent requests - intermediaries do not require a password.This will be confirmed to you by your Account Manager during set up. || Initials | String | [A-Z] 3 chars | N | The initials of the Operator / Agent. || key | String | [A-Z] | Y | This will be assigned to you by your Account Manager during set up. || token | String | [0-9] 9 chars | Y | Please see [user token endpoint](/hxapi/usertoken) for details of how to generate a token. || ArrivalDate | Date | YYYY-MM-DD | Y | Date customer arrives at hotel. || Nights | Integer | 1 | Y | Number of nights the customer wants to stay in the hotel. NB: It is only possible to book one night stays. || RoomType | String | [A-Z0-9] 3 chars | Y | See [RoomCodes](/hxapi/types/roomcode) for a list of valid codes. || SecondRoomType | String | [A-Z0-9] 3 chars | N* | NB: This feature is only available in the UK. This parameter is mandatory if the customer wishes to book two rooms at the same time. (Max 2 rooms) The room codes are as per RoomType. || ParkingDays | Integer | [0-9] 2 chars | Y | NB: The maximum duration accepted for ParkingDays is 30. || System | String | [A-Z] 3 chars | Y* | For European products, you need to pass in the value of `System=ABG` (the default is `System=ABC`, which is UK products only). || lang | String | [A-Z] 2 chars | Y* | Required for requests for European products. (Values available are `en`, `de`, `it`, `es`, `pt` and `nl`.) || Terminal | String | [A-Z1-9] 1 char | N | An optional field when requesting hotel and parking that will filter the availble results to those that serve the given terminal. Terminal options can be found using the [Terminal](/hxapi/terminal) request, where the name of the terminal is a word only the first character is needed for this request ( eg. N for the North terminal ). || fields | String | [A-Z] a csv list of product info fields | N | A list of product info fields can be passed in to return configurable product information e.g. `fields=name,address,latitude,sellingpoint`. |## Hotel Availability ResponseFor a detailed explanation of the fields returned, please see below:| Field | Additional Information ||------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|| Hotel/Name | The name of the product || Hotel/Code | The product code || Hotel/BookingURL | The URL to POST the booking request to for this particular product. || Hotel/MoreInfoURL | The link to more information about this product, sourced from the Product Library. || Hotel/RequestFlags | These flags list which details the car park operator requires from the customer. If a flag is returned with a ‘Y’ your application should send the corresponding field/value in the booking request. Flags are only returned when required. The flags which can be returned are: `Registration`, `CarMake`, `CarModel`, `CarColour`, `OutFlight`, `ReturnFlight`, `OutTerminal`, `ReturnTerminal`, `Destination`, `MobileNum` || Hotel/Price | The price of product without any surcharges/fees added. || Hotel/PriceWithSurcharge | *NB: Please ignore this field - we no longer accept new agents sending payment details via our API.* || Hotel/Adults* | The maximum number of adults included in the room occupancy. || Hotel/Children* | The maximum number of children included in the room occupancy. || Hotel/RoomCode | *NB: Please ignore this field as it relates to internal systems.* || Hotel/BoardBasis | *NB: Please ignore this field as it is no longer used and will be deprecated in future versions of the API.* || Hotel/ParkingDays | This returns the number of days parking available. NB: This may differ from the value requested, due to parking packages usually being set up in the system as either 4, 8 or 15 days. || Hotel/NonDiscPrice | The non discounted price. Some agent codes apply a discount so we return this field to enable a comparison. || Hotel/CancellationFeeExceptions | If the hotel has non-standard cancellation fees. || Hotel/AmendmentFeeExceptions | If the hotel has non-standard amendment fees. || Hotel/noncancellable_nonrefundable | Is this hotel noncancellable or non-refundable? || Hotel/parking_includes_arrival | If parking during the customer's hotel stay included in their parking package || Hotel/CarPark | If your request included car parking, this is the car park code. || Hotel/Filter | *NB: Please ignore this field as it is for internal use only.* || Hotel/lead_time_cancellation | This is the number of days before the booking starts that the product will switch from flexible to non-flexible. || API_Header/Request | The API returns every parameter and value you sent in the previous request. | \\* Where two rooms have been requested, these fields represent the total of adults and children across all rooms. Additional fields will show the individual room occupancy: `FirstRoomAdults`, `FirstRoomChildren`, `SecondRoomAdults` and `SecondRoomChildren`.## Key Information on HotelsPlease read this section through carefully, as it contains useful information about restrictions on how hotels must be sold.### Advance purchaseAdvance purchase products are non-refundable and non-cancellable. As a result, Cancellation Waiver must *not* be sold to customers purchasing a product with `advance_purchase` set to 1.### Day Use OnlyThere is a field in the product library for hotels, named `day_use_only`. Day use products must not be sold to customers wishing to have an overnight stay where `day_use_only` is set to 1.### Parking Includes ArrivalIn order to establish whether the package includes parking for the night of the hotel stay the `parking_includes_arrival` field needs to be taken into account.Where this field is set to 0, this means the night of the hotel stay is not included as there is free overnight parking. Parking stay will start from the following day. Where it is set to 1, this means that parking starts from the date the customer checks into the hotel.### Mystery / Un-named ProductsThere are some hotels in which the name field will not provide the name of the hotel e.g `Mystery 4-star hotel`. The name of these hotels should not be provided to the customer until the booking is made, along with other identifying details such as address, hotel images, restaurant names etc.### Lead time cancellationFlexible bookings become non flexible within a certain timeframe before the stay date ie booking turns non flexible within 30 days of stay.Scenario 1* Flexible booking made outside 60 days of stay.* Cancellation policy - only able to canx up to 30 days before stay date.* Booking is non flex within 30 days of stay date.Scenario 2* Flexible booking made inside 60 days of stay date.* Cancellation policy - only able to canx up to 3 days before stay date.* Booking is non flex within 3 days of stay date.## Worked ExamplesBelow are worked examples of both the requests and responses for hotel availability.### UK Hotel Availability Request - Room Only (zero days parking)```https://api.holidayextras.co.uk/v1/hotel/LHR?ABTANumber=YourABTANumber&Password=YourPassword&key=YourKey&token=YourToken&ArrivalDate=2017-12-01&Nights=1&RoomType=T21&ParkingDays=0```### UK Hotel Availability Response - Room Only (zero days parking)NB: This is a shortened example compiled from a full availability response.```xml Mercure LHRMEA /v1/hotel/HPLHRMEA /v1/product/LHRMEA 1 45.00 45.90 2 1 TRL RO 0 45.00 30 1 1 1 Thistle T5 LHRPAA /v1/hotel/HPLHRPAA /v1/product/LHRPAA 85.50 87.21 2 1 TRL RO 0 85.50 30 1 0 1 Hilton T5 LHRHLT /v1/hotel/HPLHRHLT /v1/product/LHRHLT 1 1 1 99.00 100.98 2 1 TRL RO 0 99.00 2.00 0.00 4.00 0.00 0.00 0.00 2.99 YourABTANumber YourPassword YourKey YourToken 2017-12-01 1 T21 0 1 ```### UK Hotel Availability Request - Room with Parking```https://api.holidayextras.co.uk/v1/hotel/LHR?ABTANumber=YourABTANumber&Password=YourPassword&key=YourKey&token=YourToken&ArrivalDate=2017-12-01&Nights=1&RoomType=T21&ParkingDays=8```### UK Hotel Availability Response - Room with ParkingNB: This is a shortened example compiled from a full availability response.```xml Mercure with Purple Parking Meet and Greet LHRMPU /v1/hotel/HPLHRMPU /v1/product/LHRMPU 1 1 1 1 1 1 1 129.00 131.58 2 1 TRL RO 8 129.00 LHR5 LHR5 1 Thistle T5 with parking at the hotel and breakfast LHRPAT /v1/hotel/HPLHRPAT /v1/product/LHRPAT 130.00 132.60 2 1 TRL RO 8 130.00 1 1 0 Sheraton Skyline with parking at the hotel LHRSKA /v1/hotel/HPLHRSKA /v1/product/LHRSKA 134.00 136.68 2 1 TRL RO 8 134.00 0 2.00 0.00 4.00 0.00 0.00 0.00 2.99 YourABTANumber YourPassword YourKey YourToken 2017-12-01 1 T21 8 1 ```### European Hotel Availability Request - Room with Parking```https://api.holidayextras.co.uk/v1/hotel/MUC?ABTANumber=YourABTANumber&Password=YourPassword&key=YourKey&token=YourToken&ArrivalDate=2017-12-01&Nights=1&RoomType=D20&ParkingDays=8&System=ABG&lang=de```### European Hotel Availability Response - Room with ParkingNB: This is a shortened example compiled from a full availability response.```xml Schweigers Landgasthof MUCLAN /v1/hotel/FRMUCLAN /v1/product/MUCLAN 120.00 NaN 2 0 DZ F 15 120.00 Airporthotel Regent MUCREG /v1/hotel/FRMUCREG /v1/product/MUCREG 97.00 NaN 2 0 DZ F 15 97.00 NH München Airport MUCAST /v1/hotel/FRMUCAST /v1/product/MUCAST 113.00 NaN 2 0 DZ U 8 113.00 0.00 0.00 0.00 TESTG Redacted mytestkey generate 2017-12-01 1 D20 8 ABG de 1 ```",
- "url": "/hxapi/hotel/av/"
- }
- ,
-
- "hxapi-hotel": {
- "title": "Hotels",
- "content": "# Hotels[API Docs](/hxapi/) > product:[Hotels](index)## Hotel EndpointsHere are the hotel specific endpoints: | Action | Endpoint | Method | | ------ | -------- | ------ | | Availability at hotel | [https://api.holidayextras.co.uk/v1/hotel/LocationCode](av) | GET | | Make booking at hotel | [https://api.holidayextras.co.uk/v1/hotel/LocationCode](bkg) | POST |Please note: All hotel requests include parking options of zero, 8 and 15 days parking. To make a request for a hotel only product, please select zero days parking.## Hotel User JourneyTo follow -",
- "url": "/hxapi/hotel/"
- }
- ,
-
- "hxapi-viewamendcancel": {
- "title": "Manage A Booking",
- "content": "# Manage A Booking[API Docs](/hxapi/) > product:[viewamendcancel](index)## Manage A Booking EndpointsHere are the endpoints for managing a booking:| View booking | [https://api.holidayextras.co.uk/v1/booking/YourBookingRef](view) | GET || Amend booking - Simple | [https://api.holidayextras.co.uk/v1/booking/YourBookingRef](amend_simple) | POST || Amend booking - Complex | [https://api.holidayextras.co.uk/v1/booking/YourBookingRef](amend_complex) | POST || Cancel booking | [https://api.holidayextras.co.uk/v1/booking/YourBookingRef](cancel) | POST |## Manage A Booking Top TipsThe three methods provided will enable your customers via your integration to manage their own booking online.### Amending a bookingWe allow both simple and complex amends:- A ***simple amend*** is where the booking details are updated, without affecting the price. This is also known as an \"amend no re-price\". For example, adding a car registration number to a parking booking.- A ***complex amend*** is where the booking details are updated and this does affect the price. This is also known as an \"amend re-price\". For example, changing the date of a booking.",
- "url": "/hxapi/viewamendcancel/"
+ "hxapi-insurance": {
+ "title": "Insurance",
+ "content": "# Insurance[API Docs](/hxapi/) > product:[Insurance](index)## Insurance Endpoints | Request | Endpoint | Method | | ------- | -------- | ------ | | List all regions and / or countries | [https://api.holidayextras.co.uk/v1/insurancecountries](countries) | GET | | Request insurance schemes available | [https://api.holidayextras.co.uk/v1/insurancepolicy/RegionCode](availability) | GET | | Request options for insurance scheme | [https://api.holidayextras.co.uk/v1/insurancepolicy/SchemeCode](options) | GET | | Create insurance policy | [https://api.holidayextras.co.uk/v1/insurancepolicy/CertificateRef](createpolicy) | POST |## Insurance User JourneyBelow is a diagram detailing how the endpoints can be used to create an insurance user journey. More information on each endpoint can be found in the detailed guides listed above.",
+ "url": "/hxapi/insurance/"
}
,
@@ -296,6 +275,13 @@
}
,
+ "hxapi-carhire": {
+ "title": "Car Hire",
+ "content": "# Car Hire[API Docs](/hxapi/) > product:[Car Hire](index)These are the car hire requests.| Action | Endpoint | Method || --- | --- | --- || Lookup Locations | [https://api.holidayextras.co.uk/v1/carHire/locations](locations) | GET || Availability | [https://api.holidayextras.co.uk/v1/carHire/products](availability) | GET || Make Booking | [https://api.holidayextras.co.uk/v1/carHire/](booking/make) | POST || Lookup Booking | [https://api.holidayextras.co.uk/v1/carHire-booking/](booking/lookup) | GET |",
+ "url": "/hxapi/carhire/"
+ }
+ ,
+
"hxapi-lounge": {
"title": "Lounge",
"content": "# LoungeHere are the lounge specific endpoints:| Request | Endpoint | Method || --- | --- | --- || Availability of lounges at airport | [https://api.holidayextras.co.uk/v1/lounge/AirportCode](av/airport) | GET || Make booking for lounge | [https://api.holidayextras.co.uk/v1/lounge/LoungeCode](bkg) | POST |",
@@ -303,17 +289,31 @@
}
,
- "hxapi-upgrade": {
- "title": "Product Upgrades",
- "content": "# Product Upgrades[API Docs](/hxapi/) > [Product Upgrades](/hxapi/upgrade)## Upgrades Availability RequestUpgrades are currently only supported for parking, hotel and lounge bookings. Upgrades can be requested on a per product basis.#### MethodGET#### Endpoint/upgrade/{productCode}NB: Where `productCode` is the code of the base product i.e. the parking/hotel/lounge etc. product.```https://api.holidayextras.co.uk/v1/upgrade/LGV4```## Request Parameters| Name | Data Type | Format | Mandatory? | Additional Information ||-------------|-----------|------------------|------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------|| ABTANumber | String | [A-Z0-9] 5 chars | Y | This is also known as an 'agent code'. This will be confirmed to you by your Account Manager during set up. || Password | String | [A-Z0-9] 5 chars | Y* | Password required for retail agent requests - intermediaries do not require a password.This will be confirmed to you by your Account Manager during set up. || Initials | String | [A-Z] 3 chars | N | The initials of the Operator / Agent. || key | String | [A-Z] | Y | This will be assigned to you by your Account Manager during set up. || token | String | [0-9] 9 chars | Y | Please see [user token endpoint](/hxapi/usertoken) for details of how to generate a token. || ArrivalDate | String | YYYY-MM-DD | Y | This should be the same as the `ArrivalDate` from the base product request. || ArrivalTime | Time | HHMM | Y | This should be the same as the `ArrivalTime` from the base product request. || DepartDate | Date | YYYY-MM-DD | N | This should be the same as the `DepartDate` from the base product request. || DepartTime | Time | HHMM | N | This should be the same as the `DepartTime` from the base product request. || Adults | Integer | [0-9] | Y* | Mandatory for Lounge upgrade requests. Number of adults in the party || Children | Integer | [0-9] | Y* | Mandatory for Lounge upgrade requests. Number of children in the party |## Upgrade Availability ResponseThe response will return a list of available upgrades.Upgrades are sold on a per booking, per person, or per room basis.Upgrades can be for the day before travel, day of departure or day of return.| Field | Additional Information ||--------------------|---------------------------------------------------------------------------------------------|| Code | Product code for the upgrade || Name | Name of the upgrade || Per | Pricing basis, either per *P*erson, per *B*ooking, per *R*oom || Canx | Whether the upgrade is cancellable (Y/N) || description | || supplement_type | Type classification for the upgrade || Date | Date the upgrade is to be booked for. Format YYYY-MM-DD || only_for_adults | Upgrades restricted to adult only parties e.g. Adult only lounges || Price | The price of the upgrade minus any discounts. Only present for per booking upgrades || NonDiscPrice | The total price of the upgrade before discounts. Only present for per booking upgrades || DiscAmt | The amount of any discount applied. Only present for per booking upgrades || AdPrice | The per adult price minus any discounts. Only present for per person upgrades || NonDiscAdPrice | The per adult price before any discounts. Only present for per person upgrades || AdDiscAmt | The amount of discount applied to the per adult price. Only present for per person upgrades || ChPrice | The per child price minus any discounts. Only present for per person upgrades || NonDiscChPrice | The per child price before any discounts. Only present for per person upgrades || ChDiscAmt | The amount of discount applied to the child price. Only present for per person upgrades || API_Header/Request | The API returns every parameter and value you sent in the request. |## Examples### Example 1 - Carpark Upgrades#### Request{% codetabs %} {% codetab XML %} ```https://api.holidayextras.co.uk/v1/upgrade/STN5?ABTANumber=YourABTANumber&Password=YourPassword&key=YourKey&token=YourToken&ArrivalDate=2020-11-03&ArrivalTime=12:30&DepartDate=2020-11-11&DepartTime=13:45 ``` {% endcodetab %} {% codetab JSON %}```https://api.holidayextras.co.uk/v1/upgrade/STN5.js?ABTANumber=YourABTANumber&Password=YourPassword&key=YourKey&token=YourToken&ArrivalDate=2020-11-03&ArrivalTime=12:30&DepartDate=2020-11-11&DepartTime=13:45``` {% endcodetab %}{% endcodetabs %}#### Response{% codetabs %}{% codetab XML %}```xml{% include_relative examples/_example_1_response.xml %}```{% endcodetab %}{% codetab JSON %}```json{% include_relative examples/_example_1_response.json %}```{% endcodetab %}{% endcodetabs %}### Example 1 - Hotel Upgrades#### Request{% codetabs %}{% codetab XML %}```https://api.holidayextras.co.uk/v1/upgrade/LGWSOF?ABTANumber=YourABTANumber&Password=YourPassword&key=YourKey&token=YourToken&ArrivalDate=2020-11-03&ArrivalTime=12:30&DepartDate=2020-11-11&DepartTime=13:45```{% endcodetab %}{% codetab JSON %}```https://api.holidayextras.co.uk/v1/upgrade/LGWSOF.js?ABTANumber=YourABTANumber&Password=YourPassword&key=YourKey&token=YourToken&ArrivalDate=2020-11-03&ArrivalTime=12:30&DepartDate=2020-11-11&DepartTime=13:45```{% endcodetab %}{% endcodetabs %}#### Response{% codetabs %}{% codetab XML %}```xml{% include_relative examples/_example_2_response.xml %}```{% endcodetab %}{% codetab JSON %}```json{% include_relative examples/_example_2_response.json %}```{% endcodetab %}{% endcodetabs %}",
- "url": "/hxapi/upgrade/"
+ "hxapi-fasttrack-av": {
+ "title": "Availability At FastTrack",
+ "content": "# Availability At FastTrack## FastTrack Availability Request### MethodGET### EndpointThe endpoint to use is:```https://api.holidayextras.co.uk/v1/fasttrack/AirportCode```For example, for fasttrack availability at Manchester the endpoint is:```https://api.holidayextras.co.uk/v1/fasttrack/MAN```To find the airport locations available for fasttrack, please refer to the [locations endpoint.](/hxapi/locations)### Request ParametersNB: All parameter names are case sensitive.| Name | Data Type | Format | Mandatory? | Additional Information ||-------------|-----------|------------------|------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|| ABTANumber | String | [A-Z0-9] 5 chars | Y | This is also known as an 'agent code'. This will be confirmed to you by your Account Manager during set up. || Password | String | [A-Z0-9] 5 chars | Y* | Password required for retail agent requests - intermediaries do not require a password.This will be confirmed to you by your Account Manager during set up. || Initials | String | [A-Z] 3 chars | N | The initials of the Operator / Agent. || key | String | [A-Z] | Y | This will be assigned to you by your Account Manager during set up. || token | String | [0-9] 9 chars | Y | Please see [user token endpoint](/hxapi/usertoken) for details of how to generate a token. || ArrivalDate | Date | YYYY-MM-DD | Y | Date customer enters the fasttrack. || ArrivalTime | Time | HHMM | Y | Time customer enters the fasttrack. || Adults | Integer | [0-4] 1 char | Y | Number of adults requiring entry to the fasttrack. || Children | Integer | [0-3] 1 char | N | Number of children requiring entry to the fasttrack. || OutFlight | String | [A-Z0-9] 9 chars | N | This is also known as an 'flight number'. Used to establish which terminal the customer is flying from using our look up tool and return products specific to that terminal. || Terminal | String | [A-Z1-9] 1 char | N | An optional field when requesting hotel and parking that will filter the availble results to those that serve the given terminal. Terminal options can be found using the [Terminal](/hxapi/terminal) request, where the name of the terminal is a word only the first character is needed for this request ( eg. N for the North terminal ). |## FastTrack Availability ResponseThe fasttrack availability response will return the specific product requested, so long as it has availability on the specific dates and times. A summary of the request received can be found in the header field at the end of the response.For a detailed explanation of the fields returned, please see below:| Field | Additional Information ||----------------------------|-------------------------------------------------------------------------------------------------------------|| FastTrack/Name | The name of the fasttrack. || FastTrack/Code | The product code for the fasttrack, which must be used in the booking request. || FastTrack/BookingURL | The URL to POST the booking request to for this particular product. || FastTrack/MoreInfoURL | The link to more information about this product, sourced from the Product Library. || FastTrack/Price | The price of product _without_ any surcharges/fees added. || FastTrack/NonDiscPrice | The non discounted price. Some agent codes apply a discount so we return this field to enable a comparison. || FastTrack/SalesCurrency | Three character identifier for the sale currency to qualify the price || FastTrack/Images/Src | Link to a image for the product. Prepend with `https:` || FastTrack/Description | Product description || FastTrack/Logo | Link to a logo for the product. Prepend with `https:` || FastTrack/ExtraInformation | Extended description of the product || IsRefundable | Whether the product can be refunded || AirportLocation | The location code for the product airport || Terminal | The airport terminal of the product |## Worked ExamplesBelow are worked examples of both the request and response for availability at an airport.### UK Products Availability Request```https://api.holidayextras.co.uk/v1/fasttrack/MAN/?ABTANumber=YourABTANumber&Password=YourPassword&Initials=YourInitials&key=YourKey&token=YourToken&ArrivalDate=2019-10-22&ArrivalTime=1200&Adults=2&Children=0```### UK Products Availability Response ```xml FastTrack Terminal 1 APMANSF1 /v1/fastTrack/APMANSF1 /v1/product/MANSF1 10.00 GBP //d1xcii4rs5n6co.cloudfront.net/libraryimages/85558-manchester-airport-security-fasttrack-T1.png Short on time? Take the fast track through security and you’ll fly through. //d1xcii4rs5n6co.cloudfront.net/libraryimages/81386-MAN-fasttrack-core.png What is it? The Security FastTrack pass gives you access to the priority lane at the airport’s security checks. You’ll whizz past the standard queue, giving you more time to relax in departures before your flight. Once you book we’ll email you the passes, so make sure you print them and take them with you, or have them ready on your mobile phone. There’ll be a voucher each with a barcode, which you’ll need to scan at the entrance before you go through. When can I use it? Available 2.30am - 11pm. Is it the same price for children? Yes, the pass is £5 per person. The small print: You won't need this service if you have mobility issues or small children with pushchairs as there's already a dedicated lane. Jet 2 passengers who have purchased FastTrack tickets must use the security lanes located on Departure level 5, in Terminal 1. Security FastTrack tickets can only be used once for the date you have booked. If you have booked more than one ticket the vouchers will all be in the lead passenger’s name. All FastTrack's terms and conditions will apply to you, so please read them here. 0 0 0 0 1000 0 0 0 0 1000 MAN Manchester airport 1 1 2 2 3 3 1 //d1xcii4rs5n6co.cloudfront.net/libraryimages/fasttrack.jpg With this special, VIP pass through security, you could be the first through the gate. We'll give you one voucher for all passengers, so make sure you hold the square, patterned barcode on your own voucher under the special camera at the entrance before you go through. You’ll then need to do the same with your boarding pass. You can only use the Fast Track once, on the day you’ve booked. Even though Fast Track customers get their own lane through security, all the normal airport security rules will still apply. Since the airport already has its own special lanes for customers with mobility issues or those with small children, they won't need to use this service. Jet 2 customers who have purchased Fast Track tickets must use the security lanes located on Departure level 5 in Terminal 1. Please ensure you have read the Airport's Terms and Conditions. Manchester 1 10.00 1 FastTrack Terminal 2 APMANSF2 /v1/fastTrack/APMANSF2 /v1/product/MANSF2 10.00 GBP //d1xcii4rs5n6co.cloudfront.net/libraryimages/85558-manchester-airport-security-fasttrack-T2.png Short on time? Take the fast track through security and you’ll fly through. //d1xcii4rs5n6co.cloudfront.net/libraryimages/81386-MAN-fasttrack-core.png <h2> What is it?</h2> <p>The Security FastTrack pass gives you access to the priority lane at the airport’s security checks. You’ll whizz past the standard queue, giving you more time to relax in departures before your flight. </p> <p> Once you book we’ll email you the passes, so make sure you print them and take them with you. There’ll be a voucher each with a barcode, which you’ll need to scan at the entrance before you go through. </p> <h2>When can I use it?</h2> <p>Available 2.30am - 11pm.</p> <h2> Is it the same price for children?</h2> <p>Yes, the pass is £5 per person.</p> <h2>The small print:</h2> <p>You won't need this service if you have mobility issues or small children with pushchairs as there's already a dedicated lane.</p><p>Security FastTrack tickets can only be used once for the date you have booked.</p> <p> If you have booked more than one ticket the vouchers will all be in the lead passenger’s name.</p> <p>All FastTrack's terms and conditions will apply to you, so please read them <a href=\"http://www.manchesterairport.co.uk/terms-and-conditions/fasttrack/\" target=\"_blank\">here.</a></p> 0 0 0 0 1000 0 0 0 0 1000 MAN Manchester airport 1 1 2 2 3 3 1 //d1xcii4rs5n6co.cloudfront.net/libraryimages/fasttrack.jpg With this special, VIP pass through security, you could be the first through the gate. We'll give you one voucher for all passengers, so make sure you hold the square, patterned barcode on your own voucher under the special camera at the entrance before you go through. You’ll then need to do the same with your boarding pass. You can only use the Fast Track once, on the day you’ve booked. Even though Fast Track customers get their own lane through security, all the normal airport security rules will still apply. Since the airport already has its own special lanes for customers with mobility issues or those with small children, they won't need to use this service. Jet 2 customers who have purchased Fast Track tickets must use the security lanes located on Departure level 5 in Terminal 1. Please ensure you have read the Airport's Terms and Conditions. Manchester 2 10.00 1 FastTrack Terminal 3 APMANSF3 /v1/fastTrack/APMANSF3 /v1/product/MANSF3 10.00 GBP //d1xcii4rs5n6co.cloudfront.net/libraryimages/85558-manchester-airport-security-fasttrack-T3.png Short on time? Take the fast track through security and you’ll fly through. //d1xcii4rs5n6co.cloudfront.net/libraryimages/81386-MAN-fasttrack-core.png <h2> What is it?</h2> <p>The Security FastTrack pass gives you access to the priority lane at the airport’s security checks. You’ll whizz past the standard queue, giving you more time to relax in departures before your flight. </p> <p> Once you book we’ll email you the passes, so make sure you print them and take them with you. There’ll be a voucher each with a barcode, which you’ll need to scan at the entrance before you go through. </p> <h2>When can I use it?</h2> <p>Available 2.30am - 11pm.</p> <h2> Is it the same price for children?</h2> <p>Yes, the pass is £5 per person.</p> <h2>The small print:</h2> <p>You won't need this service if you have mobility issues or small children with pushchairs as there's already a dedicated lane.</p> <p>Security FastTrack tickets can only be used once for the date you have booked.</p> <p> If you have booked more than one ticket the vouchers will all be in the lead passenger’s name.</p> <p>All FastTrack's terms and conditions will apply to you, so please read them <a href=\"http://www.manchesterairport.co.uk/terms-and-conditions/fasttrack/\" target=\"_blank\">here.</a></p> 0 0 0 0 1000 0 0 0 0 1000 MAN Manchester airport 1 1 2 2 3 3 1 //d1xcii4rs5n6co.cloudfront.net/libraryimages/fasttrack.jpg With this special, VIP pass through security, you could be the first through the gate. We'll give you one voucher for all passengers, so make sure you hold the square, patterned barcode on your own voucher under the special camera at the entrance before you go through. You’ll then need to do the same with your boarding pass. You can only use the Fast Track once, on the day you’ve booked. Even though Fast Track customers get their own lane through security, all the normal airport security rules will still apply. Since the airport already has its own special lanes for customers with mobility issues or those with small children, they won't need to use this service. Jet 2 customers who have purchased Fast Track tickets must use the security lanes located on Departure level 5 in Terminal 1. Please ensure you have read the Airport's Terms and Conditions. Manchester 3 10.00 1 0.00 0.00 0.00 0.00 0.00 0.00 TESTX Redacted partnerapitest generate 2019-10-22 1200 0 2 1 ```",
+ "url": "/hxapi/fasttrack/av/"
}
,
- "hxapi-transfers-av": {
- "title": "Transfers Availability",
- "content": "# Transfers Availability## Availability Request### MethodGET### EndpointThe endpoint to use is:```https://api.holidayextras.co.uk/v1/transfers/search```Here is an example:```https://api.holidayextras.co.uk/v1/transfers/search?token=[TOKEN]&key=[KEY]&ABTANumber=[ABTA]&FromDate=2020-08-01&FromTime=1000&ReturnDate=2020-08-07&ReturnTime=1730&PickUp=AGP&PickUpType=IATA&DropOff=85101062&DropOffType=TTI&OutFlight=U28605&ReturnFlight=U28602&Adults=2```### Request ParametersNB: All parameter names are case sensitive.| Name | Data Type | Format | Mandatory? | Additional Information ||--------------------|-----------|------------------|------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|| ABTANumber | String | [A-Z0-9] 5 chars | Y | This is also known as an 'agent code'. This will be confirmed to you by your Account Manager during set up. || Password | String | [A-Z0-9] 5 chars | Y* | Password required for retail agent requests - intermediaries do not require a password.This will be confirmed to you by your Account Manager during set up. || Initials | String | [A-Z] 3 chars | N | The initials of the Operator/Agent. || key | String | [A-Z] | Y | This will be assigned to you by your Account Manager during set up. || token | String | [0-9] 9 chars | Y | Please see [user token endpoint](/hxapi/usertoken) for details of how to generate a token. || PickUpType | String | [A-Z0-9] | Y | The type can either be `IATA`, `TTI`, `postal-address` or `PC` (Postcode) (i.e `PickUpType=IATA`). || PickUp | String | [A-Z0-9] | Y* | The IATA, TTI or Postcode (i.e `PickUp=AGP`).Not required for `postal-address` || PickUpName | String | [A-Z0-9] | Y [^1] | The pick up location name. || PickUpAddress[] | String | [A-Z0-9] | Y [^1] | First line of address (house name / number and road) of the destination.If you require more than one address line, then you can replicate this field and increment the number in square brackets, i.e. \"PickUpAddress[1]\" for address line two. Up to a maximum of two address lines. || PickUpTown | String | [A-Z0-9] | Y [^1] | The pick up town name. || PickUpCounty | String | [A-Z0-9] | Y [^1] | The pick up county name. || PickUpPostcode | String | [A-Z0-9] | Y [^1] | The pick up postcode. || PickUpCountryCode | String | [A-Z] 2 chars | Y [^1] | The pick up country code in [ISO 3166-1 alpha-2](https://www.iso.org/iso-3166-country-codes.html) format. || PickUpLongitude | Float | [0-9] | Y [^1] | The pick up location longitude. || PickUpLatitude | Float | [0-9] | Y [^1] | The pick up location latitude. || DropOffType | String | [A-Z0-9] | Y | The type can either be `IATA`, `TTI`, `postal-address` or `PC` (Postcode) (i.e `DropOffType=TTI`). || DropOff | String | [A-Z0-9] | Y* | The IATA, TTI or Postcode (i.e `DropOff=85101062`).Not required for `postal-address` || DropOffName | String | [A-Z0-9] | Y [^1] | The drop off location name. || DropOffAddress[] | String | [A-Z0-9] | Y [^1] | First line of address (house name / number and road) of the destination.If you require more than one address line, then you can replicate this field and increment the number in square brackets, i.e. \"DropOffAddress[1]\" for address line two. Up to a maximum of two address lines. || DropOffTown | String | [A-Z0-9] | Y [^1] | The drop off town name. || DropOffCounty | String | [A-Z0-9] | Y [^1] | The drop off county name. || DropOffPostcode | String | [A-Z0-9] | Y [^1] | The drop off postcode. || DropOffCountryCode | String | [A-Z] 2 chars | Y [^1] | The drop off country code in [ISO 3166-1 alpha-2](https://www.iso.org/iso-3166-country-codes.html) format. || DropOffLongitude | Float | [0-9] | Y [^1] | The drop off location longitude. || DropOffLatitude | Float | [0-9] | Y [^1] | The drop off location latitude. || FromDate | Date | YYYY-MM-DD | Y | Flight Arrival Date (`PickUpType` = `IATA`), Flight Departure Date (`DropOffType` = `IATA`), Preferred Date. || FromTime | Time | HHMM | Y | Flight Arrival Time (`PickUpType` = `IATA`), Flight Departure Time (`DropOffType` = `IATA`), Preferred Time. || ReturnDate | Date | YYYY-MM-DD | N | Flight Arrival Date (`DropOffType` = `IATA`), Flight Departure Date (`PickUpType` = `IATA`), Preferred Date. || ReturnTime | Time | HHMM | N | Flight Arrival Time (`DropOffType` = `IATA`), Flight Departure Time (`PickUpType` = `IATA`), Preferred Time. || Adults | Integer | [0-9] | Y | Number of Adults requiring a transfer. || Children | Integer | [0-9] | N | Number of Children requiring a transfer. || Infants | Integer | [0-9] | N | Number of Infants requiring a transfer. || OutFlight | String | [A-Z0-9] | Y* | A flight number is required if the journey involves being picked up or dropped off at an Airport. || ReturnFlight | String | [A-Z0-9] | N* | A flight number is required if the return journey involves being picked up or dropped off at an Airport. |#### Dates and TimesIt's important to note that availability should be requested with accurate dates and times. A good scenario would be if an Airport Transfer is required, where the `PickUp` would be an Airport and the `DropOff` would be a Hotel. The `FromDate` and `FromTime` should be the flight arrival date and time. If a return transfer is requested, then the `ReturnDate` and `ReturnTime` should be the flight departure date and time, our system will calculate an estimated pickup time from the Hotel.## Availability ResponseIf availability has been found for the requested parameters, the response will contain a `Transfers` field with all the nested Transfers available. A summary of the request received can be found in the header field at the end of the response.For a detailed explanation of the fields returned, please see below:| Field | Additional Information ||----------------------------|-------------------------------------------------------------------------------------------------------------|| Transfers/Name | The name of the Transfer. || Transfers/Code | The product code for the transfer, which must be used in the booking request. || Transfers/BookingURL | The URL to POST the booking request to for this particular product. || Transfers/TotalPrice | The total price of the Transfer/s. || Transfers/NonDiscPrice | If a discount has been applied, this is the total price before discount. || Transfers/SalesCurrency | Three character identifier for the sale currency to qualify the price. || Transfers/Images/Src | Link to a image for the product. Prefix with `https:`. || Transfers/Images/Alt | The alt tag for the image. || Transfers/Category | The category assigned to the Transfer/s, for the full list of categories [please see below](/hxapi/transfers/av/#transfer-categories). || Transfers/Disclaimer | Depending on supplier and transfer type, the Disclaimer will contain pickup details. || Transfers/ProviderDetails | Shows the providers name and rating (if applicable). || Transfers/Cancellation | Shows the cancellation period before pickup date/time. || Transfers/VehicleDetails | Details about the vehicle being used for the Transfer/s. || Transfers/OutboundTransfer | Details about the outbound transfer. || Transfers/ReturnTransfer | Details about the return transfer (This field will be `null` if no return was requested). |#### [Transfer Categories](#transfer-categories)Here are the available categories which may be returned, there will only be one category assigned to each Transfer:- shared_shuttle- speedy_shuttle- private_transfer- wheelchair_adapted- helicopter_transfer- water_taxi- shared_water_taxi- limo_transfer- private_coach- private_minibus- private_executive- land_and_water- train- suv### Example```json{ \"API_Reply\": { \"ATTRIBUTES\": { \"Product\": \"Transfers\", \"RequestCode\": 1, \"Result\": \"OK\", \"cached\": true, \"expires\": \"2020-07-21 15:20:14\" }, \"Transfers\": [ { \"ATTRIBUTES\": [], \"Name\": \"Shuttle\", \"Code\": \"TBHT39\", \"BookingURL\": \"/v1/transfers/TBHT39.js\", \"MoreInfoURL\": null, \"TotalPrice\": 103.52, \"NonDiscPrice\": 103.52, \"SalesCurrency\": \"GBP\", \"Images\": [ { \"Src\": \"//dfgkosjf6iw47.cloudfront.net/resortTransfers/shuttlebus.jpeg\", \"Alt\": \"shuttlebus\" } ], \"Category\": \"shared_shuttle\", \"Disclaimer\": { \"Title\": null, \"Message\": null }, \"ProviderDetails\": { \"ProviderName\": \"\", \"ProviderRating\": \"\" }, \"Cancellation\": { \"Period\": 72, \"Percentage\": 100, \"Fee\": 0 }, \"VehicleDetails\": { \"MinCapacity\": \"\", \"MaxCapacity\": \"\", \"MinStops\": \"\", \"MaxStops\": \"\", \"Bags\": 1, \"NumberOfVehicles\": 1, \"IsPrivate\": \"\", \"Supplier\": \"\" }, \"OutboundTransfer\": { \"SupplierRef\": \"\", \"Origin\": \"Málaga Airport\", \"OriginAddress\": \"Málaga Airport, Málaga\", \"OriginIata\": \"AGP\", \"Destination\": \"BlueBay Banús\", \"DestinationAddress\": \"Carretera Cadiz, 29660, Marbella\", \"DestinationIata\": \"\", \"JourneyTime\": 90, \"ArrivalDate\": \"2020-08-01\", \"ArrivalTime\": \"09:00\", \"ReturnDate\": null, \"ReturnTime\": null, \"PickupDate\": \"2020-08-01\", \"PickupTime\": \"09:00\", \"JoiningInstructions\": null, \"ContactNumbers\": null }, \"ReturnTransfer\": { \"SupplierRef\": \"\", \"Origin\": \"BlueBay Banús\", \"OriginAddress\": \"Carretera Cadiz, 29660, Marbella\", \"OriginIata\": \"\", \"Destination\": \"Málaga Airport\", \"DestinationAddress\": \"Málaga Airport, Málaga\", \"DestinationIata\": \"AGP\", \"JourneyTime\": 90, \"ArrivalDate\": null, \"ArrivalTime\": null, \"ReturnDate\": \"2020-08-07\", \"ReturnTime\": \"16:30\", \"PickupDate\": \"2020-08-07\", \"PickupTime\": \"12:30\", \"JoiningInstructions\": null, \"ContactNumbers\": null }, \"advance_purchase\": true }, { \"ATTRIBUTES\": [], \"Name\": \"Speedy Shuttle\", \"Code\": \"TBHT519\", \"BookingURL\": \"/v1/transfers/TBHT519.js\", \"MoreInfoURL\": null, \"TotalPrice\": 134.8, \"NonDiscPrice\": 134.8, \"SalesCurrency\": \"GBP\", \"Images\": [ { \"Src\": \"//dfgkosjf6iw47.cloudfront.net/resortTransfers/shuttlebus.jpeg\", \"Alt\": \"shuttlebus\" } ], \"Category\": \"speedy_shuttle\", \"Disclaimer\": { \"Title\": null, \"Message\": null }, \"ProviderDetails\": { \"ProviderName\": \"\", \"ProviderRating\": \"\" }, \"Cancellation\": { \"Period\": 72, \"Percentage\": 100, \"Fee\": 0 }, \"VehicleDetails\": { \"MinCapacity\": \"\", \"MaxCapacity\": \"\", \"MinStops\": \"\", \"MaxStops\": \"\", \"Bags\": 1, \"NumberOfVehicles\": 1, \"IsPrivate\": \"\", \"Supplier\": \"\" }, \"OutboundTransfer\": { \"SupplierRef\": \"\", \"Origin\": \"Málaga Airport\", \"OriginAddress\": \"Málaga Airport, Málaga\", \"OriginIata\": \"AGP\", \"Destination\": \"BlueBay Banús\", \"DestinationAddress\": \"Carretera Cadiz, 29660, Marbella\", \"DestinationIata\": \"\", \"JourneyTime\": 75, \"ArrivalDate\": \"2020-08-01\", \"ArrivalTime\": \"09:00\", \"ReturnDate\": null, \"ReturnTime\": null, \"PickupDate\": \"2020-08-01\", \"PickupTime\": \"09:00\", \"JoiningInstructions\": null, \"ContactNumbers\": null }, \"ReturnTransfer\": { \"SupplierRef\": \"\", \"Origin\": \"BlueBay Banús\", \"OriginAddress\": \"Carretera Cadiz, 29660, Marbella\", \"OriginIata\": \"\", \"Destination\": \"Málaga Airport\", \"DestinationAddress\": \"Málaga Airport, Málaga\", \"DestinationIata\": \"AGP\", \"JourneyTime\": 75, \"ArrivalDate\": null, \"ArrivalTime\": null, \"ReturnDate\": \"2020-08-07\", \"ReturnTime\": \"16:30\", \"PickupDate\": \"2020-08-07\", \"PickupTime\": \"12:45\", \"JoiningInstructions\": null, \"ContactNumbers\": null }, \"advance_purchase\": true }, { \"ATTRIBUTES\": [], \"Name\": \"Private Car\", \"Code\": \"TBHT43\", \"BookingURL\": \"/v1/transfers/TBHT43.js\", \"MoreInfoURL\": null, \"TotalPrice\": 201.72, \"NonDiscPrice\": 201.72, \"SalesCurrency\": \"GBP\", \"Images\": [ { \"Src\": \"//dfgkosjf6iw47.cloudfront.net/resortTransfers/private_standard.jpeg\", \"Alt\": \"private standard\" } ], \"Category\": \"private_transfer\", \"Disclaimer\": { \"Title\": null, \"Message\": null }, \"ProviderDetails\": { \"ProviderName\": \"\", \"ProviderRating\": \"\" }, \"Cancellation\": { \"Period\": 72, \"Percentage\": 100, \"Fee\": 0 }, \"VehicleDetails\": { \"MinCapacity\": 1, \"MaxCapacity\": 4, \"MinStops\": \"\", \"MaxStops\": \"\", \"Bags\": 4, \"NumberOfVehicles\": 1, \"IsPrivate\": true, \"Supplier\": \"\" }, \"OutboundTransfer\": { \"SupplierRef\": \"\", \"Origin\": \"Málaga Airport\", \"OriginAddress\": \"Málaga Airport, Málaga\", \"OriginIata\": \"AGP\", \"Destination\": \"BlueBay Banús\", \"DestinationAddress\": \"Carretera Cadiz, 29660, Marbella\", \"DestinationIata\": \"\", \"JourneyTime\": 60, \"ArrivalDate\": \"2020-08-01\", \"ArrivalTime\": \"09:00\", \"ReturnDate\": null, \"ReturnTime\": null, \"PickupDate\": \"2020-08-01\", \"PickupTime\": \"09:00\", \"JoiningInstructions\": null, \"ContactNumbers\": null }, \"ReturnTransfer\": { \"SupplierRef\": \"\", \"Origin\": \"BlueBay Banús\", \"OriginAddress\": \"Carretera Cadiz, 29660, Marbella\", \"OriginIata\": \"\", \"Destination\": \"Málaga Airport\", \"DestinationAddress\": \"Málaga Airport, Málaga\", \"DestinationIata\": \"AGP\", \"JourneyTime\": 60, \"ArrivalDate\": null, \"ArrivalTime\": null, \"ReturnDate\": \"2020-08-07\", \"ReturnTime\": \"16:30\", \"PickupDate\": \"2020-08-07\", \"PickupTime\": \"13:00\", \"JoiningInstructions\": null, \"ContactNumbers\": null }, \"advance_purchase\": true }, { \"ATTRIBUTES\": [], \"Name\": \"Private Executive Car\", \"Code\": \"TBHT18\", \"BookingURL\": \"/v1/transfers/TBHT18.js\", \"MoreInfoURL\": null, \"TotalPrice\": 291.86, \"NonDiscPrice\": 291.86, \"SalesCurrency\": \"GBP\", \"Images\": [ { \"Src\": \"//dfgkosjf6iw47.cloudfront.net/resortTransfers/private_luxury.jpeg\", \"Alt\": \"private luxury\" } ], \"Category\": \"private_executive\", \"Disclaimer\": { \"Title\": null, \"Message\": null }, \"ProviderDetails\": { \"ProviderName\": \"\", \"ProviderRating\": \"\" }, \"Cancellation\": { \"Period\": 72, \"Percentage\": 100, \"Fee\": 0 }, \"VehicleDetails\": { \"MinCapacity\": 1, \"MaxCapacity\": 4, \"MinStops\": \"\", \"MaxStops\": \"\", \"Bags\": 4, \"NumberOfVehicles\": 1, \"IsPrivate\": true, \"Supplier\": \"\" }, \"OutboundTransfer\": { \"SupplierRef\": \"\", \"Origin\": \"Málaga Airport\", \"OriginAddress\": \"Málaga Airport, Málaga\", \"OriginIata\": \"AGP\", \"Destination\": \"BlueBay Banús\", \"DestinationAddress\": \"Carretera Cadiz, 29660, Marbella\", \"DestinationIata\": \"\", \"JourneyTime\": 60, \"ArrivalDate\": \"2020-08-01\", \"ArrivalTime\": \"09:00\", \"ReturnDate\": null, \"ReturnTime\": null, \"PickupDate\": \"2020-08-01\", \"PickupTime\": \"09:00\", \"JoiningInstructions\": null, \"ContactNumbers\": null }, \"ReturnTransfer\": { \"SupplierRef\": \"\", \"Origin\": \"BlueBay Banús\", \"OriginAddress\": \"Carretera Cadiz, 29660, Marbella\", \"OriginIata\": \"\", \"Destination\": \"Málaga Airport\", \"DestinationAddress\": \"Málaga Airport, Málaga\", \"DestinationIata\": \"AGP\", \"JourneyTime\": 60, \"ArrivalDate\": null, \"ArrivalTime\": null, \"ReturnDate\": \"2020-08-07\", \"ReturnTime\": \"16:30\", \"PickupDate\": \"2020-08-07\", \"PickupTime\": \"13:00\", \"JoiningInstructions\": null, \"ContactNumbers\": null }, \"advance_purchase\": true }, { \"ATTRIBUTES\": [], \"Name\": \"Private Minibus\", \"Code\": \"TBHT2\", \"BookingURL\": \"/v1/transfers/TBHT2.js\", \"MoreInfoURL\": null, \"TotalPrice\": 295.32, \"NonDiscPrice\": 295.32, \"SalesCurrency\": \"GBP\", \"Images\": [ { \"Src\": \"//dfgkosjf6iw47.cloudfront.net/resortTransfers/private_standard.jpeg\", \"Alt\": \"private standard\" } ], \"Category\": \"private_minibus\", \"Disclaimer\": { \"Title\": null, \"Message\": null }, \"ProviderDetails\": { \"ProviderName\": \"\", \"ProviderRating\": \"\" }, \"Cancellation\": { \"Period\": 72, \"Percentage\": 100, \"Fee\": 0 }, \"VehicleDetails\": { \"MinCapacity\": 5, \"MaxCapacity\": 8, \"MinStops\": \"\", \"MaxStops\": \"\", \"Bags\": 8, \"NumberOfVehicles\": 1, \"IsPrivate\": true, \"Supplier\": \"\" }, \"OutboundTransfer\": { \"SupplierRef\": \"\", \"Origin\": \"Málaga Airport\", \"OriginAddress\": \"Málaga Airport, Málaga\", \"OriginIata\": \"AGP\", \"Destination\": \"BlueBay Banús\", \"DestinationAddress\": \"Carretera Cadiz, 29660, Marbella\", \"DestinationIata\": \"\", \"JourneyTime\": 60, \"ArrivalDate\": \"2020-08-01\", \"ArrivalTime\": \"09:00\", \"ReturnDate\": null, \"ReturnTime\": null, \"PickupDate\": \"2020-08-01\", \"PickupTime\": \"09:00\", \"JoiningInstructions\": null, \"ContactNumbers\": null }, \"ReturnTransfer\": { \"SupplierRef\": \"\", \"Origin\": \"BlueBay Banús\", \"OriginAddress\": \"Carretera Cadiz, 29660, Marbella\", \"OriginIata\": \"\", \"Destination\": \"Málaga Airport\", \"DestinationAddress\": \"Málaga Airport, Málaga\", \"DestinationIata\": \"AGP\", \"JourneyTime\": 60, \"ArrivalDate\": null, \"ArrivalTime\": null, \"ReturnDate\": \"2020-08-07\", \"ReturnTime\": \"16:30\", \"PickupDate\": \"2020-08-07\", \"PickupTime\": \"13:00\", \"JoiningInstructions\": null, \"ContactNumbers\": null }, \"advance_purchase\": true } ], \"Pricing\": {}, \"SepaID\": \"\", \"API_Header\": { \"Request\": { \"ABTANumber\": \"YourABTANumber\", \"Password\": \"YourPassword\", \"Initials\": \"YourInitials\", \"key\": \"YourKey\", \"token\": \"YourToken\", \"FromDate\": \"2020-08-01\", \"FromTime\": 1000, \"ReturnDate\": \"2020-08-07\", \"ReturnTime\": 1730, \"PickUp\": \"AGP\", \"PickUpType\": \"IATA\", \"DropOff\": 85101062, \"DropOffType\": \"TTI\", \"OutFlight\": \"U28605\", \"ReturnFlight\": \"U28602\", \"Adults\": 2, \"v\": 1, \"format\": \"js\" } } }}```### Worked ExamplesBelow are some worked examples of both the request and response when requesting transfers avalability.#### Airport to TTI##### Request{% codetabs %}{% codetab XML %}```https:///api.holidayextras.co.uk/v1/transfers/search?ABTANumber=YourABTANumber&Password=YourABTANumber&Initials=YourInitials&key=YourKey&token=YourToken&PickUp=ALC&PickUpType=IATA&DropOffType=TTI&DropOff=10147575&FromDate=2022-03-16&FromTime=1115&ReturnDate=2022-03-23&ReturnTime=1115&Adults=2&OutFlight=U28605&ReturnFlight=U28602```{% endcodetab %}{% codetab JSON %}```https:///api.holidayextras.co.uk/v1/transfers/search.js?ABTANumber=YourABTANumber&Password=YourABTANumber&Initials=YourInitials&key=YourKey&token=YourToken&PickUp=ALC&PickUpType=IATA&DropOffType=TTI&DropOff=10147575&FromDate=2022-03-16&FromTime=1115&ReturnDate=2022-03-23&ReturnTime=1115&Adults=2&OutFlight=U28605&ReturnFlight=U28602```Note the `.js` extension.{% endcodetab %}{% endcodetabs %}##### ResponseNB: This is a shortened example compiled from a full availability response.{% codetabs %}{% codetab XML %}```xml Private Standard Car TBHT1169922 /transfers/TBHT1169922 87.96 87.96 GBP //dfgkosjf6iw47.cloudfront.net/resortTransfers/private_standard.jpeg private standard private_transfer 72 100 0 1 4 4 1 1 Alicante International Airport (Benidorm) Alicante International Airport (Benidorm), Alicante ALC Hotel Rural Castillo De Biar s/n, Carretera de Banyeres, 03410, Biar 60 16/03/2022 11:15 16/03/2022 11:15 Hotel Rural Castillo De Biar s/n, Carretera de Banyeres, 03410, Biar Alicante International Airport (Benidorm) Alicante International Airport (Benidorm), Alicante ALC 60 23/03/2022 11:15 23/03/2022 07:45 1 YourABTANumber YourPassword YourInitials YourKey YourToken ALC IATA TTI 10147575 2022-03-16 1115 2022-03-23 1115 2 U28605 U28602 ```{% endcodetab %}{% codetab JSON %}```json{ \"API_Reply\": { \"ATTRIBUTES\": { \"Product\": \"Transfers\", \"RequestCode\": 1, \"Result\": \"OK\", \"cached\": true, \"expires\": \"2021-12-07 14:50:30\" }, \"Transfers\": [ { \"ATTRIBUTES\": [], \"Name\": \"Private Standard Car\", \"Code\": \"TBHT1169922\", \"BookingURL\": \"/transfers/TBHT1169922.js\", \"MoreInfoURL\": null, \"TotalPrice\": 87.96, \"NonDiscPrice\": 87.96, \"SalesCurrency\": \"GBP\", \"Images\": [ { \"Src\": \"//dfgkosjf6iw47.cloudfront.net/resortTransfers/private_standard.jpeg\", \"Alt\": \"private standard\" } ], \"Category\": \"private_transfer\", \"Disclaimer\": { \"Title\": null, \"Message\": null }, \"ProviderDetails\": { \"ProviderName\": \"\", \"ProviderRating\": \"\" }, \"Cancellation\": { \"Period\": 72, \"Percentage\": 100, \"Fee\": 0 }, \"VehicleDetails\": { \"MinCapacity\": 1, \"MaxCapacity\": 4, \"MinStops\": \"\", \"MaxStops\": \"\", \"Bags\": 4, \"NumberOfVehicles\": 1, \"IsPrivate\": true, \"Supplier\": \"\", \"Make\": \"\" }, \"OutboundTransfer\": { \"SupplierRef\": \"\", \"Origin\": \"Alicante International Airport (Benidorm)\", \"OriginAddress\": \"Alicante International Airport (Benidorm), Alicante\", \"OriginIata\": \"ALC\", \"Destination\": \"Hotel Rural Castillo De Biar\", \"DestinationAddress\": \"s/n, Carretera de Banyeres, 03410, Biar\", \"DestinationIata\": \"\", \"JourneyTime\": 60, \"DepartureDate\": null, \"DepartureTime\": null, \"ArrivalDate\": \"2022-03-16\", \"ArrivalTime\": \"11:15\", \"ReturnDate\": null, \"ReturnTime\": null, \"PickupDate\": \"2022-03-16\", \"PickupTime\": \"11:15\", \"JoiningInstructions\": null, \"ContactNumbers\": null }, \"ReturnTransfer\": { \"SupplierRef\": \"\", \"Origin\": \"Hotel Rural Castillo De Biar\", \"OriginAddress\": \"s/n, Carretera de Banyeres, 03410, Biar\", \"OriginIata\": \"\", \"Destination\": \"Alicante International Airport (Benidorm)\", \"DestinationAddress\": \"Alicante International Airport (Benidorm), Alicante\", \"DestinationIata\": \"ALC\", \"JourneyTime\": 60, \"DepartureDate\": null, \"DepartureTime\": null, \"ArrivalDate\": null, \"ArrivalTime\": null, \"ReturnDate\": \"2022-03-23\", \"ReturnTime\": \"11:15\", \"PickupDate\": \"2022-03-23\", \"PickupTime\": \"07:45\", \"JoiningInstructions\": null, \"ContactNumbers\": null }, \"advance_purchase\": true }, ], \"Pricing\": {}, \"SepaID\": \"\", \"API_Header\": { \"Request\": { \"ABTANumber\": \"YourABTANumber\", \"Password\": \"YourPassword\", \"Initials\": \"YourInitials\", \"key\": \"YourKey\", \"token\": \"YourToken\", \"PickUp\": \"ALC\", \"PickUpType\": \"IATA\", \"DropOffType\": \"TTI\", \"DropOff\": 10147575, \"FromDate\": \"2022-03-16\", \"FromTime\": 1115, \"ReturnDate\": \"2022-03-23\", \"ReturnTime\": 1115, \"Adults\": 2, \"OutFlight\": \"U28605\", \"ReturnFlight\": \"U28602\", \"format\": \"js\" } } }}```{% endcodetab %}{% endcodetabs %}#### Airport to Postal Address##### Request{% codetabs %}{% codetab XML %}```https:///api.holidayextras.co.uk/v1/transfers/search?ABTANumber=YourABTANumber&Password=YourABTANumber&Initials=YourInitials&key=YourKey&token=YourToken&PickUp=ALC&PickUpType=IATA&DropOffType=postal-address&DropOffName=Hotel%20Rural%20Castillo%20De%20Biar&DropOffAddress[0]=Carretera%20de%20Banyeres&DropOffAddress[1]=s/n&DropOffTown=%20Biar&DropOffCounty=Alicante&DropOffPostcode=03410&DropOffCountryCode=ES&DropOffLongitude=-0.76832006&DropOffLatitude=38.63852215&Adults=2&FromDate=2022-03-16&FromTime=1115&ReturnDate=2022-03-23&ReturnTime=1115&OutFlight=U28605&ReturnFlight=U28602```{% endcodetab %}{% codetab JSON %}```https:///api.holidayextras.co.uk/v1/transfers/search.js?ABTANumber=YourABTANumber&Password=YourABTANumber&Initials=YourInitials&key=YourKey&token=YourToken&PickUp=ALC&PickUpType=IATA&DropOffType=postal-address&DropOffName=Hotel%20Rural%20Castillo%20De%20Biar&DropOffAddress[0]=Carretera%20de%20Banyeres&DropOffAddress[1]=s/n&DropOffTown=%20Biar&DropOffCounty=Alicante&DropOffPostcode=03410&DropOffCountryCode=ES&DropOffLongitude=-0.76832006&DropOffLatitude=38.63852215&Adults=2&FromDate=2022-03-16&FromTime=1115&ReturnDate=2022-03-23&ReturnTime=1115&OutFlight=U28605&ReturnFlight=U28602```Note the `.js` extension.{% endcodetab %}{% endcodetabs %}##### ResponseNB: This is a shortened example compiled from a full availability response.{% codetabs %}{% codetab XML %}```xml Private Standard Car TBHT1169922 /transfers/TBHT1169922 87.96 87.96 GBP //dfgkosjf6iw47.cloudfront.net/resortTransfers/private_standard.jpeg private standard private_transfer 72 100 0 1 4 4 1 1 Alicante International Airport (Benidorm) Alicante International Airport (Benidorm), Alicante ALC Hotel Rural Castillo De Biar Hotel Rural Castillo De Biar, Carretera de Banyeres, s/n, Biar, Alicante, 03410, ES 60 16/03/2022 11:15 16/03/2022 11:15 Hotel Rural Castillo De Biar Hotel Rural Castillo De Biar, Carretera de Banyeres, s/n, Biar, Alicante, 03410, ES Alicante International Airport (Benidorm) Alicante International Airport (Benidorm), Alicante ALC 60 23/03/2022 11:15 23/03/2022 07:45 1 YourABTANumber YourPassword YourInitials YourKey YourToken ALC IATA postal-address Hotel Rural Castillo De Biar Carretera de Banyeres s/n Biar Alicante 03410 ES -0.76832006 38.63852215 2022-03-16 1115 2022-03-23 1115 2 U28605 U28602 ```{% endcodetab %}{% codetab JSON %}```json{ \"API_Reply\": { \"ATTRIBUTES\": { \"Product\": \"Transfers\", \"RequestCode\": 1, \"Result\": \"OK\", \"cached\": true, \"expires\": \"2021-12-07 16:26:43\" }, \"Transfers\": [ { \"ATTRIBUTES\": [], \"Name\": \"Private Standard Car\", \"Code\": \"TBHT1169922\", \"BookingURL\": \"/transfers/TBHT1169922.js\", \"MoreInfoURL\": null, \"TotalPrice\": 87.96, \"NonDiscPrice\": 87.96, \"SalesCurrency\": \"GBP\", \"Images\": [{ \"Src\": \"//dfgkosjf6iw47.cloudfront.net/resortTransfers/private_standard.jpeg\", \"Alt\": \"private standard\" }], \"Category\": \"private_transfer\", \"Disclaimer\": { \"Title\": null, \"Message\": null }, \"ProviderDetails\": { \"ProviderName\": \"\", \"ProviderRating\": \"\" }, \"Cancellation\": { \"Period\": 72, \"Percentage\": 100, \"Fee\": 0 }, \"VehicleDetails\": { \"MinCapacity\": 1, \"MaxCapacity\": 4, \"MinStops\": \"\", \"MaxStops\": \"\", \"Bags\": 4, \"NumberOfVehicles\": 1, \"IsPrivate\": true, \"Supplier\": \"\", \"Make\": \"\" }, \"OutboundTransfer\": { \"SupplierRef\": \"\", \"Origin\": \"Alicante International Airport (Benidorm)\", \"OriginAddress\": \"Alicante International Airport (Benidorm), Alicante\", \"OriginIata\": \"ALC\", \"Destination\": \"Hotel Rural Castillo De Biar\", \"DestinationAddress\": \"Hotel Rural Castillo De Biar, Carretera de Banyeres, s/n, Biar, Alicante, 03410, ES\", \"DestinationIata\": \"\", \"JourneyTime\": 60, \"DepartureDate\": null, \"DepartureTime\": null, \"ArrivalDate\": \"2022-03-16\", \"ArrivalTime\": \"11:15\", \"ReturnDate\": null, \"ReturnTime\": null, \"PickupDate\": \"2022-03-16\", \"PickupTime\": \"11:15\", \"JoiningInstructions\": null, \"ContactNumbers\": null }, \"ReturnTransfer\": { \"SupplierRef\": \"\", \"Origin\": \"Hotel Rural Castillo De Biar\", \"OriginAddress\": \"Hotel Rural Castillo De Biar, Carretera de Banyeres, s/n, Biar, Alicante, 03410, ES\", \"OriginIata\": \"\", \"Destination\": \"Alicante International Airport (Benidorm)\", \"DestinationAddress\": \"Alicante International Airport (Benidorm), Alicante\", \"DestinationIata\": \"ALC\", \"JourneyTime\": 60, \"DepartureDate\": null, \"DepartureTime\": null, \"ArrivalDate\": null, \"ArrivalTime\": null, \"ReturnDate\": \"2022-03-23\", \"ReturnTime\": \"11:15\", \"PickupDate\": \"2022-03-23\", \"PickupTime\": \"07:45\", \"JoiningInstructions\": null, \"ContactNumbers\": null }, \"advance_purchase\": true } ], \"Pricing\": {}, \"SepaID\": \"\", \"API_Header\": { \"Request\": { \"ABTANumber\": \"YourABTANumber\", \"Password\": \"YourPassword\", \"Initials\": \"YourInitials\", \"key\": \"YourKey\", \"token\": \"YourToken\", \"PickUp\": \"ALC\", \"PickUpType\": \"IATA\", \"DropOffType\": \"postal-address\", \"DropOffName\": \"Hotel Rural Castillo De Biar\", \"DropOffAddress\": [ \"Carretera de Banyeres\", \"s/n\" ], \"DropOffTown\": \" Biar\", \"DropOffCounty\": \"Alicante\", \"DropOffPostcode\": \"03410\", \"DropOffCountryCode\": \"ES\", \"DropOffLongitude\": -0.76832006, \"DropOffLatitude\": 38.63852215, \"FromDate\": \"2022-03-16\", \"FromTime\": 1115, \"ReturnDate\": \"2022-03-23\", \"ReturnTime\": 1115, \"Adults\": 2, \"OutFlight\": \"U28605\", \"ReturnFlight\": \"U28602\", \"format\": \"js\" } } }}```{% endcodetab %}{% endcodetabs %}[^1]: Only required when the location type is `postal-address`.",
- "url": "/hxapi/transfers/av/"
+ "hxapi-fasttrack": {
+ "title": "FastTrack",
+ "content": "# FastTrackHere are the fasttrack specific endpoints:| Request | Endpoint | Method || --- | --- | --- || Availability of fasttrack at airport | [https://api.holidayextras.co.uk/v1/fasttrack/AirportCode](av) | GET || Make booking for fasttrack | [https://api.holidayextras.co.uk/v1/fastTrack/FastTrackCode](bkg) | POST |",
+ "url": "/hxapi/fasttrack/"
+ }
+ ,
+
+ "hxapi-hotel-av": {
+ "title": "Hotel Availability Request",
+ "content": "## Hotel Availability Request### MethodGET### EndpointThe endpoint to use is:```https://api.holidayextras.co.uk/v1/hotel/LocationCode```For example, for London Heathrow the endpoint is:```https://api.holidayextras.co.uk/v1/hotel/LHR```If you know the specific hotel code, then you can request availability by entering that into the endpoint. For example, for the Hilton at London Heathrow the endpoint is:```https://api.holidayextras.co.uk/v1/hotel/LHRHIL```To find the airport locations available for hotels, please refer to the [locations endpoint.](/hxapi/locations)### Request ParametersNB: All parameter names are case sensitive.| Name | Data Type | Format | Mandatory? | Additional Information ||----------------|-----------|-----------------------------------------|------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|| ABTANumber | String | [A-Z0-9] 5 chars | Y | This is also known as an 'agent code'. This will be confirmed to you by your Account Manager during set up. || Password | String | [A-Z0-9] 5 chars | Y* | Password required for retail agent requests - intermediaries do not require a password.This will be confirmed to you by your Account Manager during set up. || Initials | String | [A-Z] 3 chars | N | The initials of the Operator / Agent. || key | String | [A-Z] | Y | This will be assigned to you by your Account Manager during set up. || token | String | [0-9] 9 chars | Y | Please see [user token endpoint](/hxapi/usertoken) for details of how to generate a token. || ArrivalDate | Date | YYYY-MM-DD | Y | Date customer arrives at hotel. || Nights | Integer | 1 | Y | Number of nights the customer wants to stay in the hotel. NB: It is only possible to book one night stays. || RoomType | String | [A-Z0-9] 3 chars | Y | See [RoomCodes](/hxapi/types/roomcode) for a list of valid codes. || SecondRoomType | String | [A-Z0-9] 3 chars | N* | NB: This feature is only available in the UK. This parameter is mandatory if the customer wishes to book two rooms at the same time. (Max 2 rooms) The room codes are as per RoomType. || ParkingDays | Integer | [0-9] 2 chars | Y | NB: The maximum duration accepted for ParkingDays is 30. || System | String | [A-Z] 3 chars | Y* | For European products, you need to pass in the value of `System=ABG` (the default is `System=ABC`, which is UK products only). || lang | String | [A-Z] 2 chars | Y* | Required for requests for European products. (Values available are `en`, `de`, `it`, `es`, `pt` and `nl`.) || Terminal | String | [A-Z1-9] 1 char | N | An optional field when requesting hotel and parking that will filter the availble results to those that serve the given terminal. Terminal options can be found using the [Terminal](/hxapi/terminal) request, where the name of the terminal is a word only the first character is needed for this request ( eg. N for the North terminal ). || fields | String | [A-Z] a csv list of product info fields | N | A list of product info fields can be passed in to return configurable product information e.g. `fields=name,address,latitude,sellingpoint`. |## Hotel Availability ResponseFor a detailed explanation of the fields returned, please see below:| Field | Additional Information ||------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|| Hotel/Name | The name of the product || Hotel/Code | The product code || Hotel/BookingURL | The URL to POST the booking request to for this particular product. || Hotel/MoreInfoURL | The link to more information about this product, sourced from the Product Library. || Hotel/RequestFlags | These flags list which details the car park operator requires from the customer. If a flag is returned with a ‘Y’ your application should send the corresponding field/value in the booking request. Flags are only returned when required. The flags which can be returned are: `Registration`, `CarMake`, `CarModel`, `CarColour`, `OutFlight`, `ReturnFlight`, `OutTerminal`, `ReturnTerminal`, `Destination`, `MobileNum` || Hotel/Price | The price of product without any surcharges/fees added. || Hotel/PriceWithSurcharge | *NB: Please ignore this field - we no longer accept new agents sending payment details via our API.* || Hotel/Adults* | The maximum number of adults included in the room occupancy. || Hotel/Children* | The maximum number of children included in the room occupancy. || Hotel/RoomCode | *NB: Please ignore this field as it relates to internal systems.* || Hotel/BoardBasis | *NB: Please ignore this field as it is no longer used and will be deprecated in future versions of the API.* || Hotel/ParkingDays | This returns the number of days parking available. NB: This may differ from the value requested, due to parking packages usually being set up in the system as either 4, 8 or 15 days. || Hotel/NonDiscPrice | The non discounted price. Some agent codes apply a discount so we return this field to enable a comparison. || Hotel/CancellationFeeExceptions | If the hotel has non-standard cancellation fees. || Hotel/AmendmentFeeExceptions | If the hotel has non-standard amendment fees. || Hotel/noncancellable_nonrefundable | Is this hotel noncancellable or non-refundable? || Hotel/parking_includes_arrival | If parking during the customer's hotel stay included in their parking package || Hotel/CarPark | If your request included car parking, this is the car park code. || Hotel/Filter | *NB: Please ignore this field as it is for internal use only.* || Hotel/lead_time_cancellation | This is the number of days before the booking starts that the product will switch from flexible to non-flexible. || API_Header/Request | The API returns every parameter and value you sent in the previous request. | \\* Where two rooms have been requested, these fields represent the total of adults and children across all rooms. Additional fields will show the individual room occupancy: `FirstRoomAdults`, `FirstRoomChildren`, `SecondRoomAdults` and `SecondRoomChildren`.## Key Information on HotelsPlease read this section through carefully, as it contains useful information about restrictions on how hotels must be sold.### Advance purchaseAdvance purchase products are non-refundable and non-cancellable. As a result, Cancellation Waiver must *not* be sold to customers purchasing a product with `advance_purchase` set to 1.### Day Use OnlyThere is a field in the product library for hotels, named `day_use_only`. Day use products must not be sold to customers wishing to have an overnight stay where `day_use_only` is set to 1.### Parking Includes ArrivalIn order to establish whether the package includes parking for the night of the hotel stay the `parking_includes_arrival` field needs to be taken into account.Where this field is set to 0, this means the night of the hotel stay is not included as there is free overnight parking. Parking stay will start from the following day. Where it is set to 1, this means that parking starts from the date the customer checks into the hotel.### Mystery / Un-named ProductsThere are some hotels in which the name field will not provide the name of the hotel e.g `Mystery 4-star hotel`. The name of these hotels should not be provided to the customer until the booking is made, along with other identifying details such as address, hotel images, restaurant names etc.### Lead time cancellationFlexible bookings become non flexible within a certain timeframe before the stay date ie booking turns non flexible within 30 days of stay.Scenario 1* Flexible booking made outside 60 days of stay.* Cancellation policy - only able to canx up to 30 days before stay date.* Booking is non flex within 30 days of stay date.Scenario 2* Flexible booking made inside 60 days of stay date.* Cancellation policy - only able to canx up to 3 days before stay date.* Booking is non flex within 3 days of stay date.## Worked ExamplesBelow are worked examples of both the requests and responses for hotel availability.### UK Hotel Availability Request - Room Only (zero days parking)```https://api.holidayextras.co.uk/v1/hotel/LHR?ABTANumber=YourABTANumber&Password=YourPassword&key=YourKey&token=YourToken&ArrivalDate=2017-12-01&Nights=1&RoomType=T21&ParkingDays=0```### UK Hotel Availability Response - Room Only (zero days parking)NB: This is a shortened example compiled from a full availability response.```xml Mercure LHRMEA /v1/hotel/HPLHRMEA /v1/product/LHRMEA 1 45.00 45.90 2 1 TRL RO 0 45.00 30 1 1 1 Thistle T5 LHRPAA /v1/hotel/HPLHRPAA /v1/product/LHRPAA 85.50 87.21 2 1 TRL RO 0 85.50 30 1 0 1 Hilton T5 LHRHLT /v1/hotel/HPLHRHLT /v1/product/LHRHLT 1 1 1 99.00 100.98 2 1 TRL RO 0 99.00 2.00 0.00 4.00 0.00 0.00 0.00 2.99 YourABTANumber YourPassword YourKey YourToken 2017-12-01 1 T21 0 1 ```### UK Hotel Availability Request - Room with Parking```https://api.holidayextras.co.uk/v1/hotel/LHR?ABTANumber=YourABTANumber&Password=YourPassword&key=YourKey&token=YourToken&ArrivalDate=2017-12-01&Nights=1&RoomType=T21&ParkingDays=8```### UK Hotel Availability Response - Room with ParkingNB: This is a shortened example compiled from a full availability response.```xml Mercure with Purple Parking Meet and Greet LHRMPU /v1/hotel/HPLHRMPU /v1/product/LHRMPU 1 1 1 1 1 1 1 129.00 131.58 2 1 TRL RO 8 129.00 LHR5 LHR5 1 Thistle T5 with parking at the hotel and breakfast LHRPAT /v1/hotel/HPLHRPAT /v1/product/LHRPAT 130.00 132.60 2 1 TRL RO 8 130.00 1 1 0 Sheraton Skyline with parking at the hotel LHRSKA /v1/hotel/HPLHRSKA /v1/product/LHRSKA 134.00 136.68 2 1 TRL RO 8 134.00 0 2.00 0.00 4.00 0.00 0.00 0.00 2.99 YourABTANumber YourPassword YourKey YourToken 2017-12-01 1 T21 8 1 ```### European Hotel Availability Request - Room with Parking```https://api.holidayextras.co.uk/v1/hotel/MUC?ABTANumber=YourABTANumber&Password=YourPassword&key=YourKey&token=YourToken&ArrivalDate=2017-12-01&Nights=1&RoomType=D20&ParkingDays=8&System=ABG&lang=de```### European Hotel Availability Response - Room with ParkingNB: This is a shortened example compiled from a full availability response.```xml Schweigers Landgasthof MUCLAN /v1/hotel/FRMUCLAN /v1/product/MUCLAN 120.00 NaN 2 0 DZ F 15 120.00 Airporthotel Regent MUCREG /v1/hotel/FRMUCREG /v1/product/MUCREG 97.00 NaN 2 0 DZ F 15 97.00 NH München Airport MUCAST /v1/hotel/FRMUCAST /v1/product/MUCAST 113.00 NaN 2 0 DZ U 8 113.00 0.00 0.00 0.00 TESTG Redacted mytestkey generate 2017-12-01 1 D20 8 ABG de 1 ```",
+ "url": "/hxapi/hotel/av/"
+ }
+ ,
+
+ "hxapi-hotel": {
+ "title": "Hotels",
+ "content": "# Hotels[API Docs](/hxapi/) > product:[Hotels](index)## Hotel EndpointsHere are the hotel specific endpoints: | Action | Endpoint | Method | | ------ | -------- | ------ | | Availability at hotel | [https://api.holidayextras.co.uk/v1/hotel/LocationCode](av) | GET | | Make booking at hotel | [https://api.holidayextras.co.uk/v1/hotel/LocationCode](bkg) | POST |Please note: All hotel requests include parking options of zero, 8 and 15 days parking. To make a request for a hotel only product, please select zero days parking.## Hotel User JourneyTo follow -",
+ "url": "/hxapi/hotel/"
}
,
@@ -324,6 +324,13 @@
}
,
+ "hxapi-transfers-av": {
+ "title": "Transfers Availability",
+ "content": "# Transfers Availability## Availability Request### MethodGET### EndpointThe endpoint to use is:```https://api.holidayextras.co.uk/v1/transfers/search```Here is an example:```https://api.holidayextras.co.uk/v1/transfers/search?token=[TOKEN]&key=[KEY]&ABTANumber=[ABTA]&FromDate=2020-08-01&FromTime=1000&ReturnDate=2020-08-07&ReturnTime=1730&PickUp=AGP&PickUpType=IATA&DropOff=85101062&DropOffType=TTI&OutFlight=U28605&ReturnFlight=U28602&Adults=2```### Request ParametersNB: All parameter names are case sensitive.| Name | Data Type | Format | Mandatory? | Additional Information ||--------------------|-----------|------------------|------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|| ABTANumber | String | [A-Z0-9] 5 chars | Y | This is also known as an 'agent code'. This will be confirmed to you by your Account Manager during set up. || Password | String | [A-Z0-9] 5 chars | Y* | Password required for retail agent requests - intermediaries do not require a password.This will be confirmed to you by your Account Manager during set up. || Initials | String | [A-Z] 3 chars | N | The initials of the Operator/Agent. || key | String | [A-Z] | Y | This will be assigned to you by your Account Manager during set up. || token | String | [0-9] 9 chars | Y | Please see [user token endpoint](/hxapi/usertoken) for details of how to generate a token. || PickUpType | String | [A-Z0-9] | Y | The type can either be `IATA`, `TTI`, `postal-address` or `PC` (Postcode) (i.e `PickUpType=IATA`). || PickUp | String | [A-Z0-9] | Y* | The IATA, TTI or Postcode (i.e `PickUp=AGP`).Not required for `postal-address` || PickUpName | String | [A-Z0-9] | Y [^1] | The pick up location name. || PickUpAddress[] | String | [A-Z0-9] | Y [^1] | First line of address (house name / number and road) of the destination.If you require more than one address line, then you can replicate this field and increment the number in square brackets, i.e. \"PickUpAddress[1]\" for address line two. Up to a maximum of two address lines. || PickUpTown | String | [A-Z0-9] | Y [^1] | The pick up town name. || PickUpCounty | String | [A-Z0-9] | Y [^1] | The pick up county name. || PickUpPostcode | String | [A-Z0-9] | Y [^1] | The pick up postcode. || PickUpCountryCode | String | [A-Z] 2 chars | Y [^1] | The pick up country code in [ISO 3166-1 alpha-2](https://www.iso.org/iso-3166-country-codes.html) format. || PickUpLongitude | Float | [0-9] | Y [^1] | The pick up location longitude. || PickUpLatitude | Float | [0-9] | Y [^1] | The pick up location latitude. || DropOffType | String | [A-Z0-9] | Y | The type can either be `IATA`, `TTI`, `postal-address` or `PC` (Postcode) (i.e `DropOffType=TTI`). || DropOff | String | [A-Z0-9] | Y* | The IATA, TTI or Postcode (i.e `DropOff=85101062`).Not required for `postal-address` || DropOffName | String | [A-Z0-9] | Y [^1] | The drop off location name. || DropOffAddress[] | String | [A-Z0-9] | Y [^1] | First line of address (house name / number and road) of the destination.If you require more than one address line, then you can replicate this field and increment the number in square brackets, i.e. \"DropOffAddress[1]\" for address line two. Up to a maximum of two address lines. || DropOffTown | String | [A-Z0-9] | Y [^1] | The drop off town name. || DropOffCounty | String | [A-Z0-9] | Y [^1] | The drop off county name. || DropOffPostcode | String | [A-Z0-9] | Y [^1] | The drop off postcode. || DropOffCountryCode | String | [A-Z] 2 chars | Y [^1] | The drop off country code in [ISO 3166-1 alpha-2](https://www.iso.org/iso-3166-country-codes.html) format. || DropOffLongitude | Float | [0-9] | Y [^1] | The drop off location longitude. || DropOffLatitude | Float | [0-9] | Y [^1] | The drop off location latitude. || FromDate | Date | YYYY-MM-DD | Y | Flight Arrival Date (`PickUpType` = `IATA`), Flight Departure Date (`DropOffType` = `IATA`), Preferred Date. || FromTime | Time | HHMM | Y | Flight Arrival Time (`PickUpType` = `IATA`), Flight Departure Time (`DropOffType` = `IATA`), Preferred Time. || ReturnDate | Date | YYYY-MM-DD | N | Flight Arrival Date (`DropOffType` = `IATA`), Flight Departure Date (`PickUpType` = `IATA`), Preferred Date. || ReturnTime | Time | HHMM | N | Flight Arrival Time (`DropOffType` = `IATA`), Flight Departure Time (`PickUpType` = `IATA`), Preferred Time. || Adults | Integer | [0-9] | Y | Number of Adults requiring a transfer. || Children | Integer | [0-9] | N | Number of Children requiring a transfer. || Infants | Integer | [0-9] | N | Number of Infants requiring a transfer. || OutFlight | String | [A-Z0-9] | Y* | A flight number is required if the journey involves being picked up or dropped off at an Airport. || ReturnFlight | String | [A-Z0-9] | N* | A flight number is required if the return journey involves being picked up or dropped off at an Airport. |#### Dates and TimesIt's important to note that availability should be requested with accurate dates and times. A good scenario would be if an Airport Transfer is required, where the `PickUp` would be an Airport and the `DropOff` would be a Hotel. The `FromDate` and `FromTime` should be the flight arrival date and time. If a return transfer is requested, then the `ReturnDate` and `ReturnTime` should be the flight departure date and time, our system will calculate an estimated pickup time from the Hotel.## Availability ResponseIf availability has been found for the requested parameters, the response will contain a `Transfers` field with all the nested Transfers available. A summary of the request received can be found in the header field at the end of the response.For a detailed explanation of the fields returned, please see below:| Field | Additional Information ||----------------------------|-------------------------------------------------------------------------------------------------------------|| Transfers/Name | The name of the Transfer. || Transfers/Code | The product code for the transfer, which must be used in the booking request. || Transfers/BookingURL | The URL to POST the booking request to for this particular product. || Transfers/TotalPrice | The total price of the Transfer/s. || Transfers/NonDiscPrice | If a discount has been applied, this is the total price before discount. || Transfers/SalesCurrency | Three character identifier for the sale currency to qualify the price. || Transfers/Images/Src | Link to a image for the product. Prefix with `https:`. || Transfers/Images/Alt | The alt tag for the image. || Transfers/Category | The category assigned to the Transfer/s, for the full list of categories [please see below](/hxapi/transfers/av/#transfer-categories). || Transfers/Disclaimer | Depending on supplier and transfer type, the Disclaimer will contain pickup details. || Transfers/ProviderDetails | Shows the providers name and rating (if applicable). || Transfers/Cancellation | Shows the cancellation period before pickup date/time. || Transfers/VehicleDetails | Details about the vehicle being used for the Transfer/s. || Transfers/OutboundTransfer | Details about the outbound transfer. || Transfers/ReturnTransfer | Details about the return transfer (This field will be `null` if no return was requested). |#### [Transfer Categories](#transfer-categories)Here are the available categories which may be returned, there will only be one category assigned to each Transfer:- shared_shuttle- speedy_shuttle- private_transfer- wheelchair_adapted- helicopter_transfer- water_taxi- shared_water_taxi- limo_transfer- private_coach- private_minibus- private_executive- land_and_water- train- suv### Example```json{ \"API_Reply\": { \"ATTRIBUTES\": { \"Product\": \"Transfers\", \"RequestCode\": 1, \"Result\": \"OK\", \"cached\": true, \"expires\": \"2020-07-21 15:20:14\" }, \"Transfers\": [ { \"ATTRIBUTES\": [], \"Name\": \"Shuttle\", \"Code\": \"TBHT39\", \"BookingURL\": \"/v1/transfers/TBHT39.js\", \"MoreInfoURL\": null, \"TotalPrice\": 103.52, \"NonDiscPrice\": 103.52, \"SalesCurrency\": \"GBP\", \"Images\": [ { \"Src\": \"//dfgkosjf6iw47.cloudfront.net/resortTransfers/shuttlebus.jpeg\", \"Alt\": \"shuttlebus\" } ], \"Category\": \"shared_shuttle\", \"Disclaimer\": { \"Title\": null, \"Message\": null }, \"ProviderDetails\": { \"ProviderName\": \"\", \"ProviderRating\": \"\" }, \"Cancellation\": { \"Period\": 72, \"Percentage\": 100, \"Fee\": 0 }, \"VehicleDetails\": { \"MinCapacity\": \"\", \"MaxCapacity\": \"\", \"MinStops\": \"\", \"MaxStops\": \"\", \"Bags\": 1, \"NumberOfVehicles\": 1, \"IsPrivate\": \"\", \"Supplier\": \"\" }, \"OutboundTransfer\": { \"SupplierRef\": \"\", \"Origin\": \"Málaga Airport\", \"OriginAddress\": \"Málaga Airport, Málaga\", \"OriginIata\": \"AGP\", \"Destination\": \"BlueBay Banús\", \"DestinationAddress\": \"Carretera Cadiz, 29660, Marbella\", \"DestinationIata\": \"\", \"JourneyTime\": 90, \"ArrivalDate\": \"2020-08-01\", \"ArrivalTime\": \"09:00\", \"ReturnDate\": null, \"ReturnTime\": null, \"PickupDate\": \"2020-08-01\", \"PickupTime\": \"09:00\", \"JoiningInstructions\": null, \"ContactNumbers\": null }, \"ReturnTransfer\": { \"SupplierRef\": \"\", \"Origin\": \"BlueBay Banús\", \"OriginAddress\": \"Carretera Cadiz, 29660, Marbella\", \"OriginIata\": \"\", \"Destination\": \"Málaga Airport\", \"DestinationAddress\": \"Málaga Airport, Málaga\", \"DestinationIata\": \"AGP\", \"JourneyTime\": 90, \"ArrivalDate\": null, \"ArrivalTime\": null, \"ReturnDate\": \"2020-08-07\", \"ReturnTime\": \"16:30\", \"PickupDate\": \"2020-08-07\", \"PickupTime\": \"12:30\", \"JoiningInstructions\": null, \"ContactNumbers\": null }, \"advance_purchase\": true }, { \"ATTRIBUTES\": [], \"Name\": \"Speedy Shuttle\", \"Code\": \"TBHT519\", \"BookingURL\": \"/v1/transfers/TBHT519.js\", \"MoreInfoURL\": null, \"TotalPrice\": 134.8, \"NonDiscPrice\": 134.8, \"SalesCurrency\": \"GBP\", \"Images\": [ { \"Src\": \"//dfgkosjf6iw47.cloudfront.net/resortTransfers/shuttlebus.jpeg\", \"Alt\": \"shuttlebus\" } ], \"Category\": \"speedy_shuttle\", \"Disclaimer\": { \"Title\": null, \"Message\": null }, \"ProviderDetails\": { \"ProviderName\": \"\", \"ProviderRating\": \"\" }, \"Cancellation\": { \"Period\": 72, \"Percentage\": 100, \"Fee\": 0 }, \"VehicleDetails\": { \"MinCapacity\": \"\", \"MaxCapacity\": \"\", \"MinStops\": \"\", \"MaxStops\": \"\", \"Bags\": 1, \"NumberOfVehicles\": 1, \"IsPrivate\": \"\", \"Supplier\": \"\" }, \"OutboundTransfer\": { \"SupplierRef\": \"\", \"Origin\": \"Málaga Airport\", \"OriginAddress\": \"Málaga Airport, Málaga\", \"OriginIata\": \"AGP\", \"Destination\": \"BlueBay Banús\", \"DestinationAddress\": \"Carretera Cadiz, 29660, Marbella\", \"DestinationIata\": \"\", \"JourneyTime\": 75, \"ArrivalDate\": \"2020-08-01\", \"ArrivalTime\": \"09:00\", \"ReturnDate\": null, \"ReturnTime\": null, \"PickupDate\": \"2020-08-01\", \"PickupTime\": \"09:00\", \"JoiningInstructions\": null, \"ContactNumbers\": null }, \"ReturnTransfer\": { \"SupplierRef\": \"\", \"Origin\": \"BlueBay Banús\", \"OriginAddress\": \"Carretera Cadiz, 29660, Marbella\", \"OriginIata\": \"\", \"Destination\": \"Málaga Airport\", \"DestinationAddress\": \"Málaga Airport, Málaga\", \"DestinationIata\": \"AGP\", \"JourneyTime\": 75, \"ArrivalDate\": null, \"ArrivalTime\": null, \"ReturnDate\": \"2020-08-07\", \"ReturnTime\": \"16:30\", \"PickupDate\": \"2020-08-07\", \"PickupTime\": \"12:45\", \"JoiningInstructions\": null, \"ContactNumbers\": null }, \"advance_purchase\": true }, { \"ATTRIBUTES\": [], \"Name\": \"Private Car\", \"Code\": \"TBHT43\", \"BookingURL\": \"/v1/transfers/TBHT43.js\", \"MoreInfoURL\": null, \"TotalPrice\": 201.72, \"NonDiscPrice\": 201.72, \"SalesCurrency\": \"GBP\", \"Images\": [ { \"Src\": \"//dfgkosjf6iw47.cloudfront.net/resortTransfers/private_standard.jpeg\", \"Alt\": \"private standard\" } ], \"Category\": \"private_transfer\", \"Disclaimer\": { \"Title\": null, \"Message\": null }, \"ProviderDetails\": { \"ProviderName\": \"\", \"ProviderRating\": \"\" }, \"Cancellation\": { \"Period\": 72, \"Percentage\": 100, \"Fee\": 0 }, \"VehicleDetails\": { \"MinCapacity\": 1, \"MaxCapacity\": 4, \"MinStops\": \"\", \"MaxStops\": \"\", \"Bags\": 4, \"NumberOfVehicles\": 1, \"IsPrivate\": true, \"Supplier\": \"\" }, \"OutboundTransfer\": { \"SupplierRef\": \"\", \"Origin\": \"Málaga Airport\", \"OriginAddress\": \"Málaga Airport, Málaga\", \"OriginIata\": \"AGP\", \"Destination\": \"BlueBay Banús\", \"DestinationAddress\": \"Carretera Cadiz, 29660, Marbella\", \"DestinationIata\": \"\", \"JourneyTime\": 60, \"ArrivalDate\": \"2020-08-01\", \"ArrivalTime\": \"09:00\", \"ReturnDate\": null, \"ReturnTime\": null, \"PickupDate\": \"2020-08-01\", \"PickupTime\": \"09:00\", \"JoiningInstructions\": null, \"ContactNumbers\": null }, \"ReturnTransfer\": { \"SupplierRef\": \"\", \"Origin\": \"BlueBay Banús\", \"OriginAddress\": \"Carretera Cadiz, 29660, Marbella\", \"OriginIata\": \"\", \"Destination\": \"Málaga Airport\", \"DestinationAddress\": \"Málaga Airport, Málaga\", \"DestinationIata\": \"AGP\", \"JourneyTime\": 60, \"ArrivalDate\": null, \"ArrivalTime\": null, \"ReturnDate\": \"2020-08-07\", \"ReturnTime\": \"16:30\", \"PickupDate\": \"2020-08-07\", \"PickupTime\": \"13:00\", \"JoiningInstructions\": null, \"ContactNumbers\": null }, \"advance_purchase\": true }, { \"ATTRIBUTES\": [], \"Name\": \"Private Executive Car\", \"Code\": \"TBHT18\", \"BookingURL\": \"/v1/transfers/TBHT18.js\", \"MoreInfoURL\": null, \"TotalPrice\": 291.86, \"NonDiscPrice\": 291.86, \"SalesCurrency\": \"GBP\", \"Images\": [ { \"Src\": \"//dfgkosjf6iw47.cloudfront.net/resortTransfers/private_luxury.jpeg\", \"Alt\": \"private luxury\" } ], \"Category\": \"private_executive\", \"Disclaimer\": { \"Title\": null, \"Message\": null }, \"ProviderDetails\": { \"ProviderName\": \"\", \"ProviderRating\": \"\" }, \"Cancellation\": { \"Period\": 72, \"Percentage\": 100, \"Fee\": 0 }, \"VehicleDetails\": { \"MinCapacity\": 1, \"MaxCapacity\": 4, \"MinStops\": \"\", \"MaxStops\": \"\", \"Bags\": 4, \"NumberOfVehicles\": 1, \"IsPrivate\": true, \"Supplier\": \"\" }, \"OutboundTransfer\": { \"SupplierRef\": \"\", \"Origin\": \"Málaga Airport\", \"OriginAddress\": \"Málaga Airport, Málaga\", \"OriginIata\": \"AGP\", \"Destination\": \"BlueBay Banús\", \"DestinationAddress\": \"Carretera Cadiz, 29660, Marbella\", \"DestinationIata\": \"\", \"JourneyTime\": 60, \"ArrivalDate\": \"2020-08-01\", \"ArrivalTime\": \"09:00\", \"ReturnDate\": null, \"ReturnTime\": null, \"PickupDate\": \"2020-08-01\", \"PickupTime\": \"09:00\", \"JoiningInstructions\": null, \"ContactNumbers\": null }, \"ReturnTransfer\": { \"SupplierRef\": \"\", \"Origin\": \"BlueBay Banús\", \"OriginAddress\": \"Carretera Cadiz, 29660, Marbella\", \"OriginIata\": \"\", \"Destination\": \"Málaga Airport\", \"DestinationAddress\": \"Málaga Airport, Málaga\", \"DestinationIata\": \"AGP\", \"JourneyTime\": 60, \"ArrivalDate\": null, \"ArrivalTime\": null, \"ReturnDate\": \"2020-08-07\", \"ReturnTime\": \"16:30\", \"PickupDate\": \"2020-08-07\", \"PickupTime\": \"13:00\", \"JoiningInstructions\": null, \"ContactNumbers\": null }, \"advance_purchase\": true }, { \"ATTRIBUTES\": [], \"Name\": \"Private Minibus\", \"Code\": \"TBHT2\", \"BookingURL\": \"/v1/transfers/TBHT2.js\", \"MoreInfoURL\": null, \"TotalPrice\": 295.32, \"NonDiscPrice\": 295.32, \"SalesCurrency\": \"GBP\", \"Images\": [ { \"Src\": \"//dfgkosjf6iw47.cloudfront.net/resortTransfers/private_standard.jpeg\", \"Alt\": \"private standard\" } ], \"Category\": \"private_minibus\", \"Disclaimer\": { \"Title\": null, \"Message\": null }, \"ProviderDetails\": { \"ProviderName\": \"\", \"ProviderRating\": \"\" }, \"Cancellation\": { \"Period\": 72, \"Percentage\": 100, \"Fee\": 0 }, \"VehicleDetails\": { \"MinCapacity\": 5, \"MaxCapacity\": 8, \"MinStops\": \"\", \"MaxStops\": \"\", \"Bags\": 8, \"NumberOfVehicles\": 1, \"IsPrivate\": true, \"Supplier\": \"\" }, \"OutboundTransfer\": { \"SupplierRef\": \"\", \"Origin\": \"Málaga Airport\", \"OriginAddress\": \"Málaga Airport, Málaga\", \"OriginIata\": \"AGP\", \"Destination\": \"BlueBay Banús\", \"DestinationAddress\": \"Carretera Cadiz, 29660, Marbella\", \"DestinationIata\": \"\", \"JourneyTime\": 60, \"ArrivalDate\": \"2020-08-01\", \"ArrivalTime\": \"09:00\", \"ReturnDate\": null, \"ReturnTime\": null, \"PickupDate\": \"2020-08-01\", \"PickupTime\": \"09:00\", \"JoiningInstructions\": null, \"ContactNumbers\": null }, \"ReturnTransfer\": { \"SupplierRef\": \"\", \"Origin\": \"BlueBay Banús\", \"OriginAddress\": \"Carretera Cadiz, 29660, Marbella\", \"OriginIata\": \"\", \"Destination\": \"Málaga Airport\", \"DestinationAddress\": \"Málaga Airport, Málaga\", \"DestinationIata\": \"AGP\", \"JourneyTime\": 60, \"ArrivalDate\": null, \"ArrivalTime\": null, \"ReturnDate\": \"2020-08-07\", \"ReturnTime\": \"16:30\", \"PickupDate\": \"2020-08-07\", \"PickupTime\": \"13:00\", \"JoiningInstructions\": null, \"ContactNumbers\": null }, \"advance_purchase\": true } ], \"Pricing\": {}, \"SepaID\": \"\", \"API_Header\": { \"Request\": { \"ABTANumber\": \"YourABTANumber\", \"Password\": \"YourPassword\", \"Initials\": \"YourInitials\", \"key\": \"YourKey\", \"token\": \"YourToken\", \"FromDate\": \"2020-08-01\", \"FromTime\": 1000, \"ReturnDate\": \"2020-08-07\", \"ReturnTime\": 1730, \"PickUp\": \"AGP\", \"PickUpType\": \"IATA\", \"DropOff\": 85101062, \"DropOffType\": \"TTI\", \"OutFlight\": \"U28605\", \"ReturnFlight\": \"U28602\", \"Adults\": 2, \"v\": 1, \"format\": \"js\" } } }}```### Worked ExamplesBelow are some worked examples of both the request and response when requesting transfers avalability.#### Airport to TTI##### Request{% codetabs %}{% codetab XML %}```https:///api.holidayextras.co.uk/v1/transfers/search?ABTANumber=YourABTANumber&Password=YourABTANumber&Initials=YourInitials&key=YourKey&token=YourToken&PickUp=ALC&PickUpType=IATA&DropOffType=TTI&DropOff=10147575&FromDate=2022-03-16&FromTime=1115&ReturnDate=2022-03-23&ReturnTime=1115&Adults=2&OutFlight=U28605&ReturnFlight=U28602```{% endcodetab %}{% codetab JSON %}```https:///api.holidayextras.co.uk/v1/transfers/search.js?ABTANumber=YourABTANumber&Password=YourABTANumber&Initials=YourInitials&key=YourKey&token=YourToken&PickUp=ALC&PickUpType=IATA&DropOffType=TTI&DropOff=10147575&FromDate=2022-03-16&FromTime=1115&ReturnDate=2022-03-23&ReturnTime=1115&Adults=2&OutFlight=U28605&ReturnFlight=U28602```Note the `.js` extension.{% endcodetab %}{% endcodetabs %}##### ResponseNB: This is a shortened example compiled from a full availability response.{% codetabs %}{% codetab XML %}```xml Private Standard Car TBHT1169922 /transfers/TBHT1169922 87.96 87.96 GBP //dfgkosjf6iw47.cloudfront.net/resortTransfers/private_standard.jpeg private standard private_transfer 72 100 0 1 4 4 1 1 Alicante International Airport (Benidorm) Alicante International Airport (Benidorm), Alicante ALC Hotel Rural Castillo De Biar s/n, Carretera de Banyeres, 03410, Biar 60 16/03/2022 11:15 16/03/2022 11:15 Hotel Rural Castillo De Biar s/n, Carretera de Banyeres, 03410, Biar Alicante International Airport (Benidorm) Alicante International Airport (Benidorm), Alicante ALC 60 23/03/2022 11:15 23/03/2022 07:45 1 YourABTANumber YourPassword YourInitials YourKey YourToken ALC IATA TTI 10147575 2022-03-16 1115 2022-03-23 1115 2 U28605 U28602 ```{% endcodetab %}{% codetab JSON %}```json{ \"API_Reply\": { \"ATTRIBUTES\": { \"Product\": \"Transfers\", \"RequestCode\": 1, \"Result\": \"OK\", \"cached\": true, \"expires\": \"2021-12-07 14:50:30\" }, \"Transfers\": [ { \"ATTRIBUTES\": [], \"Name\": \"Private Standard Car\", \"Code\": \"TBHT1169922\", \"BookingURL\": \"/transfers/TBHT1169922.js\", \"MoreInfoURL\": null, \"TotalPrice\": 87.96, \"NonDiscPrice\": 87.96, \"SalesCurrency\": \"GBP\", \"Images\": [ { \"Src\": \"//dfgkosjf6iw47.cloudfront.net/resortTransfers/private_standard.jpeg\", \"Alt\": \"private standard\" } ], \"Category\": \"private_transfer\", \"Disclaimer\": { \"Title\": null, \"Message\": null }, \"ProviderDetails\": { \"ProviderName\": \"\", \"ProviderRating\": \"\" }, \"Cancellation\": { \"Period\": 72, \"Percentage\": 100, \"Fee\": 0 }, \"VehicleDetails\": { \"MinCapacity\": 1, \"MaxCapacity\": 4, \"MinStops\": \"\", \"MaxStops\": \"\", \"Bags\": 4, \"NumberOfVehicles\": 1, \"IsPrivate\": true, \"Supplier\": \"\", \"Make\": \"\" }, \"OutboundTransfer\": { \"SupplierRef\": \"\", \"Origin\": \"Alicante International Airport (Benidorm)\", \"OriginAddress\": \"Alicante International Airport (Benidorm), Alicante\", \"OriginIata\": \"ALC\", \"Destination\": \"Hotel Rural Castillo De Biar\", \"DestinationAddress\": \"s/n, Carretera de Banyeres, 03410, Biar\", \"DestinationIata\": \"\", \"JourneyTime\": 60, \"DepartureDate\": null, \"DepartureTime\": null, \"ArrivalDate\": \"2022-03-16\", \"ArrivalTime\": \"11:15\", \"ReturnDate\": null, \"ReturnTime\": null, \"PickupDate\": \"2022-03-16\", \"PickupTime\": \"11:15\", \"JoiningInstructions\": null, \"ContactNumbers\": null }, \"ReturnTransfer\": { \"SupplierRef\": \"\", \"Origin\": \"Hotel Rural Castillo De Biar\", \"OriginAddress\": \"s/n, Carretera de Banyeres, 03410, Biar\", \"OriginIata\": \"\", \"Destination\": \"Alicante International Airport (Benidorm)\", \"DestinationAddress\": \"Alicante International Airport (Benidorm), Alicante\", \"DestinationIata\": \"ALC\", \"JourneyTime\": 60, \"DepartureDate\": null, \"DepartureTime\": null, \"ArrivalDate\": null, \"ArrivalTime\": null, \"ReturnDate\": \"2022-03-23\", \"ReturnTime\": \"11:15\", \"PickupDate\": \"2022-03-23\", \"PickupTime\": \"07:45\", \"JoiningInstructions\": null, \"ContactNumbers\": null }, \"advance_purchase\": true }, ], \"Pricing\": {}, \"SepaID\": \"\", \"API_Header\": { \"Request\": { \"ABTANumber\": \"YourABTANumber\", \"Password\": \"YourPassword\", \"Initials\": \"YourInitials\", \"key\": \"YourKey\", \"token\": \"YourToken\", \"PickUp\": \"ALC\", \"PickUpType\": \"IATA\", \"DropOffType\": \"TTI\", \"DropOff\": 10147575, \"FromDate\": \"2022-03-16\", \"FromTime\": 1115, \"ReturnDate\": \"2022-03-23\", \"ReturnTime\": 1115, \"Adults\": 2, \"OutFlight\": \"U28605\", \"ReturnFlight\": \"U28602\", \"format\": \"js\" } } }}```{% endcodetab %}{% endcodetabs %}#### Airport to Postal Address##### Request{% codetabs %}{% codetab XML %}```https:///api.holidayextras.co.uk/v1/transfers/search?ABTANumber=YourABTANumber&Password=YourABTANumber&Initials=YourInitials&key=YourKey&token=YourToken&PickUp=ALC&PickUpType=IATA&DropOffType=postal-address&DropOffName=Hotel%20Rural%20Castillo%20De%20Biar&DropOffAddress[0]=Carretera%20de%20Banyeres&DropOffAddress[1]=s/n&DropOffTown=%20Biar&DropOffCounty=Alicante&DropOffPostcode=03410&DropOffCountryCode=ES&DropOffLongitude=-0.76832006&DropOffLatitude=38.63852215&Adults=2&FromDate=2022-03-16&FromTime=1115&ReturnDate=2022-03-23&ReturnTime=1115&OutFlight=U28605&ReturnFlight=U28602```{% endcodetab %}{% codetab JSON %}```https:///api.holidayextras.co.uk/v1/transfers/search.js?ABTANumber=YourABTANumber&Password=YourABTANumber&Initials=YourInitials&key=YourKey&token=YourToken&PickUp=ALC&PickUpType=IATA&DropOffType=postal-address&DropOffName=Hotel%20Rural%20Castillo%20De%20Biar&DropOffAddress[0]=Carretera%20de%20Banyeres&DropOffAddress[1]=s/n&DropOffTown=%20Biar&DropOffCounty=Alicante&DropOffPostcode=03410&DropOffCountryCode=ES&DropOffLongitude=-0.76832006&DropOffLatitude=38.63852215&Adults=2&FromDate=2022-03-16&FromTime=1115&ReturnDate=2022-03-23&ReturnTime=1115&OutFlight=U28605&ReturnFlight=U28602```Note the `.js` extension.{% endcodetab %}{% endcodetabs %}##### ResponseNB: This is a shortened example compiled from a full availability response.{% codetabs %}{% codetab XML %}```xml Private Standard Car TBHT1169922 /transfers/TBHT1169922 87.96 87.96 GBP //dfgkosjf6iw47.cloudfront.net/resortTransfers/private_standard.jpeg private standard private_transfer 72 100 0 1 4 4 1 1 Alicante International Airport (Benidorm) Alicante International Airport (Benidorm), Alicante ALC Hotel Rural Castillo De Biar Hotel Rural Castillo De Biar, Carretera de Banyeres, s/n, Biar, Alicante, 03410, ES 60 16/03/2022 11:15 16/03/2022 11:15 Hotel Rural Castillo De Biar Hotel Rural Castillo De Biar, Carretera de Banyeres, s/n, Biar, Alicante, 03410, ES Alicante International Airport (Benidorm) Alicante International Airport (Benidorm), Alicante ALC 60 23/03/2022 11:15 23/03/2022 07:45 1 YourABTANumber YourPassword YourInitials YourKey YourToken ALC IATA postal-address Hotel Rural Castillo De Biar Carretera de Banyeres s/n Biar Alicante 03410 ES -0.76832006 38.63852215 2022-03-16 1115 2022-03-23 1115 2 U28605 U28602 ```{% endcodetab %}{% codetab JSON %}```json{ \"API_Reply\": { \"ATTRIBUTES\": { \"Product\": \"Transfers\", \"RequestCode\": 1, \"Result\": \"OK\", \"cached\": true, \"expires\": \"2021-12-07 16:26:43\" }, \"Transfers\": [ { \"ATTRIBUTES\": [], \"Name\": \"Private Standard Car\", \"Code\": \"TBHT1169922\", \"BookingURL\": \"/transfers/TBHT1169922.js\", \"MoreInfoURL\": null, \"TotalPrice\": 87.96, \"NonDiscPrice\": 87.96, \"SalesCurrency\": \"GBP\", \"Images\": [{ \"Src\": \"//dfgkosjf6iw47.cloudfront.net/resortTransfers/private_standard.jpeg\", \"Alt\": \"private standard\" }], \"Category\": \"private_transfer\", \"Disclaimer\": { \"Title\": null, \"Message\": null }, \"ProviderDetails\": { \"ProviderName\": \"\", \"ProviderRating\": \"\" }, \"Cancellation\": { \"Period\": 72, \"Percentage\": 100, \"Fee\": 0 }, \"VehicleDetails\": { \"MinCapacity\": 1, \"MaxCapacity\": 4, \"MinStops\": \"\", \"MaxStops\": \"\", \"Bags\": 4, \"NumberOfVehicles\": 1, \"IsPrivate\": true, \"Supplier\": \"\", \"Make\": \"\" }, \"OutboundTransfer\": { \"SupplierRef\": \"\", \"Origin\": \"Alicante International Airport (Benidorm)\", \"OriginAddress\": \"Alicante International Airport (Benidorm), Alicante\", \"OriginIata\": \"ALC\", \"Destination\": \"Hotel Rural Castillo De Biar\", \"DestinationAddress\": \"Hotel Rural Castillo De Biar, Carretera de Banyeres, s/n, Biar, Alicante, 03410, ES\", \"DestinationIata\": \"\", \"JourneyTime\": 60, \"DepartureDate\": null, \"DepartureTime\": null, \"ArrivalDate\": \"2022-03-16\", \"ArrivalTime\": \"11:15\", \"ReturnDate\": null, \"ReturnTime\": null, \"PickupDate\": \"2022-03-16\", \"PickupTime\": \"11:15\", \"JoiningInstructions\": null, \"ContactNumbers\": null }, \"ReturnTransfer\": { \"SupplierRef\": \"\", \"Origin\": \"Hotel Rural Castillo De Biar\", \"OriginAddress\": \"Hotel Rural Castillo De Biar, Carretera de Banyeres, s/n, Biar, Alicante, 03410, ES\", \"OriginIata\": \"\", \"Destination\": \"Alicante International Airport (Benidorm)\", \"DestinationAddress\": \"Alicante International Airport (Benidorm), Alicante\", \"DestinationIata\": \"ALC\", \"JourneyTime\": 60, \"DepartureDate\": null, \"DepartureTime\": null, \"ArrivalDate\": null, \"ArrivalTime\": null, \"ReturnDate\": \"2022-03-23\", \"ReturnTime\": \"11:15\", \"PickupDate\": \"2022-03-23\", \"PickupTime\": \"07:45\", \"JoiningInstructions\": null, \"ContactNumbers\": null }, \"advance_purchase\": true } ], \"Pricing\": {}, \"SepaID\": \"\", \"API_Header\": { \"Request\": { \"ABTANumber\": \"YourABTANumber\", \"Password\": \"YourPassword\", \"Initials\": \"YourInitials\", \"key\": \"YourKey\", \"token\": \"YourToken\", \"PickUp\": \"ALC\", \"PickUpType\": \"IATA\", \"DropOffType\": \"postal-address\", \"DropOffName\": \"Hotel Rural Castillo De Biar\", \"DropOffAddress\": [ \"Carretera de Banyeres\", \"s/n\" ], \"DropOffTown\": \" Biar\", \"DropOffCounty\": \"Alicante\", \"DropOffPostcode\": \"03410\", \"DropOffCountryCode\": \"ES\", \"DropOffLongitude\": -0.76832006, \"DropOffLatitude\": 38.63852215, \"FromDate\": \"2022-03-16\", \"FromTime\": 1115, \"ReturnDate\": \"2022-03-23\", \"ReturnTime\": 1115, \"Adults\": 2, \"OutFlight\": \"U28605\", \"ReturnFlight\": \"U28602\", \"format\": \"js\" } } }}```{% endcodetab %}{% endcodetabs %}[^1]: Only required when the location type is `postal-address`.",
+ "url": "/hxapi/transfers/av/"
+ }
+ ,
+
"hxapi-transfers": {
"title": "Transfers",
"content": "# Transfers[API Docs](/hxapi/) > product:[Transfers](index)## Transfer EndpointsWhen using the Transfer endpoints below, you will be able to search using various types of location data which will represent the transfers pickup and dropoff points. Currently, the API will accept IATA Codes, TTI Codes and Postcodes (Postcodes can be used for UK Transfers). | Action | Endpoint | Method | | ------ | -------- | ------ | | Availability | [https://api.holidayextras.co.uk/v1/transfers/search](av) | GET | | Make Booking | [https://api.holidayextras.co.uk/v1/transfers/[TransferCode]](bkg) | POST |To View and Cancel your existing bookings, this can be done using the generic product based [View Booking](/hxapi/viewamendcancel/view/) and [Cancel Booking](/hxapi/viewamendcancel/cancel/) endpoints.",
@@ -338,13 +345,6 @@
}
,
- "payment-gateway": {
- "title": "Payment Gateway",
- "content": "# Payment Gateway[API Docs](/index) > [Payment Gateway](index)## Integration guidePlease read the integration guide before attempting to make any requests to these endpoints. Without the appropriate setup, you will not be able to access any of the Payment Gateway functionality.The correct steps to get setup can be found in our [guide to getting setup.](integration)## VersioningThis API is versioned, a specific version can be targetted with an `Accept` header on the request with a value matching `application/vnd.holidayextras.v{VERSION_NUMBER}+json`.### Notice on sunset of v1As of September 16th 2022 v1 of the payment gateway API will not longer be supported. Clients should ensure they are migrated fully to v2 before this time to ensure that payments can still be taken.## Payment| Request | Endpoint | Method | Versions || ------- | -------- | ------ | -------- || Make Payment | https://payment-gateway.holidayextras.co.uk/pay | POST | [v1](v1/pay) [v2](v2/pay) |## Refund| Request | Endpoint | Method | Versions || ------- | -------- | ------ | -------- || Make Refund | https://payment-gateway.holidayextras.co.uk/refund | POST | [v1](v1/refund) [v2](v2/refund) |",
- "url": "/payment-gateway/"
- }
- ,
-
"": {
"title": "Welcome to Holiday Extras",
"content": "# Welcome to Holiday Extras[Holiday Extras](https://www.holidayextras.com/) is the UK market leader for airport hotels and other travel ancillaries including airport parking, lounges, insurance, resort transfer and car hire.The purpose of this documentation is to enable you to quickly on-board with our API, so you can start searching for and booking our products in *just a few hours*.## Contents* [Getting Started](intro)* [Detailed Guides](hxapi/)* [Payment Gateway](/payment-gateway)* [FAQs](/faq)* [Versioning](/versioning)",
diff --git a/site/faq.md b/site/faq.md
index d55f306f..57177804 100644
--- a/site/faq.md
+++ b/site/faq.md
@@ -17,7 +17,7 @@ Whenever writing new code or altering existing functionality, you must use the d
https://api.holidayextras.co.uk/
-
+HELLO