Booking Request

Request

Method	URL
POST	api/v3/transfers/bookings

Booking Payload

Attribute	Type	Required	Description
search_id	string	REQUIRED	Search ID returned in the search response
transfer_code	string	REQUIRED	GRN Transfer code returned in search response
booking_name	string	OPTIONAL	Name of the booking; for agent’s reference
holder	object	REQUIRED	Information of the lead passenger. See Holder for details.
booking_items	array	REQUIRED	Information of the vehicles and the pax in the vehicles. See “Booking Item” for details.
booking_comments	string	OPTIONAL	Optional booking comments to be passed along to the transfer

Booking Item:

Attribute	Type	Required	Description
rate_key	string	REQUIRED	rate_key value from the search response
pickup_details	object	REQUIRED	Pickup details w.r.t Airport, City(Address), Station, Port, Hotel
dropoff_details	object	REQUIRED	Dropoff details w.r.t Airport, City(Address), Station, Port, Hotel
vehicles	array	REQUIRED	List of vehicle elements

PickUp Details

Depending on the PickUp Type the structure needs to be defined

Airport

Attribute	Type	Required	Description
flight_number	string	REQUIRED	The flight number the passenger is arriving
time	time	REQUIRED	The estimated arrival time of the passenger
arriving_from	string	REQUIRED	The airport code the passenger is arriving from

City

Attribute	Type	Required	Description
address_line1	string	REQUIRED	The address of the pickup location
address_line2	string	OPTIONAL	Additional field for address
postal_code	string	REQUIRED	Postal code of the address

Station

Attribute	Type	Required	Description
train_name	string	REQUIRED	The train name the passenger is arriving
time	time	REQUIRED	The estimated arrival time of the passenger
arriving_from	string	REQUIRED	The station code the passenger is arriving from

DropOff Details

Depending on the DropOff Type the structure needs to be defined

Airport

Attribute	Type	Required	Description
flight_number	string	REQUIRED	The flight number the passenger is arriving
time	time	REQUIRED	The departure time of the passenger
departing_to	string	REQUIRED	The airport code the passenger is departing to

City

Attribute	Type	Required	Description
address_line1	string	REQUIRED	The address of the dropoff location
address_line2	string	OPTIONAL	Additional field for address
postal_code	string	REQUIRED	Postal code of the address

Station

Attribute	Type	Required	Description
train_number	string	REQUIRED	The train number the passenger is arriving
time	time	REQUIRED	The departure time of the passenger
departing_to	string	REQUIRED	The station code the passenger is departing to

Vehicle

Attribute	Type	Required	Description
paxes	array	REQUIRED	Contains the information of pax in the vehicle

Pax

Attribute	Type	Required	Description
title	string	REQUIRED	Title of the passenger (accepted values are: “Mr.”, “Ms.”, “Mrs.”, “Mstr.”)
name	string	REQUIRED	Name of the person. Must not contain any special characters and numbers.
surname	string	REQUIRED	Surname/patronymic of the person. Must not contain any special characters and numbers.
type	string	REQUIRED	Must be either “AD” or “CH”
age	integer	REQUIRED if type = “CH”	Age of the child

Holder

Attribute	Type	Required	Description
title	string	REQUIRED	Title of the passenger (accepted values are: “Mr.”, “Ms.”, “Mrs.”, “Mstr.”)
name	string	REQUIRED	Name of the lead passenger. Must not contain any special characters and numbers.
surname	string	REQUIRED	Surname/patronymic of the lead passenger. Must not contain any special characters and numbers.
email	string	REQUIRED	Valid email address of the lead passenger
phone_number	string	REQUIRED	Phone number of the lead passenger
client_nationality	string	REQUIRED	Two-letter ISO country code of the lead passenger

Sample Booking Payload

{
    "search_id": "mbpoybauvy7mmsxpkeflxfqhxe",
    "transfer_code": "T!000006399006",
    "booking_name": "transfers test",
    "booking_comments": "transfers test booking",
    "booking_items": [{
        "rate_key": "5hgfdnbi4iucpubi3l4w2f4busdkls72uxr35vzorfgal6hlitkwfbxqoyfdj25x6abchvvxzbkvgwr4uk2hg5o2",
        "vehicles": [{
            "paxes": [{
                    "name": "James",
                    "surname": "Patrick",
                    "type": "AD",
                    "title": "Mr."
                },
                {
                    "name": "Harry",
                    "surname": "Patrick",
                    "type": "AD",
                    "title": "Mr."
                }
            ]
        }],
        "dropoff": {
            "flight_number": "test flight",
            "time": "23:00",
            "departing_to": "A!HYD"
        },
        "pickup": {
            "flight_number": "test flight",
            "time": "13:00",
            "arriving_from": "A!HYD"
        }
    }],
    "holder": {
        "title": "Mrs.",
        "surname": "James",
        "phone_number": "8801622227333",
        "name": "Patrick",
        "email": "jamie@abc.com",
        "client_nationality": "IN"
    }
}