POST api/Availability
Create a new availability tour search (required to commence a new web booking journey session)
Request Information
URI Parameters
None.
Body Parameters
The tour search input parameters
AvailabilitySearchParameters| Name | Description | Type | Additional information |
|---|---|---|---|
| channel |
The sales channel, i.e. WEB, SCS, XML or API (defaults to WEB) |
string |
None. |
| agentCode |
Agent code to which the booking will be attributed (set to NMP or an empty string for direct bookings) |
string |
None. |
| tourCode |
Tour code, e.g. 11254 |
integer |
None. |
| departureDate |
Departure date in the format YYYY-MM-DD, e.g. 2023-12-01 |
string |
None. |
| cabins |
The cabin grades requested (ocean cruises only) |
Collection of string |
None. |
| adults |
Number of adult (i.e. aged 16 years and older as at the tour return date) passengers in the party |
integer |
None. |
| children |
Number of child (i.e. aged 2 to 15 years as at the tour return date) passengers in the party |
integer |
None. |
| infants |
Number of infant (i.e. aged 0 to 1 year as at the tour return date) passengers in the party |
integer |
None. |
| departureCode |
Departure airport or train station code, e.g. LHR (not required for ocean cruises, MYOW and tour only holiday departures) |
string |
None. |
| ppToken |
The Phonepop session token associated with this reservation |
string |
None. |
Request Formats
application/json, text/json
Sample:
{
"channel": "sample string 1",
"agentCode": "sample string 2",
"tourCode": 1,
"departureDate": "sample string 3",
"cabins": [
"sample string 1",
"sample string 2"
],
"adults": 4,
"children": 5,
"infants": 6,
"departureCode": "sample string 7",
"ppToken": "sample string 8"
}
Response Information
Resource Description
AvailabilityResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| token |
The tour search token |
string |
None. |
| response |
The response object |
TourDeparture |
None. |
| status |
The response status |
ResponseStatus |
None. |
| success |
An indication that the request was successfully completed or failed |
boolean |
None. |
| datestamp |
The date and time that the request was completed |
date |
None. |
Response Formats
application/json, text/json
Sample:
{
"token": "sample string 1",
"response": {
"channel": "sample string 1",
"agentCode": "sample string 2",
"agentType": "sample string 3",
"tourCode": 1,
"brandChannelID": 4,
"departureDate": "sample string 5",
"departureCode": "sample string 6",
"duration": 7,
"cabins": [
"sample string 1",
"sample string 2"
],
"depPointType": "sample string 8",
"adults": 9,
"children": 10,
"infants": 11,
"avail": 12,
"availStatus": true,
"deposit": 1.1,
"balanceDueDate": "sample string 14",
"departureDetails": {
"outbound": [
{
"Id": "sample string 1",
"componentID": 2,
"supplierID": 3,
"transportType": "sample string 4",
"supplierCode": "sample string 5",
"supplierDesc": "sample string 6",
"supplierLogo": "sample string 7",
"departs": "sample string 8",
"departsDesc": "sample string 9",
"depPointType": "sample string 10",
"depDate": "sample string 11",
"depTime": "sample string 12",
"arrives": "sample string 13",
"arrivesDesc": "sample string 14",
"arrPointType": "sample string 15",
"arrDate": "sample string 16",
"arrTime": "sample string 17",
"checkInTime": "sample string 18",
"departureTerminal": "sample string 19",
"arrivalTerminal": "sample string 20",
"description": "sample string 21",
"seat": "sample string 22",
"baggageUnit": 1,
"baggageWeightLimit": 1,
"baggageWeightUnit": "sample string 23",
"internalFlight": 1,
"flightType": "sample string 24",
"dataSource": "sample string 25"
},
{
"Id": "sample string 1",
"componentID": 2,
"supplierID": 3,
"transportType": "sample string 4",
"supplierCode": "sample string 5",
"supplierDesc": "sample string 6",
"supplierLogo": "sample string 7",
"departs": "sample string 8",
"departsDesc": "sample string 9",
"depPointType": "sample string 10",
"depDate": "sample string 11",
"depTime": "sample string 12",
"arrives": "sample string 13",
"arrivesDesc": "sample string 14",
"arrPointType": "sample string 15",
"arrDate": "sample string 16",
"arrTime": "sample string 17",
"checkInTime": "sample string 18",
"departureTerminal": "sample string 19",
"arrivalTerminal": "sample string 20",
"description": "sample string 21",
"seat": "sample string 22",
"baggageUnit": 1,
"baggageWeightLimit": 1,
"baggageWeightUnit": "sample string 23",
"internalFlight": 1,
"flightType": "sample string 24",
"dataSource": "sample string 25"
}
],
"inbound": [
{
"Id": "sample string 1",
"componentID": 2,
"supplierID": 3,
"transportType": "sample string 4",
"supplierCode": "sample string 5",
"supplierDesc": "sample string 6",
"supplierLogo": "sample string 7",
"departs": "sample string 8",
"departsDesc": "sample string 9",
"depPointType": "sample string 10",
"depDate": "sample string 11",
"depTime": "sample string 12",
"arrives": "sample string 13",
"arrivesDesc": "sample string 14",
"arrPointType": "sample string 15",
"arrDate": "sample string 16",
"arrTime": "sample string 17",
"checkInTime": "sample string 18",
"departureTerminal": "sample string 19",
"arrivalTerminal": "sample string 20",
"description": "sample string 21",
"seat": "sample string 22",
"baggageUnit": 1,
"baggageWeightLimit": 1,
"baggageWeightUnit": "sample string 23",
"internalFlight": 1,
"flightType": "sample string 24",
"dataSource": "sample string 25"
},
{
"Id": "sample string 1",
"componentID": 2,
"supplierID": 3,
"transportType": "sample string 4",
"supplierCode": "sample string 5",
"supplierDesc": "sample string 6",
"supplierLogo": "sample string 7",
"departs": "sample string 8",
"departsDesc": "sample string 9",
"depPointType": "sample string 10",
"depDate": "sample string 11",
"depTime": "sample string 12",
"arrives": "sample string 13",
"arrivesDesc": "sample string 14",
"arrPointType": "sample string 15",
"arrDate": "sample string 16",
"arrTime": "sample string 17",
"checkInTime": "sample string 18",
"departureTerminal": "sample string 19",
"arrivalTerminal": "sample string 20",
"description": "sample string 21",
"seat": "sample string 22",
"baggageUnit": 1,
"baggageWeightLimit": 1,
"baggageWeightUnit": "sample string 23",
"internalFlight": 1,
"flightType": "sample string 24",
"dataSource": "sample string 25"
}
]
},
"accommodations": [
{
"accType": "sample string 1",
"accName": "sample string 2",
"accDescription": [
{
"title": "sample string 1",
"body": "sample string 2"
},
{
"title": "sample string 1",
"body": "sample string 2"
}
],
"deckPlanImage": "sample string 3",
"accThumbnail": "sample string 4",
"accImages": [
{
"galleryImage": "sample string 1",
"tileImage": "sample string 2"
},
{
"galleryImage": "sample string 1",
"tileImage": "sample string 2"
}
],
"accLocation": "sample string 5",
"accRating": 1,
"boardBasisCode": "sample string 6",
"boardBasisDesc": "sample string 7",
"checkIn": "sample string 8",
"checkOut": "sample string 9",
"nights": 10,
"accCode": "sample string 11",
"offer": "sample string 12",
"selection": "sample string 13",
"units": [
{
"Id": "sample string 1",
"componentID": 2,
"supplierID": 3,
"unitType": "sample string 4",
"unitName": "sample string 5",
"unitDesc": "sample string 6",
"unitImages": [
"sample string 1",
"sample string 2"
],
"unitGrade": "sample string 7",
"unitNumber": "sample string 8",
"currency": "sample string 9",
"price": 1.1,
"wasPrice": 1.1,
"secondPersonPrice": 1.1,
"secondPersonDiscount": 1.1,
"childPrice": 1.1,
"infantPrice": 1.1,
"ambassadorPrice": 1.1,
"ambassadorWasPrice": 1.1,
"ambassadorSecondPersonPrice": 1.1,
"ambassadorSecondPersonDiscount": 1.1,
"ambassadorChildPrice": 1.1,
"cost": 1.1,
"costType": "sample string 10",
"priceType": "sample string 11",
"offer": "sample string 12",
"avail": 13,
"adultMinOcc": 14,
"adultMaxOcc": 15,
"childMinOcc": 16,
"childMaxOcc": 17,
"infantMinOcc": 18,
"infantMaxOcc": 19,
"minOcc": 20,
"maxOcc": 21,
"minQty": 22,
"maxQty": 23,
"extras": [
{
"Id": "sample string 1",
"componentID": 2,
"name": "sample string 3",
"description": "sample string 4",
"heroImage": {
"galleryImage": "sample string 1",
"tileImage": "sample string 2"
},
"images": [
{
"galleryImage": "sample string 1",
"tileImage": "sample string 2"
},
{
"galleryImage": "sample string 1",
"tileImage": "sample string 2"
}
],
"tags": [
"sample string 1",
"sample string 2"
],
"date": "sample string 5",
"minQty": 6,
"maxQty": 7,
"price": 1.1,
"priceBasis": "sample string 8",
"currency": "sample string 9"
},
{
"Id": "sample string 1",
"componentID": 2,
"name": "sample string 3",
"description": "sample string 4",
"heroImage": {
"galleryImage": "sample string 1",
"tileImage": "sample string 2"
},
"images": [
{
"galleryImage": "sample string 1",
"tileImage": "sample string 2"
},
{
"galleryImage": "sample string 1",
"tileImage": "sample string 2"
}
],
"tags": [
"sample string 1",
"sample string 2"
],
"date": "sample string 5",
"minQty": 6,
"maxQty": 7,
"price": 1.1,
"priceBasis": "sample string 8",
"currency": "sample string 9"
}
]
},
{
"Id": "sample string 1",
"componentID": 2,
"supplierID": 3,
"unitType": "sample string 4",
"unitName": "sample string 5",
"unitDesc": "sample string 6",
"unitImages": [
"sample string 1",
"sample string 2"
],
"unitGrade": "sample string 7",
"unitNumber": "sample string 8",
"currency": "sample string 9",
"price": 1.1,
"wasPrice": 1.1,
"secondPersonPrice": 1.1,
"secondPersonDiscount": 1.1,
"childPrice": 1.1,
"infantPrice": 1.1,
"ambassadorPrice": 1.1,
"ambassadorWasPrice": 1.1,
"ambassadorSecondPersonPrice": 1.1,
"ambassadorSecondPersonDiscount": 1.1,
"ambassadorChildPrice": 1.1,
"cost": 1.1,
"costType": "sample string 10",
"priceType": "sample string 11",
"offer": "sample string 12",
"avail": 13,
"adultMinOcc": 14,
"adultMaxOcc": 15,
"childMinOcc": 16,
"childMaxOcc": 17,
"infantMinOcc": 18,
"infantMaxOcc": 19,
"minOcc": 20,
"maxOcc": 21,
"minQty": 22,
"maxQty": 23,
"extras": [
{
"Id": "sample string 1",
"componentID": 2,
"name": "sample string 3",
"description": "sample string 4",
"heroImage": {
"galleryImage": "sample string 1",
"tileImage": "sample string 2"
},
"images": [
{
"galleryImage": "sample string 1",
"tileImage": "sample string 2"
},
{
"galleryImage": "sample string 1",
"tileImage": "sample string 2"
}
],
"tags": [
"sample string 1",
"sample string 2"
],
"date": "sample string 5",
"minQty": 6,
"maxQty": 7,
"price": 1.1,
"priceBasis": "sample string 8",
"currency": "sample string 9"
},
{
"Id": "sample string 1",
"componentID": 2,
"name": "sample string 3",
"description": "sample string 4",
"heroImage": {
"galleryImage": "sample string 1",
"tileImage": "sample string 2"
},
"images": [
{
"galleryImage": "sample string 1",
"tileImage": "sample string 2"
},
{
"galleryImage": "sample string 1",
"tileImage": "sample string 2"
}
],
"tags": [
"sample string 1",
"sample string 2"
],
"date": "sample string 5",
"minQty": 6,
"maxQty": 7,
"price": 1.1,
"priceBasis": "sample string 8",
"currency": "sample string 9"
}
]
}
]
},
{
"accType": "sample string 1",
"accName": "sample string 2",
"accDescription": [
{
"title": "sample string 1",
"body": "sample string 2"
},
{
"title": "sample string 1",
"body": "sample string 2"
}
],
"deckPlanImage": "sample string 3",
"accThumbnail": "sample string 4",
"accImages": [
{
"galleryImage": "sample string 1",
"tileImage": "sample string 2"
},
{
"galleryImage": "sample string 1",
"tileImage": "sample string 2"
}
],
"accLocation": "sample string 5",
"accRating": 1,
"boardBasisCode": "sample string 6",
"boardBasisDesc": "sample string 7",
"checkIn": "sample string 8",
"checkOut": "sample string 9",
"nights": 10,
"accCode": "sample string 11",
"offer": "sample string 12",
"selection": "sample string 13",
"units": [
{
"Id": "sample string 1",
"componentID": 2,
"supplierID": 3,
"unitType": "sample string 4",
"unitName": "sample string 5",
"unitDesc": "sample string 6",
"unitImages": [
"sample string 1",
"sample string 2"
],
"unitGrade": "sample string 7",
"unitNumber": "sample string 8",
"currency": "sample string 9",
"price": 1.1,
"wasPrice": 1.1,
"secondPersonPrice": 1.1,
"secondPersonDiscount": 1.1,
"childPrice": 1.1,
"infantPrice": 1.1,
"ambassadorPrice": 1.1,
"ambassadorWasPrice": 1.1,
"ambassadorSecondPersonPrice": 1.1,
"ambassadorSecondPersonDiscount": 1.1,
"ambassadorChildPrice": 1.1,
"cost": 1.1,
"costType": "sample string 10",
"priceType": "sample string 11",
"offer": "sample string 12",
"avail": 13,
"adultMinOcc": 14,
"adultMaxOcc": 15,
"childMinOcc": 16,
"childMaxOcc": 17,
"infantMinOcc": 18,
"infantMaxOcc": 19,
"minOcc": 20,
"maxOcc": 21,
"minQty": 22,
"maxQty": 23,
"extras": [
{
"Id": "sample string 1",
"componentID": 2,
"name": "sample string 3",
"description": "sample string 4",
"heroImage": {
"galleryImage": "sample string 1",
"tileImage": "sample string 2"
},
"images": [
{
"galleryImage": "sample string 1",
"tileImage": "sample string 2"
},
{
"galleryImage": "sample string 1",
"tileImage": "sample string 2"
}
],
"tags": [
"sample string 1",
"sample string 2"
],
"date": "sample string 5",
"minQty": 6,
"maxQty": 7,
"price": 1.1,
"priceBasis": "sample string 8",
"currency": "sample string 9"
},
{
"Id": "sample string 1",
"componentID": 2,
"name": "sample string 3",
"description": "sample string 4",
"heroImage": {
"galleryImage": "sample string 1",
"tileImage": "sample string 2"
},
"images": [
{
"galleryImage": "sample string 1",
"tileImage": "sample string 2"
},
{
"galleryImage": "sample string 1",
"tileImage": "sample string 2"
}
],
"tags": [
"sample string 1",
"sample string 2"
],
"date": "sample string 5",
"minQty": 6,
"maxQty": 7,
"price": 1.1,
"priceBasis": "sample string 8",
"currency": "sample string 9"
}
]
},
{
"Id": "sample string 1",
"componentID": 2,
"supplierID": 3,
"unitType": "sample string 4",
"unitName": "sample string 5",
"unitDesc": "sample string 6",
"unitImages": [
"sample string 1",
"sample string 2"
],
"unitGrade": "sample string 7",
"unitNumber": "sample string 8",
"currency": "sample string 9",
"price": 1.1,
"wasPrice": 1.1,
"secondPersonPrice": 1.1,
"secondPersonDiscount": 1.1,
"childPrice": 1.1,
"infantPrice": 1.1,
"ambassadorPrice": 1.1,
"ambassadorWasPrice": 1.1,
"ambassadorSecondPersonPrice": 1.1,
"ambassadorSecondPersonDiscount": 1.1,
"ambassadorChildPrice": 1.1,
"cost": 1.1,
"costType": "sample string 10",
"priceType": "sample string 11",
"offer": "sample string 12",
"avail": 13,
"adultMinOcc": 14,
"adultMaxOcc": 15,
"childMinOcc": 16,
"childMaxOcc": 17,
"infantMinOcc": 18,
"infantMaxOcc": 19,
"minOcc": 20,
"maxOcc": 21,
"minQty": 22,
"maxQty": 23,
"extras": [
{
"Id": "sample string 1",
"componentID": 2,
"name": "sample string 3",
"description": "sample string 4",
"heroImage": {
"galleryImage": "sample string 1",
"tileImage": "sample string 2"
},
"images": [
{
"galleryImage": "sample string 1",
"tileImage": "sample string 2"
},
{
"galleryImage": "sample string 1",
"tileImage": "sample string 2"
}
],
"tags": [
"sample string 1",
"sample string 2"
],
"date": "sample string 5",
"minQty": 6,
"maxQty": 7,
"price": 1.1,
"priceBasis": "sample string 8",
"currency": "sample string 9"
},
{
"Id": "sample string 1",
"componentID": 2,
"name": "sample string 3",
"description": "sample string 4",
"heroImage": {
"galleryImage": "sample string 1",
"tileImage": "sample string 2"
},
"images": [
{
"galleryImage": "sample string 1",
"tileImage": "sample string 2"
},
{
"galleryImage": "sample string 1",
"tileImage": "sample string 2"
}
],
"tags": [
"sample string 1",
"sample string 2"
],
"date": "sample string 5",
"minQty": 6,
"maxQty": 7,
"price": 1.1,
"priceBasis": "sample string 8",
"currency": "sample string 9"
}
]
}
]
}
],
"extensions": true,
"altTransport": true,
"extras": true
},
"status": {
"code": 1,
"message": "sample string 2"
},
"success": true,
"datestamp": "2026-08-03T20:50:35.0793135+01:00"
}