Flight Book
Last updated
Last updated
gatkey
string
gatkey (provided by traveloapi)Pass gatkey with url
BookSegment
string
It contains information about booking Segments
EngineID
string
This parameter has been defined as Enumeration type which has specified list of constant values. Each int value has been assigned to a different airline Indigo = 0, Spicjet = 1, GoAir = 5, TravelPort = 7, AirAsia=10, AirCosta = 6, Trujet=11.
EngineIDList
string
It contains list of all airlines
IsAndroidBooking
string
It contains boolean value(True/False)
IsDomestic
string
This element represents whether flight is for domestic or international places and has bool type values(True/False)
PaymentDetails
string
BookingAmount
string
This is required element and represents total amount needed to make flight booking.
BookingCurrencyCode
string
Represents currency code for a speific country (like INR for Indian Rupee and AUD for Australia Dollar).
SearchDetail
string
This parameter gets and sets the entire flight search – specified properties entered by user.These search parameters should be submiited as query string with URL
Origin
string
This value represents source city name. Three alphabetic IATA code should be entered by user to get valid source city. This field should not contain More than and less than 3 characters.
Destination
string
It represents destination city/airport name .It cannot be same as source value. Three alphabetic IATA code should be entered by user to get valid destination city. This field should not contain More than and less than 3 characters.
BeginDate
string
It represents journey date. This value should be entered as string not less than and More than 10 characters in date format ‘dd/mm/yyyy’.(Date and time are taken in miliseconds)
EndDate
string
It represents return date and should be entered as string not less than and More than 10 characters in date format ‘dd/mm/yyyy’. It cannot be greater than journey date.(Date and time are taken in miliseconds)
Cabin
string
This field has enumeration values (Economy =0,Business=2)
CurrencyCode
string
Represents currency code for a speific country (like INR for Indian Rupee and AUD for Australia Dollar).
VisaType
string
Type of the Visa (e.g Employee Visa, Student Visa and Tourist Visa)
TraceId
string
Mandatory To Send Flight Recheck and Flight Booking Api, It is a unique id By Us
TransactionId
string
It contains value of transaction id which is unique for every booking.
Travellers
string
This property has been defined under class Traveller which sets all the properties of TravellerDetail class which in turn sets all properties related to passenger detail mentioned below.
AdultTraveller
string
Domain for this field contains values from 1-9. At least one adult must be selected.
Address1
string
It represents address details of the user
Address2
string
It also use for the address details of the user
City
string
This value represents source city name.
CountryCode
string
Two letter ISO country code.
CultureCode
string
DOB
string
It represents the date of birth of the user(Date and time are taken in miliseconds)
EmailAddress
string
Email id of the user
FirstName
string
It represents the first name of the user.
FrequentFlierNumber
string
Flight frequent flier number
Gender
string
This property has been defined as enumeration type having two constant values as MALE and FEMALE
HomePhone
string
Land-line number
LastName
string
It represents the last name of the user
Meal
string
This property has been defined as enumeration type having three constant values as VGML, NVML, UnMapped
MiddleName
string
It represents the middle name of the user
MobileNumber
string
It represents the mobile number
Nationality
string
It represents natinality of the user like Indian etc etc.
PassportExpiryDate
string
Represents date of passport expiration(Date and time are taken in miliseconds)
PassportNo
string
Reprsents passport number of the user.
PaxType
string
This property has enumeration type and has specified list of constant values as (ADT, CHD and INF)
ProvisionState
string
It represents state.
ResidentCountry
string
It represents country where the user resident
Title
string
It represents the values like Mr., Mrs.
ChildTraveller
string
Domain range for this field is 0-9
Address1
string
It represents address details of the user
Address2
string
It also use for the address details of the user
City
string
This value represents source city name.
CountryCode
string
Two letter ISO country code.
CultureCode
string
DOB
string
It represents the date of birth of the user(Date and time are taken in miliseconds)
EmailAddress
string
Email id of the user
FirstName
string
It represents the first name of the user.
FrequentFlierNumber
string
Flight frequent flier number
Gender
string
This property has been defined as enumeration type having two constant values as MALE and FEMALE
HomePhone
string
Land-line number
LastName
string
It represents the last name of the user
Meal
string
This property has been defined as enumeration type having three constant values as VGML, NVML, UnMapped
MiddleName
string
It represents the middle name of the user
MobileNumber
string
It represents the mobile number
Nationality
string
It represents natinality of the user like Indian etc etc.
PassportExpiryDate
string
Represents date of passport expiration(Date and time are taken in miliseconds).
PassportNo
string
Reprsents passport number of the user.
PaxType
string
This property has enumeration type and has specified list of constant values as (ADT, CHD and INF)
ProvisionState
string
It represents state.
ResidentCountry
string
It represents country where the user resident
Title
string
It represents the values like Mr., Mrs.
InfantTraveller
string
This field’s domain has values from 0-2. Number of infants cannot be more than number of adults as per single booking
Address1
string
It represents address details of the user
Address2
string
It also use for the address details of the user
City
string
This value represents source city name.
CountryCode
string
Two letter ISO country code.
CultureCode
string
Culture Code
DOB
string
It represents the date of birth of the user(Date and time are taken in miliseconds)
EmailAddress
string
Email id of the user
FirstName
string
It represents the first name of the user.
FrequentFlierNumber
string
Flight frequent flier number
Gender
string
This property has been defined as enumeration type having two constant values as MALE and FEMALE
HomePhone
string
Land-line number
LastName
string
It represents the last name of the user
Meal
string
This property has been defined as enumeration type having three constant values as VGML, NVML, UnMapped
MiddleName
string
It represents the middle name of the user
MobileNumber
string
It represents the mobile number
Nationality
string
It represents natinality of the user like Indian etc etc.
PassportExpiryDate
string
Represents date of passport expiration(Date and time are taken in miliseconds).
PassportNo
string
Reprsents passport number of the user.
PaxType
string
This property has enumeration type and has specified list of constant values as (ADT, CHD and INF)
ProvisionState
string
It represents state.
ResidentCountry
string
It represents country where the user resident
Title
string
It represents the values like Mr., Mrs.
Segments
string
BondType
string
IsInternational
Bonds
string
IsRoundTrip
Deeplink
string
IsSpecial
EngineID
string
IsSpecialId
Fare
string
ItineraryKey
FareRule
string
JourneyIndex
IsBaggageFare
string
NearByAirport
IsCache
string
Remark
IsHoldBooking
string
SearchId
Bonds
string
BoundType
string
Represents Inbound/Outbound flight
ItineraryKey
string
Represents a string value for a particular journey from source to destination
IsBaggageFare
string
Fares for baggage facility(True/False)
IsSSR
string
It contains boolean value(True/False)
JourneyTime
string
Represents journey duration
Legs
string
Represents details about flight
SpecialServices
string
Represents special services provided in flight
MealType
string
This property has been defined as enumeration type having three constant values as VGML, NVML, UnMapped
IsMeal
string
It contains boolean value (True/False)
PaxType
string
This property has enumeration type and has specified list of constant values as (ADT=0,CHD=1 and INF=2)
Id
string
Unique id provided to each meal type
Legs
string
AircraftCode
string
This is provided by airline (for eg: VX09KHT7TSm+ZhCrSZcPJg==)
AircraftType
string
Provided by airline
AirlineName
string
Represents name of the airline(Spice Jet,Indigo,GoAir,GDS)
Amount
string
Calculated amount of other services like tax, PSF, UDF
ArrivalDate
string
It represents arrival date of the Journey.
ArrivalTerminal
string
It represents arrival terminal of the Journey.
ArrivalTime
string
It represents arrival time of the Journey.
AvailableSeat
string
Total numbers of seats available.
BaggageUnit
string
Units like KG and G etc.
BaggageWeight
string
It represents the weight of the baggage.
BoundType
string
Represents Inbound/Outbound flight
Cabin
string
This field has enumeration values (Economy =0,Business=2)
CabinClasses
string
BookingClass
string
CabinType
string
This field has enumeration values (Economy =0,Business=2)
Capacity
string
Total capacity
CarrierCode
string
Flight carrier code
CurrencyCode
string
Represents currency codes(INR for india)
DepartureDate
string
It represents departure date of the journey.
DepartureTerminal
string
It represents departure terminal of the Journey.
DepartureTime
string
It represents departure time of the journey.
Destination
string
It represents destination city/airport name .It cannot be same as source value. Three alphabetic IATA code should be entered by user to get valid destination city. This field should not contain More than and less than 3 characters.
Duration
string
It represents the total time duration of the journey.
FareBasisCode
string
Flight fare basis code
FareClassOfService
string
It is an array type having a list of constant values.
FlightDesignator
string
Flight designator details
FlightDetailRefKey
string
Id for flight details
FlightNumber
string
It represents the flight number.
Group
string
IsConnecting
string
It contains boolean value(True/False)
NumberOfStops
string
Total number of stops between source to destination
Origin
string
This value represents source city name. Three alphabetic IATA code should be entered by user to get valid source city. This field should not contain More than and less than 3 characters.
ProviderCode
string
Airline provider code
Remarks
string
Brief description
SSRDetails
string
Amount
string
Detail
string
SSRCode
string
SSRType
string
Sold
string
Status
string
Status of the booking
Fare
string
BasicFare
string
Represents basic fares excluding of any other service charges
ExchangeRate
string
Exchange Rate
PaxFares
string
It contains information about BaggageUnit,BaggageWeight, BasicFare and PaxType.
TotalFareWithOutMarkUp
string
Total amount
TotalTaxWithOutMarkUp
string
Total tax
PaxFares
string
BaggageUnit
string
Units like KG and G etc.
BaggageWeight
string
It represents the weight of the baggage.
BaseTransactionAmount
string
It contains transaction amount
BasicFare
string
Represents basic fares excluding of any other service charges
CancelPenalty
string
Cancel before departure date within twenty four hours(CAN-BEF 24_0:14811)
ChangePenalty
string
Change before departure date within twenty fore hours (CHG-BEF 24_0:4443.0)
EquivCurrencyCode
string
Flight equivalent currency code
Fare
string
Amount
string
Calculated amount of other services like tax, PSF, UDF
ChargeCode
string
This field stores a specific code for applied charge.
ChargeType
string
Represents which type of charge has been applied(Like Tax, Service Charge, Travel Fee, Fare Price)
FareBasisCode
string
Flight fare basis code
FareInfoKey
string
Flight fare information key
FareInfoValue
string
Flight fare information value
MarkUP
string
Flight markup
PaxType
string
This property has enumeration type and has specified list of constant values as (ADT, CHD and INF)
Refundable
string
Represents whether this flight is refundable or non refundable
TotalFare
string
Calculated amount of other services like tax, PSF, UDF
TotalTax
string
Total tax
TransactionAmount
string
Transaction Amount