From 85588621e8af12252f8a2db6085dfe3abfb255c1 Mon Sep 17 00:00:00 2001 From: Aurore Festaud Date: Tue, 17 Mar 2026 15:00:59 +0000 Subject: [PATCH 1/6] Update v2 documentation to match schema changes - Add UUID v4 recommendation for idempotency key - Add 422 error guidance for expired tokens (product, amendment, cancellation) - Describe confirmation-details response shapes per format (json vs html/markdown) - Fix 3rd-person partner reference to use 'you' - Add Transfers to coming soon product list - Mark List Bookings as available in a later phase - Note that errors array is always present in error responses --- .../v2/api-endpoint-navigation-guide.md | 19 +++++++++++-------- site/partner/v2/problems/bad-request.md | 2 ++ 2 files changed, 13 insertions(+), 8 deletions(-) diff --git a/site/partner/v2/api-endpoint-navigation-guide.md b/site/partner/v2/api-endpoint-navigation-guide.md index 8863473b..4e1b92a9 100644 --- a/site/partner/v2/api-endpoint-navigation-guide.md +++ b/site/partner/v2/api-endpoint-navigation-guide.md @@ -37,7 +37,7 @@ This can be viewed using a tool of your choice. We recommend This endpoint will be available in a later phase. + **Endpoint:** `GET /v2/bookings/parking?partner_reference={your-reference}` **Purpose:** Find bookings using YOUR reference @@ -447,7 +450,7 @@ You have four options for handling pending bookings, depending on how much contr * Confirmation of changes * Receipt of any charges/refunds -**Important:** The amendment token works the same as the price guarantee token. +**Important:** The amendment token is short-lived, like the price guarantee token. Using an expired token will return a `422 Unprocessable Entity` error — re-request the amendment quote to get a fresh token. **Typical workflow:** @@ -502,7 +505,7 @@ You have four options for handling pending bookings, depending on how much contr * Confirmation of cancellation * Final refund amounts -**Important:** Cancellations cannot be undone. The customer would need to create a new booking. +**Important:** The cancellation token is short-lived. Using an expired token will return a `422 Unprocessable Entity` error — re-request the cancellation quote to get a fresh token. Cancellations cannot be undone; you would need to create a new booking. **Typical workflow:** diff --git a/site/partner/v2/problems/bad-request.md b/site/partner/v2/problems/bad-request.md index e2210f62..fa89889f 100644 --- a/site/partner/v2/problems/bad-request.md +++ b/site/partner/v2/problems/bad-request.md @@ -33,3 +33,5 @@ The request was malformed or missing required parameters. Check the `errors` arr ## How to resolve Review the `errors` array to identify which fields need correcting. Each error includes a `field` name and a `message` describing the validation failure. + +> **Note:** The `errors` array is always present in every error response. It will contain field-level details when applicable, or be empty (e.g., for 500 errors). From a2e32c7825c0fbaaeae39e842b90e91a2271fc73 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Tue, 17 Mar 2026 15:18:34 +0000 Subject: [PATCH 2/6] Update dist --- docs/feed.xml | 2 +- docs/hxapi/asynchronous-bookings/index.html | 8 +++--- docs/hxapi/carhire/availability/index.html | 4 +-- docs/hxapi/parking/av/airport/index.html | 20 ++++++------- docs/hxapi/productlibrary/index.html | 28 +++++++++---------- docs/hxapi/transfers/av/index.html | 24 ++++++++-------- docs/hxapi/transfers/cancel/index.html | 4 +-- .../transfers/cancellation-policy/index.html | 8 +++--- docs/hxapi/transfers/view/index.html | 4 +-- docs/hxapi/upgrade/index.html | 16 +++++------ docs/hxapi/viewamendcancel/view/index.html | 20 ++++++------- .../v2/api-endpoint-navigation-guide.md | 19 +++++++------ .../api-endpoint-navigation-guide/index.html | 21 ++++++++------ docs/partner/v2/problems/bad-request.md | 2 ++ .../v2/problems/bad-request/index.html | 4 +++ docs/search/index.html | 4 +-- 16 files changed, 101 insertions(+), 87 deletions(-) diff --git a/docs/feed.xml b/docs/feed.xml index eda83059..45ab1b1d 100644 --- a/docs/feed.xml +++ b/docs/feed.xml @@ -1,2 +1,2 @@ -Jekyll2026-03-16T10:01:34+00:00/feed.xmlHoliday Extras APIDocumentation to give to partners who would like to integrate with our API. +Jekyll2026-03-17T15:18:31+00:00/feed.xmlHoliday Extras APIDocumentation to give to partners who would like to integrate with our API. \ No newline at end of file diff --git a/docs/hxapi/asynchronous-bookings/index.html b/docs/hxapi/asynchronous-bookings/index.html index 7f8b6c52..d05a78ea 100644 --- a/docs/hxapi/asynchronous-bookings/index.html +++ b/docs/hxapi/asynchronous-bookings/index.html @@ -85,7 +85,7 @@

Availability Request

UK Products Availability Request

-
    +
    • XML
    • @@ -93,7 +93,7 @@

      UK Products Availability Request

    -
      +
      • 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 @@

            European Products Availability R

          -
            +
            • 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
              diff --git a/docs/hxapi/carhire/availability/index.html b/docs/hxapi/carhire/availability/index.html
              index 4ea5ce12..b7c3907d 100644
              --- a/docs/hxapi/carhire/availability/index.html
              +++ b/docs/hxapi/carhire/availability/index.html
              @@ -61,7 +61,7 @@ 

              Request

              Example request:

              -
                +
                • XML
                • @@ -69,7 +69,7 @@

                  Request

                -
                  +
                  • 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 8a8bdebf..fa4f67d8 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.com/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.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 @@

                                    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.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 @@

                                                  European Products Availability

                                                -
                                                  +
                                                  • <?xml version="1.0"?>
                                                    diff --git a/docs/hxapi/productlibrary/index.html b/docs/hxapi/productlibrary/index.html
                                                    index f5a5da13..e034c13f 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

                                                      -
                                                        +
                                                        • @@ -976,7 +976,7 @@

                                                          Example 1 - Default Response

                                                          Request

                                                          -
                                                            + -
                                                              +
                                                              • https://api.holidayextras.com/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

                                              -
                                                + -
                                                  +
                                                  • 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 @@

                                                        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.

                                                          -
                                                            + -
                                                              +
                                                              • https://api.holidayextras.com/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 10760616..9327b1e2 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 @@
                                                                          Request
                                                                        -
                                                                          +
                                                                          • 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 @@
                                                                                Response
                                                                              -
                                                                                +
                                                                                • <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 @@
                                                                                      Request
                                                                                    -
                                                                                      +
                                                                                      • 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 @@
                                                                                            Response
                                                                                          -
                                                                                            +
                                                                                            • <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 @@
                                                                                                  Request
                                                                                                -
                                                                                                  +
                                                                                                  • 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 @@
                                                                                                        Response
                                                                                                      -
                                                                                                        +
                                                                                                        • <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 70541bfe..caf24011 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 @@

                                                                                                              Example

                                                                                                            -
                                                                                                              +
                                                                                                              • <Booking>
                                                                                                                diff --git a/docs/hxapi/transfers/cancellation-policy/index.html b/docs/hxapi/transfers/cancellation-policy/index.html
                                                                                                                index a7c9e46f..29136d1d 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 @@

                                                                                                                    Example

                                                                                                                  -
                                                                                                                    +
                                                                                                                    • <BookingRef>TB12345</BookingRef>
                                                                                                                      @@ -187,7 +187,7 @@ 

                                                                                                                      Example

                                                                                                                      Example - Non-Cancellable Booking

                                                                                                                      -
                                                                                                                        +
                                                                                                                        • XML
                                                                                                                        • @@ -195,7 +195,7 @@

                                                                                                                          Example - Non-Cancellable Booking

                                                                                                                          -
                                                                                                                            +
                                                                                                                            • <BookingRef>TB12345</BookingRef>
                                                                                                                              diff --git a/docs/hxapi/transfers/view/index.html b/docs/hxapi/transfers/view/index.html
                                                                                                                              index 20cc6ddf..95d0dfff 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 @@

                                                                                                                                  Example

                                                                                                                                -
                                                                                                                                  +
                                                                                                                                  • <Booking>
                                                                                                                                    diff --git a/docs/hxapi/upgrade/index.html b/docs/hxapi/upgrade/index.html
                                                                                                                                    index b532ebc5..5fc59d80 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.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 @@

                                                                                                                                              Response

                                                                                                                                            -
                                                                                                                                              +
                                                                                                                                              • <?xml version="1.0"?>
                                                                                                                                                @@ -618,7 +618,7 @@ 

                                                                                                                                                Example 1 - Hotel Upgrades

                                                                                                                                                Request

                                                                                                                                                -
                                                                                                                                                  +
                                                                                                                                                  • XML
                                                                                                                                                  • @@ -626,7 +626,7 @@

                                                                                                                                                    Request

                                                                                                                                                  -
                                                                                                                                                    +
                                                                                                                                                    • 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 @@

                                                                                                                                                          Response

                                                                                                                                                        -
                                                                                                                                                          +
                                                                                                                                                          • <?xml version="1.0"?>
                                                                                                                                                            diff --git a/docs/hxapi/viewamendcancel/view/index.html b/docs/hxapi/viewamendcancel/view/index.html
                                                                                                                                                            index 8867a1db..0abd6a17 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.com/v1/booking/YourBookingRef
                                                                                                                                                                  @@ -366,7 +366,7 @@ 

                                                                                                                                                                  UK Products View Booking (for a

                                                                                                                                                                  Request

                                                                                                                                                                  -
                                                                                                                                                                    +
                                                                                                                                                                    • XML
                                                                                                                                                                    • @@ -374,7 +374,7 @@

                                                                                                                                                                      Request

                                                                                                                                                                    -
                                                                                                                                                                      +
                                                                                                                                                                      • https://api.holidayextras.com/v1/booking/YourBookingRef?ABTANumber=YourABTANumber&Password=YourPassword&Initials=YourInitials&key=YourKey&Email=test@test.com
                                                                                                                                                                        @@ -391,7 +391,7 @@ 

                                                                                                                                                                        Request

                                                                                                                                                                        Response

                                                                                                                                                                        -
                                                                                                                                                                          +
                                                                                                                                                                          • XML
                                                                                                                                                                          • @@ -399,7 +399,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.com/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/partner/v2/api-endpoint-navigation-guide.md b/docs/partner/v2/api-endpoint-navigation-guide.md
                                                                                                                                                                                          index 8863473b..4e1b92a9 100644
                                                                                                                                                                                          --- a/docs/partner/v2/api-endpoint-navigation-guide.md
                                                                                                                                                                                          +++ b/docs/partner/v2/api-endpoint-navigation-guide.md
                                                                                                                                                                                          @@ -37,7 +37,7 @@ This can be viewed using a tool of your choice. We recommend  This endpoint will be available in a later phase.
                                                                                                                                                                                          +
                                                                                                                                                                                           **Endpoint:** `GET /v2/bookings/parking?partner_reference={your-reference}`
                                                                                                                                                                                           
                                                                                                                                                                                           **Purpose:** Find bookings using YOUR reference
                                                                                                                                                                                          @@ -447,7 +450,7 @@ You have four options for handling pending bookings, depending on how much contr
                                                                                                                                                                                           * Confirmation of changes
                                                                                                                                                                                           * Receipt of any charges/refunds
                                                                                                                                                                                           
                                                                                                                                                                                          -**Important:** The amendment token works the same as the price guarantee token.
                                                                                                                                                                                          +**Important:** The amendment token is short-lived, like the price guarantee token. Using an expired token will return a `422 Unprocessable Entity` error — re-request the amendment quote to get a fresh token.
                                                                                                                                                                                           
                                                                                                                                                                                           **Typical workflow:**
                                                                                                                                                                                           
                                                                                                                                                                                          @@ -502,7 +505,7 @@ You have four options for handling pending bookings, depending on how much contr
                                                                                                                                                                                           * Confirmation of cancellation
                                                                                                                                                                                           * Final refund amounts
                                                                                                                                                                                           
                                                                                                                                                                                          -**Important:** Cancellations cannot be undone. The customer would need to create a new booking.
                                                                                                                                                                                          +**Important:** The cancellation token is short-lived. Using an expired token will return a `422 Unprocessable Entity` error — re-request the cancellation quote to get a fresh token. Cancellations cannot be undone; you would need to create a new booking.
                                                                                                                                                                                           
                                                                                                                                                                                           **Typical workflow:**
                                                                                                                                                                                           
                                                                                                                                                                                          diff --git a/docs/partner/v2/api-endpoint-navigation-guide/index.html b/docs/partner/v2/api-endpoint-navigation-guide/index.html
                                                                                                                                                                                          index 9a4f39ad..eb84b17c 100644
                                                                                                                                                                                          --- a/docs/partner/v2/api-endpoint-navigation-guide/index.html
                                                                                                                                                                                          +++ b/docs/partner/v2/api-endpoint-navigation-guide/index.html
                                                                                                                                                                                          @@ -75,7 +75,7 @@ 

                                                                                                                                                                                          API Architecture Overview

                                                                                                                                                                                          Product-Centric Design

                                                                                                                                                                                          -

                                                                                                                                                                                          The APIConnect API is built around products. Each of our five products has the same set of endpoints:

                                                                                                                                                                                          +

                                                                                                                                                                                          The APIConnect API is built around products. Each of our products has the same set of endpoints:

                                                                                                                                                                                          Available Products:

                                                                                                                                                                                          @@ -86,6 +86,7 @@

                                                                                                                                                                                          Product-Centric Design

                                                                                                                                                                                          Coming Soon

                                                                                                                                                                                            +
                                                                                                                                                                                          • Transfers - Airport transfers
                                                                                                                                                                                          • Hotels - Airport hotel accommodation
                                                                                                                                                                                          • Hotel with Parking - Integrated packages
                                                                                                                                                                                          • Lounges - Airport lounge access
                                                                                                                                                                                          • @@ -257,7 +258,7 @@
                                                                                                                                                                                          • Supplier required information
                                                                                                                                                                                          -

                                                                                                                                                                                          Important: The price guarantee token will expire. We will inform you in the API response of this duration. If the customer takes longer to book, you’ll need to search again to get a fresh token.

                                                                                                                                                                                          +

                                                                                                                                                                                          Important: The price guarantee token will expire — the expiry time is included in the response. Using an expired token will return a 422 Unprocessable Entity error. If this happens, re-run the search to get a fresh token.

                                                                                                                                                                                          Caching: DO NOT cache this response - prices and availability change frequently

                                                                                                                                                                                          @@ -337,7 +338,7 @@

                                                                                                                                                                                          Stage 4: Create Booking

                                                                                                                                                                                        • All booking details
                                                                                                                                                                                        -

                                                                                                                                                                                        Important: Always include an Idempotency-Key header to prevent duplicate bookings if there’s a network error.

                                                                                                                                                                                        +

                                                                                                                                                                                        Important: Always include an Idempotency-Key header to prevent duplicate bookings if there’s a network error. Any unique string is accepted; UUID v4 is recommended. Re-use the same key to safely retry a failed request.

                                                                                                                                                                                        Understanding Booking Status:

                                                                                                                                                                                        @@ -441,9 +442,9 @@

                                                                                                                                                                                        Stage 5: Booking Confirmation Deta

                                                                                                                                                                                        Format options:

                                                                                                                                                                                          -
                                                                                                                                                                                        • json: Structured data for your own rendering
                                                                                                                                                                                        • -
                                                                                                                                                                                        • html: Ready-to-use HTML snippet for web pages
                                                                                                                                                                                        • -
                                                                                                                                                                                        • markdown: Text-based format for simpler emails
                                                                                                                                                                                        • +
                                                                                                                                                                                        • json: Returns an array of { type, value } pairs (e.g., { "type": "booking_reference", "value": "HX123456" }). Use these fields to build your own confirmation page.
                                                                                                                                                                                        • +
                                                                                                                                                                                        • html: Returns a { text } object containing a ready-to-use HTML snippet for web pages.
                                                                                                                                                                                        • +
                                                                                                                                                                                        • markdown: Returns a { text } object containing text-based format for simpler emails.

                                                                                                                                                                                        Why use this? The formatted confirmation includes product-specific instructions. It’s optimized for customer-facing display.

                                                                                                                                                                                        @@ -478,6 +479,10 @@

                                                                                                                                                                                        Stage 6: View Booking

                                                                                                                                                                                        Stage 7: List Bookings (Alternative Lookup)

                                                                                                                                                                                        +
                                                                                                                                                                                        +

                                                                                                                                                                                        This endpoint will be available in a later phase.

                                                                                                                                                                                        +
                                                                                                                                                                                        +

                                                                                                                                                                                        Endpoint: GET /v2/bookings/parking?partner_reference={your-reference}

                                                                                                                                                                                        Purpose: Find bookings using YOUR reference

                                                                                                                                                                                        @@ -557,7 +562,7 @@

                                                                                                                                                                                        Step 2: Amend Confirm

                                                                                                                                                                                      • Receipt of any charges/refunds
                                                                                                                                                                                      -

                                                                                                                                                                                      Important: The amendment token works the same as the price guarantee token.

                                                                                                                                                                                      +

                                                                                                                                                                                      Important: The amendment token is short-lived, like the price guarantee token. Using an expired token will return a 422 Unprocessable Entity error — re-request the amendment quote to get a fresh token.

                                                                                                                                                                                      Typical workflow:

                                                                                                                                                                                      @@ -620,7 +625,7 @@

                                                                                                                                                                                      Step 2: Cancel Confirm

                                                                                                                                                                                    • Final refund amounts
                                                                                                                                                                                    -

                                                                                                                                                                                    Important: Cancellations cannot be undone. The customer would need to create a new booking.

                                                                                                                                                                                    +

                                                                                                                                                                                    Important: The cancellation token is short-lived. Using an expired token will return a 422 Unprocessable Entity error — re-request the cancellation quote to get a fresh token. Cancellations cannot be undone; you would need to create a new booking.

                                                                                                                                                                                    Typical workflow:

                                                                                                                                                                                    diff --git a/docs/partner/v2/problems/bad-request.md b/docs/partner/v2/problems/bad-request.md index e2210f62..fa89889f 100644 --- a/docs/partner/v2/problems/bad-request.md +++ b/docs/partner/v2/problems/bad-request.md @@ -33,3 +33,5 @@ The request was malformed or missing required parameters. Check the `errors` arr ## How to resolve Review the `errors` array to identify which fields need correcting. Each error includes a `field` name and a `message` describing the validation failure. + +> **Note:** The `errors` array is always present in every error response. It will contain field-level details when applicable, or be empty (e.g., for 500 errors). diff --git a/docs/partner/v2/problems/bad-request/index.html b/docs/partner/v2/problems/bad-request/index.html index 7ba7c13c..21008531 100644 --- a/docs/partner/v2/problems/bad-request/index.html +++ b/docs/partner/v2/problems/bad-request/index.html @@ -89,6 +89,10 @@

                                                                                                                                                                                    How to resolve

                                                                                                                                                                                    Review the errors array to identify which fields need correcting. Each error includes a field name and a message describing the validation failure.

                                                                                                                                                                                    +
                                                                                                                                                                                    +

                                                                                                                                                                                    Note: The errors array is always present in every error response. It will contain field-level details when applicable, or be empty (e.g., for 500 errors).

                                                                                                                                                                                    +
                                                                                                                                                                                    +
                                                                                                                                                                                    diff --git a/docs/search/index.html b/docs/search/index.html index ed58a289..dedf3b6b 100644 --- a/docs/search/index.html +++ b/docs/search/index.html @@ -536,7 +536,7 @@ "partner-v2-api-endpoint-navigation-guide": { "title": "APIConnect Partner API v2 - Understanding the OpenAPI Documentation", - "content": "# APIConnect Partner API v2 - Understanding the OpenAPI DocumentationDocument Version: 0.1 Last Updated: 2026-01-30This document is in Beta---## Purpose of This GuideThis guide helps you navigate the Swagger/OpenAPI documentation by explaining the **context** and **workflow** of the API endpoints. While Swagger shows you *what* each endpoint does, this guide explains *when* and *why* to use each endpoint, and how they work together.## OpenAPI SpecificationThe openapi schema for the API can be found at This is a live document and is expected to be updated.This can be viewed using a tool of your choice. We recommend or importing the schema into [Postman](https://www.postman.com/).---## Table of Contents1. [API Architecture Overview](#api-architecture-overview)2. [Core Concepts](#core-concepts)3. [The Customer Journey](#the-customer-journey)4. [Common Workflows](#common-workflows)---## API Architecture Overview### Product-Centric DesignThe APIConnect API is built around **products**. Each of our five products has the same set of endpoints:**Available Products:*** **Parking** - Airport car parking**Coming Soon*** **Hotels** - Airport hotel accommodation* **Hotel with Parking** - Integrated packages* **Lounges** - Airport lounge access* **FastTrack** - Priority security lanes**Endpoint Pattern:** When you see endpoints in the OpenAPI schema like:* `GET /v2/products/parking`* `GET /v2/products/hotels`* `GET /v2/products/lounges`These all follow the same pattern - just replace the product type.### The One Exception: LocationsThe **Locations** endpoint is the only endpoint that doesn't follow the product-specific pattern. It's used to discover which locations (airports) have which products available.---## Core Concepts### 1. Price Guarantee Tokens**What:** A time-limited token that locks in a price **When:** Obtained from the Products endpoint **Why:** Ensures customers aren't charged more than the quoted price **Validity:** 30 minutes **Usage:** Required for Book endpoint**Example Flow:**```1. Customer searches → Products endpoint returns price + token2. Customer sees price: £45.993. Customer books → Pass token to Book endpoint4. API validates token → Price has increased to £48.995. API only charges £45.99 (the guaranteed price)```### 2. Booking Reference vs Partner Reference**Booking Reference:*** **Format:** e.g., `HX123456`* **Source:** Generated by APIConnect* **Uniqueness:** Guaranteed unique* **Usage:** Use this for View Booking, Amend, Cancel endpoints* **Why:** This is our internal identifier that pinpoints a single booking**Partner Reference:*** **Format:** Your choice (e.g., `ORDER-12345`)* **Source:** Provided by you* **Uniqueness:** NOT guaranteed unique (up to you to manage)* **Usage:** Use this for List Bookings endpoint only* **Why:** Helps you match our bookings to your internal systems### 3. Quote and Confirm PatternFor amendments and cancellations, we use a two-step \"quote and confirm\" pattern:**Quote Step:*** Preview what will happen* Get costs/refunds calculated* Receive a token* Nothing is actioned yet**Confirm Step:*** Use the token from the quote* Actually execute the change* Booking is modified/cancelled* Customer is charged/refunded**Why this pattern?** It allows customers to see the financial impact before committing to the change.---## The Customer Journey### Stage 1: Discovery**Endpoint:** `GET /v2/locations`**Purpose:** Find out which airports have which products available**When to use:*** User hasn't selected a location yet* Building a location selector* Need to show available products by location**Response includes:*** Location types* Location codes (IATA / UNLOCODE)* Location names* Available product types at each location**Caching:** Safe to cache for 24 hours---### Stage 2: Product Search**Endpoint:** `GET /v2/products/parking`**Purpose:** Search for available products with pricing**When to use:*** Customer has selected location and dates* You need availability and pricing* This is always the first step in the booking flow**Parking-specific parameter options:**For parking products, you have flexibility in how you specify timing. You can provide **either** set of parameters:**Option 1: Explicit parking times*** `parking_entry_date_time` - When the customer will arrive at the car park* `parking_exit_date_time` - When the customer will leave the car parkUse this when you know the exact parking duration needed.**Option 2: Flight-based calculation*** `outbound_flight_number` - Departure flight number* `outbound_flight_date_time` - Departure flight time* `inbound_flight_number` - Return flight number* `inbound_flight_date_time` - Return flight timeUse this when you want the API to calculate appropriate parking times based on flight schedules. The API will automatically add buffer time for airport arrival/departure.**Important rules:*** At least one set of parameters must be provided* If both sets are provided, `parking_entry_date_time` and `parking_exit_date_time` take precedence* Flight-based calculation is useful when you're unsure how much time customers need between parking and their flight**Response includes:*** List of available products* Pricing for each product* **Price guarantee token** (important!)* Product capabilities (modifiable, cancellable, etc.)* Basic product information* Supplier required information**Important:** The price guarantee token will expire. We will inform you in the API response of this duration. If the customer takes longer to book, you'll need to search again to get a fresh token.**Caching:** DO NOT cache this response - prices and availability change frequently---### Stage 3: Content Enrichment (Optional)**Endpoint:** `GET /v2/content/parking`Examples:* `GET /v2/content/parking`**Purpose:** Get detailed product information, images, descriptions, and features**When to use:*** Customer clicks on a product to see more details* You want to show rich product information* Building a product details page**Response includes:*** Full product descriptions (multi-language)* Images and gallery* Detailed features and amenities* Location details and directions**Caching:** Safe to cache - check response headers for cache duration**Why separate from Products?** Content is large and changes less frequently. Separating it allows the Products endpoint to be fast and efficient, while Content can be cached and only fetched when needed.---### Stage 4: Create Booking**Endpoint:** `POST /v2/bookings/parking`**Purpose:** Create a booking.**When to use:*** Customer has selected a product* Customer is ready to confirm the booking**Request requires:*** **Price guarantee token** (from the search results)* Customer details* Product-specific details (see product-specific integration guide) * Parking: Vehicle details, flight info, entry/exit times * Hotels: Room requirements, arrival time, guest count * Lounges: Passenger details, flight info, visit time * FastTrack: Passenger details, flight info, travel time* Your partner reference (optional but recommended)**Response includes:*** **Booking reference** (e.g., HX123456) - Our booking reference* **Booking status** (`pending` or `confirmed`)* **Hosted confirmation page URL** - A link to our hosted confirmation page* **Recommended polling interval** (in seconds) - Suggested frequency for status checks* All booking details**Important:** Always include an `Idempotency-Key` header to prevent duplicate bookings if there's a network error.**Understanding Booking Status:****Confirmed Status:*** The booking is fully confirmed with the supplier* Show confirmation details to the customer immediately* No further action needed**Pending Status:*** We have created the booking on our side* Our supplier is still processing the confirmation on their side* The booking will transition to either `confirmed` or `error`**Handling Pending Bookings - Four Options:**You have four options for handling pending bookings, depending on how much control you want:**Option 1: Hosted Confirmation Page (Simplest)*** Use the Holiday Extras co-branded hosted confirmation page URL included in the booking response* Direct customers to this URL* We handle all status updates and display logic* The page automatically updates when the booking confirms* No polling or webhooks needed on your side**Option 2: Confirmation Endpoint (Simple)*** Use the Confirmation endpoint (Stage 5) to display booking details* The data returned is always relevant to the current status* Shows \"pending\" messaging when pending, \"confirmed\" details when confirmed* Make the same call regardless of status - we handle the logic* No need to track status transitions yourself**Option 3: Polling (More Control)*** Call the GET booking endpoint (`GET /v2/bookings/parking/{booking-reference}`) repeatedly* Use the `recommended_polling_interval` from the booking response* Check the status field in each response* Stop polling when status changes to `confirmed` or `error`* You control the customer experience during the pending period**Option 4: Webhooks (Event-Driven)*** Build an endpoint on your side matching our webhook specification* We call your endpoint when the booking status changes* Your endpoint receives notification of the status update* Then call GET booking to retrieve the latest information* Most efficient for handling status updates**Recommendation:*** Use Option 1 or 2 if you want us to handle the complexity* Use Option 3 or 4 if you need full control over the customer experience---### Stage 5: Booking Confirmation Details**Endpoint:** `GET /v2/bookings/parking/{booking-reference}/confirmation-details`**Purpose:** Get formatted confirmation details for display**When to use:*** Immediately after booking is created* Displaying a confirmation page**Query parameters:*** `format`: `json` (default), `html`, or `markdown`**Response includes:*** All booking details formatted for display* Product-specific instructions (PIN codes, meeting points, etc.)* Contact information* Important notices**Format options:*** `json`: Structured data for your own rendering* `html`: Ready-to-use HTML snippet for web pages* `markdown`: Text-based format for simpler emails**Why use this?** The formatted confirmation includes product-specific instructions. It's optimized for customer-facing display.---### Stage 6: View Booking**Endpoint:** `GET /v2/bookings/parking/{booking-reference}`**Purpose:** Retrieve a specific booking by our booking reference**When to use:*** Customer wants to view their booking* You need to check current booking status* Before allowing amendments or cancellations**Response includes:*** Complete booking details* Current status (pending, confirmed, cancelled, error)* Customer details**Important:** Use our **booking reference**, not your partner reference.---### Stage 7: List Bookings (Alternative Lookup)**Endpoint:** `GET /v2/bookings/parking?partner_reference={your-reference}`**Purpose:** Find bookings using YOUR reference**When to use:*** Customer lost our booking reference* You need to look up by your internal order ID* You need to reconcile your orders with our bookings**Response includes:*** **Array of bookings** (not a single booking)* Each booking has our booking reference* Use our booking reference for subsequent operations**Why an array?** We don't guarantee your partner reference is unique. You might reuse order IDs or have multiple bookings per order. Therefore, we always return an array, even if there's only one result.**Next step:** Display the bookings to the customer and let them select which one they want to manage, then use our booking reference for amendments/cancellations.---### Stage 8: Amend Booking (Two-Step Process)#### Step 1: Amend Quote**Endpoint:** `PATCH /v2/bookings/parking/{booking-reference}/amendments/quote`**Purpose:** Preview the amendment without executing it**When to use:*** Customer wants to change booking details* You need to show pricing impact before confirming**Response includes:*** Amendment fee (if any)* Price difference (if dates/product changed)* Total charge or refund* **Amendment token** (for the confirm step)**Nothing is changed yet** - this is just a quote.#### Step 2: Amend Confirm**Endpoint:** `POST /v2/bookings/parking/{booking-reference}/amendments/confirm`**Purpose:** Actually execute the amendment**When to use:*** Customer has seen the quote and accepted it* You're ready to charge/refund the difference**Request requires:*** **Amendment token** (from the quote response)**Response includes:*** Updated booking details* Confirmation of changes* Receipt of any charges/refunds**Important:** The amendment token works the same as the price guarantee token.**Typical workflow:**```1. Customer clicks \"Change flight details\"2. Call Amend Quote → Show \"£5 amendment fee\"3. Customer clicks \"Confirm changes\"4. Call Amend Confirm with token → Booking updated```---### Stage 9: Cancel Booking (Two-Step Process)#### Step 1: Cancel Quote**Endpoint:** `PATCH /v2/bookings/parking/{booking-reference}/cancellations/quote`**Purpose:** Preview the cancellation without executing it**When to use:*** Customer wants to cancel* You need to show refund amount before confirming**Response includes:*** Cancellation fee (if any)* Refund amount* **Cancellation token** (for the confirm step)**Nothing is cancelled yet** - this is just a quote.#### Step 2: Cancel Confirm**Endpoint:** `POST /v2/bookings/parking/{booking-reference}/cancellations/confirm`**Purpose:** Actually cancel the booking**When to use:*** Customer has seen the refund amount and confirmed* You're ready to process the cancellation**Request requires:*** **Cancellation token** (from the quote response)**Response includes:*** Confirmation of cancellation* Final refund amounts**Important:** Cancellations cannot be undone. The customer would need to create a new booking.**Typical workflow:**```1. Customer clicks \"Cancel booking\"2. Call Cancel Quote → Show \"You'll receive a £40.99 refund\"3. Customer clicks \"Confirm cancellation\"4. Call Cancel Confirm with token → Booking cancelled5. Show confirmation```---## Common Workflows### Workflow 1: Standard Booking Flow```1. GET /v2/locations → Show airport selector2. GET /v2/products/parking?location_code=LHR&... → Show available parking products with prices → Save price_guarantee_token from response3. [Optional] GET /v2/content/parking → Show detailed product information4. POST /v2/bookings/parking → Include the price_guarantee_token → Create booking5. GET /v2/bookings/parking/{booking-reference}/confirmation-details?format=html → Display confirmation to customer → Send confirmation email```### Workflow 2: Customer Wants to View Their Booking**Scenario A: Customer has our booking reference**```1. GET /v2/bookings/parking/{booking-reference} → Show booking details```**Scenario B: Customer only has your order number**```1. GET /v2/bookings/parking?partner_reference={your-ref} → Returns array of bookings2. Display list of bookings to customer3. Customer selects booking → Use our booking_reference4. GET /v2/bookings/parking/{booking-reference} → Show booking details```### Workflow 3: Customer Wants to Change Flight Details```1. GET /v2/bookings/parking/{booking-reference} → Get current booking details → Show to customer2. Customer enters new flight details3. PATCH /v2/bookings/parking/{booking-reference}/amendments/quote → Pass new flight details → Get amendment_token4. Show customer: \"Amendment fee: £5.00\" → Customer confirms5. POST /v2/bookings/parking/{booking-reference}/amendments/confirm → Include amendment_token → Booking updated6. GET /v2/bookings/parking/{booking-reference}/confirmation-details?format=html → Send updated confirmation email```### Workflow 4: Customer Wants to Cancel```1. GET /v2/bookings/parking/{booking-reference} → Get current booking details2. PATCH /v2/bookings/parking/{booking-reference}/cancellations/quote → Get cancellation_token and refund amount3. Show customer: \"You'll receive a refund of £40.99\" → Customer confirms4. POST /v2/bookings/parking/{booking-reference}/cancellations/confirm → Include cancellation_token → Booking cancelled5. Show confirmation: \"Booking cancelled.\"```", + "content": "# APIConnect Partner API v2 - Understanding the OpenAPI DocumentationDocument Version: 0.1 Last Updated: 2026-01-30This document is in Beta---## Purpose of This GuideThis guide helps you navigate the Swagger/OpenAPI documentation by explaining the **context** and **workflow** of the API endpoints. While Swagger shows you *what* each endpoint does, this guide explains *when* and *why* to use each endpoint, and how they work together.## OpenAPI SpecificationThe openapi schema for the API can be found at This is a live document and is expected to be updated.This can be viewed using a tool of your choice. We recommend or importing the schema into [Postman](https://www.postman.com/).---## Table of Contents1. [API Architecture Overview](#api-architecture-overview)2. [Core Concepts](#core-concepts)3. [The Customer Journey](#the-customer-journey)4. [Common Workflows](#common-workflows)---## API Architecture Overview### Product-Centric DesignThe APIConnect API is built around **products**. Each of our products has the same set of endpoints:**Available Products:*** **Parking** - Airport car parking**Coming Soon*** **Transfers** - Airport transfers* **Hotels** - Airport hotel accommodation* **Hotel with Parking** - Integrated packages* **Lounges** - Airport lounge access* **FastTrack** - Priority security lanes**Endpoint Pattern:** When you see endpoints in the OpenAPI schema like:* `GET /v2/products/parking`* `GET /v2/products/hotels`* `GET /v2/products/lounges`These all follow the same pattern - just replace the product type.### The One Exception: LocationsThe **Locations** endpoint is the only endpoint that doesn't follow the product-specific pattern. It's used to discover which locations (airports) have which products available.---## Core Concepts### 1. Price Guarantee Tokens**What:** A time-limited token that locks in a price **When:** Obtained from the Products endpoint **Why:** Ensures customers aren't charged more than the quoted price **Validity:** 30 minutes **Usage:** Required for Book endpoint**Example Flow:**```1. Customer searches → Products endpoint returns price + token2. Customer sees price: £45.993. Customer books → Pass token to Book endpoint4. API validates token → Price has increased to £48.995. API only charges £45.99 (the guaranteed price)```### 2. Booking Reference vs Partner Reference**Booking Reference:*** **Format:** e.g., `HX123456`* **Source:** Generated by APIConnect* **Uniqueness:** Guaranteed unique* **Usage:** Use this for View Booking, Amend, Cancel endpoints* **Why:** This is our internal identifier that pinpoints a single booking**Partner Reference:*** **Format:** Your choice (e.g., `ORDER-12345`)* **Source:** Provided by you* **Uniqueness:** NOT guaranteed unique (up to you to manage)* **Usage:** Use this for List Bookings endpoint only* **Why:** Helps you match our bookings to your internal systems### 3. Quote and Confirm PatternFor amendments and cancellations, we use a two-step \"quote and confirm\" pattern:**Quote Step:*** Preview what will happen* Get costs/refunds calculated* Receive a token* Nothing is actioned yet**Confirm Step:*** Use the token from the quote* Actually execute the change* Booking is modified/cancelled* Customer is charged/refunded**Why this pattern?** It allows customers to see the financial impact before committing to the change.---## The Customer Journey### Stage 1: Discovery**Endpoint:** `GET /v2/locations`**Purpose:** Find out which airports have which products available**When to use:*** User hasn't selected a location yet* Building a location selector* Need to show available products by location**Response includes:*** Location types* Location codes (IATA / UNLOCODE)* Location names* Available product types at each location**Caching:** Safe to cache for 24 hours---### Stage 2: Product Search**Endpoint:** `GET /v2/products/parking`**Purpose:** Search for available products with pricing**When to use:*** Customer has selected location and dates* You need availability and pricing* This is always the first step in the booking flow**Parking-specific parameter options:**For parking products, you have flexibility in how you specify timing. You can provide **either** set of parameters:**Option 1: Explicit parking times*** `parking_entry_date_time` - When the customer will arrive at the car park* `parking_exit_date_time` - When the customer will leave the car parkUse this when you know the exact parking duration needed.**Option 2: Flight-based calculation*** `outbound_flight_number` - Departure flight number* `outbound_flight_date_time` - Departure flight time* `inbound_flight_number` - Return flight number* `inbound_flight_date_time` - Return flight timeUse this when you want the API to calculate appropriate parking times based on flight schedules. The API will automatically add buffer time for airport arrival/departure.**Important rules:*** At least one set of parameters must be provided* If both sets are provided, `parking_entry_date_time` and `parking_exit_date_time` take precedence* Flight-based calculation is useful when you're unsure how much time customers need between parking and their flight**Response includes:*** List of available products* Pricing for each product* **Price guarantee token** (important!)* Product capabilities (modifiable, cancellable, etc.)* Basic product information* Supplier required information**Important:** The price guarantee token will expire — the expiry time is included in the response. Using an expired token will return a `422 Unprocessable Entity` error. If this happens, re-run the search to get a fresh token.**Caching:** DO NOT cache this response - prices and availability change frequently---### Stage 3: Content Enrichment (Optional)**Endpoint:** `GET /v2/content/parking`Examples:* `GET /v2/content/parking`**Purpose:** Get detailed product information, images, descriptions, and features**When to use:*** Customer clicks on a product to see more details* You want to show rich product information* Building a product details page**Response includes:*** Full product descriptions (multi-language)* Images and gallery* Detailed features and amenities* Location details and directions**Caching:** Safe to cache - check response headers for cache duration**Why separate from Products?** Content is large and changes less frequently. Separating it allows the Products endpoint to be fast and efficient, while Content can be cached and only fetched when needed.---### Stage 4: Create Booking**Endpoint:** `POST /v2/bookings/parking`**Purpose:** Create a booking.**When to use:*** Customer has selected a product* Customer is ready to confirm the booking**Request requires:*** **Price guarantee token** (from the search results)* Customer details* Product-specific details (see product-specific integration guide) * Parking: Vehicle details, flight info, entry/exit times * Hotels: Room requirements, arrival time, guest count * Lounges: Passenger details, flight info, visit time * FastTrack: Passenger details, flight info, travel time* Your partner reference (optional but recommended)**Response includes:*** **Booking reference** (e.g., HX123456) - Our booking reference* **Booking status** (`pending` or `confirmed`)* **Hosted confirmation page URL** - A link to our hosted confirmation page* **Recommended polling interval** (in seconds) - Suggested frequency for status checks* All booking details**Important:** Always include an `Idempotency-Key` header to prevent duplicate bookings if there's a network error. Any unique string is accepted; UUID v4 is recommended. Re-use the same key to safely retry a failed request.**Understanding Booking Status:****Confirmed Status:*** The booking is fully confirmed with the supplier* Show confirmation details to the customer immediately* No further action needed**Pending Status:*** We have created the booking on our side* Our supplier is still processing the confirmation on their side* The booking will transition to either `confirmed` or `error`**Handling Pending Bookings - Four Options:**You have four options for handling pending bookings, depending on how much control you want:**Option 1: Hosted Confirmation Page (Simplest)*** Use the Holiday Extras co-branded hosted confirmation page URL included in the booking response* Direct customers to this URL* We handle all status updates and display logic* The page automatically updates when the booking confirms* No polling or webhooks needed on your side**Option 2: Confirmation Endpoint (Simple)*** Use the Confirmation endpoint (Stage 5) to display booking details* The data returned is always relevant to the current status* Shows \"pending\" messaging when pending, \"confirmed\" details when confirmed* Make the same call regardless of status - we handle the logic* No need to track status transitions yourself**Option 3: Polling (More Control)*** Call the GET booking endpoint (`GET /v2/bookings/parking/{booking-reference}`) repeatedly* Use the `recommended_polling_interval` from the booking response* Check the status field in each response* Stop polling when status changes to `confirmed` or `error`* You control the customer experience during the pending period**Option 4: Webhooks (Event-Driven)*** Build an endpoint on your side matching our webhook specification* We call your endpoint when the booking status changes* Your endpoint receives notification of the status update* Then call GET booking to retrieve the latest information* Most efficient for handling status updates**Recommendation:*** Use Option 1 or 2 if you want us to handle the complexity* Use Option 3 or 4 if you need full control over the customer experience---### Stage 5: Booking Confirmation Details**Endpoint:** `GET /v2/bookings/parking/{booking-reference}/confirmation-details`**Purpose:** Get formatted confirmation details for display**When to use:*** Immediately after booking is created* Displaying a confirmation page**Query parameters:*** `format`: `json` (default), `html`, or `markdown`**Response includes:*** All booking details formatted for display* Product-specific instructions (PIN codes, meeting points, etc.)* Contact information* Important notices**Format options:*** `json`: Returns an array of `{ type, value }` pairs (e.g., `{ \"type\": \"booking_reference\", \"value\": \"HX123456\" }`). Use these fields to build your own confirmation page.* `html`: Returns a `{ text }` object containing a ready-to-use HTML snippet for web pages.* `markdown`: Returns a `{ text }` object containing text-based format for simpler emails.**Why use this?** The formatted confirmation includes product-specific instructions. It's optimized for customer-facing display.---### Stage 6: View Booking**Endpoint:** `GET /v2/bookings/parking/{booking-reference}`**Purpose:** Retrieve a specific booking by our booking reference**When to use:*** Customer wants to view their booking* You need to check current booking status* Before allowing amendments or cancellations**Response includes:*** Complete booking details* Current status (pending, confirmed, cancelled, error)* Customer details**Important:** Use our **booking reference**, not your partner reference.---### Stage 7: List Bookings (Alternative Lookup)> This endpoint will be available in a later phase.**Endpoint:** `GET /v2/bookings/parking?partner_reference={your-reference}`**Purpose:** Find bookings using YOUR reference**When to use:*** Customer lost our booking reference* You need to look up by your internal order ID* You need to reconcile your orders with our bookings**Response includes:*** **Array of bookings** (not a single booking)* Each booking has our booking reference* Use our booking reference for subsequent operations**Why an array?** We don't guarantee your partner reference is unique. You might reuse order IDs or have multiple bookings per order. Therefore, we always return an array, even if there's only one result.**Next step:** Display the bookings to the customer and let them select which one they want to manage, then use our booking reference for amendments/cancellations.---### Stage 8: Amend Booking (Two-Step Process)#### Step 1: Amend Quote**Endpoint:** `PATCH /v2/bookings/parking/{booking-reference}/amendments/quote`**Purpose:** Preview the amendment without executing it**When to use:*** Customer wants to change booking details* You need to show pricing impact before confirming**Response includes:*** Amendment fee (if any)* Price difference (if dates/product changed)* Total charge or refund* **Amendment token** (for the confirm step)**Nothing is changed yet** - this is just a quote.#### Step 2: Amend Confirm**Endpoint:** `POST /v2/bookings/parking/{booking-reference}/amendments/confirm`**Purpose:** Actually execute the amendment**When to use:*** Customer has seen the quote and accepted it* You're ready to charge/refund the difference**Request requires:*** **Amendment token** (from the quote response)**Response includes:*** Updated booking details* Confirmation of changes* Receipt of any charges/refunds**Important:** The amendment token is short-lived, like the price guarantee token. Using an expired token will return a `422 Unprocessable Entity` error — re-request the amendment quote to get a fresh token.**Typical workflow:**```1. Customer clicks \"Change flight details\"2. Call Amend Quote → Show \"£5 amendment fee\"3. Customer clicks \"Confirm changes\"4. Call Amend Confirm with token → Booking updated```---### Stage 9: Cancel Booking (Two-Step Process)#### Step 1: Cancel Quote**Endpoint:** `PATCH /v2/bookings/parking/{booking-reference}/cancellations/quote`**Purpose:** Preview the cancellation without executing it**When to use:*** Customer wants to cancel* You need to show refund amount before confirming**Response includes:*** Cancellation fee (if any)* Refund amount* **Cancellation token** (for the confirm step)**Nothing is cancelled yet** - this is just a quote.#### Step 2: Cancel Confirm**Endpoint:** `POST /v2/bookings/parking/{booking-reference}/cancellations/confirm`**Purpose:** Actually cancel the booking**When to use:*** Customer has seen the refund amount and confirmed* You're ready to process the cancellation**Request requires:*** **Cancellation token** (from the quote response)**Response includes:*** Confirmation of cancellation* Final refund amounts**Important:** The cancellation token is short-lived. Using an expired token will return a `422 Unprocessable Entity` error — re-request the cancellation quote to get a fresh token. Cancellations cannot be undone; you would need to create a new booking.**Typical workflow:**```1. Customer clicks \"Cancel booking\"2. Call Cancel Quote → Show \"You'll receive a £40.99 refund\"3. Customer clicks \"Confirm cancellation\"4. Call Cancel Confirm with token → Booking cancelled5. Show confirmation```---## Common Workflows### Workflow 1: Standard Booking Flow```1. GET /v2/locations → Show airport selector2. GET /v2/products/parking?location_code=LHR&... → Show available parking products with prices → Save price_guarantee_token from response3. [Optional] GET /v2/content/parking → Show detailed product information4. POST /v2/bookings/parking → Include the price_guarantee_token → Create booking5. GET /v2/bookings/parking/{booking-reference}/confirmation-details?format=html → Display confirmation to customer → Send confirmation email```### Workflow 2: Customer Wants to View Their Booking**Scenario A: Customer has our booking reference**```1. GET /v2/bookings/parking/{booking-reference} → Show booking details```**Scenario B: Customer only has your order number**```1. GET /v2/bookings/parking?partner_reference={your-ref} → Returns array of bookings2. Display list of bookings to customer3. Customer selects booking → Use our booking_reference4. GET /v2/bookings/parking/{booking-reference} → Show booking details```### Workflow 3: Customer Wants to Change Flight Details```1. GET /v2/bookings/parking/{booking-reference} → Get current booking details → Show to customer2. Customer enters new flight details3. PATCH /v2/bookings/parking/{booking-reference}/amendments/quote → Pass new flight details → Get amendment_token4. Show customer: \"Amendment fee: £5.00\" → Customer confirms5. POST /v2/bookings/parking/{booking-reference}/amendments/confirm → Include amendment_token → Booking updated6. GET /v2/bookings/parking/{booking-reference}/confirmation-details?format=html → Send updated confirmation email```### Workflow 4: Customer Wants to Cancel```1. GET /v2/bookings/parking/{booking-reference} → Get current booking details2. PATCH /v2/bookings/parking/{booking-reference}/cancellations/quote → Get cancellation_token and refund amount3. Show customer: \"You'll receive a refund of £40.99\" → Customer confirms4. POST /v2/bookings/parking/{booking-reference}/cancellations/confirm → Include cancellation_token → Booking cancelled5. Show confirmation: \"Booking cancelled.\"```", "url": "/partner/v2/api-endpoint-navigation-guide/" } , @@ -564,7 +564,7 @@ "partner-v2-problems-bad-request": { "title": "Bad Request", - "content": "# Bad Request| Field | Value ||-------|-------|| **Status** | 400 || **Code** | `bad_request` |The request was malformed or missing required parameters. Check the `errors` array for details on which fields failed validation.## Common causes- Missing required query parameters (e.g. `location_code`, `currency`)- Invalid parameter format (e.g. non-ISO datetime, invalid IATA code)- Missing or malformed request body on POST/PATCH endpoints## Example response```json{ \"type\": \"https://docs.holidayextras.co.uk/partner/v2/problems/bad-request\", \"title\": \"Bad Request\", \"status\": 400, \"code\": \"bad_request\", \"errors\": [ { \"field\": \"location_code\", \"message\": \"must match pattern \\\"^[A-Z]{3}$\\\"\" } ]}```## How to resolveReview the `errors` array to identify which fields need correcting. Each error includes a `field` name and a `message` describing the validation failure.", + "content": "# Bad Request| Field | Value ||-------|-------|| **Status** | 400 || **Code** | `bad_request` |The request was malformed or missing required parameters. Check the `errors` array for details on which fields failed validation.## Common causes- Missing required query parameters (e.g. `location_code`, `currency`)- Invalid parameter format (e.g. non-ISO datetime, invalid IATA code)- Missing or malformed request body on POST/PATCH endpoints## Example response```json{ \"type\": \"https://docs.holidayextras.co.uk/partner/v2/problems/bad-request\", \"title\": \"Bad Request\", \"status\": 400, \"code\": \"bad_request\", \"errors\": [ { \"field\": \"location_code\", \"message\": \"must match pattern \\\"^[A-Z]{3}$\\\"\" } ]}```## How to resolveReview the `errors` array to identify which fields need correcting. Each error includes a `field` name and a `message` describing the validation failure.> **Note:** The `errors` array is always present in every error response. It will contain field-level details when applicable, or be empty (e.g., for 500 errors).", "url": "/partner/v2/problems/bad-request/" } , From af6828b8c2df2ddadd644453412d12fd6d4cfb9d Mon Sep 17 00:00:00 2001 From: Aurore Festaud Date: Wed, 18 Mar 2026 14:00:20 +0000 Subject: [PATCH 3/6] Update document title and version date Rename to 'APIConnect (Partner API 2026)' and bump version to 0.2. --- site/partner/v2/api-endpoint-navigation-guide.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/site/partner/v2/api-endpoint-navigation-guide.md b/site/partner/v2/api-endpoint-navigation-guide.md index 4e1b92a9..245b72ec 100644 --- a/site/partner/v2/api-endpoint-navigation-guide.md +++ b/site/partner/v2/api-endpoint-navigation-guide.md @@ -1,6 +1,6 @@ -# APIConnect Partner API v2 - Understanding the OpenAPI Documentation +# APIConnect (Partner API 2026) - Understanding the OpenAPI Documentation -Document Version: 0.1 Last Updated: 2026-01-30 +Document Version: 0.2 Last Updated: 2026-03-18 This document is in Beta From 5aebf2b8c05f852f9fb6baf5fceb1bbfc12643e5 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Wed, 18 Mar 2026 14:03:45 +0000 Subject: [PATCH 4/6] Update dist --- docs/feed.xml | 2 +- docs/hxapi/asynchronous-bookings/index.html | 8 +++--- docs/hxapi/carhire/availability/index.html | 4 +-- docs/hxapi/parking/av/airport/index.html | 20 ++++++------- docs/hxapi/productlibrary/index.html | 28 +++++++++---------- docs/hxapi/transfers/av/index.html | 24 ++++++++-------- docs/hxapi/transfers/cancel/index.html | 4 +-- .../transfers/cancellation-policy/index.html | 8 +++--- docs/hxapi/transfers/view/index.html | 4 +-- docs/hxapi/upgrade/index.html | 16 +++++------ docs/hxapi/viewamendcancel/view/index.html | 20 ++++++------- .../v2/api-endpoint-navigation-guide.md | 4 +-- .../api-endpoint-navigation-guide/index.html | 4 +-- docs/search/index.html | 4 +-- 14 files changed, 75 insertions(+), 75 deletions(-) diff --git a/docs/feed.xml b/docs/feed.xml index 45ab1b1d..d2a51e2c 100644 --- a/docs/feed.xml +++ b/docs/feed.xml @@ -1,2 +1,2 @@ -Jekyll2026-03-17T15:18:31+00:00/feed.xmlHoliday Extras APIDocumentation to give to partners who would like to integrate with our API. +Jekyll2026-03-18T14:03:42+00:00/feed.xmlHoliday Extras APIDocumentation to give to partners who would like to integrate with our API. \ No newline at end of file diff --git a/docs/hxapi/asynchronous-bookings/index.html b/docs/hxapi/asynchronous-bookings/index.html index d05a78ea..7a2ccc3e 100644 --- a/docs/hxapi/asynchronous-bookings/index.html +++ b/docs/hxapi/asynchronous-bookings/index.html @@ -85,7 +85,7 @@

                                                                                                                                                                                    Availability Request

                                                                                                                                                                                    UK Products Availability Request

                                                                                                                                                                                    -
                                                                                                                                                                                      +
                                                                                                                                                                                      • XML
                                                                                                                                                                                      • @@ -93,7 +93,7 @@

                                                                                                                                                                                        UK Products Availability Request

                                                                                                                                                                                      -
                                                                                                                                                                                        +
                                                                                                                                                                                        • 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 @@

                                                                                                                                                                                              European Products Availability R

                                                                                                                                                                                            -
                                                                                                                                                                                              +
                                                                                                                                                                                              • 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
                                                                                                                                                                                                diff --git a/docs/hxapi/carhire/availability/index.html b/docs/hxapi/carhire/availability/index.html
                                                                                                                                                                                                index b7c3907d..f53f5b38 100644
                                                                                                                                                                                                --- a/docs/hxapi/carhire/availability/index.html
                                                                                                                                                                                                +++ b/docs/hxapi/carhire/availability/index.html
                                                                                                                                                                                                @@ -61,7 +61,7 @@ 

                                                                                                                                                                                                Request

                                                                                                                                                                                                Example request:

                                                                                                                                                                                                -
                                                                                                                                                                                                  +
                                                                                                                                                                                                  • XML
                                                                                                                                                                                                  • @@ -69,7 +69,7 @@

                                                                                                                                                                                                    Request

                                                                                                                                                                                                  -
                                                                                                                                                                                                    +
                                                                                                                                                                                                    • 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 fa4f67d8..befa701f 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.com/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.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 @@

                                                                                                                                                                                                                      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.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 @@

                                                                                                                                                                                                                                    European Products Availability

                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    • <?xml version="1.0"?>
                                                                                                                                                                                                                                      diff --git a/docs/hxapi/productlibrary/index.html b/docs/hxapi/productlibrary/index.html
                                                                                                                                                                                                                                      index e034c13f..cea25005 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

                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          • @@ -976,7 +976,7 @@

                                                                                                                                                                                                                                            Example 1 - Default Response

                                                                                                                                                                                                                                            Request

                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                              + -
                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                • https://api.holidayextras.com/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

                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                  + -
                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    • 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 @@

                                                                                                                                                                                                                                          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.

                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                              + -
                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                • https://api.holidayextras.com/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 9327b1e2..51ad7586 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 @@
                                                                                                                                                                                                                                                            Request
                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            • 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 @@
                                                                                                                                                                                                                                                                  Response
                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  • <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 @@
                                                                                                                                                                                                                                                                        Request
                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                        • 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 @@
                                                                                                                                                                                                                                                                              Response
                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                              • <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 @@
                                                                                                                                                                                                                                                                                    Request
                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    • 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 @@
                                                                                                                                                                                                                                                                                          Response
                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          • <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 caf24011..53193e0c 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 @@

                                                                                                                                                                                                                                                                                                Example

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                • <Booking>
                                                                                                                                                                                                                                                                                                  diff --git a/docs/hxapi/transfers/cancellation-policy/index.html b/docs/hxapi/transfers/cancellation-policy/index.html
                                                                                                                                                                                                                                                                                                  index 29136d1d..269857a9 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 @@

                                                                                                                                                                                                                                                                                                      Example

                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      • <BookingRef>TB12345</BookingRef>
                                                                                                                                                                                                                                                                                                        @@ -187,7 +187,7 @@ 

                                                                                                                                                                                                                                                                                                        Example

                                                                                                                                                                                                                                                                                                        Example - Non-Cancellable Booking

                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          • XML
                                                                                                                                                                                                                                                                                                          • @@ -195,7 +195,7 @@

                                                                                                                                                                                                                                                                                                            Example - Non-Cancellable Booking

                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                              • <BookingRef>TB12345</BookingRef>
                                                                                                                                                                                                                                                                                                                diff --git a/docs/hxapi/transfers/view/index.html b/docs/hxapi/transfers/view/index.html
                                                                                                                                                                                                                                                                                                                index 95d0dfff..9b42364a 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 @@

                                                                                                                                                                                                                                                                                                                    Example

                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                    • <Booking>
                                                                                                                                                                                                                                                                                                                      diff --git a/docs/hxapi/upgrade/index.html b/docs/hxapi/upgrade/index.html
                                                                                                                                                                                                                                                                                                                      index 5fc59d80..cf5e5d92 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.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 @@

                                                                                                                                                                                                                                                                                                                                Response

                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                • <?xml version="1.0"?>
                                                                                                                                                                                                                                                                                                                                  @@ -618,7 +618,7 @@ 

                                                                                                                                                                                                                                                                                                                                  Example 1 - Hotel Upgrades

                                                                                                                                                                                                                                                                                                                                  Request

                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    • XML
                                                                                                                                                                                                                                                                                                                                    • @@ -626,7 +626,7 @@

                                                                                                                                                                                                                                                                                                                                      Request

                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      • 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 @@

                                                                                                                                                                                                                                                                                                                                            Response

                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            • <?xml version="1.0"?>
                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/hxapi/viewamendcancel/view/index.html b/docs/hxapi/viewamendcancel/view/index.html
                                                                                                                                                                                                                                                                                                                                              index 0abd6a17..2ad73660 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.com/v1/booking/YourBookingRef
                                                                                                                                                                                                                                                                                                                                                    @@ -366,7 +366,7 @@ 

                                                                                                                                                                                                                                                                                                                                                    UK Products View Booking (for a

                                                                                                                                                                                                                                                                                                                                                    Request

                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      • XML
                                                                                                                                                                                                                                                                                                                                                      • @@ -374,7 +374,7 @@

                                                                                                                                                                                                                                                                                                                                                        Request

                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        • https://api.holidayextras.com/v1/booking/YourBookingRef?ABTANumber=YourABTANumber&Password=YourPassword&Initials=YourInitials&key=YourKey&Email=test@test.com
                                                                                                                                                                                                                                                                                                                                                          @@ -391,7 +391,7 @@ 

                                                                                                                                                                                                                                                                                                                                                          Request

                                                                                                                                                                                                                                                                                                                                                          Response

                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                            • XML
                                                                                                                                                                                                                                                                                                                                                            • @@ -399,7 +399,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.com/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/partner/v2/api-endpoint-navigation-guide.md b/docs/partner/v2/api-endpoint-navigation-guide.md
                                                                                                                                                                                                                                                                                                                                                                            index 4e1b92a9..245b72ec 100644
                                                                                                                                                                                                                                                                                                                                                                            --- a/docs/partner/v2/api-endpoint-navigation-guide.md
                                                                                                                                                                                                                                                                                                                                                                            +++ b/docs/partner/v2/api-endpoint-navigation-guide.md
                                                                                                                                                                                                                                                                                                                                                                            @@ -1,6 +1,6 @@
                                                                                                                                                                                                                                                                                                                                                                            -# APIConnect Partner API v2 - Understanding the OpenAPI Documentation
                                                                                                                                                                                                                                                                                                                                                                            +# APIConnect (Partner API 2026) - Understanding the OpenAPI Documentation
                                                                                                                                                                                                                                                                                                                                                                             
                                                                                                                                                                                                                                                                                                                                                                            -Document Version: 0.1 Last Updated: 2026-01-30
                                                                                                                                                                                                                                                                                                                                                                            +Document Version: 0.2 Last Updated: 2026-03-18
                                                                                                                                                                                                                                                                                                                                                                             
                                                                                                                                                                                                                                                                                                                                                                             This document is in Beta
                                                                                                                                                                                                                                                                                                                                                                             
                                                                                                                                                                                                                                                                                                                                                                            diff --git a/docs/partner/v2/api-endpoint-navigation-guide/index.html b/docs/partner/v2/api-endpoint-navigation-guide/index.html
                                                                                                                                                                                                                                                                                                                                                                            index eb84b17c..cb136d4b 100644
                                                                                                                                                                                                                                                                                                                                                                            --- a/docs/partner/v2/api-endpoint-navigation-guide/index.html
                                                                                                                                                                                                                                                                                                                                                                            +++ b/docs/partner/v2/api-endpoint-navigation-guide/index.html
                                                                                                                                                                                                                                                                                                                                                                            @@ -38,9 +38,9 @@
                                                                                                                                                                                                                                                                                                                                                                                 
                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                            APIConnect Partner API v2 - Understanding the OpenAPI Documentation

                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                            APIConnect (Partner API 2026) - Understanding the OpenAPI Documentation

                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                            Document Version: 0.1 Last Updated: 2026-01-30

                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                            Document Version: 0.2 Last Updated: 2026-03-18

                                                                                                                                                                                                                                                                                                                                                                            This document is in Beta

                                                                                                                                                                                                                                                                                                                                                                            diff --git a/docs/search/index.html b/docs/search/index.html index dedf3b6b..86d03831 100644 --- a/docs/search/index.html +++ b/docs/search/index.html @@ -535,8 +535,8 @@ , "partner-v2-api-endpoint-navigation-guide": { - "title": "APIConnect Partner API v2 - Understanding the OpenAPI Documentation", - "content": "# APIConnect Partner API v2 - Understanding the OpenAPI DocumentationDocument Version: 0.1 Last Updated: 2026-01-30This document is in Beta---## Purpose of This GuideThis guide helps you navigate the Swagger/OpenAPI documentation by explaining the **context** and **workflow** of the API endpoints. While Swagger shows you *what* each endpoint does, this guide explains *when* and *why* to use each endpoint, and how they work together.## OpenAPI SpecificationThe openapi schema for the API can be found at This is a live document and is expected to be updated.This can be viewed using a tool of your choice. We recommend or importing the schema into [Postman](https://www.postman.com/).---## Table of Contents1. [API Architecture Overview](#api-architecture-overview)2. [Core Concepts](#core-concepts)3. [The Customer Journey](#the-customer-journey)4. [Common Workflows](#common-workflows)---## API Architecture Overview### Product-Centric DesignThe APIConnect API is built around **products**. Each of our products has the same set of endpoints:**Available Products:*** **Parking** - Airport car parking**Coming Soon*** **Transfers** - Airport transfers* **Hotels** - Airport hotel accommodation* **Hotel with Parking** - Integrated packages* **Lounges** - Airport lounge access* **FastTrack** - Priority security lanes**Endpoint Pattern:** When you see endpoints in the OpenAPI schema like:* `GET /v2/products/parking`* `GET /v2/products/hotels`* `GET /v2/products/lounges`These all follow the same pattern - just replace the product type.### The One Exception: LocationsThe **Locations** endpoint is the only endpoint that doesn't follow the product-specific pattern. It's used to discover which locations (airports) have which products available.---## Core Concepts### 1. Price Guarantee Tokens**What:** A time-limited token that locks in a price **When:** Obtained from the Products endpoint **Why:** Ensures customers aren't charged more than the quoted price **Validity:** 30 minutes **Usage:** Required for Book endpoint**Example Flow:**```1. Customer searches → Products endpoint returns price + token2. Customer sees price: £45.993. Customer books → Pass token to Book endpoint4. API validates token → Price has increased to £48.995. API only charges £45.99 (the guaranteed price)```### 2. Booking Reference vs Partner Reference**Booking Reference:*** **Format:** e.g., `HX123456`* **Source:** Generated by APIConnect* **Uniqueness:** Guaranteed unique* **Usage:** Use this for View Booking, Amend, Cancel endpoints* **Why:** This is our internal identifier that pinpoints a single booking**Partner Reference:*** **Format:** Your choice (e.g., `ORDER-12345`)* **Source:** Provided by you* **Uniqueness:** NOT guaranteed unique (up to you to manage)* **Usage:** Use this for List Bookings endpoint only* **Why:** Helps you match our bookings to your internal systems### 3. Quote and Confirm PatternFor amendments and cancellations, we use a two-step \"quote and confirm\" pattern:**Quote Step:*** Preview what will happen* Get costs/refunds calculated* Receive a token* Nothing is actioned yet**Confirm Step:*** Use the token from the quote* Actually execute the change* Booking is modified/cancelled* Customer is charged/refunded**Why this pattern?** It allows customers to see the financial impact before committing to the change.---## The Customer Journey### Stage 1: Discovery**Endpoint:** `GET /v2/locations`**Purpose:** Find out which airports have which products available**When to use:*** User hasn't selected a location yet* Building a location selector* Need to show available products by location**Response includes:*** Location types* Location codes (IATA / UNLOCODE)* Location names* Available product types at each location**Caching:** Safe to cache for 24 hours---### Stage 2: Product Search**Endpoint:** `GET /v2/products/parking`**Purpose:** Search for available products with pricing**When to use:*** Customer has selected location and dates* You need availability and pricing* This is always the first step in the booking flow**Parking-specific parameter options:**For parking products, you have flexibility in how you specify timing. You can provide **either** set of parameters:**Option 1: Explicit parking times*** `parking_entry_date_time` - When the customer will arrive at the car park* `parking_exit_date_time` - When the customer will leave the car parkUse this when you know the exact parking duration needed.**Option 2: Flight-based calculation*** `outbound_flight_number` - Departure flight number* `outbound_flight_date_time` - Departure flight time* `inbound_flight_number` - Return flight number* `inbound_flight_date_time` - Return flight timeUse this when you want the API to calculate appropriate parking times based on flight schedules. The API will automatically add buffer time for airport arrival/departure.**Important rules:*** At least one set of parameters must be provided* If both sets are provided, `parking_entry_date_time` and `parking_exit_date_time` take precedence* Flight-based calculation is useful when you're unsure how much time customers need between parking and their flight**Response includes:*** List of available products* Pricing for each product* **Price guarantee token** (important!)* Product capabilities (modifiable, cancellable, etc.)* Basic product information* Supplier required information**Important:** The price guarantee token will expire — the expiry time is included in the response. Using an expired token will return a `422 Unprocessable Entity` error. If this happens, re-run the search to get a fresh token.**Caching:** DO NOT cache this response - prices and availability change frequently---### Stage 3: Content Enrichment (Optional)**Endpoint:** `GET /v2/content/parking`Examples:* `GET /v2/content/parking`**Purpose:** Get detailed product information, images, descriptions, and features**When to use:*** Customer clicks on a product to see more details* You want to show rich product information* Building a product details page**Response includes:*** Full product descriptions (multi-language)* Images and gallery* Detailed features and amenities* Location details and directions**Caching:** Safe to cache - check response headers for cache duration**Why separate from Products?** Content is large and changes less frequently. Separating it allows the Products endpoint to be fast and efficient, while Content can be cached and only fetched when needed.---### Stage 4: Create Booking**Endpoint:** `POST /v2/bookings/parking`**Purpose:** Create a booking.**When to use:*** Customer has selected a product* Customer is ready to confirm the booking**Request requires:*** **Price guarantee token** (from the search results)* Customer details* Product-specific details (see product-specific integration guide) * Parking: Vehicle details, flight info, entry/exit times * Hotels: Room requirements, arrival time, guest count * Lounges: Passenger details, flight info, visit time * FastTrack: Passenger details, flight info, travel time* Your partner reference (optional but recommended)**Response includes:*** **Booking reference** (e.g., HX123456) - Our booking reference* **Booking status** (`pending` or `confirmed`)* **Hosted confirmation page URL** - A link to our hosted confirmation page* **Recommended polling interval** (in seconds) - Suggested frequency for status checks* All booking details**Important:** Always include an `Idempotency-Key` header to prevent duplicate bookings if there's a network error. Any unique string is accepted; UUID v4 is recommended. Re-use the same key to safely retry a failed request.**Understanding Booking Status:****Confirmed Status:*** The booking is fully confirmed with the supplier* Show confirmation details to the customer immediately* No further action needed**Pending Status:*** We have created the booking on our side* Our supplier is still processing the confirmation on their side* The booking will transition to either `confirmed` or `error`**Handling Pending Bookings - Four Options:**You have four options for handling pending bookings, depending on how much control you want:**Option 1: Hosted Confirmation Page (Simplest)*** Use the Holiday Extras co-branded hosted confirmation page URL included in the booking response* Direct customers to this URL* We handle all status updates and display logic* The page automatically updates when the booking confirms* No polling or webhooks needed on your side**Option 2: Confirmation Endpoint (Simple)*** Use the Confirmation endpoint (Stage 5) to display booking details* The data returned is always relevant to the current status* Shows \"pending\" messaging when pending, \"confirmed\" details when confirmed* Make the same call regardless of status - we handle the logic* No need to track status transitions yourself**Option 3: Polling (More Control)*** Call the GET booking endpoint (`GET /v2/bookings/parking/{booking-reference}`) repeatedly* Use the `recommended_polling_interval` from the booking response* Check the status field in each response* Stop polling when status changes to `confirmed` or `error`* You control the customer experience during the pending period**Option 4: Webhooks (Event-Driven)*** Build an endpoint on your side matching our webhook specification* We call your endpoint when the booking status changes* Your endpoint receives notification of the status update* Then call GET booking to retrieve the latest information* Most efficient for handling status updates**Recommendation:*** Use Option 1 or 2 if you want us to handle the complexity* Use Option 3 or 4 if you need full control over the customer experience---### Stage 5: Booking Confirmation Details**Endpoint:** `GET /v2/bookings/parking/{booking-reference}/confirmation-details`**Purpose:** Get formatted confirmation details for display**When to use:*** Immediately after booking is created* Displaying a confirmation page**Query parameters:*** `format`: `json` (default), `html`, or `markdown`**Response includes:*** All booking details formatted for display* Product-specific instructions (PIN codes, meeting points, etc.)* Contact information* Important notices**Format options:*** `json`: Returns an array of `{ type, value }` pairs (e.g., `{ \"type\": \"booking_reference\", \"value\": \"HX123456\" }`). Use these fields to build your own confirmation page.* `html`: Returns a `{ text }` object containing a ready-to-use HTML snippet for web pages.* `markdown`: Returns a `{ text }` object containing text-based format for simpler emails.**Why use this?** The formatted confirmation includes product-specific instructions. It's optimized for customer-facing display.---### Stage 6: View Booking**Endpoint:** `GET /v2/bookings/parking/{booking-reference}`**Purpose:** Retrieve a specific booking by our booking reference**When to use:*** Customer wants to view their booking* You need to check current booking status* Before allowing amendments or cancellations**Response includes:*** Complete booking details* Current status (pending, confirmed, cancelled, error)* Customer details**Important:** Use our **booking reference**, not your partner reference.---### Stage 7: List Bookings (Alternative Lookup)> This endpoint will be available in a later phase.**Endpoint:** `GET /v2/bookings/parking?partner_reference={your-reference}`**Purpose:** Find bookings using YOUR reference**When to use:*** Customer lost our booking reference* You need to look up by your internal order ID* You need to reconcile your orders with our bookings**Response includes:*** **Array of bookings** (not a single booking)* Each booking has our booking reference* Use our booking reference for subsequent operations**Why an array?** We don't guarantee your partner reference is unique. You might reuse order IDs or have multiple bookings per order. Therefore, we always return an array, even if there's only one result.**Next step:** Display the bookings to the customer and let them select which one they want to manage, then use our booking reference for amendments/cancellations.---### Stage 8: Amend Booking (Two-Step Process)#### Step 1: Amend Quote**Endpoint:** `PATCH /v2/bookings/parking/{booking-reference}/amendments/quote`**Purpose:** Preview the amendment without executing it**When to use:*** Customer wants to change booking details* You need to show pricing impact before confirming**Response includes:*** Amendment fee (if any)* Price difference (if dates/product changed)* Total charge or refund* **Amendment token** (for the confirm step)**Nothing is changed yet** - this is just a quote.#### Step 2: Amend Confirm**Endpoint:** `POST /v2/bookings/parking/{booking-reference}/amendments/confirm`**Purpose:** Actually execute the amendment**When to use:*** Customer has seen the quote and accepted it* You're ready to charge/refund the difference**Request requires:*** **Amendment token** (from the quote response)**Response includes:*** Updated booking details* Confirmation of changes* Receipt of any charges/refunds**Important:** The amendment token is short-lived, like the price guarantee token. Using an expired token will return a `422 Unprocessable Entity` error — re-request the amendment quote to get a fresh token.**Typical workflow:**```1. Customer clicks \"Change flight details\"2. Call Amend Quote → Show \"£5 amendment fee\"3. Customer clicks \"Confirm changes\"4. Call Amend Confirm with token → Booking updated```---### Stage 9: Cancel Booking (Two-Step Process)#### Step 1: Cancel Quote**Endpoint:** `PATCH /v2/bookings/parking/{booking-reference}/cancellations/quote`**Purpose:** Preview the cancellation without executing it**When to use:*** Customer wants to cancel* You need to show refund amount before confirming**Response includes:*** Cancellation fee (if any)* Refund amount* **Cancellation token** (for the confirm step)**Nothing is cancelled yet** - this is just a quote.#### Step 2: Cancel Confirm**Endpoint:** `POST /v2/bookings/parking/{booking-reference}/cancellations/confirm`**Purpose:** Actually cancel the booking**When to use:*** Customer has seen the refund amount and confirmed* You're ready to process the cancellation**Request requires:*** **Cancellation token** (from the quote response)**Response includes:*** Confirmation of cancellation* Final refund amounts**Important:** The cancellation token is short-lived. Using an expired token will return a `422 Unprocessable Entity` error — re-request the cancellation quote to get a fresh token. Cancellations cannot be undone; you would need to create a new booking.**Typical workflow:**```1. Customer clicks \"Cancel booking\"2. Call Cancel Quote → Show \"You'll receive a £40.99 refund\"3. Customer clicks \"Confirm cancellation\"4. Call Cancel Confirm with token → Booking cancelled5. Show confirmation```---## Common Workflows### Workflow 1: Standard Booking Flow```1. GET /v2/locations → Show airport selector2. GET /v2/products/parking?location_code=LHR&... → Show available parking products with prices → Save price_guarantee_token from response3. [Optional] GET /v2/content/parking → Show detailed product information4. POST /v2/bookings/parking → Include the price_guarantee_token → Create booking5. GET /v2/bookings/parking/{booking-reference}/confirmation-details?format=html → Display confirmation to customer → Send confirmation email```### Workflow 2: Customer Wants to View Their Booking**Scenario A: Customer has our booking reference**```1. GET /v2/bookings/parking/{booking-reference} → Show booking details```**Scenario B: Customer only has your order number**```1. GET /v2/bookings/parking?partner_reference={your-ref} → Returns array of bookings2. Display list of bookings to customer3. Customer selects booking → Use our booking_reference4. GET /v2/bookings/parking/{booking-reference} → Show booking details```### Workflow 3: Customer Wants to Change Flight Details```1. GET /v2/bookings/parking/{booking-reference} → Get current booking details → Show to customer2. Customer enters new flight details3. PATCH /v2/bookings/parking/{booking-reference}/amendments/quote → Pass new flight details → Get amendment_token4. Show customer: \"Amendment fee: £5.00\" → Customer confirms5. POST /v2/bookings/parking/{booking-reference}/amendments/confirm → Include amendment_token → Booking updated6. GET /v2/bookings/parking/{booking-reference}/confirmation-details?format=html → Send updated confirmation email```### Workflow 4: Customer Wants to Cancel```1. GET /v2/bookings/parking/{booking-reference} → Get current booking details2. PATCH /v2/bookings/parking/{booking-reference}/cancellations/quote → Get cancellation_token and refund amount3. Show customer: \"You'll receive a refund of £40.99\" → Customer confirms4. POST /v2/bookings/parking/{booking-reference}/cancellations/confirm → Include cancellation_token → Booking cancelled5. Show confirmation: \"Booking cancelled.\"```", + "title": "APIConnect (Partner API 2026) - Understanding the OpenAPI Documentation", + "content": "# APIConnect (Partner API 2026) - Understanding the OpenAPI DocumentationDocument Version: 0.2 Last Updated: 2026-03-18This document is in Beta---## Purpose of This GuideThis guide helps you navigate the Swagger/OpenAPI documentation by explaining the **context** and **workflow** of the API endpoints. While Swagger shows you *what* each endpoint does, this guide explains *when* and *why* to use each endpoint, and how they work together.## OpenAPI SpecificationThe openapi schema for the API can be found at This is a live document and is expected to be updated.This can be viewed using a tool of your choice. We recommend or importing the schema into [Postman](https://www.postman.com/).---## Table of Contents1. [API Architecture Overview](#api-architecture-overview)2. [Core Concepts](#core-concepts)3. [The Customer Journey](#the-customer-journey)4. [Common Workflows](#common-workflows)---## API Architecture Overview### Product-Centric DesignThe APIConnect API is built around **products**. Each of our products has the same set of endpoints:**Available Products:*** **Parking** - Airport car parking**Coming Soon*** **Transfers** - Airport transfers* **Hotels** - Airport hotel accommodation* **Hotel with Parking** - Integrated packages* **Lounges** - Airport lounge access* **FastTrack** - Priority security lanes**Endpoint Pattern:** When you see endpoints in the OpenAPI schema like:* `GET /v2/products/parking`* `GET /v2/products/hotels`* `GET /v2/products/lounges`These all follow the same pattern - just replace the product type.### The One Exception: LocationsThe **Locations** endpoint is the only endpoint that doesn't follow the product-specific pattern. It's used to discover which locations (airports) have which products available.---## Core Concepts### 1. Price Guarantee Tokens**What:** A time-limited token that locks in a price **When:** Obtained from the Products endpoint **Why:** Ensures customers aren't charged more than the quoted price **Validity:** 30 minutes **Usage:** Required for Book endpoint**Example Flow:**```1. Customer searches → Products endpoint returns price + token2. Customer sees price: £45.993. Customer books → Pass token to Book endpoint4. API validates token → Price has increased to £48.995. API only charges £45.99 (the guaranteed price)```### 2. Booking Reference vs Partner Reference**Booking Reference:*** **Format:** e.g., `HX123456`* **Source:** Generated by APIConnect* **Uniqueness:** Guaranteed unique* **Usage:** Use this for View Booking, Amend, Cancel endpoints* **Why:** This is our internal identifier that pinpoints a single booking**Partner Reference:*** **Format:** Your choice (e.g., `ORDER-12345`)* **Source:** Provided by you* **Uniqueness:** NOT guaranteed unique (up to you to manage)* **Usage:** Use this for List Bookings endpoint only* **Why:** Helps you match our bookings to your internal systems### 3. Quote and Confirm PatternFor amendments and cancellations, we use a two-step \"quote and confirm\" pattern:**Quote Step:*** Preview what will happen* Get costs/refunds calculated* Receive a token* Nothing is actioned yet**Confirm Step:*** Use the token from the quote* Actually execute the change* Booking is modified/cancelled* Customer is charged/refunded**Why this pattern?** It allows customers to see the financial impact before committing to the change.---## The Customer Journey### Stage 1: Discovery**Endpoint:** `GET /v2/locations`**Purpose:** Find out which airports have which products available**When to use:*** User hasn't selected a location yet* Building a location selector* Need to show available products by location**Response includes:*** Location types* Location codes (IATA / UNLOCODE)* Location names* Available product types at each location**Caching:** Safe to cache for 24 hours---### Stage 2: Product Search**Endpoint:** `GET /v2/products/parking`**Purpose:** Search for available products with pricing**When to use:*** Customer has selected location and dates* You need availability and pricing* This is always the first step in the booking flow**Parking-specific parameter options:**For parking products, you have flexibility in how you specify timing. You can provide **either** set of parameters:**Option 1: Explicit parking times*** `parking_entry_date_time` - When the customer will arrive at the car park* `parking_exit_date_time` - When the customer will leave the car parkUse this when you know the exact parking duration needed.**Option 2: Flight-based calculation*** `outbound_flight_number` - Departure flight number* `outbound_flight_date_time` - Departure flight time* `inbound_flight_number` - Return flight number* `inbound_flight_date_time` - Return flight timeUse this when you want the API to calculate appropriate parking times based on flight schedules. The API will automatically add buffer time for airport arrival/departure.**Important rules:*** At least one set of parameters must be provided* If both sets are provided, `parking_entry_date_time` and `parking_exit_date_time` take precedence* Flight-based calculation is useful when you're unsure how much time customers need between parking and their flight**Response includes:*** List of available products* Pricing for each product* **Price guarantee token** (important!)* Product capabilities (modifiable, cancellable, etc.)* Basic product information* Supplier required information**Important:** The price guarantee token will expire — the expiry time is included in the response. Using an expired token will return a `422 Unprocessable Entity` error. If this happens, re-run the search to get a fresh token.**Caching:** DO NOT cache this response - prices and availability change frequently---### Stage 3: Content Enrichment (Optional)**Endpoint:** `GET /v2/content/parking`Examples:* `GET /v2/content/parking`**Purpose:** Get detailed product information, images, descriptions, and features**When to use:*** Customer clicks on a product to see more details* You want to show rich product information* Building a product details page**Response includes:*** Full product descriptions (multi-language)* Images and gallery* Detailed features and amenities* Location details and directions**Caching:** Safe to cache - check response headers for cache duration**Why separate from Products?** Content is large and changes less frequently. Separating it allows the Products endpoint to be fast and efficient, while Content can be cached and only fetched when needed.---### Stage 4: Create Booking**Endpoint:** `POST /v2/bookings/parking`**Purpose:** Create a booking.**When to use:*** Customer has selected a product* Customer is ready to confirm the booking**Request requires:*** **Price guarantee token** (from the search results)* Customer details* Product-specific details (see product-specific integration guide) * Parking: Vehicle details, flight info, entry/exit times * Hotels: Room requirements, arrival time, guest count * Lounges: Passenger details, flight info, visit time * FastTrack: Passenger details, flight info, travel time* Your partner reference (optional but recommended)**Response includes:*** **Booking reference** (e.g., HX123456) - Our booking reference* **Booking status** (`pending` or `confirmed`)* **Hosted confirmation page URL** - A link to our hosted confirmation page* **Recommended polling interval** (in seconds) - Suggested frequency for status checks* All booking details**Important:** Always include an `Idempotency-Key` header to prevent duplicate bookings if there's a network error. Any unique string is accepted; UUID v4 is recommended. Re-use the same key to safely retry a failed request.**Understanding Booking Status:****Confirmed Status:*** The booking is fully confirmed with the supplier* Show confirmation details to the customer immediately* No further action needed**Pending Status:*** We have created the booking on our side* Our supplier is still processing the confirmation on their side* The booking will transition to either `confirmed` or `error`**Handling Pending Bookings - Four Options:**You have four options for handling pending bookings, depending on how much control you want:**Option 1: Hosted Confirmation Page (Simplest)*** Use the Holiday Extras co-branded hosted confirmation page URL included in the booking response* Direct customers to this URL* We handle all status updates and display logic* The page automatically updates when the booking confirms* No polling or webhooks needed on your side**Option 2: Confirmation Endpoint (Simple)*** Use the Confirmation endpoint (Stage 5) to display booking details* The data returned is always relevant to the current status* Shows \"pending\" messaging when pending, \"confirmed\" details when confirmed* Make the same call regardless of status - we handle the logic* No need to track status transitions yourself**Option 3: Polling (More Control)*** Call the GET booking endpoint (`GET /v2/bookings/parking/{booking-reference}`) repeatedly* Use the `recommended_polling_interval` from the booking response* Check the status field in each response* Stop polling when status changes to `confirmed` or `error`* You control the customer experience during the pending period**Option 4: Webhooks (Event-Driven)*** Build an endpoint on your side matching our webhook specification* We call your endpoint when the booking status changes* Your endpoint receives notification of the status update* Then call GET booking to retrieve the latest information* Most efficient for handling status updates**Recommendation:*** Use Option 1 or 2 if you want us to handle the complexity* Use Option 3 or 4 if you need full control over the customer experience---### Stage 5: Booking Confirmation Details**Endpoint:** `GET /v2/bookings/parking/{booking-reference}/confirmation-details`**Purpose:** Get formatted confirmation details for display**When to use:*** Immediately after booking is created* Displaying a confirmation page**Query parameters:*** `format`: `json` (default), `html`, or `markdown`**Response includes:*** All booking details formatted for display* Product-specific instructions (PIN codes, meeting points, etc.)* Contact information* Important notices**Format options:*** `json`: Returns an array of `{ type, value }` pairs (e.g., `{ \"type\": \"booking_reference\", \"value\": \"HX123456\" }`). Use these fields to build your own confirmation page.* `html`: Returns a `{ text }` object containing a ready-to-use HTML snippet for web pages.* `markdown`: Returns a `{ text }` object containing text-based format for simpler emails.**Why use this?** The formatted confirmation includes product-specific instructions. It's optimized for customer-facing display.---### Stage 6: View Booking**Endpoint:** `GET /v2/bookings/parking/{booking-reference}`**Purpose:** Retrieve a specific booking by our booking reference**When to use:*** Customer wants to view their booking* You need to check current booking status* Before allowing amendments or cancellations**Response includes:*** Complete booking details* Current status (pending, confirmed, cancelled, error)* Customer details**Important:** Use our **booking reference**, not your partner reference.---### Stage 7: List Bookings (Alternative Lookup)> This endpoint will be available in a later phase.**Endpoint:** `GET /v2/bookings/parking?partner_reference={your-reference}`**Purpose:** Find bookings using YOUR reference**When to use:*** Customer lost our booking reference* You need to look up by your internal order ID* You need to reconcile your orders with our bookings**Response includes:*** **Array of bookings** (not a single booking)* Each booking has our booking reference* Use our booking reference for subsequent operations**Why an array?** We don't guarantee your partner reference is unique. You might reuse order IDs or have multiple bookings per order. Therefore, we always return an array, even if there's only one result.**Next step:** Display the bookings to the customer and let them select which one they want to manage, then use our booking reference for amendments/cancellations.---### Stage 8: Amend Booking (Two-Step Process)#### Step 1: Amend Quote**Endpoint:** `PATCH /v2/bookings/parking/{booking-reference}/amendments/quote`**Purpose:** Preview the amendment without executing it**When to use:*** Customer wants to change booking details* You need to show pricing impact before confirming**Response includes:*** Amendment fee (if any)* Price difference (if dates/product changed)* Total charge or refund* **Amendment token** (for the confirm step)**Nothing is changed yet** - this is just a quote.#### Step 2: Amend Confirm**Endpoint:** `POST /v2/bookings/parking/{booking-reference}/amendments/confirm`**Purpose:** Actually execute the amendment**When to use:*** Customer has seen the quote and accepted it* You're ready to charge/refund the difference**Request requires:*** **Amendment token** (from the quote response)**Response includes:*** Updated booking details* Confirmation of changes* Receipt of any charges/refunds**Important:** The amendment token is short-lived, like the price guarantee token. Using an expired token will return a `422 Unprocessable Entity` error — re-request the amendment quote to get a fresh token.**Typical workflow:**```1. Customer clicks \"Change flight details\"2. Call Amend Quote → Show \"£5 amendment fee\"3. Customer clicks \"Confirm changes\"4. Call Amend Confirm with token → Booking updated```---### Stage 9: Cancel Booking (Two-Step Process)#### Step 1: Cancel Quote**Endpoint:** `PATCH /v2/bookings/parking/{booking-reference}/cancellations/quote`**Purpose:** Preview the cancellation without executing it**When to use:*** Customer wants to cancel* You need to show refund amount before confirming**Response includes:*** Cancellation fee (if any)* Refund amount* **Cancellation token** (for the confirm step)**Nothing is cancelled yet** - this is just a quote.#### Step 2: Cancel Confirm**Endpoint:** `POST /v2/bookings/parking/{booking-reference}/cancellations/confirm`**Purpose:** Actually cancel the booking**When to use:*** Customer has seen the refund amount and confirmed* You're ready to process the cancellation**Request requires:*** **Cancellation token** (from the quote response)**Response includes:*** Confirmation of cancellation* Final refund amounts**Important:** The cancellation token is short-lived. Using an expired token will return a `422 Unprocessable Entity` error — re-request the cancellation quote to get a fresh token. Cancellations cannot be undone; you would need to create a new booking.**Typical workflow:**```1. Customer clicks \"Cancel booking\"2. Call Cancel Quote → Show \"You'll receive a £40.99 refund\"3. Customer clicks \"Confirm cancellation\"4. Call Cancel Confirm with token → Booking cancelled5. Show confirmation```---## Common Workflows### Workflow 1: Standard Booking Flow```1. GET /v2/locations → Show airport selector2. GET /v2/products/parking?location_code=LHR&... → Show available parking products with prices → Save price_guarantee_token from response3. [Optional] GET /v2/content/parking → Show detailed product information4. POST /v2/bookings/parking → Include the price_guarantee_token → Create booking5. GET /v2/bookings/parking/{booking-reference}/confirmation-details?format=html → Display confirmation to customer → Send confirmation email```### Workflow 2: Customer Wants to View Their Booking**Scenario A: Customer has our booking reference**```1. GET /v2/bookings/parking/{booking-reference} → Show booking details```**Scenario B: Customer only has your order number**```1. GET /v2/bookings/parking?partner_reference={your-ref} → Returns array of bookings2. Display list of bookings to customer3. Customer selects booking → Use our booking_reference4. GET /v2/bookings/parking/{booking-reference} → Show booking details```### Workflow 3: Customer Wants to Change Flight Details```1. GET /v2/bookings/parking/{booking-reference} → Get current booking details → Show to customer2. Customer enters new flight details3. PATCH /v2/bookings/parking/{booking-reference}/amendments/quote → Pass new flight details → Get amendment_token4. Show customer: \"Amendment fee: £5.00\" → Customer confirms5. POST /v2/bookings/parking/{booking-reference}/amendments/confirm → Include amendment_token → Booking updated6. GET /v2/bookings/parking/{booking-reference}/confirmation-details?format=html → Send updated confirmation email```### Workflow 4: Customer Wants to Cancel```1. GET /v2/bookings/parking/{booking-reference} → Get current booking details2. PATCH /v2/bookings/parking/{booking-reference}/cancellations/quote → Get cancellation_token and refund amount3. Show customer: \"You'll receive a refund of £40.99\" → Customer confirms4. POST /v2/bookings/parking/{booking-reference}/cancellations/confirm → Include cancellation_token → Booking cancelled5. Show confirmation: \"Booking cancelled.\"```", "url": "/partner/v2/api-endpoint-navigation-guide/" } , From 7e08e8e98c46a822c224af4da0d075f613baff13 Mon Sep 17 00:00:00 2001 From: Aurore Festaud Date: Wed, 18 Mar 2026 14:04:32 +0000 Subject: [PATCH 5/6] Rename event notifications doc title to match new naming convention --- site/partner/v2/webhook-integration-guide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/site/partner/v2/webhook-integration-guide.md b/site/partner/v2/webhook-integration-guide.md index 976f9e28..fda933af 100644 --- a/site/partner/v2/webhook-integration-guide.md +++ b/site/partner/v2/webhook-integration-guide.md @@ -1,4 +1,4 @@ -# APIConnect Partner API v2 - Event Notifications +# APIConnect (Partner API 2026) - Event Notifications Version: 1.0 Last Updated: 2026-01-29 From e128aa5e502f83ea35c8db918e81ca500620042e Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Wed, 18 Mar 2026 14:05:16 +0000 Subject: [PATCH 6/6] Update dist --- docs/feed.xml | 2 +- docs/hxapi/asynchronous-bookings/index.html | 8 +++--- docs/hxapi/carhire/availability/index.html | 4 +-- docs/hxapi/parking/av/airport/index.html | 20 ++++++------- docs/hxapi/productlibrary/index.html | 28 +++++++++---------- docs/hxapi/transfers/av/index.html | 24 ++++++++-------- docs/hxapi/transfers/cancel/index.html | 4 +-- .../transfers/cancellation-policy/index.html | 8 +++--- docs/hxapi/transfers/view/index.html | 4 +-- docs/hxapi/upgrade/index.html | 16 +++++------ docs/hxapi/viewamendcancel/view/index.html | 20 ++++++------- docs/partner/v2/webhook-integration-guide.md | 2 +- .../v2/webhook-integration-guide/index.html | 2 +- docs/search/index.html | 4 +-- 14 files changed, 73 insertions(+), 73 deletions(-) diff --git a/docs/feed.xml b/docs/feed.xml index d2a51e2c..075da236 100644 --- a/docs/feed.xml +++ b/docs/feed.xml @@ -1,2 +1,2 @@ -Jekyll2026-03-18T14:03:42+00:00/feed.xmlHoliday Extras APIDocumentation to give to partners who would like to integrate with our API. +Jekyll2026-03-18T14:05:13+00:00/feed.xmlHoliday Extras APIDocumentation to give to partners who would like to integrate with our API. \ No newline at end of file diff --git a/docs/hxapi/asynchronous-bookings/index.html b/docs/hxapi/asynchronous-bookings/index.html index 7a2ccc3e..6acf5ade 100644 --- a/docs/hxapi/asynchronous-bookings/index.html +++ b/docs/hxapi/asynchronous-bookings/index.html @@ -85,7 +85,7 @@

                                                                                                                                                                                                                                                                                                                                                                            Availability Request

                                                                                                                                                                                                                                                                                                                                                                            UK Products Availability Request

                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                              • XML
                                                                                                                                                                                                                                                                                                                                                                              • @@ -93,7 +93,7 @@

                                                                                                                                                                                                                                                                                                                                                                                UK Products Availability Request

                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                • 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 @@

                                                                                                                                                                                                                                                                                                                                                                                      European Products Availability R

                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                      • 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
                                                                                                                                                                                                                                                                                                                                                                                        diff --git a/docs/hxapi/carhire/availability/index.html b/docs/hxapi/carhire/availability/index.html
                                                                                                                                                                                                                                                                                                                                                                                        index f53f5b38..f9790cb4 100644
                                                                                                                                                                                                                                                                                                                                                                                        --- a/docs/hxapi/carhire/availability/index.html
                                                                                                                                                                                                                                                                                                                                                                                        +++ b/docs/hxapi/carhire/availability/index.html
                                                                                                                                                                                                                                                                                                                                                                                        @@ -61,7 +61,7 @@ 

                                                                                                                                                                                                                                                                                                                                                                                        Request

                                                                                                                                                                                                                                                                                                                                                                                        Example request:

                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                          • XML
                                                                                                                                                                                                                                                                                                                                                                                          • @@ -69,7 +69,7 @@

                                                                                                                                                                                                                                                                                                                                                                                            Request

                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            • 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 befa701f..56686554 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.com/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.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 @@

                                                                                                                                                                                                                                                                                                                                                                                                              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.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 @@

                                                                                                                                                                                                                                                                                                                                                                                                                            European Products Availability

                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                            • <?xml version="1.0"?>
                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/hxapi/productlibrary/index.html b/docs/hxapi/productlibrary/index.html
                                                                                                                                                                                                                                                                                                                                                                                                                              index cea25005..c1dab506 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

                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                  • @@ -976,7 +976,7 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                    Example 1 - Default Response

                                                                                                                                                                                                                                                                                                                                                                                                                                    Request

                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                      + -
                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                        • https://api.holidayextras.com/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

                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                          + -
                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                            • 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 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                  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.

                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                      + -
                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                        • https://api.holidayextras.com/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 51ad7586..8d1e9802 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 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                    Request
                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                    • 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 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                          Response
                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                          • <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 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                Request
                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                • 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 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Response
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • <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 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Request
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • 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 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Response
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • <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 53193e0c..173c6a7d 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 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Example

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • <Booking>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/hxapi/transfers/cancellation-policy/index.html b/docs/hxapi/transfers/cancellation-policy/index.html
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          index 269857a9..9037f25a 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 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Example

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • <BookingRef>TB12345</BookingRef>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                @@ -187,7 +187,7 @@ 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Example

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Example - Non-Cancellable Booking

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • XML
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • @@ -195,7 +195,7 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Example - Non-Cancellable Booking

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • <BookingRef>TB12345</BookingRef>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        diff --git a/docs/hxapi/transfers/view/index.html b/docs/hxapi/transfers/view/index.html
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        index 9b42364a..e717241f 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 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Example

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • <Booking>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/hxapi/upgrade/index.html b/docs/hxapi/upgrade/index.html
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              index cf5e5d92..272316df 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.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 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Response

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • <?xml version="1.0"?>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          @@ -618,7 +618,7 @@ 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Example 1 - Hotel Upgrades

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Request

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • XML
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • @@ -626,7 +626,7 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Request

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • 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 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Response

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • <?xml version="1.0"?>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/hxapi/viewamendcancel/view/index.html b/docs/hxapi/viewamendcancel/view/index.html
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      index 2ad73660..c967aba3 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.com/v1/booking/YourBookingRef
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            @@ -366,7 +366,7 @@ 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            UK Products View Booking (for a

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Request

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • XML
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • @@ -374,7 +374,7 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Request

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • https://api.holidayextras.com/v1/booking/YourBookingRef?ABTANumber=YourABTANumber&Password=YourPassword&Initials=YourInitials&key=YourKey&Email=test@test.com
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  @@ -391,7 +391,7 @@ 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Request

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Response

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • XML
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • @@ -399,7 +399,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.com/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/partner/v2/webhook-integration-guide.md b/docs/partner/v2/webhook-integration-guide.md
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    index 976f9e28..fda933af 100644
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    --- a/docs/partner/v2/webhook-integration-guide.md
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +++ b/docs/partner/v2/webhook-integration-guide.md
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    @@ -1,4 +1,4 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -# APIConnect Partner API v2 - Event Notifications
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +# APIConnect (Partner API 2026) - Event Notifications
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     Version: 1.0 Last Updated: 2026-01-29
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    diff --git a/docs/partner/v2/webhook-integration-guide/index.html b/docs/partner/v2/webhook-integration-guide/index.html
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    index 460cff6c..61c0e532 100644
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    --- a/docs/partner/v2/webhook-integration-guide/index.html
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +++ b/docs/partner/v2/webhook-integration-guide/index.html
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    @@ -38,7 +38,7 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    APIConnect Partner API v2 - Event Notifications

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    APIConnect (Partner API 2026) - Event Notifications

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Version: 1.0 Last Updated: 2026-01-29

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    diff --git a/docs/search/index.html b/docs/search/index.html index 86d03831..48666bab 100644 --- a/docs/search/index.html +++ b/docs/search/index.html @@ -619,8 +619,8 @@ , "partner-v2-webhook-integration-guide": { - "title": "APIConnect Partner API v2 - Event Notifications", - "content": "# APIConnect Partner API v2 - Event NotificationsVersion: 1.0 Last Updated: 2026-01-29---## OverviewWebhooks allow you to receive real-time notifications when booking events occur. We'll send HTTP POST requests to your endpoint when booking states change.### When to Use WebhooksUse webhooks when you want to be notified about booking status changes, particularly for pending bookings that need confirmation.**Note:** If you use our hosted confirmation page or the confirmation endpoint (which handles status automatically), you may not need webhooks. See the [API Endpoint Navigation Guide](/partner/v2/api-endpoint-navigation-guide/#stage-4-create-booking) for alternatives.---## Configuration### Step 1: Create Your EndpointYour webhook endpoint must:* Accept HTTP POST requests* Be publicly accessible via HTTPS (valid SSL certificate required)* Respond with HTTP 200 within 10 seconds* Verify the signature we send (security requirement)### Step 2: Speak With Your Partnerships ManagerLet your partnerships manager know your endpoint and they will configure it within the Holiday Extras APIConnect platform**Important:** Store your webhook secret securely (environment variable or vault).---## Event Payload StructureAll webhook events follow this structure:```json{ \"collection_id\": \"550e8400-e29b-41d4-a716-446655440000\", \"event_type\": \"booking.confirmed\", \"timestamp\": \"2026-01-29T10:30:45.123Z\", \"correlation_id\": \"c7f8e3d2-a1b4-4c5d-9e8f-7a6b5c4d3e2f\", \"trace_id\": \"trace_abc123xyz789\", \"source\": \"APIConnect\", \"data\": { \"booking_reference\": \"HX123456\", \"partner_reference\": \"ORDER-12345\" }}```### Envelope Fields| Field | Purpose | How to Use ||-------|---------|------------|| `collection_id` | Unique event identifier | Use for deduplication - store this to prevent processing the same event twice || `event_type` | Type of event | Describes what has occurred || `timestamp` | When event occurred | For ordering events and auditing || `correlation_id` | Groups related events | For tracking the entire booking lifecycle || `trace_id` | Debug identifier | Include in support requests || `source` | Who sent this webhook | Verification purposes || `data.booking_reference` | Our booking reference | Use to fetch full booking details via API || `data.partner_reference` | Your reference | Match to your internal order/transaction |### Why Thin Payloads?The webhook contains **only identifiers**, not full booking details. This is intentional:* You always get fresh data by calling the API* No risk of processing stale information* Consistent data structure across all events**After receiving a webhook, call:** `GET /api/v1/bookings/{booking_reference}` to fetch full booking details.---## Event Types| Event Type | When Sent | Typical Action ||------------|-----------|----------------|| `booking.confirmed` | Supplier confirms | Fetch booking details, update database, send confirmation email || `booking.failed` | Supplier rejects | Fetch failure reason, process refund, notify customer |## Security: Signature VerificationEvery webhook includes an HMAC-SHA256 signature in the `X-HX-Signature` header. You **must** verify this signature to ensure the webhook came from us.### Request Headers```httpPOST /webhooks/apiconnect HTTP/1.1Host: api.yourcompany.comContent-Type: application/jsonX-HX-Signature: sha256=a1b2c3d4e5f6...X-HX-Timestamp: 1738152645X-HX-Collection-Id: 550e8400-e29b-41d4-a716-446655440000{...webhook payload...}```---## Handling DuplicatesWebhooks use **at-least-once delivery**, meaning the same event may be delivered multiple times.---", + "title": "APIConnect (Partner API 2026) - Event Notifications", + "content": "# APIConnect (Partner API 2026) - Event NotificationsVersion: 1.0 Last Updated: 2026-01-29---## OverviewWebhooks allow you to receive real-time notifications when booking events occur. We'll send HTTP POST requests to your endpoint when booking states change.### When to Use WebhooksUse webhooks when you want to be notified about booking status changes, particularly for pending bookings that need confirmation.**Note:** If you use our hosted confirmation page or the confirmation endpoint (which handles status automatically), you may not need webhooks. See the [API Endpoint Navigation Guide](/partner/v2/api-endpoint-navigation-guide/#stage-4-create-booking) for alternatives.---## Configuration### Step 1: Create Your EndpointYour webhook endpoint must:* Accept HTTP POST requests* Be publicly accessible via HTTPS (valid SSL certificate required)* Respond with HTTP 200 within 10 seconds* Verify the signature we send (security requirement)### Step 2: Speak With Your Partnerships ManagerLet your partnerships manager know your endpoint and they will configure it within the Holiday Extras APIConnect platform**Important:** Store your webhook secret securely (environment variable or vault).---## Event Payload StructureAll webhook events follow this structure:```json{ \"collection_id\": \"550e8400-e29b-41d4-a716-446655440000\", \"event_type\": \"booking.confirmed\", \"timestamp\": \"2026-01-29T10:30:45.123Z\", \"correlation_id\": \"c7f8e3d2-a1b4-4c5d-9e8f-7a6b5c4d3e2f\", \"trace_id\": \"trace_abc123xyz789\", \"source\": \"APIConnect\", \"data\": { \"booking_reference\": \"HX123456\", \"partner_reference\": \"ORDER-12345\" }}```### Envelope Fields| Field | Purpose | How to Use ||-------|---------|------------|| `collection_id` | Unique event identifier | Use for deduplication - store this to prevent processing the same event twice || `event_type` | Type of event | Describes what has occurred || `timestamp` | When event occurred | For ordering events and auditing || `correlation_id` | Groups related events | For tracking the entire booking lifecycle || `trace_id` | Debug identifier | Include in support requests || `source` | Who sent this webhook | Verification purposes || `data.booking_reference` | Our booking reference | Use to fetch full booking details via API || `data.partner_reference` | Your reference | Match to your internal order/transaction |### Why Thin Payloads?The webhook contains **only identifiers**, not full booking details. This is intentional:* You always get fresh data by calling the API* No risk of processing stale information* Consistent data structure across all events**After receiving a webhook, call:** `GET /api/v1/bookings/{booking_reference}` to fetch full booking details.---## Event Types| Event Type | When Sent | Typical Action ||------------|-----------|----------------|| `booking.confirmed` | Supplier confirms | Fetch booking details, update database, send confirmation email || `booking.failed` | Supplier rejects | Fetch failure reason, process refund, notify customer |## Security: Signature VerificationEvery webhook includes an HMAC-SHA256 signature in the `X-HX-Signature` header. You **must** verify this signature to ensure the webhook came from us.### Request Headers```httpPOST /webhooks/apiconnect HTTP/1.1Host: api.yourcompany.comContent-Type: application/jsonX-HX-Signature: sha256=a1b2c3d4e5f6...X-HX-Timestamp: 1738152645X-HX-Collection-Id: 550e8400-e29b-41d4-a716-446655440000{...webhook payload...}```---## Handling DuplicatesWebhooks use **at-least-once delivery**, meaning the same event may be delivered multiple times.---", "url": "/partner/v2/webhook-integration-guide/" } ,