Flight Search 
To search for flights, you'll need to create a flight search request. An search request describes the passengers and where and when they want to travel (in the form of a list of flight segments). It may also include additional filters (e.g. a particular cabin to travel in).
Flight search request consists with mainly origin , destination details, cabin preference and passenger details.
Search response have the segment details, price breakdown and tax information.
Search Options
There are mainly two search options for Flight search which are OPTIMIZED,FULL. From the search request it can be set up with responseParameters attribute.
- FULL
If the client has sent responseParameters as FULL then all fare options will be available for all results. But the FULL search option will not be the recommended way due to performance of the Verteil search response. However, this is working in the case of the Verteil only. i.e the Verteil has developed the functionality to provide the results on the basis of this flag.
- OPTIMIZED
If the client has sent responseParameters as OPTIMIZED then the response will have only one fare option each result. Then the client can fire another search via More fare search and can get the rest of fares for selected result.
This option is handled for the Verteil only. As per the API flow, Verteil has developed such functionality. The Travlinq will receive a number of results which are available at the airline end.
Create a flight search request
The Travlinq will send your search to a range of airlines, and return your results back to you with a series of flights.Each result represents a set of flights you can buy from an airline at a particular price that meet your search criteria.
Inside flight result will include a list of one or more specific flight segments (called segments) that the airline is offering to get the passengers where they want to go.
When presenting result to your customers, you should always show the full name of the operating carrier of each segment (flight[].flightsegments[].operatingAirline). This must be displayed prominently on the first screen where the flight is presented in order to comply with US regulations.
Flight Search Request
| Tags | Attribute | Description |
|---|---|---|
| meta | meta (Object) |
|
| FlightSearchCriteria | (JsonObject) | |
| currency (String) |
Flight results/fares requesting currency Not released yet |
|
| flightSegments | flightSegments* (List) |
This tag contains the flight result related information. |
| departureAirportCode* (String) |
This tag indicates the origin location BOM |
|
| departureDate* (String) |
This tag indicates the departure date of travel YYYY-MM-DD |
|
| departureTimeFrom (String) |
This tag indicates the departure from time , Results will filter based on from time.This will be used when filtering the onward segment. 00:50 |
|
| departureTimeTo (String) |
This tag indicates the departure to time , Results will filter from this.This will be used when filtering the onward segment. 10:30 |
|
| arrivalAirportCode* (String) |
This tag indicates the destination location DEL |
|
| arrivalDate (String) |
This tag indicates the arrival date of travel YYYY-MM-DD Not released yet |
|
| arrivalTimeFrom (String) |
This tag indicates the arrival from time, Results will filter from this.This will be used when filtering the return segment. 00:50 |
|
| arrivalTimeTo (String) |
This tag indicates the arrival to time ,Results will filter from this time.This will be used when filtering the return segment. 20:30 |
|
| calendarDatesDaysAfter (Integer) |
Number of days after the requested date Not released yet |
|
| calendarDatesDaysBefore (Integer) |
Number of days before the requested date Not released yet |
|
| cabinPreferences | cabinPreferences* (List) |
This indicates the class of preference 1 = First, 2 = Business, 4 = Premium Economy and 5 = Economy |
| passengers | passengers (List) |
|
| id* (String) |
This tag indicates the passenger id 1 |
|
| ptc * (String) |
This tag indicates the passenger type code ADT ,CHD,INF |
|
| age (Integer) |
Age of the passenger Not released yet 23 |
|
| nameTitle (String) |
Title of the passenger Mr Not released yet |
|
| givenName (String) |
First name of the passenger Test Not released yet |
|
| middleName (String) |
Middle name of he passenger Test Not released yet |
|
| surName (String) |
Last name of the passenger Test Not released yet |
|
| loyaltyProgrammeAccounts | accountNumber (String) |
Loyalty account number Not released yet |
| airlineIataCode (String) |
Airline indicator BA Not released yet |
|
| preference | flightPreference (Object) |
|
| equipmentTypes (List) |
Equipment types Not released yet |
|
| directPreferences (Boolean) |
This attribute indicates whether the journey is a direct route or not. | |
| maxConnections (String) |
This attribute indicates max number of stops that flight takes during the travel. 3 |
|
| farePreference (String) |
This attribute indicates the fare preference Ex : ("758", PRIVATE), ("70G", CORPORATE), and ("70J", NORMAL) |
|
| supplierAccountCode (String) |
This attribute indicates the Supplier Account Code. It can be taken from supplier master in Operator portal. Operator master >> suppliers >> select supplier >> Contact Details >> Details >> edit supplier name >> Account code |
|
| preferenceContext (String) |
This attribute indicates the fare preference Context Ex : preferenceContext = SEA - Seaman LBR - Labour ITX - ITX Fare |
|
| fareCodes | fareCodes (List) |
Specify the fare codes/deal codes/promo codes. |
| fareCode (String) |
Fare code/Deal code/Promo code. EX; fareCode = 'ITX13' |
|
| airline (String) |
Fare applicable airline. |
|
| currency (String) |
Fare currency Not released yet |
|
| airlinePreferences | airlinePreferences (Object) |
|
| supplierAccountCode (String) |
This attribute indicates the Supplier Account Code. It can be taken from supplier master in Operator portal. Operator master >> suppliers >> select supplier >> Contact Details >> Details >> edit supplier name >> Account code |
|
| unacceptable | unacceptable (List) |
This attribute can be used to specify the unacceptable(excluded) airlines. |
| allowOnly | allowOnly (List) |
Multiple airlines can be added in this attribute and only he mentioned airlines will be available in the search response. |
| preferred | preferred (List) |
This attribute indicates the preferred airlines for the search. Not released yet |
| transferPreference | transferPreference (Object) |
Not released yet |
| connectionCodes | connectionCodes (String) |
Not released yet |
| codes | codes (List) |
Codes should be repeated for each transfer point per OD. Not released yet |
| baggagePreference | baggageOption (Integer) |
Preferred baggage options can be added in this attribute Not released yet |
| formOfPayment | formOfPayment* (String) |
This tag consist of Form of Payment Ex: CC = Credit Card, CR = Credit |
| travelType | TravelType* (String) |
This tag consist of travel type i.e Business or Personal B or P |
| responseParameters | shopResultPreference (String) |
Search options should be added in this attribute. OPTIMIZED,FULL |
| responseTimeout (Integer) |
This tag can be used to specify supplier timeout in seconds to get the response. |
| Flight Search Request | |
|---|---|
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 | |
Flight Search Response
After you have searched for flights by creating a flight search request, Travlinq will send your search to a range of airlines, which may return flight results. Each results represent flights that you can buy from an airline at a particular price that meet your search criteria.
You will see Journies inside the results. Each journey will also include a list of one or more specific flights that the airline is offering to get the passengers where they want to go.
An offer is only available to create a booking for a limited time by the traveller before it expires, typically within 30 minutes.
| 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 (Object) |
This tag has the common Data 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) |
|
| offerId* (String) |
A unique offer id will be returned in the search response per each resul.This should be used all subsequent API calls for identify user selected result.The offerId is a combination of search id and result id. Ex : offerId= AIR03019045-67. |
|
| detail | detail (Object) |
Common details for the specific flight should be included here |
| ancillaryDetailsAvailable (Boolean) |
This attribute shows whether ancillary details available | |
| fareRuleMandatory (Boolean) |
This flag enables in two scenarios.i.e when additional important notes are available or fare rule call is mandatory from supplier.If this is true then from the fare rule API call relevant notes can be taken and also booking rules validation will be enabled and do the mandatory information validation in provisional book. Hence if this is true then fare rule API call is mandatory*. |
|
| lcc (Boolean) |
This attribute shows whether fair is low cost carrier | |
| apis (Boolean) |
This attribute indicate whether passenger Passport details are required or not during booking flow for the relevant supplier | |
| ndc (Boolean) |
New Distribution Capability(ndc) fare | |
| onHoldSupported (Boolean) |
This tag should contain an indicator for whether holding supporting or not . For some suppliers(GDS) this value will be received from master data but for some suppliers(LCC) it will receive from Fare rule call. if fareRuleMandatory is true then check fare rule response onHoldSupported flag for further update. |
|
| moreFaresAvailable (Boolean) |
This flag will be set to true when more options are available | |
| 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.This key should be same throughout the booking floor. | |
| stopQuantity (Integer) |
This attribute indicates total number of stops in a journey level | |
| 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) |
Onpoint 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 |
|
| layoverTime (String) |
A layover is a time you spend at a connecting airport between your primary flight and destination. Usually, on domestic flights, a layover is between 60 minutes to several hours, up to 23 hours, that you have on a transfer flight. 02H30M |
|
| 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 |
|
| seatsAvailable (Integer) |
This tags contains seat count available for this fare class. | |
| 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. | |
| value (String) |
Value of the particular baggage | |
| unit (String) |
Number of units | |
| description (String) |
Baggage description | |
| flightServices | flightServices (List) |
This returns the service this OfferItem is entitled to |
| 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. "CA","VI", "AX" |
|
| 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) |
This tag indicates the Fare type : Normal/YM/Corporate/ Private |
| fareCode (String) |
This attribute indicates the Code in case of Private and corporate fare type. EX:HRG15 |
|
| 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) |
Airline code | |
| supplierAdditionalFareInfo | supplierAdditionalFareInfo (Object) |
|
| currency (String) |
||
| discount (Double) |
Not released yet | |
| publishedFare (Double) |
||
| 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 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 (List) |
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) |
Passenger type | |
| 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 | |
| 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 breakdown level |
| transactionFeeEarned (Double) |
This tag indicates the earned transaction amount. earned trs amount |
|
| commissionEarned (Double) |
||
| markupEarned (Double) |
||
| plbearned (Double) |
||
| incentiveEarned (Double) |
||
| discount (Double) |
||
| tdsOnIncentive (Double) |
||
| vat (Double) |
Not released yet | |
| cgst (Double) |
Not released yet | |
| sgst (Double) |
Not released yet | |
| igst (Double) |
Not released yet | |
| penalties | penalties (List) |
Not released yet |
| type (String) |
Not released yet | |
| penaltyInfo | penaltyInfo (Object) |
Not released yet |
| 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 (String) |
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 |
| Flight Search 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 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 | |
Flight Search request with minimum parameters
You can use below request message as well for the search. It has only minimum required parameters.