GET Departures by id

Overview

Retrieve departure by ID

Request

GET /Departures/[id]

Request Information

Request Parameters

Name
Type
Requirement
Description
id
Integer
Mandatory 
ID of the departure

Response Information

Response Properties

Name
Type
Description
product
HrefWrapper
URI of the trip product
webPublishedProduct
HrefWrapper
URI of the web published Product (Main Product) for VRTT & SBA Products
name
String
Name of the departure
code
String
The Intrepid alphanumeric code for the departure
startDate
String
Start date of the departure
endDate
String
End date of the departure
numberOfDays
Integer
Duration of the departure
startLocation
String
Start location of the departure
endLocation
String
End location of the departure
departureGuaranteed
Boolean
• true
Trip is guaranteed to depart
• false
Trip is not guaranteed to depart
status
String
• available
Departure has at least 1 spot available
• bookingClosed
Departure is closed for booking
• fullyBooked
Departure has no spots available
availability
Availability
Availability details for the departure
prices
HrefWrapper
URI used to retrieve departure prices
onRequestOnly
Boolean
• true
On request departure
• false
Not an on request departure
onRequestCapacity
Integer
Number of spaces available when this departure is On Request. Leave blank if there are no restrictions.
freeSell
Boolean
• true
Departure is on free sell
• false
Departure is not free sell
lateRequest
Boolean
• true
Departure is on late request
• false
Departure is not late request
bookingClosed
Integer
The latest time, prior to start, that the departure can be booked, even on request
onRequest
Boolean
• true
Departure is now on request
• false
Departure is now not on request
onRequestDays
Integer
Departure can be sold freely until this many days prior to start
relatedAccommodation
List<RelatedProduct>
List of accommodation products related to this departure
relatedSingleSupplement
List<RelatedProduct>
List of single supplement products related to this departure
relatedTransfers
List<RelatedProduct>
List of transfer products related to this departure
roomTypeName
String
Room Type Name
vehicleName
String
Vehicle Name/Ship Name
vehicleID
Integer
Vehicle ID/Ship ID
roomTypeID
Integer
Room Type ID
lastUpdatedDateTime
String
Last Updated Date Time
startCity
String
Start City
startCountry
String
Start Country
endCity
String
End City
endCountry
String
End Country
canPlaceOnHoldDeparture
Boolean
• true
Departure is available to book on hold
• false
Departure is not available to book on hold
singleTravellerCompulsorySingleSupFlag
Boolean
• true
Single suppliment is compulsory for the trip
• false
Single suppliment is not compulsory for the trip
id
Integer
ID of the resource
href
String
URI of the resource
sequence
Int64
Sequence of product

Product

Name
Type
Description
href
String
URI of the resource

Webpublishedproduct

Name
Type
Description
href
String
URI of the resource

Availability

Name
Type
Description
availableSpots
Integer
Total number of spots available on departure
availableSpotsFreeSell
Integer
Total number of spots available that can be immediately confirmed
Attempting to book more spots than this will need to be confirmed with the supplier

Prices

Name
Type
Description
href
String
URI of the resource

Relatedaccommodation

Name
Type
Description
href
String
URI of related product
relationship
String
Relationship to trip:
• preTrip
Product has been booked for before the trip 
	(applicable for accommodation,transfer,sightseeing)
• postTrip
 Product has been booked for after the trip
	(applicable for accommodation,transfer,sightseeing)
• availableToPurchase
 Product is available to purchase
	(applicable for single supplement, additional service)

Relatedsinglesupplement

Name
Type
Description
href
String
URI of related product
relationship
String
Relationship to trip:
• preTrip
Product has been booked for before the trip 
	(applicable for accommodation,transfer,sightseeing)
• postTrip
 Product has been booked for after the trip
	(applicable for accommodation,transfer,sightseeing)
• availableToPurchase
 Product is available to purchase
	(applicable for single supplement, additional service)

Relatedtransfers

Name
Type
Description
href
String
URI of related product
relationship
String
Relationship to trip:
• preTrip
Product has been booked for before the trip 
	(applicable for accommodation,transfer,sightseeing)
• postTrip
 Product has been booked for after the trip
	(applicable for accommodation,transfer,sightseeing)
• availableToPurchase
 Product is available to purchase
	(applicable for single supplement, additional service)

Response Codes

HTTP status code
Description
200 OK
The resource was retrieved successfully
400 Bad Request
The resource was malformed
401 Unauthorized
Missing or invalid API key
404 Not Found
The specified resource was not found
500 Internal Server Error
An unexpected error occurred on the API server

Response Example

{
  "product": {
    "href": "/products/91066"
  },
  "webPublishedProduct": {
    "href": "/products/91066"
  },
  "name": "Beautiful Thailand",
  "code": "TTSN161211",
  "startDate": "2016-12-10",
  "endDate": "2016-12-15",
  "numberOfDays": 5,
  "startLocation": "Royal Princess Larn Luang Hotel, Bangkok",
  "endLocation": "Royal Princess Larn Luang Hotel, Bangkok",
  "departureGuaranteed": true,
  "status": "available",
  "availability": {
    "availableSpots": 10,
    "availableSpotsFreeSell": 3
  },
  "prices": {
    "href": "/departures/887124/prices"
  },
  "onRequestOnly": true,
  "onRequestCapacity": 7,
  "freeSell": false,
  "lateRequest": true,
  "bookingClosed": 10,
  "onRequest": true,
  "onRequestDays": 7,
  "relatedAccommodation": [
    {
      "href": "/products/91066",
      "relationship": "preTrip"
    },
    {
      "href": "/products/91066",
      "relationship": "preTrip"
    }
  ],
  "relatedSingleSupplement": [
    {
      "href": "/products/91066",
      "relationship": "preTrip"
    },
    {
      "href": "/products/91066",
      "relationship": "preTrip"
    }
  ],
  "relatedTransfers": [
    {
      "href": "/products/91066",
      "relationship": "preTrip"
    },
    {
      "href": "/products/91066",
      "relationship": "preTrip"
    }
  ],
  "roomTypeName": "Twin Share",
  "vehicleName": "Ocean Adventure",
  "vehicleID": 15,
  "roomTypeID": 2,
  "lastUpdatedDateTime": "2019-11-06T11:06:46.257Z",
  "startCity": "Ho Chi Minh City",
  "startCountry": "Vietnam",
  "endCity": "Perth",
  "endCountry": "Australia",
  "canPlaceOnHoldDeparture": true,
  "singleTravellerCompulsorySingleSupFlag": true,
  "id": 887124,
  "href": "departures/887124",
  "sequence": "202403312359580000"
}