GDS Flight Book
Book method is to hold the Booking of NonLCC airline. Every NonLCC airline must be Hold first before ticketing. It will not work for LCC airline because LCC airline is ticketed directly.
Parameters
Name
Description
Accept
string
( header )
Must be application/json
Accept - Encoding
string
( header )
Must be gzip
Authorization
string
( header )
Must be Your PID
Must be Your API Key
Customer-Ip
string
( header )
Must be IP address of the customer, as captured by your integration. Send IPV4 addresses only.
Ensure your integration passes the customer’s IP, not your own. This value helps determine their location and other settings.
Also used for fraud recovery and other important analytics.
Definition and request parameters for Flight Book Method
action
string
( query )
Must be "flightBook" as parameter
Action methods in Web API controller can have one or more parameters of different types. It can be either primitive type or complex type. Web API binds action method parameters either with URL's query string or with request body depending on the parameter type.
ResultIndex
string
( query )
Result Index ie. "OB1"
TraceId
string
( query )
Trace Id (Get Trace Id from search response)
IsLCC
string
( query )
IsLCC (IsLCC="0")
isoneway
string
( query )
oneway Or return trip (isoneway="Yes" or isoneway="No")
isDomestic
string
( query )
isDomestic (isDomestic="Yes" or isDomestic="No")
IsDomesticReturn
string
( query )
IsDomesticReturn (isDomestic="Yes" or isDomestic="No")
Passengers
Array
Passengers details for the ticket
Title
string
( query )
Title (Adult Mr/Mrs Child Miss/Mstr Infant Miss/Mstr)
FirstName
string
( query )
First name
LastName
string
( query )
Last Name
PaxType
String
( query )
Pax type (Adult = 1,Child = 2,Infant = 3)
DateOfBirth
Date Time
String
( query )
Gender
String
( query )
Gender (Male=1,Female=2)
PassportNo
String
( query )
Passport no
PassportExpiry
Date time
( query )
Passport expiry
AddressLine1
String
( query )
Address
AddressLine2
String
( query )
Address
City
String
( query )
City
CountryCode
String
( query )
Country code
CountryName
String
( query )
Country Name
Nationality
String
( query )
Nationality
ContactNo
String
( query )
Contact no
String
( query )
IsLeadPax
Boolean
( query )
Represent the lead guest of the booking (Value True/ False)
Fare
Array
Fare details for the ticket
Currency
String
( query )
Currency
BaseFare
decimal
( query )
Base fare
Tax
decimal
( query )
Tax
YQTax
decimal
( query )
Fuel Surcharge
AdditionalTxnFeePub
decimal
( query )
Additional Transaction Fee Published
AdditionalTxnFeeOfrd
decimal
( query )
Additional Transaction Fee Offered
OtherCharges
decimal
( query )
Other Charges
Discount
decimal
( query )
Discount
PublishedFare
decimal
( query )
Published Fare
OfferedFare
decimal
( query )
Offered Fare
TdsOnCommission
decimal
( query )
Tds On Commission
TdsOnPLB
decimal
( query )
Tds On PLB
TdsOnIncentive
decimal
( query )
Tds On Incentive
ServiceFee
decimal
( query )
Service Fee
GSTCompanyAddress
String
( query )
GSTCompanyAddress
GSTCompanyContactNumber
String
( query )
GSTCompanyContactNumber
GSTCompanyName
String
( query )
GSTCompanyName
GSTNumber
String
( query )
GSTNumber
GSTCompanyEmail
String
( query )
GSTCompanyEmail
REQUEST
API Endpoint: https://your-end-point/api/v1/travel-api/flights/
header: array(
'Content-Type:application/json',
'Accept-encoding: gzip',
'PID:'ADD-YOUR-KEY',
'x-api-key:'ADD-YOUR-KEY'
);
POST:
{
"action": "flightBook",
"IsLCC": "0",
"isoneway": "Yes",
"isDomestic": "Yes",
"IsDomesticReturn": "No",
"TraceId": "6fda2744-05e6-47fb-98b4-73e12c30ef73",
"ResultIndex": "OB35",
"Passengers": [
{
"Title": "Mr",
"FirstName": "Test",
"LastName": "Booking",
"PaxType": "1",
"DateOfBirth": "1995-07-17T00:00:00",
"Gender": 1,
"AddressLine1": "D-88 Ground Floor Sector 17 Vashi, Navi mumbai",
"AddressLine2": "",
"City": "Navi Mumbai",
"CountryCode": "IN",
"CountryName": "India",
"Nationality": "IN",
"ContactNo": "9988776655",
"Email": "test@gmail.com",
"IsLeadPax": true,
"PassportNo": "",
"PassportExpiry": "",
"Fare": {
"Currency": "INR",
"BaseFare": 1000,
"Tax": 518,
"YQTax": 0,
"AdditionalTxnFeePub": 0,
"AdditionalTxnFeeOfrd": 0,
"OtherCharges": 640,
"Discount": 0,
"PublishedFare": 2158,
"OfferedFare": 2158,
"TdsOnCommission": 0,
"TdsOnPLB": 0,
"TdsOnIncentive": 0,
"ServiceFee": 0
},
"GSTCompanyAddress": null,
"GSTCompanyContactNumber": null,
"GSTCompanyName": null,
"GSTNumber": null,
"GSTCompanyEmail": null
}
]
}
Response
The API returns an HTTP response, which generally includes the result of the request invocation
{
"status": "200",
"status_message": "OK",
"responseData": {
{
"Error": {
"ErrorCode": 0,
"ErrorMessage": ""
},
"TraceId": "5cfdf80d-7b55-4e9d-a6c1-21f091dc6ee7",
"ResponseStatus": 1,
"Response": {
"PNR": "WFWVIA",
"BookingId": 1304924,
"SSRDenied": false,
"SSRMessage": null,
"Status": 1,
"IsPriceChanged": false,
"IsTimeChanged": false,
"FlightItinerary": {
"BookingAllowedForRoamer": true,
"BookingId": 1304924,
"PNR": "WFWVIA",
"IsManual": false,
"Source": 4,
"IsDomestic": true,
"Origin": "DEL",
"Destination": "BOM",
"AirlineCode": "AI",
"ValidatingAirlineCode": "AI",
"LastTicketDate": "29JUN17",
"AirlineTollFreeNo": "1800-1100-2200-100",
"IsLCC": false,
"NonRefundable": true,
"AirlineRemark": "",
"FareType": "RP",
"CreditNoteNo": null,
"BaseCurrencyFare": {
"Currency": "INR",
"BaseFare": 3171.0,
"Tax": 1284.0,
"TaxBreakup": [
{
"Key": "YQTax",
"Value": 0.0
},
{
"Key": "YR",
"Value": 140.0
},
{
"Key": "TotalTax",
"Value": 1284.0
}
],
"YQTax": 0.0,
"AdditionalTxnFeePub": 0.0,
"PGCharge": 0.0,
"AdditionalTxnFeeOfrd": 0.0,
"OtherCharges": 116.96,
"ChargeBU": [
{
"Key": "TBOMARKUP",
"Value": 26.81
},
{
"Key": "CONVENIENCECHARGE",
"Value": 0.0
},
{
"Key": "OTHERCHARGE",
"Value": 90.15
}
],
"Discount": 0.0,
"PublishedFare": 4581.96,
"CommissionEarned": 63.42,
"PLBEarned": 91.36,
"IncentiveEarned": 62.15,
"OfferedFare": 4355.03,
"TdsOnCommission": 6.34,
"TdsOnPLB": 9.14,
"TdsOnIncentive": 6.22,
"ServiceFee": 10.0,
"TotalBaggageCharges": 0.0,
"TotalMealCharges": 0.0,
"TotalSeatCharges": 0.0,
"TotalSpecialServiceCharges": 0.0
},
"Fare": {
"Currency": "INR",
"BaseFare": 3171.0,
"Tax": 1284.0,
"TaxBreakup": [
{
"Key": "YQTax",
"Value": 0.0
},
{
"Key": "YR",
"Value": 140.0
},
{
"Key": "TotalTax",
"Value": 1284.0
}
],
"YQTax": 0.0,
"AdditionalTxnFeePub": 0.0,
"PGCharge": 0.0,
"AdditionalTxnFeeOfrd": 0.0,
"OtherCharges": 116.96,
"ChargeBU": [
{
"Key": "TBOMARKUP",
"Value": 26.81
},
{
"Key": "CONVENIENCECHARGE",
"Value": 0.0
},
{
"Key": "OTHERCHARGE",
"Value": 90.15
}
],
"Discount": 0.0,
"PublishedFare": 4581.96,
"CommissionEarned": 63.42,
"PLBEarned": 91.36,
"IncentiveEarned": 62.15,
"OfferedFare": 4355.03,
"TdsOnCommission": 6.34,
"TdsOnPLB": 9.14,
"TdsOnIncentive": 6.22,
"ServiceFee": 10.0,
"TotalBaggageCharges": 0.0,
"TotalMealCharges": 0.0,
"TotalSeatCharges": 0.0,
"TotalSpecialServiceCharges": 0.0
},
"CreditNoteCreatedOn": null,
"Passenger": [
{
"PaxId": 1785775,
"Title": "Mr",
"FirstName": "hgjsshsxsgjh",
"LastName": "tbotest",
"PaxType": 1,
"DateOfBirth": "1987-12-06T00:00:00",
"Gender": 1,
"PassportNo": "KJHHJKHKJH",
"PassportExpiry": "2020-12-06T00:00:00",
"AddressLine1": "123, Test",
"AddressLine2": "",
"Fare": {
"Currency": "INR",
"BaseFare": 3171.0,
"Tax": 1284.0,
"TaxBreakup": [
{
"Key": "YQTax",
"Value": 0.0
},
{
"Key": "YR",
"Value": 140.0
},
{
"Key": "TotalTax",
"Value": 1284.0
}
],
"YQTax": 0.0,
"AdditionalTxnFeePub": 0.0,
"PGCharge": 0.0,
"AdditionalTxnFeeOfrd": 0.0,
"OtherCharges": 116.96,
"ChargeBU": [
{
"Key": "TBOMARKUP",
"Value": 26.81
},
{
"Key": "CONVENIENCECHARGE",
"Value": 0.0
},
{
"Key": "OTHERCHARGE",
"Value": 90.15
}
],
"Discount": 0.0,
"PublishedFare": 4581.96,
"CommissionEarned": 63.42,
"PLBEarned": 91.36,
"IncentiveEarned": 62.15,
"OfferedFare": 4355.03,
"TdsOnCommission": 6.34,
"TdsOnPLB": 9.14,
"TdsOnIncentive": 6.22,
"ServiceFee": 10.0,
"TotalBaggageCharges": 0.0,
"TotalMealCharges": 0.0,
"TotalSeatCharges": 0.0,
"TotalSpecialServiceCharges": 0.0
},
"City": "Gurgaon",
"CountryCode": "IN",
"CountryName": "India",
"Nationality": "IN",
"ContactNo": "+92581-1234567890",
"Email": "harsh@tbtq.in",
"IsLeadPax": true,
"FFAirlineCode": null,
s"FFNumber": "",
"GSTCompanyAddress": "A-fhgjkhsjkfd",
"GSTCompanyContactNumber": "98881063278748979",
"GSTCompanyName": "nikhil",
"GSTNumber": "700932234532413",
"GSTCompanyEmail": "nikhil123@gmail.com"
}
],
"CancellationCharges": null,
"Segments": [
{
"Baggage": null,
"CabinBaggage": null,
"TripIndicator": 1,
"SegmentIndicator": 1,
"Airline": {
"AirlineCode": "AI",
"AirlineName": "Air India",
"FlightNumber": "544",
"FareClass": "S",
"OperatingCarrier": "AI"
},
"AirlinePNR": "",
"Origin": {
"Airport": {
"AirportCode": "DEL",
"AirportName": "Indira Gandhi Airport",
"Terminal": "3",
"CityCode": "DEL",
"CityName": "Delhi",
"CountryCode": "IN",
"CountryName": "India"
},
"DepTime": "2017-08-15T13:15:00"
},
"Destination": {
"Airport": {
"AirportCode": "HYD",
"AirportName": "Shamsabad International Airport",
"Terminal": "",
"CityCode": "HYD",
"CityName": "Hyderabad",
"CountryCode": "IN",
"CountryName": "India"
},
"ArrTime": "2017-08-15T15:15:00"
},
"Duration": 0,
"GroundTime": 0,
"Mile": 0,
"StopOver": false,
"StopPoint": "",
"StopPointArrivalTime": "2017-08-15T15:15:00",
"StopPointDepartureTime": "2017-08-15T13:15:00",
"Craft": "320",
"Remark": "DEPARTURE DEL TERMINAL 3 / ARRIVAL HYD TERMINAL, SEE RTSVC",
"IsETicketEligible": false,
"FlightStatus": "Confirmed",
"Status": "HK"
},
{
"Baggage": null,
"CabinBaggage": null,
"TripIndicator": 1,
"SegmentIndicator": 2,
"Airline": {
"AirlineCode": "AI",
"AirlineName": "Air India",
"FlightNumber": "318",
"FareClass": "S",
"OperatingCarrier": "AI"
},
"AirlinePNR": "",
"Origin": {
"Airport": {
"AirportCode": "HYD",
"AirportName": "Shamsabad International Airport",
"Terminal": "",
"CityCode": "HYD",
"CityName": "Hyderabad",
"CountryCode": "IN",
"CountryName": "India"
},
"DepTime": "2017-08-15T17:00:00"
},
"Destination": {
"Airport": {
"AirportCode": "BOM",
"AirportName": "Mumbai",
"Terminal": "",
"CityCode": "BOM",
"CityName": "Mumbai",
"CountryCode": "IN",
"CountryName": "India"
},
"ArrTime": "2017-08-15T18:25:00"
},
"AccumulatedDuration": 310,
"Duration": 0,
"GroundTime": 0,
"Mile": 0,
"StopOver": false,
"StopPoint": "",
"StopPointArrivalTime": "2017-08-15T18:25:00",
"StopPointDepartureTime": "2017-08-15T17:00:00",
"Craft": "319",
"Remark": null,
"IsETicketEligible": false,
"FlightStatus": "Confirmed",
"Status": "HK"
}
],
"FareRules": [
{
"Origin": "DEL",
"Destination": "HYD",
"Airline": "AI",
"FareBasisCode": "SAP20",
"FareRuleDetail": " Advance Purchase Fare Component SAP20 Sector DEL-HYD Fare Component SAP20 Sector HYD-BOM Earliest reservation date before departure No restriction Earliest ticketing date before departure No restriction Latest reservation date before departure No restriction Latest ticketing date before departure 26JUL17 2359 Latest ticketing date after reservation No restriction There is no Minimum Stay requirement There is no Maximum Stay requirement Adult Revalidation/Reissue Fare Component SAP20 Sector DEL-HYD Revalidation before/after departure, including failure to show at first/subsequent flight(s) : Not Allowed Reissue, including failure to show at first flight : Allowed with Restrictions Prior to Departure of journey Reissue Penalty fee : 2500 INR(at today exchange rates 2500 INR) Maximum reissue penalty fee for entire ticket (per reissue) : 5000 INR Revalidation/Reissue request must be made prior to : No restriction Failure to show at first flight Reissue Penalty fee between : 0 INR/2500 INR Maximum reissue penalty fee for entire ticket (per reissue) : 5000 INR Revalidation/Reissue request must be made prior to : No restriction After departure of journey Revalidation/Reissue request must be made prior to : No restriction Failure to show at subsequent flight(s) Revalidation/Reissue request must be made prior to : No restriction Revalidation/Reissue Fare Component SAP20 Sector HYD-BOM Revalidation before/after departure, including failure to show at first/subsequent flight(s) : Not Allowed Reissue before/after departure, including failure to show at first/subsequent flight(s) : Allowed with Restrictions Prior to Departure of journey Reissue Penalty fee : 2500 INR(at today exchange rates 2500 INR) Maximum reissue penalty fee for entire ticket (per reissue) : 5000 INR Revalidation/Reissue request must be made prior to : No restriction Failure to show at first flight Reissue Penalty fee between : 0 INR/5000 INR Maximum reissue penalty fee for entire ticket (per reissue) : 5000 INR Revalidation/Reissue request must be made prior to : No restriction After departure of journey Reissue Penalty fee : 2500 INR(at today exchange rates 2500 INR) Maximum reissue penalty fee for entire ticket (per reissue) : 2500 INR Revalidation/Reissue request must be made prior to : No restriction Failure to show at subsequent flight(s) Reissue Penalty fee between : 0 INR/2500 INR Maximum reissue penalty fee for entire ticket (per reissue) : 2500 INR Revalidation/Reissue request must be made prior to : No restriction Refund Fare Component SAP20 Sector DEL-HYD Refund, including failure to show at subsequent flight(s) : Not Allowed Prior to Departure of journey Refund : Not Allowed Refund request must be made prior to : No restriction Failure to show at first flight Refund : Allowed with Restrictions Penalty fee : 2500 INR(at today exchange rates 2500 INR) Maximum Refund penalty fee for entire ticket : 2500 INR Refund request must be made prior to : No restriction After departure of journey Refund request must be made prior to : No restriction Failure to show at subsequent flight(s) Refund request must be made prior to : No restriction Refund Fare Component SAP20 Sector HYD-BOM Prior to Departure of journey Refund : Not Allowed Refund request must be made prior to : No restriction Failure to show at first flight Refund : Allowed with Restrictions Refund : Allowed, Check with Agent for further details Maximum Refund penalty fee for entire ticket : 2500 INR Refund request must be made prior to : No restriction After departure of journey Refund : Not Allowed Refund request must be made prior to : No restriction Failure to show at subsequent flight(s) Refund : Allowed with Restrictions Refund : Allowed, Check with Agent for further details Maximum Refund penalty fee for entire ticket : No charge Refund request must be made prior to : No restriction * Revalidation is a modification of the original ticket without any reissue of a new ticket. * For Reissue, Penalty fees are in addition to any difference in fare. * For Refund, certain Taxes are non-refundable. ",
"FareRestriction": "Y"
},
{
"Origin": "HYD",
"Destination": "BOM",
"Airline": "AI",
"FareBasisCode": "SAP20",
"FareRuleDetail": "Please refer above.",
"FareRestriction": "Y"
}
],
"Status": 1,
"BookingHistory": [
{
"BookingId": 1304924,
"EventCategory": 1,
"Remarks": "Booking is on hold. (through BookingEngine Service), Booked By Auto (IP Address :- 192.168.11.58) | MSDTC OFF",
"CreatedOn": "2017-06-29T16:13:12",
"CreatedBy": 9102,
"CreatedByName": "Vikask test",
"LastModifiedOn": "2017-06-29T16:13:12",
"LastModifiedBy": 9102,
"LastModifiedByName": "Vikask test"
}
]
}
}
}
}
}