Asynchronous Bookings Draft
+Asynchronous Bookings
Background
@@ -85,7 +85,7 @@Availability Request
UK Products Availability Request
--
+
- XML @@ -93,7 +93,7 @@
-
https://api.holidayextras.com/v1/carpark/LGW?ABTANumber=YourABTANumber&Password=YourPassword&Initials=YourInitials&key=YourKey&token=YourToken&ArrivalDate=2025-01-07&ArrivalTime=1200&DepartDate=2025-01-08&DepartTime=1200&NumberOfPax=1&includeAsyncOnlyProducts=true @@ -110,7 +110,7 @@UK Products Availability Request
European Products Availability Request
--
+
- XML @@ -118,7 +118,7 @@
-
https://api.holidayextras.com/v1/carpark/MUC?ABTANumber=YourABTANumber&Password=YourPassword&Initials=YourInitials&key=YourKey&token=YourToken&ArrivalDate=2025-12-01&ArrivalTime=1200&DepartDate=2025-12-08&DepartTime=1200&NumberOfPax=1&System=ABG&lang=en&includeAsyncOnlyProducts=true @@ -138,11 +138,10 @@Behavior
true: Availability searches include async products.false: Availability searches exclude async products (default behavior).
- -
-
-
+Making an Async Booking
We have introduced a new parameter to the booking endpoint to support asynchronous bookings. This parameter helps indicate that the booking is an async booking and aligns with the availability request parameter.
@@ -173,7 +172,7 @@Booking Request Parameter
Behavior
-
-
true: The booking will be processed asynchronously. A response will indicate that the booking has been created but not yet confirmed.
+ true: The booking will be processed asynchronously. The booking response will indicate that the booking has been created but not yet confirmed.false: The booking will follow the standard synchronous process.
Request
Example request:
--
+
- XML @@ -69,7 +69,7 @@
-
https://api.holidayextras.com/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 6e7a89c1..7661895d 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 @@
-
https://api.holidayextras.com/v1/carpark/LGW @@ -452,7 +452,7 @@Worked Examples
UK Products Availability Request
--
+
- XML @@ -460,7 +460,7 @@
-
https://api.holidayextras.com/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 @@
-
<?xml version="1.0"?> @@ -715,7 +715,7 @@UK Products Availability Response
European Products Availability Request --
+
- XML @@ -723,7 +723,7 @@
-
https://api.holidayextras.com/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 @@
-
<?xml version="1.0"?> diff --git a/docs/hxapi/productlibrary/index.html b/docs/hxapi/productlibrary/index.html index bc0ad672..2e7174ac 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 @@
-
Recommended
@@ -976,7 +976,7 @@Example 1 - Default Response
Request
--
+
- Live (XML) @@ -988,7 +988,7 @@
-
https://api.holidayextras.com/v1/product/LGW4/lite?token=000015778&key=mytestkey @@ -1016,7 +1016,7 @@Request
Response
--
+
- XML @@ -1024,7 +1024,7 @@
-
<?xml version="1.0"?> @@ -1411,7 +1411,7 @@Example 2 - Restricted field list
Request --
+
- Live (XML) @@ -1423,7 +1423,7 @@
-
https://api.holidayextras.com/v1/product/LGW4/lite?token=000015778&key=mytestkey&fields=name,longitude,latitude @@ -1451,7 +1451,7 @@Request
Response
--
+
- XML @@ -1459,7 +1459,7 @@
-
<?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 @@
-
https://api.holidayextras.com/v1/product/FRA0?key=mytestkey @@ -1560,7 +1560,7 @@Request
Response
--
+
- XML @@ -1568,7 +1568,7 @@
-
<?xml version="1.0"?> diff --git a/docs/hxapi/transfers/av/index.html b/docs/hxapi/transfers/av/index.html index de0bc99a..e7222b9a 100644 --- a/docs/hxapi/transfers/av/index.html +++ b/docs/hxapi/transfers/av/index.html @@ -864,7 +864,7 @@Worked Examples
Airport to GIATA
Request
--
+
- XML @@ -872,7 +872,7 @@
-
https:///api.holidayextras.com/v1/transfers/search?ABTANumber=YourABTANumber&Password=YourABTANumber&Initials=YourInitials&key=YourKey&token=YourToken&PickUp=ALC&PickUpType=IATA&DropOffType=GIATA&DropOff=439771&FromDate=2022-03-16&FromTime=1115&ReturnDate=2022-03-23&ReturnTime=1115&Adults=2&OutFlight=U28605&ReturnFlight=U28602 @@ -890,7 +890,7 @@Request
Response
NB: This is a shortened example compiled from a full availability response.
--
+
- XML @@ -898,7 +898,7 @@
-
<API_Reply Product="Transfers" RequestCode="1" Result="OK" cached="1" expires="2021-12-07 13:06:41"> @@ -1136,7 +1136,7 @@Response
Airport to TTI
Request
--
+
- XML @@ -1144,7 +1144,7 @@
-
https:///api.holidayextras.com/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 @@ -1163,7 +1163,7 @@Response
NB: This is a shortened example compiled from a full availability response.
--
+
- XML @@ -1171,7 +1171,7 @@
-
<API_Reply Product="Transfers" RequestCode="1" Result="OK" cached="1" expires="2021-12-07 13:06:41"> @@ -1408,7 +1408,7 @@Response
Airport to Postal Address
Request
--
+
- XML @@ -1416,7 +1416,7 @@
-
https:///api.holidayextras.com/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 @@ -1435,7 +1435,7 @@Response
NB: This is a shortened example compiled from a full availability response.
--
+
- XML @@ -1443,7 +1443,7 @@
-
<API_Reply Product="Transfers" RequestCode="1" Result="OK" cached="1" expires="2021-12-07 16:31:35"> diff --git a/docs/hxapi/transfers/cancel/index.html b/docs/hxapi/transfers/cancel/index.html index f7f92ff1..d5ee108f 100644 --- a/docs/hxapi/transfers/cancel/index.html +++ b/docs/hxapi/transfers/cancel/index.html @@ -168,7 +168,7 @@Cancel Booking Response
Example
--
+
- XML @@ -176,7 +176,7 @@
-
<Booking> diff --git a/docs/hxapi/transfers/cancellation-policy/index.html b/docs/hxapi/transfers/cancellation-policy/index.html index 23fe9e96..2cd29c03 100644 --- a/docs/hxapi/transfers/cancellation-policy/index.html +++ b/docs/hxapi/transfers/cancellation-policy/index.html @@ -153,7 +153,7 @@Cancellation Policy Response
Example
--
+
- XML @@ -161,7 +161,7 @@
-
<BookingRef>TB12345</BookingRef> @@ -187,7 +187,7 @@Example
Example - Non-Cancellable Booking
--
+
- XML @@ -195,7 +195,7 @@
-
<BookingRef>TB12345</BookingRef> diff --git a/docs/hxapi/transfers/view/index.html b/docs/hxapi/transfers/view/index.html index b7fa2c5a..d419543b 100644 --- a/docs/hxapi/transfers/view/index.html +++ b/docs/hxapi/transfers/view/index.html @@ -303,7 +303,7 @@FlightDetails Fields
Example
--
+
- XML @@ -311,7 +311,7 @@
-
<Booking> diff --git a/docs/hxapi/upgrade/index.html b/docs/hxapi/upgrade/index.html index 5b6c1044..b32df72e 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 @@
-
https://api.holidayextras.com/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 @@
-
<?xml version="1.0"?> @@ -618,7 +618,7 @@Example 1 - Hotel Upgrades
Request
--
+
- XML @@ -626,7 +626,7 @@
-
https://api.holidayextras.com/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 @@
-
<?xml version="1.0"?> diff --git a/docs/hxapi/viewamendcancel/view/index.html b/docs/hxapi/viewamendcancel/view/index.html index 12033fb1..b7afd860 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
-YourBookingRefis the Holiday Extras booking reference):-
+
- XML @@ -62,7 +62,7 @@
-
https://api.holidayextras.com/v1/booking/YourBookingRef @@ -366,7 +366,7 @@UK Products View Booking (for a
Request
-
Endpoint
-
+
Response
-
+
Request
-
+
Response
-
+
Request
-
+
Example
-
+
Example - Non-Cancellable Booking
--
+
Example
-
+
Example
-
+
Response
-
+
Request
-
+
Response
-
+
Request
-
+
Response
-
+
Request
-
+
Response
-
+
Request
-
+
Response
-
+
Request
-
+
Response
-
+
Request
-
+
Available Fields
-
+
European Products Availability
-
+
European Products Availability R
-
+
UK Products Availability Response
--
+
UK Products Availability Request
-
+
Endpoint
-
+
Request
-
+
European Products Availability R
-
+
UK Products Availability Request
-
+