Search And Availability Response

Response

Attribute	Type	Description
transfers	list	An array of transfers with availability information. Transfer is described below.
search_id	string	Unique ID for the search request
pickup_date	date	Pickup date
pickup_time	time	Represents the transfer-time requested
no_of_transfers	integer	The number of transfers in the response
no_of_children	integer	Number of children
no_of_adults	integer	Number of adults

Transfer

Attribute	Type	Description
transfer_code	string	Unique GRN Transfer code
transfer_time	time	hh:mm
name	string	Name of the transfer
min_rate	object	Contains the lowest price within a given transfer for the given search criteria.
rates	array	An array of all available rates for a Transfer. rate element is described below.

Rate

Attribute	Type	Description
rate_key	string	Unique code representing the rate. REQUIRED, to be included when making a booking request.
rate_type	string	Possible values are ‘bookable’
rate_comments	object	Object of dynamic key value pairs. Ex: { “comments”: “Rate comments come here”, “pickup-Instruction”: “pickup details come here” }
non_refundable	boolean	‘true’ if the rate is Non-refundable. Otherwise, cancellation policies applicable.
price	float	Price for the vehicles included in this rate.
price_details	object	Price details. Refer below for more info.
currency	string	Three-letter ISO currency code of the price
cancellation_policy	object	Cancellation policy for the rate. See Cancellation Policy for details.
cancellation_policy_code	string	Code representing the cancellation policy for the rate. This is returned when cancellation policies are not available for the rate. This shall be used for fetching cancellation policies for the rate using cancellation policy end point.
other_inclusions	array	Array of other inclusions (strings), if available
supports_amendment	boolean	“true” if this booking can be amended through api.
supports_cancellation	boolean	“true” if this booking can be cancelled through api.
vehicles	array	Array of vehicles included for this rate. See Vehicle for details.
pickup	object	The pickup code and name are displayed. See Pickup for details.
dropoff	object	The drop code and name are displayed. See Dropoff for details.
includes_ac	boolean	“true” if this vehicle includes ac

Pickup

Attribute	Type	Description
code	string	One of the City, Airport(IATA), Hotel, Port, Station code
name	string	Name/Description

Dropoff

Attribute	Type	Description
code	string	One of the City, Airport(IATA), Hotel, Port, Station code
name	string	Name/Description

Price Details

Dynamic key-value pairs, where each value is an array of charge details. These details are for display purpose only. A compliant implementation is not required to process or interpret these details.

Refer sample price_details below.

Attribute	Type	Description
name	string	Name of the charge.
included	boolean	‘true’ if the charge is already included in the price.
amount_type	string	Defines the type of amount. Possible values: 1. value represents flat_fee 2. percent represents percentage
amount	float	Flat fee or percentage value.
mandatory	boolean	‘true’ if this must be paid either at booking. Otherwise, this has to be paid only if you need the supplement/facility.
currency	string	Three-letter ISO currency code
comments	string	Description or any notes for the charge if available.

Sample price_details

{
    "price_details": {
        "net": [{
                "name": "SupplierPrice",
                "included": true,
                "currency": "INR",
                "amount_type": "value",
                "amount": 9120
            },
            {
                "name": "ServiceFee",
                "included": true,
                "currency": "INR",
                "amount_type": "value",
                "amount": 182.4
            },
            {
                "name": "Total",
                "included": true,
                "currency": "INR",
                "amount_type": "value",
                "amount": 9302.4
            }
        ],
        "GST": [{
            "name": "Total",
            "included": true,
            "currency": "INR",
            "amount_type": "value",
            "amount": 32.83
        }]
    }
}

Vehicle

Attribute	Type	Description
vehicle_type	string	Vehicle type. E.g. Premium, sedan
vehicle_name	string	Vehicle name. E.g. Standard Car
vehicle_code	string	Vehicle code. E.g ‘SA’
no_of_adults	integer	Number of adults if available.
no_of_children	integer	Number of children if available.
children_ages	array	Ages of the children if applicable.
description	string	Description of the vehicle
vehicle_conditions	object	Object of dynamic key value pairs. Eg: { “conditions”: “IMPORTANT: All infants and children must ride in an age and size appropriate child safety seat or booster seat. Customers are responsible for providing their own safety seats.” }
max_vehicle_occupancy	object	An object representing maximum vehicle occupancy.This will be returned when no_of_adults is not available.
max_luggage	integer	Maximum luggage allowed in the vehicle
images	object	Images of the Vehicle

Max Vehicle Occupancy

Attribute	Type	Description
max_pax	integer	Maximum number of total guests allowed
max_adults	integer	Maximum number of adults allowed
max_children	integer	Maximum number of children allowed

Cancellation Policy

Attribute	Type	Description
under_cancellation	boolean	“true” if the booking is under cancellation, i.e. cancellation charges will apply should a cancellation be made later.
cancel_by_date	datetime	Last date for cancellation without charges. Mutually-exclusive with “under_cancellation” being “true”. The time zone will be the destination time zone.
no_show_fee	object	Charges for no show. An Object with the following fields: amount_type: represents the type of value. As mentioned below. currency: Three-letter ISO currency code
amount_type	string	Defines the type of value in details: value: represents amount percentage: represents percentage
details	array	List of cancellation windows and applicable charges. Refer policy details below.
policy_text	string	Description of applicable cancellation-policies in string format if available.

Policy Details:

Attribute	Type	Description
from	datetime	Date from which the charge in this window applies
percent	float	Charges in percentage
flat_fee	float	Charge applicable
currency	string	Three-letter ISO currency code

Error Codes

HTTP StatusCode	Error Code	Description
200	5101	Field[name] is required
200	5102	Field[name] value/type is invalid
200	5108	Pickup date must be valid, and in ISO8601 format (YYYY-MM-DD)
200	7109	Pickup date cannot be older than today
200	5106	Children ages should be between 0 and 18
200	1501	No availability for the requested search criteria
200	1502	No transfers found for the query
401	1102	Invalid API key

Sample Search Response

{
    "transfers": [{
        "transfer_time": "01:45",
        "transfer_code": "T!000006399006",
        "rates": [{
            "vehicles": [{
                "vehicle_name": "People Carrier",
                "vehicle_conditions": {
                    "conditions": "IMPORTANT: All infants and children must ride in an age and size appropriate child safety seat or booster seat. Customers are responsible for providing their own safety seats."
                },
                "vehicle_code": "PC",
                "max_vehicle_occupancy": {
                    "max_pax": 5
                },
                "max_luggage": 5
            }],
            "supports_cancellation": true,
            "supports_amendment": false,
            "rate_type": "bookable",
            "rate_key": "4dhf3mrw7quc3uc33xsqkf64w6lpxs5cuxtlrb35rbgu3yppisdcvgxqejmc575q65jwvghmyubamwzt77ssgigtsy",
            "price_details": {
                "net": [{
                    "name": "Net",
                    "included": true,
                    "currency": "INR",
                    "amount_type": "value",
                    "amount": 11069.6
                }]
            },
            "price": 11069.6,
            "pickup": {
                "name": "London Heathrow Airport",
                "code": "A!LHR"
            },
            "non_refundable": false,
            "dropoff": {
                "name": "London Gatwick Airport",
                "code": "A!LGW"
            },
            "currency": "INR",
            "cancellation_policy": {
                "under_cancellation": false,
                "details": [{
                    "from": "2017-10-08T00:00:00",
                    "flat_fee": 11069.6,
                    "currency": "INR"
                }],
                "cancel_by_date": "2017-10-07T23:59:59",
                "amount_type": "value"
            },
            "availability_status": "available"
        }],
        "name": "London Heathrow Airport to London Gatwick Airport with a Driver speaking the Local Language only"
    }],
    "search_id": "zmfux7oic753exyilqz5suf2im",
    "pickup_time": "23:15",
    "pickup_date": "2017-10-12",
    "no_of_transfers": 1,
    "no_of_children": 0,
    "no_of_adults": 2
}