Skip to content

Update asynchronous-bookings.md #237

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Update asynchronous-bookings.md #237

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d145c47
Update asynchronous-bookings.md
VikkiMercer Sep 23, 2025
37faf7a
Merge d145c47c936fb23c7e36711688e76f64d24e8152 into 778b29d692102880b…
VikkiMercer Sep 23, 2025
d53ea70
Update dist
github-actions[bot] Sep 23, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/feed.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
<?xml version="1.0" encoding="utf-8"?><feed xmlns="http://www.w3.org/2005/Atom" ><generator uri="https://jekyllrb.com/" version="3.9.3">Jekyll</generator><link href="/feed.xml" rel="self" type="application/atom+xml" /><link href="/" rel="alternate" type="text/html" /><updated>2025-09-22T16:00:24+00:00</updated><id>/feed.xml</id><title type="html">Holiday Extras API</title><subtitle>Documentation to give to partners who would like to integrate with our API.
<?xml version="1.0" encoding="utf-8"?><feed xmlns="http://www.w3.org/2005/Atom" ><generator uri="https://jekyllrb.com/" version="3.9.3">Jekyll</generator><link href="/feed.xml" rel="self" type="application/atom+xml" /><link href="/" rel="alternate" type="text/html" /><updated>2025-09-23T09:56:10+00:00</updated><id>/feed.xml</id><title type="html">Holiday Extras API</title><subtitle>Documentation to give to partners who would like to integrate with our API.
</subtitle></feed>
28 changes: 14 additions & 14 deletions docs/hxapi/asynchronous-bookings/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,15 +85,15 @@ <h3 id="availability-request">Availability Request</h3>

<h3 id="uk-products-availability-request">UK Products Availability Request</h3>

<ul class="uk-tab" data-uk-switcher="{connect:'#7b4fb7d0-51c9-45a9-8ee4-cc8eb3d76ce7'}">
<ul class="uk-tab" data-uk-switcher="{connect:'#7a7b0432-1209-4103-a5df-1816bc9338af'}">

<li class="uk-active"><a href="#">XML</a></li>

<li><a href="#">JSON</a></li>

</ul>

<ul id="7b4fb7d0-51c9-45a9-8ee4-cc8eb3d76ce7" class="uk-switcher uk-margin">
<ul id="7a7b0432-1209-4103-a5df-1816bc9338af" class="uk-switcher uk-margin">

<li>
<div class="language-plaintext highlighter-rouge"><div class="highlight"><pre class="highlight"><code>https://api.holidayextras.com/v1/carpark/LGW?ABTANumber=YourABTANumber&amp;Password=YourPassword&amp;Initials=YourInitials&amp;key=YourKey&amp;token=YourToken&amp;ArrivalDate=2025-01-07&amp;ArrivalTime=1200&amp;DepartDate=2025-01-08&amp;DepartTime=1200&amp;NumberOfPax=1&amp;includeAsyncOnlyProducts=true
Expand All @@ -110,15 +110,15 @@ <h3 id="uk-products-availability-request">UK Products Availability Request</h3>

<h3 id="european-products-availability-request">European Products Availability Request</h3>

<ul class="uk-tab" data-uk-switcher="{connect:'#adf24a6c-29e0-49a9-8e33-82f9b2db0147'}">
<ul class="uk-tab" data-uk-switcher="{connect:'#bbb9e990-63fc-4274-b30a-384dbe70dca2'}">

<li class="uk-active"><a href="#">XML</a></li>

<li><a href="#">JSON</a></li>

</ul>

<ul id="adf24a6c-29e0-49a9-8e33-82f9b2db0147" class="uk-switcher uk-margin">
<ul id="bbb9e990-63fc-4274-b30a-384dbe70dca2" class="uk-switcher uk-margin">

<li>
<div class="language-plaintext highlighter-rouge"><div class="highlight"><pre class="highlight"><code>https://api.holidayextras.com/v1/carpark/MUC?ABTANumber=YourABTANumber&amp;Password=YourPassword&amp;Initials=YourInitials&amp;key=YourKey&amp;token=YourToken&amp;ArrivalDate=2025-12-01&amp;ArrivalTime=1200&amp;DepartDate=2025-12-08&amp;DepartTime=1200&amp;NumberOfPax=1&amp;System=ABG&amp;lang=en&amp;includeAsyncOnlyProducts=true
Expand Down Expand Up @@ -192,8 +192,8 @@ <h4 id="missing-properties">Missing Properties:</h4>

<h4 id="added-property">Added Property:</h4>
<ul>
<li><strong><code class="language-plaintext highlighter-rouge">bookingStatus</code>:</strong> Indicates the current status of the booking (<code class="language-plaintext highlighter-rouge">Pending</code>, <code class="language-plaintext highlighter-rouge">Confirmed</code>, <code class="language-plaintext highlighter-rouge">Cancelled</code>, or <code class="language-plaintext highlighter-rouge">Error</code>).</li>
<li><strong><code class="language-plaintext highlighter-rouge">suggestedPollingInterval</code>:</strong> Specifies the recommended interval in seconds for polling the view booking endpoint. The polling frequency varies based on the product type and supplier.</li>
<li><strong><code class="language-plaintext highlighter-rouge">Status</code>:</strong> Indicates the current status of the booking (<code class="language-plaintext highlighter-rouge">Pending</code>, <code class="language-plaintext highlighter-rouge">Confirmed</code>, <code class="language-plaintext highlighter-rouge">Cancelled</code>, or <code class="language-plaintext highlighter-rouge">Error</code>).</li>
<li><strong><code class="language-plaintext highlighter-rouge">SuggestedPollingInterval</code>:</strong> Specifies the recommended interval in seconds for polling the view booking endpoint. The polling frequency varies based on the product type and supplier.</li>
</ul>

<hr />
Expand All @@ -205,14 +205,14 @@ <h2 id="booking-polling">Booking Polling</h2>
<h3 id="when-polling-is-required">When Polling is Required</h3>

<p>Polling is required when a booking has been submitted with the <code class="language-plaintext highlighter-rouge">includeAsyncOnlyProducts=true</code> parameter.
The <code class="language-plaintext highlighter-rouge">bookingStatus</code> field in the response from the <code class="language-plaintext highlighter-rouge">view booking</code> endpoint indicates the current status of a booking.</p>
The <code class="language-plaintext highlighter-rouge">Status</code> field in the response from the <code class="language-plaintext highlighter-rouge">view booking</code> endpoint indicates the current status of a booking.</p>

<p>Booking details such as the QR code, supplier reference, and other information will only be provided once the <code class="language-plaintext highlighter-rouge">bookingStatus</code> field is in a <code class="language-plaintext highlighter-rouge">Confirmed</code> state.</p>
<p>Booking details such as the QR code, supplier reference, and other information will only be provided once the <code class="language-plaintext highlighter-rouge">Status</code> field is in a <code class="language-plaintext highlighter-rouge">Confirmed</code> state.</p>

<h3 id="how-often-to-poll">How Often to Poll</h3>

<p>The frequency of polling depends on the product type and supplier.
On the initial booking response, we provide a <code class="language-plaintext highlighter-rouge">suggestedPollingInterval</code> field to guide partners on the recommended polling frequency.</p>
On the initial booking response, we provide a <code class="language-plaintext highlighter-rouge">SuggestedPollingInterval</code> field to guide partners on the recommended polling frequency.</p>

<h3 id="booking-status-values">Booking Status Values</h3>

Expand Down Expand Up @@ -250,11 +250,11 @@ <h3 id="api-endpoint">API Endpoint</h3>

<h3 id="response-example">Response Example</h3>

<p>The response will now include a <code class="language-plaintext highlighter-rouge">bookingStatus</code> field to indicate the current status of the booking and a <code class="language-plaintext highlighter-rouge">suggestedPollingInterval</code> field to guide partners on the recommended polling frequency.</p>
<p>The response will now include a <code class="language-plaintext highlighter-rouge">Status</code> field to indicate the current status of the booking and a <code class="language-plaintext highlighter-rouge">SuggestedPollingInterval</code> (integer, seconds) field to guide partners on the recommended polling frequency.</p>

<div class="language-json highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="p">{</span><span class="w">
</span><span class="nl">"bookingStatus"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Pending"</span><span class="p">,</span><span class="w">
</span><span class="nl">"suggestedPollingInterval"</span><span class="p">:</span><span class="w"> </span><span class="mi">300</span><span class="w">
</span><span class="nl">"Status"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Pending"</span><span class="p">,</span><span class="w">
</span><span class="nl">"SuggestedPollingInterval"</span><span class="p">:</span><span class="w"> </span><span class="mi">5</span><span class="w">
</span><span class="p">}</span><span class="w">
</span></code></pre></div></div>

Expand All @@ -265,7 +265,7 @@ <h2 id="best-practices">Best Practices</h2>
<ol>
<li><strong>Polling Interval:</strong>
<ul>
<li>Follow the recommended intervals provided in the response.</li>
<li>Follow the recommended intervals provided in the response (value is in seconds).</li>
<li>Avoid excessive requests to prevent unnecessary load on our systems.</li>
</ul>
</li>
Expand All @@ -287,7 +287,7 @@ <h2 id="workflow-example">Workflow Example</h2>

<ol>
<li>Make a booking</li>
<li>Start Polling: Use the view booking endpoint to check the <code class="language-plaintext highlighter-rouge">bookingStatus</code>.
<li>Start Polling: Use the view booking endpoint to check the <code class="language-plaintext highlighter-rouge">Status</code>.
<ul>
<li><strong>If <code class="language-plaintext highlighter-rouge">Pending</code>:</strong> Continue polling at the recommended intervals.</li>
<li><strong>If <code class="language-plaintext highlighter-rouge">Confirmed</code>:</strong> Retrieve full details and stop polling.</li>
Expand Down
4 changes: 2 additions & 2 deletions docs/hxapi/carhire/availability/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,15 +61,15 @@ <h2 id="request">Request</h2>
</code></pre></div></div>

<p>Example request:</p>
<ul class="uk-tab" data-uk-switcher="{connect:'#8aa7fc26-c0dd-4de8-811c-510b44ac373f'}">
<ul class="uk-tab" data-uk-switcher="{connect:'#0501622e-16d8-4932-a06d-636b870656fe'}">

<li class="uk-active"><a href="#">XML</a></li>

<li><a href="#">JSON</a></li>

</ul>

<ul id="8aa7fc26-c0dd-4de8-811c-510b44ac373f" class="uk-switcher uk-margin">
<ul id="0501622e-16d8-4932-a06d-636b870656fe" class="uk-switcher uk-margin">

<li>
<div class="language-plaintext highlighter-rouge"><div class="highlight"><pre class="highlight"><code>https://api.holidayextras.com/v1/sandbox/carHire/products?key=1&amp;From=06NOV16&amp;ArrivalTime=1200&amp;To=13NOV&amp;DepartTime=1600&amp;PickupLocation=FL965&amp;DropoffLocation=FL965&amp;DateOfBirth=1990-10-13
Expand Down
20 changes: 10 additions & 10 deletions docs/hxapi/parking/av/airport/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,15 +57,15 @@ <h3 id="endpoint">Endpoint</h3>

<p>For example, for London Gatwick the endpoint is:</p>

<ul class="uk-tab" data-uk-switcher="{connect:'#3f3b3cb8-2448-4953-ae39-4a884b6c282a'}">
<ul class="uk-tab" data-uk-switcher="{connect:'#492ff235-110f-491a-8e35-0eb832b9125e'}">

<li class="uk-active"><a href="#">XML</a></li>

<li><a href="#">JSON</a></li>

</ul>

<ul id="3f3b3cb8-2448-4953-ae39-4a884b6c282a" class="uk-switcher uk-margin">
<ul id="492ff235-110f-491a-8e35-0eb832b9125e" class="uk-switcher uk-margin">

<li>
<div class="language-plaintext highlighter-rouge"><div class="highlight"><pre class="highlight"><code>https://api.holidayextras.com/v1/carpark/LGW
Expand Down Expand Up @@ -452,15 +452,15 @@ <h2 id="worked-examples">Worked Examples</h2>

<h3 id="uk-products-availability-request">UK Products Availability Request</h3>

<ul class="uk-tab" data-uk-switcher="{connect:'#80b447d7-cb06-4a37-a4a7-defe99278cc2'}">
<ul class="uk-tab" data-uk-switcher="{connect:'#9e1651e8-a15e-4550-9ea4-78a2accfa6d6'}">

<li class="uk-active"><a href="#">XML</a></li>

<li><a href="#">JSON</a></li>

</ul>

<ul id="80b447d7-cb06-4a37-a4a7-defe99278cc2" class="uk-switcher uk-margin">
<ul id="9e1651e8-a15e-4550-9ea4-78a2accfa6d6" class="uk-switcher uk-margin">

<li>
<div class="language-plaintext highlighter-rouge"><div class="highlight"><pre class="highlight"><code>https://api.holidayextras.com/carpark/LGW?ABTANumber=YourABTANumber&amp;Password=YourPassword&amp;Initials=YourInitials&amp;key=YourKey&amp;token=YourToken&amp;ArrivalDate=2020-01-07&amp;ArrivalTime=1200&amp;DepartDate=2020-01-08&amp;DepartTime=1200&amp;NumberOfPax=1
Expand All @@ -479,15 +479,15 @@ <h3 id="uk-products-availability-response">UK Products Availability Response</h3

<p>NB: This is a shortened example compiled from a full availability response.</p>

<ul class="uk-tab" data-uk-switcher="{connect:'#58a3505d-13bc-4320-b0fe-b495a6d69767'}">
<ul class="uk-tab" data-uk-switcher="{connect:'#2c19f761-ce1b-44a3-ba0d-fbb5462ed424'}">

<li class="uk-active"><a href="#">XML</a></li>

<li><a href="#">JSON</a></li>

</ul>

<ul id="58a3505d-13bc-4320-b0fe-b495a6d69767" class="uk-switcher uk-margin">
<ul id="2c19f761-ce1b-44a3-ba0d-fbb5462ed424" class="uk-switcher uk-margin">

<li>
<div class="language-xml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="cp">&lt;?xml version="1.0"?&gt;</span>
Expand Down Expand Up @@ -715,15 +715,15 @@ <h3 id="uk-products-availability-response">UK Products Availability Response</h3

<h3 id="european-products-availability-request">European Products Availability Request</h3>

<ul class="uk-tab" data-uk-switcher="{connect:'#45c19035-6651-4828-8975-605c809a22e4'}">
<ul class="uk-tab" data-uk-switcher="{connect:'#42481e62-54f5-431f-b138-acd16bb1bb5b'}">

<li class="uk-active"><a href="#">XML</a></li>

<li><a href="#">JSON</a></li>

</ul>

<ul id="45c19035-6651-4828-8975-605c809a22e4" class="uk-switcher uk-margin">
<ul id="42481e62-54f5-431f-b138-acd16bb1bb5b" class="uk-switcher uk-margin">

<li>
<div class="language-plaintext highlighter-rouge"><div class="highlight"><pre class="highlight"><code>https://api.holidayextras.com/carpark/MUC?ABTANumber=YourABTANumber&amp;Password=YourPassword&amp;Initials=YourInitials&amp;key=YourKey&amp;token=YourToken&amp;ArrivalDate=2017-12-01&amp;ArrivalTime=1200&amp;DepartDate=2017-12-08&amp;DepartTime=1200&amp;NumberOfPax=1&amp;System=ABG&amp;lang=en
Expand All @@ -742,15 +742,15 @@ <h3 id="european-products-availability-response">European Products Availability

<p>NB: This is a shortened example compiled from a full availability response.</p>

<ul class="uk-tab" data-uk-switcher="{connect:'#977d08d6-2b23-49d6-bfe1-44f31cb43b6e'}">
<ul class="uk-tab" data-uk-switcher="{connect:'#5bf47dbb-608c-4af6-9aa7-04c98272b864'}">

<li class="uk-active"><a href="#">XML</a></li>

<li><a href="#">JSON</a></li>

</ul>

<ul id="977d08d6-2b23-49d6-bfe1-44f31cb43b6e" class="uk-switcher uk-margin">
<ul id="5bf47dbb-608c-4af6-9aa7-04c98272b864" class="uk-switcher uk-margin">

<li>
<div class="language-xml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="cp">&lt;?xml version="1.0"?&gt;</span>
Expand Down
28 changes: 14 additions & 14 deletions docs/hxapi/productlibrary/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ <h2 id="available-fields">Available Fields</h2>

<p>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.</p>

<ul class="uk-tab" data-uk-switcher="{connect:'#bef8d703-282b-4ff1-82c2-8299ebc6ac87'}">
<ul class="uk-tab" data-uk-switcher="{connect:'#8200deb5-eb80-4ea6-b599-075dbc3ba42f'}">

<li class="uk-active"><a href="#">Parking</a></li>

Expand All @@ -105,7 +105,7 @@ <h2 id="available-fields">Available Fields</h2>

</ul>

<ul id="bef8d703-282b-4ff1-82c2-8299ebc6ac87" class="uk-switcher uk-margin">
<ul id="8200deb5-eb80-4ea6-b599-075dbc3ba42f" class="uk-switcher uk-margin">

<li>
<h4 id="recommended">Recommended</h4>
Expand Down Expand Up @@ -976,7 +976,7 @@ <h3 id="example-1---default-response">Example 1 - Default Response</h3>

<h4 id="request">Request</h4>

<ul class="uk-tab" data-uk-switcher="{connect:'#d1fb8ccd-9c06-4022-bb0c-97c58285dd56'}">
<ul class="uk-tab" data-uk-switcher="{connect:'#4e7aff18-57f9-4014-9170-c683de183d06'}">

<li class="uk-active"><a href="#">Live (XML)</a></li>

Expand All @@ -988,7 +988,7 @@ <h4 id="request">Request</h4>

</ul>

<ul id="d1fb8ccd-9c06-4022-bb0c-97c58285dd56" class="uk-switcher uk-margin">
<ul id="4e7aff18-57f9-4014-9170-c683de183d06" class="uk-switcher uk-margin">

<li>
<div class="language-plaintext highlighter-rouge"><div class="highlight"><pre class="highlight"><code>https://api.holidayextras.com/v1/product/LGW4/lite?token=000015778&amp;key=mytestkey
Expand Down Expand Up @@ -1016,15 +1016,15 @@ <h4 id="request">Request</h4>

<h4 id="response">Response</h4>

<ul class="uk-tab" data-uk-switcher="{connect:'#40cbd1fe-a3bd-405c-931b-36b7740ebe09'}">
<ul class="uk-tab" data-uk-switcher="{connect:'#a5264d54-ef42-4e00-9420-8310f42da830'}">

<li class="uk-active"><a href="#">XML</a></li>

<li><a href="#">JSON</a></li>

</ul>

<ul id="40cbd1fe-a3bd-405c-931b-36b7740ebe09" class="uk-switcher uk-margin">
<ul id="a5264d54-ef42-4e00-9420-8310f42da830" class="uk-switcher uk-margin">

<li>
<div class="language-xml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="cp">&lt;?xml version="1.0"?&gt;</span>
Expand Down Expand Up @@ -1411,7 +1411,7 @@ <h3 id="example-2---restricted-field-list">Example 2 - Restricted field list</h3

<h4 id="request-1">Request</h4>

<ul class="uk-tab" data-uk-switcher="{connect:'#67b213b1-4e1d-46ae-8209-fdf5a6c9bb32'}">
<ul class="uk-tab" data-uk-switcher="{connect:'#37581616-47be-4c51-83d1-90860b25f0eb'}">

<li class="uk-active"><a href="#">Live (XML)</a></li>

Expand All @@ -1423,7 +1423,7 @@ <h4 id="request-1">Request</h4>

</ul>

<ul id="67b213b1-4e1d-46ae-8209-fdf5a6c9bb32" class="uk-switcher uk-margin">
<ul id="37581616-47be-4c51-83d1-90860b25f0eb" class="uk-switcher uk-margin">

<li>
<div class="language-plaintext highlighter-rouge"><div class="highlight"><pre class="highlight"><code>https://api.holidayextras.com/v1/product/LGW4/lite?token=000015778&amp;key=mytestkey&amp;fields=name,longitude,latitude
Expand Down Expand Up @@ -1451,15 +1451,15 @@ <h4 id="request-1">Request</h4>

<h4 id="response-1">Response</h4>

<ul class="uk-tab" data-uk-switcher="{connect:'#5e4d6897-3346-430a-8987-75922ca33e9f'}">
<ul class="uk-tab" data-uk-switcher="{connect:'#a54e0844-8903-47e1-a2be-5ff2a314a0d3'}">

<li class="uk-active"><a href="#">XML</a></li>

<li><a href="#">JSON</a></li>

</ul>

<ul id="5e4d6897-3346-430a-8987-75922ca33e9f" class="uk-switcher uk-margin">
<ul id="a54e0844-8903-47e1-a2be-5ff2a314a0d3" class="uk-switcher uk-margin">

<li>
<div class="language-xml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="cp">&lt;?xml version="1.0"?&gt;</span>
Expand Down Expand Up @@ -1520,7 +1520,7 @@ <h4 id="request-2">Request</h4>

<p>Requests for German products return a different set of fields. Explanation of fields not currently available.</p>

<ul class="uk-tab" data-uk-switcher="{connect:'#cda30bb9-d01b-4a68-beb7-30d59af915cb'}">
<ul class="uk-tab" data-uk-switcher="{connect:'#77dae101-305a-4e81-ac29-749e93f0a827'}">

<li class="uk-active"><a href="#">Live (XML)</a></li>

Expand All @@ -1532,7 +1532,7 @@ <h4 id="request-2">Request</h4>

</ul>

<ul id="cda30bb9-d01b-4a68-beb7-30d59af915cb" class="uk-switcher uk-margin">
<ul id="77dae101-305a-4e81-ac29-749e93f0a827" class="uk-switcher uk-margin">

<li>
<div class="language-plaintext highlighter-rouge"><div class="highlight"><pre class="highlight"><code>https://api.holidayextras.com/v1/product/FRA0?key=mytestkey
Expand Down Expand Up @@ -1560,15 +1560,15 @@ <h4 id="request-2">Request</h4>

<h4 id="response-2">Response</h4>

<ul class="uk-tab" data-uk-switcher="{connect:'#c0775029-29af-4f0c-9df6-d872aff7866c'}">
<ul class="uk-tab" data-uk-switcher="{connect:'#e564e0e8-3f60-4f9b-939d-745aea5dc7b8'}">

<li class="uk-active"><a href="#">XML</a></li>

<li><a href="#">JSON</a></li>

</ul>

<ul id="c0775029-29af-4f0c-9df6-d872aff7866c" class="uk-switcher uk-margin">
<ul id="e564e0e8-3f60-4f9b-939d-745aea5dc7b8" class="uk-switcher uk-margin">

<li>
<div class="language-xml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="cp">&lt;?xml version="1.0"?&gt;</span>
Expand Down
Loading