Availability Feed

The Availability feed returns a list of all departures for the trips listed in the Product feed. It includes the travel dates, number of spaces available, departure ‘sell’ status (e.g. “on request”, “booking closed”, “departure guaranteed” etc.) and prices and discounts in various currencies. A request can also be made to return the same information for an individual product code. As the XML for dates and availability for all products is very large it is recommended that you only request this feed for an individual product code.

Note: This example feed is only showing a single departure, but the full feed will include all departures. Due to the size of the full feed it is recommended that you generally only request this feed for individual products.

Click for example

Data structure

XML Element
Required?
Data Type
Notes
feed [type=<feedType>, brand=<brand>]
Top-level XML tag
<departureList>
Optional
departureList
{departure}
Mandatory
departure
<summary>
Mandatory
<statuses>
Optional
<pricesList>
Optional
<childPricesList>
Optional
<singleSupplementPriceList>
Optional
<extraList>
Optional
summary
productID
Mandatory
int
mainProductID
Optional
int
The product id of the main product for cabin-specific VRTT departures
productCode
Mandatory
string
productName
Mandatory
string
shipName
Optional
string
Only available for VRTT products
departureID
Mandatory
string
departureCode
Mandatory
string
departureName
Mandatory
string
startDate
Mandatory
string
Date Format: DDMMMYYY 
e.g. 01JAN2016
finishDate
Mandatory
string
Date Format: DDMMMYYY 
e.g. 01JAN2016
startCity
Optional
string
finishCity
Optional
string
flightInclusiveStartDate
Optional
string
Date Format: DDMMMYYY
e.g. 01JAN2016
flightInclusiveFinishDate
Optional
string
Date Format: DDMMMYYY 
e.g. 01JAN2016
flightInclusiveStartCity
Optional
string
flightInclusiveFinishCity
Optional
string
startPoint
Optional
string
finishPoint
Optional
string
statuses
availability
Optional
int
freeSell
Optional
bool
onRequest
Optional
bool
lateRequest
Optional
bool
bookingClosed
Optional
bool
departureGuaranteed
Optional
bool
pricesList
{prices}
Mandatory
prices
[productVersion=<productVersionType> currency=<currency>, numPax=<numPax>,paxType=<paxType>, roomType=<roomType>
When attribute numPax is not present the price is for a single person
base
Optional
decimal
discount
Optional
decimal
kitty [currency]
Optional
decimal
total
Optional
decimal
isHighlightPrice
Optional
bool
childPricesList
{childPrices}
Mandatory
childPrices
[productVersion=<productVersionType> currency=<currency>, numPax=<numPax>
When attribute numPax is not present the price is for a single child
base
Optional
decimal
discount
Optional
decimal
total
Optional
decimal
singleSupplementPriceList
singleSupplementPrice [currency]
Mandatory
decimal
extraList
{extra}
Mandatory
extra [currency]
description
Optional
string
amount
Optional
decimal

We have a number of ship-based trips where the actual ship varies for the same itinerary (i.e. they share the same trip code). As such the cabin configurations vary.

Previously, only one ship and its cabin configurations was being returned in the Product feed, and despite sharing the same trip code (<productCode>) not all departures were returned in the Availability feed, only those that matched that single ship.

As such, we extended the Product feed to return all ship variants, per trip code, resulting in more than one <product> node per trip code, with the relevant details under each one. Note that the <productId> is unique for each instance. The <productName> will vary per instance, indicating the ship used. E.g. "Celebrating New Year's in Antarctica (Ocean Nova)" vs. "Celebrating New Year's in Antarctica (Ocean Albatros)"

These variant instances can be grouped at your end by the shared trip code, <productCode> , which is the same for all such instances.

In the Availability feed, each departure lists its relevant as the first field. It may also list the <mainProductId> in the case of multiple cabin types per departure. You can use the <mainProductId> to match against a <productId> in the Product feed, for relevant trip content (e.g. itinerary). If no mainProductId is provided, then use the productId, to associate the departure with the relevant product or ship variant