Flight Booking
Flight Booking
Booking request issue with passenger
details, payment
information, received offerId
in the provisional booking response.
Booking reference
, gds pnr
, airline pnr
and ticket numbers returns in a successful response.
Flight Booking Request
Tag | Attributes | Description |
---|---|---|
bookingReferenceId | bookingReferenceId (String) |
Pass as empty or not required |
offerId | offerId* (String) |
OfferId can be found from provisional book response. This should be same with pro book response offerId. |
customerInfo | customerInfo (Object) |
Customer information should be passed in tis tag. If customerInfo will pass then it will tag with supplier. |
emailAddress (String) |
||
passengers | passengers* (Object List) |
Traveller information should be included in the passengers tag |
passengerKey* (String) |
Passenger key should be passed from the integrator when implementing. | |
ptc* (String) |
Pax type code. ADT,CHD,INF |
|
infantRef (String) |
Not released yet In booking create , this attribute is used to associate an infant (not requiring a seat) to an adult. Specify the infant passenger’s Example: INF1 Where INF1 is infant passenger’s booking create, it must be passed if the request includes INF passenger, as the service needs to know which Infant is associated with which Adult However Travlinq API current version, INF associate with Lead Pax. |
|
passengerInfo | passengerInfo (Object) |
This tag includes passenger information |
birthDate* (String) |
This attribute contains the DOB of the passenger. | |
gender* (String) |
This attribute contains the passenger gender. M,F |
|
nameTitle* (String) |
Tile of the passenger's need to be updated in this tag. | |
givenName* (String) |
First name of the passenger should be passed here. | |
middleName (String) |
Middle name of the passenger should be passed here. | |
surname* (String) |
Surname name of the passenger should be passed here. | |
loyaltyProgramAccount | loyaltyProgramAccount (Object) |
The frequent-flyer number (FFN) is simply the number that is used to monitor travelers and the number of points that they have accumulated over time. Travelers can then use that number to use their points when booking flights |
airlineDesignator (String) |
||
accountNumber (String) |
||
providerName (String) |
||
programName (String) |
||
tierCode (String) |
Not released yet |
|
identityDocuments | identityDocuments (String) |
Any document which may be used to identify a person or verify aspects of a person's personal identity. The possible values are: PT - Passport 709 - National ID card AEA - Passenger's Redress Number CR - Known Traveller Number) *But currently API support only for Passport (PT) |
idDocumentNumber (String) |
This attribute contains the Identity document number Ex ; Passport Number. |
|
idType (String) |
This attribute contains the id type. Currently API stamping passport(PT) detail only, All other document types are on future scope . | |
issuingCountryCode (String) |
This attribute contains the issuing country code. | |
residenceCountryCode (String) |
This attribute contains the origin resident code. | |
expiryDate (String) |
Identity document expiry date. Ex ; Passport expiry date. |
|
applicableCountry (String) |
This attribute contains the applicable Country of the doc. | |
placeOfBirth (String) |
This attribute indicates teh place of birth | |
contact | contact* (Object) |
This complete tag contains the contact information of the passenger. |
postalAddress | postalAddress (Object) |
This attribute contains the postal address of the passenger. |
label (String) |
Label contains the address type. Origin |
|
street (String) |
This attribute contains the street value. | |
postalCode (String) |
Post code of the resident area should be updated here. | |
cityName (String) |
Passenger city name | |
countryCode (String) |
Passenger country name | |
contactsProvided | contactProvided* (Object) |
|
emailAddress* (String) |
Passenger email address should be passed in this attribute. | |
phone | phone* (Object) |
Label contains the origin/destination type. Origin |
label (String) |
Passenger contact information need to be added to this tag. | |
areaCode (String) |
Area code of the passenger phone number. | |
phoneNumber (String) |
Passenger phone number. | |
paymentDetails | paymentDetails * (Object) |
|
paymentMode * (String) |
Ex: CC = Credit Card, CR = Credit |
|
transactionAmount * (Double) |
Total transaction amount | |
cardInfo (String) |
Encrypted.card.details.to.be.passed.here. This is compulsory only when payment type is CC. | |
address | address (Object) |
This address will use for payment details |
label (String) |
Ex: "Billing" | |
street (String) |
Ex: "Beeches Apartment","200 Lampton Road" | |
postalCode (String) |
Ex: "TW345RT" | |
cityName (String) |
Ex: "NYK" | |
countryCode (String) |
Ex: "USA" |
Flight Booking Response
Tags | Attribute | Description |
---|---|---|
meta | meta (Object) |
|
success (String) |
Response status will be return Ex: "true" | |
statusCode (Boolean) |
Response statusCode will be return Ex: "1" | |
statusMessage (String) |
Response statusMessage will be return Ex: "SUCCESS" | |
commonData | commonData (String) |
This tag describes common data section in the response |
productCode* (String) |
Product code of the item being booked,Flight -A | |
searchKey* (String) |
A unique search id will be returned in the search response. | |
data | data (Object) |
Common details for the specific flight should be included here |
bookingStatus* (String) |
1. TICKETED then booking is successfully done on supplier side 2. OK TO TICKET and IN PROGRESS then please check Booking Failure Handling 3. PNR FAILED then booking is failed on supplier side. |
|
bookingReferenceId* (String) |
This attribute contains the booking reference number | |
supplierLocator * (String) |
This attribute indicates Supplier Locator | |
journey | journey ( List) |
Journey information should be included in a list of journey type objects |
flight | flight (List) |
Segment reference and flight related information should be included. |
flightKey * (String) |
An unique identifier will be added as the flight key | |
stopQuantity (String) |
This attribute indicates total number of stops in Journey 2 |
|
flightInfo | flightInfo (Object) |
Duration and distance fields are added as the flight information |
duration (String) |
This attribute indicates onward and return duration in days,hours and minutes 1D5H20M. If duration is less than 24h then format is like 5H20M. If duration is less than 24h then Day component will not be available. |
|
distance | distance (Object) |
This attribute indicates onward and return distance as value and unit pair |
value (Integer) |
value of the distance Not released yet |
|
unit (String) |
unit of the distance Not released yet |
|
segmentReference | segmentReference * (Object) |
This attribute indicates the from to airport details |
onPoint * (String) |
On Point IATA code | |
offPoint * (String) |
Off Point IATA code | |
flightSegments | flightSegments * (List) |
This attribute indicates all the segment related properties |
segmentKey* (String) |
An unique identifier will be added as the segment key. a590892f-48d0-4c0b-b552-2f00d394a67c |
|
departureAirportCode * (String) |
This attribute indicates IATA code of flight departure. DXB |
|
departureDateTime * (String) |
This attribute indicates Flight DepartureDate and Time. 20120417T0940 |
|
departureTerminal (String) |
Terminal of departing airport 1 or 1 or Terminal1 |
|
arrivalAirportCode * (String) |
This attribute indicates IATA code of flight arrival. LHR |
|
arrivalDateTime * (String) |
This attribute indicates flight arrival date and Time. 20120417T0940 |
|
arrivalTerminal (String) |
Terminal of arrival airport 1 or 1 or Terminal1 |
|
duration (String) |
This attribute indicates onward and return duration in days,hours and minutes 1D5H20M. If duration is less than 24h then format is like 5H20M. If duration is less than 24h then Day component will not be available. |
|
flightNumber* (String) |
This attribute indicates your flight number for the particular leg. 0556 |
|
status (String) |
This attribute indicates the status of the segment. HS,HK |
|
resBookDesigCode (String) |
This attribute indicates the booking class C,B |
|
numberInParty (String) |
This attribute indicates the number of passengers 2 |
|
operatingAirline (String) |
This attribute indicates the operating airline. BA |
|
marketingAirline * (String) |
This attribute indicates the marketing airline GF |
|
fareBasis (String) |
Shows the leg wise fare basis | |
equipmentType (String) |
||
equipmentName (String) |
||
baggageAllowance | baggageAllowance (Object) |
Baggage allowance for the particular flight |
carryOnBaggage | carryOnBaggage (Object) |
Carry on baggage descriptions. |
paxType (String) |
Pax type related to the baggage type. |
|
value (String) |
Value of the particular baggage |
|
unit (String) |
Number of units |
|
description (String) |
Baggage description |
|
checkedInBaggage | checkedInBaggage (Object) |
Checked in baggage description |
paxType (String) |
Pax type related to the baggage type. Pax type code. ADT,CHD,INF |
|
value (String) |
Value of the particular baggage | |
unit (String) |
Number of units | |
description (String) |
Baggage description | |
flightServices | flightServices (List) |
|
flightService | flightService (Object) |
|
name (String) |
||
code (String) |
||
flightRatings | noOfObservations (Integer) |
Not released yet |
onTimeObservations (Integer) |
Not released yet | |
late30observations (Integer) |
Not released yet | |
flightsCancelled (Integer) |
Not released yet | |
onTimePercentage (Double) |
Not released yet | |
delayObservations (Integer) |
Not released yet | |
meanDelay (Integer) |
Not released yet | |
onTimePercentile (Integer) |
Not released yet | |
onTimeStars (Integer) |
Not released yet | |
delayStars (Double) |
Not released yet | |
overallStars (Double) |
Not released yet | |
financialInfo | financialInfo (Object) |
Financial info related to the particular search result |
tmc | This tag contains supplier owner name. tmc - Travel Management Company. Eg: VE |
|
supplier | This tag contains the supplier name. | |
subSupplierCode | This tag contains the supplier pcc | |
payment | payment (Object) |
|
paymentTypes (List) |
This attribute indicates the payment types.Ex: CARD,CR |
|
paymentNetwork (List) |
This attribute indicates the payment network. Ex: "CA","VI", "AX" |
|
passengers | passengers (Object List) |
Traveller information should be updated in this tag and it's attributes. |
passengerKey (String) |
passengerKey need to be passed from the front end integrator. | |
ptc (String) |
Passenger type. ADT,CHD,INF |
|
infantRef (String) |
Not released yet In booking create , this attribute is used to associate an infant (not requiring a seat) to an adult. Specify the infant passenger’s Example: INF1 Where INF1 is infant passenger’s booking create, it must be passed if the request includes INF passenger, as the service needs to know which Infant is associated with which Adult However Travlinq API current version, INF associate with Lead Pax. |
|
passengerInfo | passengerInfo (Object) |
Following attributes describes the passenger dob and name details. |
birthDate (String) |
This attribute indicates the passenger birth date | |
gender (String) |
This attribute indicates the passenger Gender | |
nameTitle (String) |
This attribute indicates the passenger Title | |
givenName (String) |
This attribute indicates the passenger Given name | |
middleName (String) |
This attribute indicates the passenger Middle name | |
surname (String) |
This attribute indicates the passenger Surname | |
loyaltyProgramAccount | loyaltyProgramAccount (Object) |
Loyalty program information can be included here Not released yet |
airlineDesignator (String) |
Not released yet |
|
accountNumber (String) |
Not released yet |
|
providerName (String) |
Not released yet |
|
programName (String) |
Not released yet |
|
tierCode (String) |
Not released yet |
|
identityDocuments | identityDocuments (String) |
Any document which may be used to identify a person or verify aspects of a person's personal identity. The possible values are: PT - Passport 709 - National ID card AEA - Passenger's Redress Number CR - Known Traveller Number) *But currently API support only for Passport (PT) |
idDocumentNumber (String) |
This attribute contains the Identity document number Ex ; Passport Number. |
|
idType (String) |
This attribute contains the id type. Currently API stamping passport(PT) detail only, All other document types are on future scope . | |
issuingCountryCode (String) |
This attribute contains the issuing country code. | |
residenceCountryCode (String) |
This attribute contains the origin resident code. | |
expiryDate (String) |
Identity document expiry date. Ex ; Passport expiry date. |
|
applicableCountry (String) |
This attribute indicates the doc applicable Country | |
placeOfBirth (String) |
This attribute indicates place Of birth | |
contact | contact (Object) |
Passenger contact information need to be updated here. |
postalAddress | postalAddress (Object) |
|
label (String) |
||
street (String) |
||
postalCode (String) |
||
cityName (String) |
||
countryCode (String) |
||
contactsProvided | contactsProvided (Object) |
|
emailAddress (String) |
||
phone | phone (Object) |
|
label (String) |
||
areaCode (String) |
||
phoneNumber (String) |
||
airlineRequests | airlineRequests (Object) |
|
ssr | ssr (Object) |
A Special Service Request (SSR) is a message sent directly to suppliers to communicate traveler preferences, special services needed by a traveler, or of a procedural requirement necessary of the carrier |
name (String) |
Ex; Meal ,seat | |
code (String) |
Ex; Meal code is 'AVML' Seat code is 'W' |
|
text (String) |
||
segmentKey (List) |
||
osi | osi (Object) |
Other Service Information (OSI) requests are messages sent directly to the supplier to communicate traveler preferences or requirements. OSIs are used only for air segments. OSIs are typically used to notify a supplier of special circumstances such as a passenger that does not speak the local language. |
name (String) |
Ex: OSI | |
code (String) |
Ex: OSI | |
segmentKey (String) |
UUID will be generated and added as segment key. | |
fare | fare * (Object) |
Total fare information for the search result |
fareKey * (String) |
An unique identifier will be added as the fare key. a590892f-48d0-4c0b-b552-2f00d394a69c |
|
currencyCode (String) |
Fare currency code | |
fareType | fareType (Object) |
|
fareCode (String) |
||
farePreference (String) |
Fare preference number added as the fare preference 759,70G |
|
oid (String) |
Office id 06FC |
|
refundable (String) |
refundable fare indication | |
baseFare (Double) |
Total fare for all pax types. 20054.45 |
|
totalTax (Double) |
An unique identifier will be added as the segment key. a590892f-48d0-4c0b-b552-2f00d394a67c |
|
totalFare (Double) |
Total fare for the search | |
platingAirlineCode (String) |
||
supplierAdditionalFareInfo | supplierAdditionalFareInfo (Object) |
Supplier fare attributes. Not released yet |
currency (String) |
Not released yet | |
discount (Double) |
Not released yet | |
publishedFare (Double) |
Not released yet | |
commissionEarned (Double) |
Not released yet | |
plbearned (Double) |
Not released yet | |
offeredFare (Double) |
Not released yet | |
tdsOnCommission (Double) |
Not released yet | |
tdsOnPlb (Double) |
Not released yet | |
tdsOnIncentive (Double) |
Not released yet | |
serviceFee (Double) |
Not released yet | |
customerAdditionalFareInfo | customerAdditionalFareInfo (Object) |
Customer Additional Fare Info at a fare level |
transactionFeeEarned (Double) |
||
commissionEarned (Double) |
||
markupEarned (Double) |
||
plbearned (Double) |
||
incentiveEarned (Double) |
||
discount (Double) |
||
tdsOnIncentive (Double) |
Not released yet | |
vat (Double) |
Not released yet | |
cgst (Double) |
Not released yet | |
sgst (Double) |
Not released yet | |
igst (Double) |
Not released yet | |
fareBreakdown | fareBreakdown (Object) |
|
fareBreakdownKey (String) |
An unique identifier is set as fare break down key. | |
passengerKey | passengerKey (List) |
Associated passenger key |
fareType (String) |
Fare type of the result. Normal/Corporate.Private |
|
fareReference | fareReference (String) |
This attribute indicates the Fare basis code |
fareBasis (String) |
FareBasis for the result | |
segmentKey (String) |
An unique identifier is set as fare key. | |
paxType (String) |
Pax type code. ADT,CHD,INF |
|
paxRate | paxRate (String) |
Pax rates of the specific result. |
baseFare (Double) |
pax wise fares are shown here | |
totalTax (Double) |
pax wise fares are shown here | |
totalFare (Double) |
pax wise fares are shown here | |
taxes | taxes (List) |
Passenger type wise tax records list |
taxCode (String) |
This tag indicates the tax code | |
amount (Double) |
This tag indicates the tax amount | |
supplierAdditionalFareInfo | supplierAdditionalFareInfo (Object) |
Not released yet |
discount (Double) |
Not released yet | |
publishedFare (Double) |
Not released yet | |
commissionEarned (Double) |
Not released yet | |
plbearned (Double) |
Not released yet | |
incentiveEarned (Double) |
Not released yet | |
tdsOnCommission (Double) |
Not released yet | |
tdsOnPlb (Double) |
Not released yet | |
tdsOnIncentive (Double) |
Not released yet | |
serviceFee (Double) |
Not released yet | |
customerAdditionalFareInfo | customerAdditionalFareInfo (Object) |
Customer Additional Fare Info at fare break down level |
transactionFeeEarned (Double) |
||
commissionEarned (Double) |
||
markupEarned (Double) |
||
plbearned (Double) |
||
incentiveEarned (Double) |
||
discount (Double) |
||
tdsOnIncentive (Double) |
Not released yet |
|
vat (Double) |
Not released yet |
|
cgst (Double) |
Not released yet |
|
sgst (Double) |
Not released yet |
|
igst (Double) |
Not released yet |
|
penalties | penalties (List) |
|
type (String) |
||
penaltyInfo | penaltyInfo (Object) |
This attribute contains the penalty related information in the search result. |
applicationCode (String) |
Not released yet | |
startTime (String) |
Not released yet | |
endTime (String) |
Not released yet | |
unit (String) |
Not released yet | |
amounts | amounts (List) |
Not released yet |
currency (String) |
Not released yet | |
amount (Double) |
Not released yet | |
amountApplication (String) |
Not released yet | |
applicableFeeRemarks | applicableFeeRemarks (String) |
Not released yet |
value (String) |
Not released yet | |
cancelFeeInd (Boolean) |
Not released yet | |
refundableInd (Boolean) |
Not released yet | |
changeFeeInd (Boolean) |
Not released yet | |
ticketDocument | ticketDocument (Object) |
Ticket document details |
ticketDocNbr (String) |
Ticket/EMD number. | |
passengerKey (String) |
||
fareBreakdownKey (String) |
||
airline (String) |
||
status (String) |
This attributes will indicate Ticket status. Ex : TICKETED = T, CANCELLED = AQ, ON HOLD = H, OK TO TICKET = P, PNR FAILED = R, RE-ISSUED = RI |
|
dateOfIssue (String) |
||
lastTicketDate (String) |
||
airlineLocators (String) |
Flight Booking response | |
---|---|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 |
|