Product Upgrades
Upgrades Availability Request
Upgrades are currently only supported for parking, hotel and lounge bookings. Upgrades can be requested on a per product basis.
Method
GET
Endpoint
/upgrade/{productCode}
NB: Where productCode
is the code of the base product i.e. the parking/hotel/lounge etc. product.
https://api.holidayextras.co.uk/v1/upgrade/LGV4
Request Parameters
Name | Data Type | Format | Mandatory? | Additional Information |
---|---|---|---|---|
ABTANumber | String | [A-Z0-9] 5 chars | Y | This is also known as an ‘agent code’. This will be confirmed to you by your Account Manager during set up. |
Password | String | [A-Z0-9] 5 chars | Y* | Password required for retail agent requests - intermediaries do not require a password. This will be confirmed to you by your Account Manager during set up. |
Initials | String | [A-Z] 3 chars | N | The initials of the Operator / Agent. |
key | String | [A-Z] | Y | This will be assigned to you by your Account Manager during set up. |
token | String | [0-9] 9 chars | Y | Please see user token endpoint for details of how to generate a token. |
ArrivalDate | String | YYYY-MM-DD | Y | This should be the same as the ArrivalDate from the base product request. |
ArrivalTime | Time | HHMM | Y | This should be the same as the ArrivalTime from the base product request. |
DepartDate | Date | YYYY-MM-DD | N | This should be the same as the DepartDate from the base product request. |
DepartTime | Time | HHMM | N | This should be the same as the DepartTime from the base product request. |
Adults | Integer | [0-9] | Y* | Mandatory for Lounge upgrade requests. Number of adults in the party |
Children | Integer | [0-9] | Y* | Mandatory for Lounge upgrade requests. Number of children in the party |
Upgrade Availability Response
The response will return a list of available upgrades. Upgrades are sold on a per booking, per person, or per room basis. Upgrades can be for the day before travel, day of departure or day of return.
Field | Additional Information |
---|---|
Code | Product code for the upgrade |
Name | Name of the upgrade |
Per | Pricing basis, either per Person, per Booking, per Room |
Canx | Whether the upgrade is cancellable (Y/N) |
description | |
supplement_type | Type classification for the upgrade |
Date | Date the upgrade is to be booked for. Format YYYY-MM-DD |
only_for_adults | Upgrades restricted to adult only parties e.g. Adult only lounges |
Price | The price of the upgrade minus any discounts. Only present for per booking upgrades |
NonDiscPrice | The total price of the upgrade before discounts. Only present for per booking upgrades |
DiscAmt | The amount of any discount applied. Only present for per booking upgrades |
AdPrice | The per adult price minus any discounts. Only present for per person upgrades |
NonDiscAdPrice | The per adult price before any discounts. Only present for per person upgrades |
AdDiscAmt | The amount of discount applied to the per adult price. Only present for per person upgrades |
ChPrice | The per child price minus any discounts. Only present for per person upgrades |
NonDiscChPrice | The per child price before any discounts. Only present for per person upgrades |
ChDiscAmt | The amount of discount applied to the child price. Only present for per person upgrades |
API_Header/Request | The API returns every parameter and value you sent in the request. |
Examples
Example 1 - Carpark Upgrades
Request
-
https://api.holidayextras.co.uk/v1/upgrade/STN5?ABTANumber=YourABTANumber&Password=YourPassword&key=YourKey&token=YourToken&ArrivalDate=2020-11-03&ArrivalTime=12:30&DepartDate=2020-11-11&DepartTime=13:45
-
https://api.holidayextras.co.uk/v1/upgrade/STN5.js?ABTANumber=YourABTANumber&Password=YourPassword&key=YourKey&token=YourToken&ArrivalDate=2020-11-03&ArrivalTime=12:30&DepartDate=2020-11-11&DepartTime=13:45
Response
-
<?xml version="1.0"?> <API_Reply Result="OK" expires="2020-07-10 09:43:97" RequestCode="2" Product="CarPark" cached="1"> <Hotel/> <Supplement> <Code>CBNOFF</Code> <Name>Trees for Cities</Name> <Per>B</Per> <Canx>N</Canx> <Filter/> <description>Do your bit for the environment. One tree can make a world of difference.</description> <supplement_type>Charity Donation</supplement_type> <Date>2020-11-03</Date> <Price>1.00</Price> <NonDiscPrice>1.00</NonDiscPrice> <DiscAmt>0.00</DiscAmt> </Supplement> <Supplement> <Code>GADCOA</Code> <Name>Insure your Mobile and your Gadgets</Name> <Per>B</Per> <Canx>Y</Canx> <Filter/> <description>£2,000 of cover for theft, loss & accidental damage when travelling.</description> <supplement_type>gadget cover</supplement_type> <Date>2020-11-03</Date> <Price>9.99</Price> <NonDiscPrice>9.99</NonDiscPrice> <DiscAmt>0.00</DiscAmt> </Supplement> <Supplement> <Code>HEXBFE</Code> <Name>booking fee</Name> <Per>B</Per> <Canx>Y</Canx> <Filter/> <description/> <supplement_type>Payment</supplement_type> <Date>2020-11-03</Date> <Price>0.25</Price> <NonDiscPrice>0.25</NonDiscPrice> <DiscAmt>0.00</DiscAmt> </Supplement> <Supplement> <Code>HXOST1</Code> <Name>Late Return Cover</Name> <Per>B</Per> <Canx>Y</Canx> <Filter/> <description>Delayed flight? No need to worry about extra parking charges with the Holiday Extras late return cover</description> <supplement_type>Payment</supplement_type> <Date>2020-11-03</Date> <Price>1.99</Price> <NonDiscPrice>1.99</NonDiscPrice> <DiscAmt>0.00</DiscAmt> </Supplement> <Supplement> <Code>HXOST2</Code> <Name>Late Return Cover</Name> <Per>B</Per> <Canx>Y</Canx> <Filter/> <description>Delayed flight? No need to worry about extra parking charges with the Holiday Extras late return cover</description> <supplement_type>Payment</supplement_type> <Date>2020-11-03</Date> <Price>1.49</Price> <NonDiscPrice>1.49</NonDiscPrice> <DiscAmt>0.00</DiscAmt> </Supplement> <Supplement> <Code>HXOSTE</Code> <Name>14-day Delayed Return Service</Name> <Per>B</Per> <Canx>Y</Canx> <Filter/> <description/> <supplement_type>Payment</supplement_type> <Date>2020-11-03</Date> <Price>9.99</Price> <NonDiscPrice>9.99</NonDiscPrice> <DiscAmt>0.00</DiscAmt> </Supplement> <Supplement> <Code>HXOSTN</Code> <Name>Late Return Cover</Name> <Per>B</Per> <Canx>Y</Canx> <Filter/> <description>Delayed flight? No need to worry about extra parking charges with the Holiday Extras late return cover</description> <supplement_type>Payment</supplement_type> <Date>2020-11-03</Date> <Price>1.99</Price> <NonDiscPrice>1.99</NonDiscPrice> <DiscAmt>0.00</DiscAmt> </Supplement> <Supplement> <Code>STNESP</Code> <Name>Escape Lounge</Name> <Per>P</Per> <Canx>Y</Canx> <Filter/> <description>Escape the hustle and bustle of the airport terminal and enjoy the calming atmosphere of the official airport lounge. Relax before your flight, catch up with last minute emails and enjoy complimentary freshly prepared food and drinks!</description> <supplement_type>Lounge</supplement_type> <Date>2020-11-03</Date> <AdPrice>25.50</AdPrice> <NonDiscAdPrice>25.50</NonDiscAdPrice> <AdDiscAmt>0.00</AdDiscAmt> <ChPrice>19.20</ChPrice> <NonDiscChPrice>19.20</NonDiscChPrice> <ChDiscAmt>0.00</ChDiscAmt> </Supplement> <Supplement> <Code>STNSFS</Code> <Name>Security FastTrack</Name> <Per>P</Per> <Canx>Y</Canx> <Filter/> <description>Short on time? Take the fast track through security and you’ll fly through.</description> <supplement_type>At the airport</supplement_type> <Date>2020-11-03</Date> <AdPrice>7.00</AdPrice> <NonDiscAdPrice>7.00</NonDiscAdPrice> <AdDiscAmt>0.00</AdDiscAmt> <ChPrice>7.00</ChPrice> <NonDiscChPrice>7.00</NonDiscChPrice> <ChDiscAmt>0.00</ChDiscAmt> </Supplement> <Supplement> <Code>STNFTA</Code> <Name>Passport Control FastTrack</Name> <Per>P</Per> <Canx>Y</Canx> <Filter/> <description>Dreading the wait in arrivals? The passport control FastTrack will have you home in no time.</description> <supplement_type>At the airport</supplement_type> <Date>2020-11-11</Date> <AdPrice>7.00</AdPrice> <NonDiscAdPrice>7.00</NonDiscAdPrice> <AdDiscAmt>0.00</AdDiscAmt> <ChPrice>7.00</ChPrice> <NonDiscChPrice>7.00</NonDiscChPrice> <ChDiscAmt>0.00</ChDiscAmt> </Supplement> <API_Header> <Request> <ABTANumber>WEB1</ABTANumber> <key>ONLIN</key> <token>ef008a98-9434-11e1-af41-123143040224</token> <ArrivalDate>2020-11-03</ArrivalDate> <ArrivalTime>12:30</ArrivalTime> <DepartDate>2020-11-11</DepartDate> <DepartTime>13:45</DepartTime> <v>1</v> </Request> </API_Header> </API_Reply>
-
{ "API_Reply": { "ATTRIBUTES": { "Result": "OK", "expires": "2020-07-10 14:20:40", "RequestCode": 2, "Product": "CarPark", "cached": true }, "Hotel": "", "Supplement": [ { "Code": "CBNOFF", "Name": "Trees for Cities", "Per": "B", "Canx": "N", "Filter": {}, "description": "Do your bit for the environment. One tree can make a world of difference.", "supplement_type": "Charity Donation", "Date": "2020-11-03", "Price": 1, "NonDiscPrice": 1, "DiscAmt": "0.00" }, { "Code": "GADCOA", "Name": "Insure your Mobile and your Gadgets", "Per": "B", "Canx": "Y", "Filter": {}, "description": "£2,000 of cover for theft, loss & accidental damage when travelling.", "supplement_type": "gadget cover", "Date": "2020-11-03", "Price": 9.99, "NonDiscPrice": 9.99, "DiscAmt": "0.00" }, { "Code": "HEXBFE", "Name": "booking fee", "Per": "B", "Canx": "Y", "Filter": {}, "description": null, "supplement_type": "Payment", "Date": "2020-11-03", "Price": "0.25", "NonDiscPrice": "0.25", "DiscAmt": "0.00" }, { "Code": "HXOST1", "Name": "Late Return Cover", "Per": "B", "Canx": "Y", "Filter": {}, "description": "Delayed flight? No need to worry about extra parking charges with the Holiday Extras late return cover", "supplement_type": "Payment", "Date": "2020-11-03", "Price": 1.99, "NonDiscPrice": 1.99, "DiscAmt": "0.00" }, { "Code": "HXOST2", "Name": "Late Return Cover", "Per": "B", "Canx": "Y", "Filter": {}, "description": "Delayed flight? No need to worry about extra parking charges with the Holiday Extras late return cover", "supplement_type": "Payment", "Date": "2020-11-03", "Price": 1.49, "NonDiscPrice": 1.49, "DiscAmt": "0.00" }, { "Code": "HXOSTE", "Name": "14-day Delayed Return Service", "Per": "B", "Canx": "Y", "Filter": {}, "description": " ", "supplement_type": "Payment", "Date": "2020-11-03", "Price": 9.99, "NonDiscPrice": 9.99, "DiscAmt": "0.00" }, { "Code": "HXOSTN", "Name": "Late Return Cover", "Per": "B", "Canx": "Y", "Filter": {}, "description": "Delayed flight? No need to worry about extra parking charges with the Holiday Extras late return cover", "supplement_type": "Payment", "Date": "2020-11-03", "Price": 1.99, "NonDiscPrice": 1.99, "DiscAmt": "0.00" }, { "Code": "STNESP", "Name": "Escape Lounge", "Per": "P", "Canx": "Y", "Filter": {}, "description": "Escape the hustle and bustle of the airport terminal and enjoy the calming atmosphere of the official airport lounge. Relax before your flight, catch up with last minute emails and enjoy complimentary freshly prepared food and drinks!", "supplement_type": "Lounge", "Date": "2020-11-03", "AdPrice": 25.5, "NonDiscAdPrice": 25.5, "AdDiscAmt": "0.00", "ChPrice": 19.2, "NonDiscChPrice": 19.2, "ChDiscAmt": "0.00" }, { "Code": "STNSFS", "Name": "Security FastTrack", "Per": "P", "Canx": "Y", "Filter": {}, "description": "Short on time? Take the fast track through security and you’ll fly through.\r\n", "supplement_type": "At the airport", "Date": "2020-11-03", "AdPrice": 7, "NonDiscAdPrice": 7, "AdDiscAmt": "0.00", "ChPrice": 7, "NonDiscChPrice": 7, "ChDiscAmt": "0.00" }, { "Code": "STNFTA", "Name": "Passport Control FastTrack", "Per": "P", "Canx": "Y", "Filter": {}, "description": "Dreading the wait in arrivals? The passport control FastTrack will have you home in no time.", "supplement_type": "At the airport", "Date": "2020-11-11", "AdPrice": 7, "NonDiscAdPrice": 7, "AdDiscAmt": "0.00", "ChPrice": 7, "NonDiscChPrice": 7, "ChDiscAmt": "0.00" } ], "API_Header": { "Request": { "ABTANumber": "WEB1", "key": "ONLIN", "token": "ef008a98-9434-11e1-af41-123143040224", "ArrivalDate": "2020-11-03", "ArrivalTime": "12:30", "DepartDate": "2020-11-11", "DepartTime": "13:45", "v": 1, "format": "js" } } } }
Example 1 - Hotel Upgrades
Request
-
https://api.holidayextras.co.uk/v1/upgrade/LGWSOF?ABTANumber=YourABTANumber&Password=YourPassword&key=YourKey&token=YourToken&ArrivalDate=2020-11-03&ArrivalTime=12:30&DepartDate=2020-11-11&DepartTime=13:45
-
https://api.holidayextras.co.uk/v1/upgrade/LGWSOF.js?ABTANumber=YourABTANumber&Password=YourPassword&key=YourKey&token=YourToken&ArrivalDate=2020-11-03&ArrivalTime=12:30&DepartDate=2020-11-11&DepartTime=13:45
Response
-
<?xml version="1.0"?> <API_Reply Result="OK" expires="2020-07-10 14:25:38" cached="1" Product="General" System="ABC" Version="1.0" Customer="A" Session="123456789" RequestCode="12"> <Itinerary> <SiteCode>LGWSOF</SiteCode> </Itinerary> <Supplement> <Code>AIRHLG</Code> <Name>Flight compensation checker</Name> <Per>B</Per> <Canx>Y</Canx> <Filter/> <description>Claim up to £550 per person.</description> <supplement_type>Payment</supplement_type> <Date>2020-11-03</Date> <Price>5.00</Price> <NonDiscPrice>5.00</NonDiscPrice> <DiscAmt>0.00</DiscAmt> </Supplement> <Supplement> <Code>AIRHLI</Code> <Name>Flight compensation checker</Name> <Per>B</Per> <Canx>Y</Canx> <Filter/> <description>Claim up to £550 per person.</description> <supplement_type>Payment</supplement_type> <Date>2020-11-03</Date> <Price>3.00</Price> <NonDiscPrice>3.00</NonDiscPrice> <DiscAmt>0.00</DiscAmt> </Supplement> <Supplement> <Code>CBNOFF</Code> <Name>Trees for Cities</Name> <Per>B</Per> <Canx>N</Canx> <Filter/> <description>Do your bit for the environment. One tree can make a world of difference.</description> <supplement_type>Charity Donation</supplement_type> <Date>2020-11-03</Date> <Price>1.00</Price> <NonDiscPrice>1.00</NonDiscPrice> <DiscAmt>0.00</DiscAmt> </Supplement> <Supplement> <Code>GADCOA</Code> <Name>Insure your Mobile and your Gadgets</Name> <Per>B</Per> <Canx>Y</Canx> <Filter/> <description>£2,000 of cover for theft, loss & accidental damage when travelling.</description> <supplement_type>gadget cover</supplement_type> <Date>2020-11-03</Date> <Price>9.99</Price> <NonDiscPrice>9.99</NonDiscPrice> <DiscAmt>0.00</DiscAmt> </Supplement> <Supplement> <Code>LGWSOD</Code> <Name>Urban Cafe 2-course dinner</Name> <Per>P</Per> <Canx>Y</Canx> <Filter> <primary_for_product_type>1</primary_for_product_type> <wistia>1</wistia> </Filter> <description>Two tasty courses for less than you'd normally pay for one.</description> <supplement_type>Dinner</supplement_type> <Date>2020-11-03</Date> <AdPrice>20.00</AdPrice> <NonDiscAdPrice>20.00</NonDiscAdPrice> <AdDiscAmt>0.00</AdDiscAmt> <ChPrice>20.00</ChPrice> <NonDiscChPrice>20.00</NonDiscChPrice> <ChDiscAmt>0.00</ChDiscAmt> </Supplement> <Supplement> <Code>LGWSOE</Code> <Name>Luxury room upgrade</Name> <Per>R</Per> <Canx>Y</Canx> <Filter/> <description>Plush room, mini bar and access to the hotel's exclusive Club Lounge.</description> <supplement_type>Luxury</supplement_type> <Date>2020-11-03</Date> <only_for_adults>1</only_for_adults> <Price>70.00</Price> <NonDiscPrice>70.00</NonDiscPrice> <DiscAmt>0.00</DiscAmt> </Supplement> <Supplement> <Code>LGWSOS</Code> <Name>Superior room upgrade</Name> <Per>R</Per> <Canx>Y</Canx> <Filter/> <description>A more luxurious room, wifi and mineral water all included.</description> <supplement_type>Luxury</supplement_type> <Date>2020-11-03</Date> <only_for_adults>1</only_for_adults> <Price>30.00</Price> <NonDiscPrice>30.00</NonDiscPrice> <DiscAmt>0.00</DiscAmt> </Supplement> <Supplement> <Code>LGWASC</Code> <Name>Club Aspire North Lounge</Name> <Per>P</Per> <Canx>Y</Canx> <Filter/> <description>Something modern. Food & drink, work & rest zones, charge points & wifi.</description> <supplement_type>Lounge</supplement_type> <Date>2020-11-04</Date> <AdPrice>28.00</AdPrice> <NonDiscAdPrice>28.00</NonDiscAdPrice> <AdDiscAmt>0.00</AdDiscAmt> <ChPrice>18.50</ChPrice> <NonDiscChPrice>18.50</NonDiscChPrice> <ChDiscAmt>0.00</ChDiscAmt> </Supplement> <Supplement> <Code>LGWSOB</Code> <Name>Buffet breakfast</Name> <Per>P</Per> <Canx>Y</Canx> <Filter> <wistia>1</wistia> </Filter> <description>Save time by booking a big and delicious breakfast now.</description> <supplement_type>Breakfast</supplement_type> <Date>2020-11-04</Date> <AdPrice>19.00</AdPrice> <NonDiscAdPrice>19.00</NonDiscAdPrice> <AdDiscAmt>0.00</AdDiscAmt> <ChPrice>19.00</ChPrice> <NonDiscChPrice>19.00</NonDiscChPrice> <ChDiscAmt>0.00</ChDiscAmt> </Supplement> <API_Header> <Request> <ABTANumber>WEB1</ABTANumber> <key>ONLIN</key> <token>ef008a98-9434-11e1-af41-123143040224</token> <ArrivalDate>2020-11-03</ArrivalDate> <ArrivalTime>12:30</ArrivalTime> <DepartDate>2020-11-11</DepartDate> <DepartTime>13:45</DepartTime> <v>1</v> </Request> </API_Header> </API_Reply>
-
{ "API_Reply": { "ATTRIBUTES": { "Result": "OK", "expires": "2020-07-10 14:22:16", "cached": true, "Product": "General", "System": "ABC", "Version": 1, "Customer": "A", "Session": 123456789, "RequestCode": 12 }, "Itinerary": { "SiteCode": "LGWSOF" }, "Supplement": [ { "Code": "AIRHLG", "Name": "Flight compensation checker", "Per": "B", "Canx": "Y", "Filter": {}, "description": "Claim up to £550 per person.\r\n\r\n", "supplement_type": "Payment", "Date": "2020-11-03", "Price": 5, "NonDiscPrice": 5, "DiscAmt": "0.00" }, { "Code": "AIRHLI", "Name": "Flight compensation checker", "Per": "B", "Canx": "Y", "Filter": {}, "description": "Claim up to £550 per person.\r\n\r\n", "supplement_type": "Payment", "Date": "2020-11-03", "Price": 3, "NonDiscPrice": 3, "DiscAmt": "0.00" }, { "Code": "CBNOFF", "Name": "Trees for Cities", "Per": "B", "Canx": "N", "Filter": {}, "description": "Do your bit for the environment. One tree can make a world of difference.", "supplement_type": "Charity Donation", "Date": "2020-11-03", "Price": 1, "NonDiscPrice": 1, "DiscAmt": "0.00" }, { "Code": "GADCOA", "Name": "Insure your Mobile and your Gadgets", "Per": "B", "Canx": "Y", "Filter": {}, "description": "£2,000 of cover for theft, loss & accidental damage when travelling.", "supplement_type": "gadget cover", "Date": "2020-11-03", "Price": 9.99, "NonDiscPrice": 9.99, "DiscAmt": "0.00" }, { "Code": "LGWSOD", "Name": "Urban Cafe 2-course dinner", "Per": "P", "Canx": "Y", "Filter": { "primary_for_product_type": 1, "wistia": 1 }, "description": "Two tasty courses for less than you'd normally pay for one.", "supplement_type": "Dinner", "Date": "2020-11-03", "AdPrice": 20, "NonDiscAdPrice": 20, "AdDiscAmt": "0.00", "ChPrice": 20, "NonDiscChPrice": 20, "ChDiscAmt": "0.00" }, { "Code": "LGWSOE", "Name": "Luxury room upgrade", "Per": "R", "Canx": "Y", "Filter": {}, "description": "Plush room, mini bar and access to the hotel's exclusive Club Lounge.", "supplement_type": "Luxury", "Date": "2020-11-03", "only_for_adults": 1, "Price": 70, "NonDiscPrice": 70, "DiscAmt": "0.00" }, { "Code": "LGWSOS", "Name": "Superior room upgrade", "Per": "R", "Canx": "Y", "Filter": {}, "description": "A more luxurious room, wifi and mineral water all included.", "supplement_type": "Luxury", "Date": "2020-11-03", "only_for_adults": 1, "Price": 30, "NonDiscPrice": 30, "DiscAmt": "0.00" }, { "Code": "LGWASC", "Name": "Club Aspire North Lounge", "Per": "P", "Canx": "Y", "Filter": {}, "description": "Something modern. Food & drink, work & rest zones, charge points & wifi.", "supplement_type": "Lounge", "Date": "2020-11-04", "AdPrice": 28, "NonDiscAdPrice": 28, "AdDiscAmt": "0.00", "ChPrice": 18.5, "NonDiscChPrice": 18.5, "ChDiscAmt": "0.00" }, { "Code": "LGWSOB", "Name": "Buffet breakfast", "Per": "P", "Canx": "Y", "Filter": { "wistia": 1 }, "description": "Save time by booking a big and delicious breakfast now.", "supplement_type": "Breakfast", "Date": "2020-11-04", "AdPrice": 19, "NonDiscAdPrice": 19, "AdDiscAmt": "0.00", "ChPrice": 19, "NonDiscChPrice": 19, "ChDiscAmt": "0.00" } ], "API_Header": { "Request": { "ABTANumber": "WEB1", "key": "ONLIN", "token": "ef008a98-9434-11e1-af41-123143040224", "ArrivalDate": "2020-11-03", "ArrivalTime": "12:30", "DepartDate": "2020-11-11", "DepartTime": "13:45", "v": 1, "format": "js" } } } }