Request
Method : POST
URL : /api/transfers/search
Request Sample Departure (One-way Trip)
{
"transfer_from": {
"type": "air",
"code": "DEL"
},
"transfer_to": {
"code": "H!0132055",
"type": "hotel"
},
"transfer_departure": {
"transfer_date": "2020-01-20",
"transfer_time": "12:06"
},
"occupancy": {
"adults": 1,
"children": 1,
"infants": 1
},
"timeout": 10000,
"client_nationality": "IN",
"currency": "INR"
}
Request Sample Departure & Return (Round Trip)
{
"transfer_from": {
"type": "air",
"code": "DEL"
},
"transfer_to": {
"code": "H!0132055",
"type": "hotel"
},
"transfer_departure": {
"transfer_date": "2020-01-20",
"transfer_time": "12:06"
},
"transfer_return": {
"transfer_date": "2020-01-22",
"transfer_time": "16:12"
},
"occupancy": {
"adults": 1,
"children": 1,
"infants": 1
},
"timeout": 10000,
"client_nationality": "IN",
"currency": "INR"
}
Transfer_From & Transfer_To
| Attribute | Type | Required | Description |
|---|---|---|---|
| type | String | REQUIRED | Type can be one of below values "air" for Airport "hotel_id" for Hotel "station" for Station "port" for Port |
| code | String | REQUIRED | Code needs to be passed depending on the given paramter "type" Airport IATA CODE if type="air" or GRN Hotel code if type ="hotel_id" or GRN Station code if type="station" or GRN Port code if type="port" All the values of Airport code, GRN Hotel code, Station code & Port code needs to be fetched from masters files. Transfers Static Data |
NOTE :
Currently the API will supports transfer between airport and hotel & so only possible value for now are "air" or "hotel"
The API doesn't supports transfer between 2 Airports ( from Airport to Airport) and transfer between 2 Hotels (Hotel to Hotel)
GRN Station and GRN Port will be launched in second phase.
Transfer - Departure & Return
| Attribute | Type | Required | Description |
|---|---|---|---|
| transfer_date | String | REQUIRED | Date of pickup 2020-03-06 yyyy-mm-dd |
| transfer_time | String | REQUIRED | Format: 16:06 hh:mm (hours:minutes) 24 hr format |
Transfer - Departure Will have transfer date & time for departure transfer
Transfer - Departure & Return (Round trip) Will have transfer date & time for return transfer
{
"transfer_departure": {
"transfer_date": "2020-03-06",
"transfer_time": "12:06"
},
"transfer_return": {
"transfer_date": "2020-03-09",
"transfer_time": "16:12"
}
}
Timeout and Currency
| Attribute | Type | Required | Description |
|---|---|---|---|
| timeout | Integer | REQUIRED | Timeout in milliseconds. This is search response time-out. One can define the value depending on the response time required. Default will be 10000 milliseconds Minimum allowed value is 8000 Maximum allowed value is 30000 |
| currency | String | REQUIRED | Preferred currency for the prices in the results. Default is the agent’s base currency. Format: Three letter ISO Currency code e.g USD, EUR, INR, CHF. |
| client_nationality | String | REQUIRED | Nationality of the guest Format: Two-letter ISO Country code |
Occupancy
Will have adult, child & infant for depature as well as return transfer. Pax remanin same for departure & return transfer.
| Attribute | Type | Required | Description |
|---|---|---|---|
| adults | Integer | REQUIRED | The number of adults in the vehicle |
| children | Integer | REQUIRED | The number of children in the vehicle Between : 1-11 years |
| infants | Integer | REQUIRED | The number of infants in the vehicle Between : 0-1 year |
NOTE : In any case "adult" is required.