GET Products by id

Overview

Retrieve Product by ID

Request

GET /Products/[id]

Request Information

Request Parameters

Name
Type
Requirement
Description
id
Integer
Mandatory 
ID of the product

Response Information

[tripProduct]

Response Properties

Name
Type
Description
minimumAge
Integer
Minimum age for trip
maximumAge
Integer
Maximum age for trip
themes
List<Theme>
The Intrepid themes for the trip
departures
HrefWrapper
URI used to retrieve all departures on trip product
style
String
Product Style
productSubType
SubProduct
Product Sub Type
onRequestDays
Integer
Product can be sold freely until this many days prior to start
onRequestOnly
Boolean
• true
Product is on request
• false
Product is not on request
bookingClosed
Integer
The latest time, prior to start, that the product can be booked, even on request
departureGuaranteed
Boolean
• true
Trip is guaranteed to depart
• false
Trip is not guaranteed to depart
onRequestCapacity
Integer
Number of spaces available when this product is On Request. Leave blank if there are no restrictions.
relatedAccommodation
List<RelatedProduct>
List of accommodation products related to this trip product
relatedTransfers
List<RelatedProduct>
List of transfer products related to this trip product
relatedAdditionalServices
List<RelatedProduct>
List of additional services products related to this trip product
relatedSightseeings
List<RelatedProduct>
List of sightseeing products related to this trip product
relatedSingleSupplement
List<RelatedProduct>
List of Single Supplement products related to this trip product
passportRequiredTypeId
Integer
Passport details are required at a time of booking
• 1- Passport details not required
• 2- Passport details required (not at booking)
• 3- Passport details required (at booking)
passportRequiredType
String
Label related to the passport required type id.
insuranceRequired
Boolean
Insurance details are required at a time of booking
name
String
Product Name
code
String
Product Code
id
Integer
ID of the resource
href
String
URI of the resource
sequence
Int64
Sequence of product

Departures

Name
Type
Description
href
String
URI of the resource

Productsubtype

Name
Type
Description
name
String
Name of the Sub Product
id
Integer
Id of the Sub Product

Themes

Name
Type
Description
name
String
Name of the theme

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)

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)

Relatedadditionalservices

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)

Relatedsightseeings

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)

[singleSupplementProduct]

Response Properties

Name
Type
Description
prices
HrefWrapper
URI used to retrieve all prices on SingleSupplement product
name
String
Product Name
code
String
Product Code
id
Integer
ID of the resource
href
String
URI of the resource
sequence
Int64
Sequence of product

Prices

Name
Type
Description
href
String
URI of the resource

[sightseeingProduct]

Response Properties

Name
Type
Description
startDate
String
Start Date of sightseeing product
startPoint
String
Start Point of sightseeing product
endPoint
String
End Point of sightseeing product
prices
HrefWrapper
URI used to retrieve all prices on sightseeing product
name
String
Product Name
code
String
Product Code
id
Integer
ID of the resource
href
String
URI of the resource
sequence
Int64
Sequence of product

Prices

Name
Type
Description
href
String
URI of the resource

[accommodationProduct]

Response Properties

Name
Type
Description
roomType
String
Room type for accommodation
capacity
Integer
Maximum room capacity
prices
HrefWrapper
URI used to retrieve all prices on Accommodation product
city
String
City of the accommodation
country
String
Country of the accommodation
onRequestDays
Integer
Product can be sold freely until this many days prior to start
onRequestOnly
Boolean
• true
Product is on request
• false
Product is not on request
bookingClosed
Integer
The latest time, prior to start, that the product can be booked, even on request
name
String
Product Name
code
String
Product Code
id
Integer
ID of the resource
href
String
URI of the resource
sequence
Int64
Sequence of product

Prices

Name
Type
Description
href
String
URI of the resource

[transferProduct]

Response Properties

Name
Type
Description
airportPickup
Boolean
• true
Transfer is picking up customers from an airport
• false
Transfer is picking up customers from a non-airport location
airportDropoff
Boolean
• true
Transfer is dropping off customers to an airport
• false
Transfer is dropping off customers to a non-airport location
prices
HrefWrapper
URI used to retrieve all prices on transfer product
onRequestDays
Integer
Product can be sold freely until this many days prior to start
onRequestOnly
Boolean
• true
Product is on request
• false
Product is not on request
bookingClosed
Integer
The latest time, prior to start, that the product can be booked, even on request
name
String
Product Name
code
String
Product Code
id
Integer
ID of the resource
href
String
URI of the resource
sequence
Int64
Sequence of product

Prices

Name
Type
Description
href
String
URI of the resource

[additionalServicesProduct]

Response Properties

Name
Type
Description
startDate
String
Start Date of additional services product
endDate
String
End Date of additional services product
prices
HrefWrapper
URI used to retrieve all prices on Additional Service product
name
String
Product Name
code
String
Product Code
id
Integer
ID of the resource
href
String
URI of the resource
sequence
Int64
Sequence of product

Prices

Name
Type
Description
href
String
URI of the resource

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

[tripProduct]

{
  "minimumAge": 12,
  "maximumAge": 90,
  "themes": [
    {
      "name": "Family"
    },
    {
      "name": "Family"
    }
  ],
  "departures": {
    "href": "products/887124"
  },
  "style": "Comfort",
  "productSubType": {
    "name": "Short Break Adv",
    "id": 18
  },
  "onRequestDays": 7,
  "onRequestOnly": true,
  "bookingClosed": 10,
  "departureGuaranteed": true,
  "onRequestCapacity": 7,
  "relatedAccommodation": [
    {
      "href": "/products/12345",
      "relationship": "preTrip"
    },
    {
      "href": "/products/12345",
      "relationship": "preTrip"
    }
  ],
  "relatedTransfers": [
    {
      "href": "/products/12345",
      "relationship": "preTrip"
    },
    {
      "href": "/products/12345",
      "relationship": "preTrip"
    }
  ],
  "relatedAdditionalServices": [
    {
      "href": "/products/12345",
      "relationship": "preTrip"
    },
    {
      "href": "/products/12345",
      "relationship": "preTrip"
    }
  ],
  "relatedSightseeings": [
    {
      "href": "/products/12345",
      "relationship": "preTrip"
    },
    {
      "href": "/products/12345",
      "relationship": "preTrip"
    }
  ],
  "relatedSingleSupplement": [
    {
      "href": "/products/91066",
      "relationship": "preTrip"
    },
    {
      "href": "/products/91066",
      "relationship": "preTrip"
    }
  ],
  "passportRequiredTypeId": 1,
  "passportRequiredType": "Passport details not required",
  "insuranceRequired": false,
  "name": "Beautiful Thailand",
  "code": "TTSN",
  "id": 887124,
  "href": "products/887124",
  "sequence": "202403312359580000"
}

[singleSupplementProduct]

{
  "prices": {
    "href": "/products/887124/prices"
  },
  "name": "Beautiful Thailand",
  "code": "TTSN",
  "id": 887124,
  "href": "products/887124",
  "sequence": "202403312359580000"
}

[sightseeingProduct]

{
  "startDate": "2016-12-13",
  "startPoint": "Melbourne",
  "endPoint": "Melbourne",
  "prices": {
    "href": "/products/887124/prices"
  },
  "name": "Beautiful Thailand",
  "code": "TTSN",
  "id": 887124,
  "href": "products/887124",
  "sequence": "202403312359580000"
}

[accommodationProduct]

{
  "roomType": "Single",
  "capacity": 2,
  "prices": {
    "href": "/products/887124/prices"
  },
  "city": "Quito",
  "country": "ECUADOR",
  "onRequestDays": 7,
  "onRequestOnly": true,
  "bookingClosed": 7,
  "name": "Beautiful Thailand",
  "code": "TTSN",
  "id": 887124,
  "href": "products/887124",
  "sequence": "202403312359580000"
}

[transferProduct]

{
  "airportPickup": false,
  "airportDropoff": true,
  "prices": {
    "href": "/products/887124/prices"
  },
  "onRequestDays": 7,
  "onRequestOnly": true,
  "bookingClosed": 7,
  "name": "Beautiful Thailand",
  "code": "TTSN",
  "id": 887124,
  "href": "products/887124",
  "sequence": "202403312359580000"
}

[additionalServicesProduct]

{
  "startDate": "2016-01-01",
  "endDate": "2016-01-04",
  "prices": {
    "href": "/products/887124/prices"
  },
  "name": "Beautiful Thailand",
  "code": "TTSN",
  "id": 887124,
  "href": "products/887124",
  "sequence": "202403312359580000"
}