Function createJsonBodyRQ

Returns {
    OTA_AirLowFareSearchRQ: {
        AvailableFlightsOnly?: boolean;
        OriginDestinationInformation: {
            ArrivalDateTime?: string;
            ArrivalWindow?: string;
            ConnectionLocations?: {
                ConnectionLocation: {
                    LocationCode: string;
                    PreferLevel?: "Only" | "Unacceptable";
                }[];
            };
            DepartureDateTime?: string;
            DepartureWindow?: string;
            DestinationLocation: { LocationCode?: string; LocationType?: string };
            Fixed?: boolean;
            OriginLocation: { LocationCode?: string; LocationType?: string };
            TPA_Extensions?: {
                AlternateTime?: { Minus?: number; PlusMinus?: number };
                Baggage?: { FreeCarryOn?: boolean; FreePieceRequired?: boolean };
                BrandFilters?: {
                    Brand?: { Code: string; PreferLevel: "Unacceptable" | "Preferred" }[];
                    NonBrandedFares?: { PreferLevel: "Unacceptable" | "Preferred" };
                };
                CabinPref?: {
                    Cabin?: | "PremiumFirst"
                    | "First"
                    | "PremiumBusiness"
                    | "Business"
                    | "PremiumEconomy"
                    | "Economy"
                    | "Y"
                    | "S"
                    | "C"
                    | "J"
                    | "F"
                    | "P";
                    PreferLevel?: "Preferred";
                };
                ClassOfService?: {
                    Code: string;
                    PreferLevel?: "Unacceptable"
                    | "Preferred";
                }[];
                ConnectionTime?: {
                    EnableExcludedConnection?: boolean;
                    ExcludedConnectionBegin?: string;
                    ExcludedConnectionEnd?: string;
                    Max?: number;
                    Min?: number;
                };
                FareBasis?: { Code: string; PreferLevel?: "Unacceptable"
                | "Preferred" }[];
                FareType?: { Code: string; PreferLevel: "Unacceptable" | "Preferred" }[];
                Flight?: {
                    Airline: { Marketing: string; Operating?: string };
                    ArrivalDateTime: string;
                    ClassOfService?: string;
                    DepartureDateTime: string;
                    DestinationLocation: { LocationCode?: string };
                    Number: number;
                    OriginLocation: { LocationCode?: string };
                    Type?: string;
                }[];
                IncludeAlliancePref?: { Code: string }[];
                IncludeVendorPref?: { Code: string }[];
                MaxOneWayOptions?: { Value: number };
                PriorityBoarding?: { FreePriorityBoarding?: boolean };
                Seats?: {
                    Seat?: { AtLeast?: number; LessThan?: number; Type?: string }[];
                };
                SeatSelection?: { FreeSeatSelection?: boolean };
                SegmentType?: { Code?: "ARUNK" | "O" | "X" };
                SisterDestinationLocation?: { LocationCode?: string }[];
                SisterDestinationMileage?: {
                    AllowBorderCross?: boolean;
                    Number: number;
                };
                SisterOriginLocation?: { LocationCode?: string }[];
                SisterOriginMileage?: { AllowBorderCross?: boolean; Number: number };
                Stopover?: {
                    DepartureDateTime?: string;
                    DepartureWindow?: string;
                    Stay?: { MaxHours?: number; MinHours?: number; Nights?: number };
                    StopoverPoint: { LocationCode: string; LocationType?: string };
                };
                TotalTravelTime?: { Max?: number; Min?: number };
            };
        }[];
        POS: {
            Source: {
                FixedPCC?: boolean;
                PseudoCityCode?: string;
                RequestorID: {
                    CompanyName?: { Code?: string };
                    ID: string;
                    Type: string;
                };
            }[];
        };
        ResponseType?: string;
        ResponseVersion?: string;
        TPA_Extensions?: {
            AlternateAirportCities?: {
                AlternateLocation: { LocationCode?: string }[];
                SpecifiedLocation: { LocationCode?: string };
            }[];
            AlternateAirportMileage?: { AllowBorderCross?: boolean; Number: string };
            AlternatePCC?: {
                FixedPCC?: boolean;
                PseudoCityCode: string;
                TravelPreferences?: {
                    TPA_Extensions?: {
                        ExcludeAlliancePref?: { Code: string }[];
                        IncludeAlliancePref?: { Code: string }[];
                    };
                    VendorPref?: {
                        Code: string;
                        PreferLevel?: "Only"
                        | "Unacceptable"
                        | "Preferred";
                    }[];
                };
            }[];
            DiversityControl?: {
                Dimensions: {
                    Carrier?: {
                        Default?: { Options: string };
                        OnlineIndicator?: boolean;
                        Override?: { Code: string; Options: string }[];
                        Weight: number;
                    };
                    InboundOutboundPairing?: { Duplicates?: number; Weight: number };
                    OperatingDuplicate?: {
                        PreferredCarrier?: { Code: string }[];
                        Weight: number;
                    };
                    PriceWeight?: number;
                    StopsNumber?: { Weight: number };
                    TimeOfDay?: {
                        Distribution?: {
                            Direction?: "Outbound" | "Inbound";
                            Endpoint?: "Departure" | "Arrival";
                            Leg?: number;
                            Range?: { Begin: string; End: string; Options?: string }[];
                        }[];
                        Weight: number;
                    };
                    TravelTime?: { Weight: number };
                };
                LowFareBucket: { FareCutOff?: string; Options?: string };
            };
            IntelliSellTransaction?: {
                AirStreaming?: {
                    MaxItinsPerChunk: number;
                    Method: "Services"
                    | "WholeResponse";
                };
                CompressResponse?: { Value?: boolean };
                MultipleSourcePerItinerary?: { Value: boolean };
                RequestType?: { Name?: string };
                ResponseSorting?: { SortFaresInsideItin?: boolean };
                ServiceTag?: { Name?: string };
                TranID?: Record<string, never>;
            };
            MultiTicket?: {
                DisplayPolicy?: "SOW"
                | "GOW2RT"
                | "SCHS";
                RequestedOneWays?: number;
            };
            RichContent?: {
                FlightAmenities?: boolean;
                Language?: string;
                SeatInfo?: boolean;
                UniversalProductAttributes?: boolean;
                UniversalTicketingAttributes?: boolean;
            };
        };
        TravelerInfoSummary: {
            AirTravelerAvail: {
                PassengerTypeQuantity: {
                    Code: string;
                    Quantity?: number;
                    TPA_Extensions?: {
                        VoluntaryChanges?: {
                            Match?: "All"
                            | "Any"
                            | "Info";
                            Penalty?: {
                                Amount?: ...;
                                Application?: ...;
                                CurrencyCode?: ...;
                                Exclude?: ...;
                                Type?: ...;
                            }[];
                        };
                    };
                }[];
            }[];
            PriceRequestInformation?: {
                AccountCode?: { Code: string }[];
                CurrencyCode?: string;
                NegotiatedFareCode?: { Code?: string; Supplier?: { Code?: string }[] }[];
                NegotiatedFaresOnly?: boolean;
                ProcessThruFaresOnly?: boolean;
                PurchaseDate?: string;
                TPA_Extensions?: {
                    BrandedFareIndicators?: {
                        BrandFilters?: {
                            Brand?: {
                                Code: string;
                                PreferLevel: "Unacceptable" | "Preferred";
                            }[];
                            NonBrandedFares?: { PreferLevel: "Unacceptable"
                            | "Preferred" };
                        };
                        ItinParityBrandlessLeg?: boolean;
                        ItinParityFallbackMode?: "LegParity"
                        | "LowestSingle";
                        MultipleBrandedFares?: boolean;
                        ParityMode?: "Leg" | "Itin";
                        ParityModeForLowest?: "None" | "Leg" | "Itin";
                        ReturnBrandAncillaries?: boolean;
                        SingleBrandedFare?: boolean;
                        UpsellLimit?: number;
                    };
                    Indicators?: {
                        MinMaxStay?: { Ind: boolean };
                        RefundPenalty?: { Ind: boolean };
                        ResTicketing?: { Ind: boolean };
                    };
                    OBFees?: Record<string, never>;
                    PassengerStatus?: {
                        CityCode?: string;
                        CountryCode?: string;
                        StateCode?: string;
                        Type: "N" | "R" | "E";
                    };
                    PointOfSaleOverride?: { Code: string };
                    PointOfTicketingOverride?: { Code: string };
                    Priority?: {
                        DirectFlights?: { Priority: number };
                        Price?: { Priority: number };
                        Time?: { Priority: number };
                        Vendor?: { Priority: number };
                    };
                    PrivateFare?: { Ind?: boolean };
                    PublicFare?: { Ind?: boolean };
                };
            };
            TPA_Extensions?: Record<string, never>;
        };
        TravelPreferences?: {
            AncillaryFees?: {
                AncillaryFeeGroup?: { Code: string; Count?: string }[];
                Enable: boolean;
                Summary?: boolean;
            };
            Baggage?: {
                CarryOnInfo?: boolean;
                Description?: boolean;
                FreeCarryOn?: boolean;
                FreePieceRequired?: boolean;
                RequestedPieces?: number;
                RequestType?: "C"
                | "A"
                | "N";
            };
            CabinPref?: {
                Cabin?: | "PremiumFirst"
                | "First"
                | "PremiumBusiness"
                | "Business"
                | "PremiumEconomy"
                | "Economy"
                | "Y"
                | "S"
                | "C"
                | "J"
                | "F"
                | "P";
                PreferLevel?: "Preferred";
            }[];
            ETicketDesired?: boolean;
            FlightTypePref?: { MaxConnections?: number
            | boolean };
            Hybrid?: boolean;
            LookForAlternatives?: boolean;
            MaxStopsQuantity?: number;
            SpanishFamilyDiscount?: { Level: 1 | 2 };
            TPA_Extensions?: {
                AdditionalFareLimit?: { Value: number };
                AvoidCabinDowngrade?: { Mode: "All" | "Main" | "None" };
                ClassOfService?: {
                    Code: string;
                    PreferLevel?: "Unacceptable" | "Preferred";
                }[];
                CodeShareIndicator?: {
                    ExcludeCodeshare: boolean;
                    KeepOnlines?: boolean;
                };
                CountryPref?: { Code: string; PreferLevel: string }[];
                DataSources?: {
                    ATPCO?: "Enable" | "Disable";
                    LCC?: "Enable" | "Disable";
                    NDC?: "Enable" | "Disable";
                };
                DiversityParameters?: {
                    AdditionalNonStopsNumber?: number;
                    AdditionalNonStopsPercentage?: number;
                    InboundOutboundPairing?: number;
                    TimeOfDayDistribution?: {
                        TimeOfDayRange: { Begin: string; End: string; Percentage: number }[];
                    };
                    Weightings?: { PriceWeight: number; TravelTimeWeight: number };
                };
                ExcludeAlliancePref?: { Code: string }[];
                ExcludeCallDirectCarriers?: { Enabled?: boolean };
                ExcludeVendorPref?: { Code?: string }[];
                ExemptAllTaxes?: { Value: boolean };
                ExemptAllTaxesAndFees?: { Value: boolean };
                ExemptTax?: { TaxCode: string }[];
                FareBasis?: { Code: string; PreferLevel?: "Unacceptable" | "Preferred" }[];
                FareFocusRules?: { Exclude?: boolean };
                FareType?: { Code: string; PreferLevel: "Unacceptable" | "Preferred" }[];
                FlexibleFares?: {
                    FareParameters: {
                        AccountCode?: { Code: string }[];
                        AvoidCabinDowngrade?: { Mode: "All" | "Main" | "None" };
                        Baggage?: { FreePieceRequired?: boolean };
                        BrandedFareIndicators?: {
                            BrandFilters?: {
                                Brand?: { Code: ...; PreferLevel: ... }[];
                                NonBrandedFares?: { PreferLevel: (...) | (...) };
                            };
                            ItinParityBrandlessLeg?: boolean;
                            ItinParityFallbackMode?: "LegParity"
                            | "LowestSingle";
                            MultipleBrandedFares?: boolean;
                            ParityMode?: "Leg" | "Itin";
                            ParityModeForLowest?: "None" | "Leg" | "Itin";
                            SingleBrandedFare?: boolean;
                            UpsellLimit?: number;
                        };
                        Cabin?: {
                            Type: | "PremiumFirst"
                            | "First"
                            | "PremiumBusiness"
                            | "Business"
                            | "PremiumEconomy"
                            | "Economy"
                            | "Y"
                            | "S"
                            | "C"
                            | "J"
                            | "F"
                            | "P";
                        };
                        ClassOfService?: {
                            Code: string;
                            PreferLevel?: "Unacceptable"
                            | "Preferred";
                        }[];
                        CorporateID?: { Code: string }[];
                        ExcludeRestricted?: { Ind: boolean };
                        FareBasis?: {
                            Code: string;
                            PreferLevel?: "Unacceptable" | "Preferred";
                        }[];
                        FareType?: { Code: string; PreferLevel: "Unacceptable"
                        | "Preferred" }[];
                        JumpCabinLogic?: { Disabled: boolean };
                        KeepSameCabin?: { Enabled: boolean };
                        Leg?: {
                            Baggage?: { FreePieceRequired?: boolean };
                            BrandFilters?: {
                                Brand?: (...)[];
                                NonBrandedFares?: { PreferLevel: ... };
                            };
                            Cabin?: {
                                Type: | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...)
                                | (...);
                            };
                            ClassOfService?: { Code: ...; PreferLevel?: ... }[];
                            FareBasis?: { Code: ...; PreferLevel?: ... }[];
                            FareType?: { Code: ...; PreferLevel: ... }[];
                            Num: number;
                            PriorityBoarding?: Record<string, never>;
                            Seats?: Record<string, never>;
                            SeatSelection?: { FreeSeatSelection?: boolean };
                        }[];
                        MinMaxStay?: { Ind: boolean };
                        NegotiatedFaresOnly?: { Ind: boolean };
                        PassengerTypeQuantity?: { Code: string; Quantity?: number }[];
                        PriorityBoarding?: Record<string, never>;
                        PrivateFare?: { Ind: boolean };
                        PublicFare?: { Ind: boolean };
                        RefundPenalty?: { Ind: boolean };
                        ResTicketing?: { Ind: boolean };
                        Seats?: Record<string, never>;
                        SeatSelection?: { FreeSeatSelection?: boolean };
                        UseNegotiatedFares?: { Ind: boolean };
                        UsePassengerFares?: { Ind: boolean };
                        VoluntaryChanges?: {
                            Match?: "All" | "Any" | "Info";
                            Penalty?: {
                                Amount?: number;
                                Application?: (...) | (...);
                                CurrencyCode?: string;
                                Exclude?: boolean;
                                Type?: (...) | (...);
                            }[];
                        };
                        XOFares?: { Ind: boolean };
                    }[];
                };
                FlightStopsAsConnections?: { Ind: boolean };
                GoverningCarrierOverride?: { AirlineCode: string };
                IncludeAlliancePref?: { Code: string }[];
                JumpCabinLogic?: { Disabled: boolean };
                KeepSameCabin?: { Enabled: boolean };
                LongConnectPoints?: { Max?: number; Min?: number };
                LongConnectTime?: {
                    Enable?: boolean;
                    Max?: number;
                    Min?: number;
                    NumberOfSolutions?: string;
                };
                LowCostCarriersProcessing?: { Disable?: boolean };
                NDCIndicators?: {
                    CarrierSpecificQualifiers?: {
                        AccountCode?: { Code: string };
                        CarrierCode: string;
                        FrequentFlyer?: {
                            AccountNumber: string;
                            AirlineDesignator: string;
                            PassengerId: string;
                        }[];
                        Qualifier?: { Name: string; Value: string }[];
                    }[];
                    FrequentFlyer?: {
                        AccountNumber: string;
                        AirlineDesignator: string;
                        PassengerId: string;
                    }[];
                    MaxNumberOfUpsells?: { Value: number };
                    MultipleBrandedFares?: { Value: boolean };
                    ParityMode?: { Mode: "Leg" | "Itin" };
                    Qualifier?: { Name: string; Value: string }[];
                    ShowOneWays?: { Value: boolean };
                    SingleBrandedFare?: { Value: boolean };
                };
                NumTrips?: { Number?: number };
                OnlineIndicator?: { Ind?: boolean };
                PreferNDCSourceOnTie?: { Value: boolean };
                PriorityBoarding?: { FreePriorityBoarding?: boolean; Info?: boolean };
                RetailerRules?: { Force?: boolean; RetailerRule: { Code: string }[] };
                Seats?: {
                    Seat?: { AtLeast?: number; LessThan?: number; Type?: string }[];
                };
                SeatSelection?: { FreeSeatSelection?: boolean; Info?: boolean };
                SellingLevels?: {
                    SellingLevelRules?: { Ignore: boolean };
                    ShowFareAmounts?: { Adjusted?: boolean; Original?: boolean };
                };
                SettlementMethod?: string;
                Taxes?: { Tax?: { Amount?: number; TaxCode: string }[] };
                TicketingSumOfLocals?: { Enable?: boolean };
                TripType?: {
                    Value?: "OneWay" | "Return" | "Circle" | "OpenJaw" | "Other";
                };
                ValidatingCarrier?: {
                    Code?: string;
                    Preference?: { Code: string; Level: "Unacceptable"
                    | "Preferred" }[];
                };
                ValidatingCarrierCheck?: {
                    Carrier?: { Code: string }[];
                    Country?: { Code: string }[];
                    IETValidation: { Ind: boolean };
                    SettlementValidation: { Ind: boolean };
                };
                VerificationItinCallLogic?: {
                    AlwaysCheckAvailability?: boolean;
                    Value?: "L"
                    | "M"
                    | "B";
                };
                XOFares?: { Value: boolean };
            };
            ValidInterlineTicket?: boolean;
            VendorPref?: {
                Code?: string;
                PreferLevel?: "Only"
                | "Unacceptable"
                | "Preferred";
                Type?: "Marketing" | "Operating";
            }[];
            VendorPrefApplicability?: {
                Type: "Marketing"
                | "Operating";
                Value: "AllSegments" | "AtLeastOneSegment";
            }[];
            VendorPrefPairing?: {
                Applicability?: "AllSegments"
                | "AtLeastOneSegment";
                PreferLevel: "Unacceptable" | "Preferred";
                VendorPref: { Code: string; Type?: "Marketing" | "Operating" }[];
            }[];
        };
        Version: string;
    };
}

• OTA_AirLowFareSearchRQ: {
      AvailableFlightsOnly?: boolean;
      OriginDestinationInformation: {
          ArrivalDateTime?: string;
          ArrivalWindow?: string;
          ConnectionLocations?: {
              ConnectionLocation: {
                  LocationCode: string;
                  PreferLevel?: "Only" | "Unacceptable";
              }[];
          };
          DepartureDateTime?: string;
          DepartureWindow?: string;
          DestinationLocation: { LocationCode?: string; LocationType?: string };
          Fixed?: boolean;
          OriginLocation: { LocationCode?: string; LocationType?: string };
          TPA_Extensions?: {
              AlternateTime?: { Minus?: number; PlusMinus?: number };
              Baggage?: { FreeCarryOn?: boolean; FreePieceRequired?: boolean };
              BrandFilters?: {
                  Brand?: { Code: string; PreferLevel: "Unacceptable" | "Preferred" }[];
                  NonBrandedFares?: { PreferLevel: "Unacceptable" | "Preferred" };
              };
              CabinPref?: {
                  Cabin?: | "PremiumFirst"
                  | "First"
                  | "PremiumBusiness"
                  | "Business"
                  | "PremiumEconomy"
                  | "Economy"
                  | "Y"
                  | "S"
                  | "C"
                  | "J"
                  | "F"
                  | "P";
                  PreferLevel?: "Preferred";
              };
              ClassOfService?: {
                  Code: string;
                  PreferLevel?: "Unacceptable"
                  | "Preferred";
              }[];
              ConnectionTime?: {
                  EnableExcludedConnection?: boolean;
                  ExcludedConnectionBegin?: string;
                  ExcludedConnectionEnd?: string;
                  Max?: number;
                  Min?: number;
              };
              FareBasis?: { Code: string; PreferLevel?: "Unacceptable"
              | "Preferred" }[];
              FareType?: { Code: string; PreferLevel: "Unacceptable" | "Preferred" }[];
              Flight?: {
                  Airline: { Marketing: string; Operating?: string };
                  ArrivalDateTime: string;
                  ClassOfService?: string;
                  DepartureDateTime: string;
                  DestinationLocation: { LocationCode?: string };
                  Number: number;
                  OriginLocation: { LocationCode?: string };
                  Type?: string;
              }[];
              IncludeAlliancePref?: { Code: string }[];
              IncludeVendorPref?: { Code: string }[];
              MaxOneWayOptions?: { Value: number };
              PriorityBoarding?: { FreePriorityBoarding?: boolean };
              Seats?: {
                  Seat?: { AtLeast?: number; LessThan?: number; Type?: string }[];
              };
              SeatSelection?: { FreeSeatSelection?: boolean };
              SegmentType?: { Code?: "ARUNK" | "O" | "X" };
              SisterDestinationLocation?: { LocationCode?: string }[];
              SisterDestinationMileage?: { AllowBorderCross?: boolean; Number: number };
              SisterOriginLocation?: { LocationCode?: string }[];
              SisterOriginMileage?: { AllowBorderCross?: boolean; Number: number };
              Stopover?: {
                  DepartureDateTime?: string;
                  DepartureWindow?: string;
                  Stay?: { MaxHours?: number; MinHours?: number; Nights?: number };
                  StopoverPoint: { LocationCode: string; LocationType?: string };
              };
              TotalTravelTime?: { Max?: number; Min?: number };
          };
      }[];
      POS: {
          Source: {
              FixedPCC?: boolean;
              PseudoCityCode?: string;
              RequestorID: {
                  CompanyName?: { Code?: string };
                  ID: string;
                  Type: string;
              };
          }[];
      };
      ResponseType?: string;
      ResponseVersion?: string;
      TPA_Extensions?: {
          AlternateAirportCities?: {
              AlternateLocation: { LocationCode?: string }[];
              SpecifiedLocation: { LocationCode?: string };
          }[];
          AlternateAirportMileage?: { AllowBorderCross?: boolean; Number: string };
          AlternatePCC?: {
              FixedPCC?: boolean;
              PseudoCityCode: string;
              TravelPreferences?: {
                  TPA_Extensions?: {
                      ExcludeAlliancePref?: { Code: string }[];
                      IncludeAlliancePref?: { Code: string }[];
                  };
                  VendorPref?: {
                      Code: string;
                      PreferLevel?: "Only"
                      | "Unacceptable"
                      | "Preferred";
                  }[];
              };
          }[];
          DiversityControl?: {
              Dimensions: {
                  Carrier?: {
                      Default?: { Options: string };
                      OnlineIndicator?: boolean;
                      Override?: { Code: string; Options: string }[];
                      Weight: number;
                  };
                  InboundOutboundPairing?: { Duplicates?: number; Weight: number };
                  OperatingDuplicate?: {
                      PreferredCarrier?: { Code: string }[];
                      Weight: number;
                  };
                  PriceWeight?: number;
                  StopsNumber?: { Weight: number };
                  TimeOfDay?: {
                      Distribution?: {
                          Direction?: "Outbound" | "Inbound";
                          Endpoint?: "Departure" | "Arrival";
                          Leg?: number;
                          Range?: { Begin: string; End: string; Options?: string }[];
                      }[];
                      Weight: number;
                  };
                  TravelTime?: { Weight: number };
              };
              LowFareBucket: { FareCutOff?: string; Options?: string };
          };
          IntelliSellTransaction?: {
              AirStreaming?: {
                  MaxItinsPerChunk: number;
                  Method: "Services"
                  | "WholeResponse";
              };
              CompressResponse?: { Value?: boolean };
              MultipleSourcePerItinerary?: { Value: boolean };
              RequestType?: { Name?: string };
              ResponseSorting?: { SortFaresInsideItin?: boolean };
              ServiceTag?: { Name?: string };
              TranID?: Record<string, never>;
          };
          MultiTicket?: {
              DisplayPolicy?: "SOW"
              | "GOW2RT"
              | "SCHS";
              RequestedOneWays?: number;
          };
          RichContent?: {
              FlightAmenities?: boolean;
              Language?: string;
              SeatInfo?: boolean;
              UniversalProductAttributes?: boolean;
              UniversalTicketingAttributes?: boolean;
          };
      };
      TravelerInfoSummary: {
          AirTravelerAvail: {
              PassengerTypeQuantity: {
                  Code: string;
                  Quantity?: number;
                  TPA_Extensions?: {
                      VoluntaryChanges?: {
                          Match?: "All"
                          | "Any"
                          | "Info";
                          Penalty?: {
                              Amount?: ...;
                              Application?: ...;
                              CurrencyCode?: ...;
                              Exclude?: ...;
                              Type?: ...;
                          }[];
                      };
                  };
              }[];
          }[];
          PriceRequestInformation?: {
              AccountCode?: { Code: string }[];
              CurrencyCode?: string;
              NegotiatedFareCode?: { Code?: string; Supplier?: { Code?: string }[] }[];
              NegotiatedFaresOnly?: boolean;
              ProcessThruFaresOnly?: boolean;
              PurchaseDate?: string;
              TPA_Extensions?: {
                  BrandedFareIndicators?: {
                      BrandFilters?: {
                          Brand?: { Code: string; PreferLevel: "Unacceptable" | "Preferred" }[];
                          NonBrandedFares?: { PreferLevel: "Unacceptable" | "Preferred" };
                      };
                      ItinParityBrandlessLeg?: boolean;
                      ItinParityFallbackMode?: "LegParity"
                      | "LowestSingle";
                      MultipleBrandedFares?: boolean;
                      ParityMode?: "Leg" | "Itin";
                      ParityModeForLowest?: "None" | "Leg" | "Itin";
                      ReturnBrandAncillaries?: boolean;
                      SingleBrandedFare?: boolean;
                      UpsellLimit?: number;
                  };
                  Indicators?: {
                      MinMaxStay?: { Ind: boolean };
                      RefundPenalty?: { Ind: boolean };
                      ResTicketing?: { Ind: boolean };
                  };
                  OBFees?: Record<string, never>;
                  PassengerStatus?: {
                      CityCode?: string;
                      CountryCode?: string;
                      StateCode?: string;
                      Type: "N" | "R" | "E";
                  };
                  PointOfSaleOverride?: { Code: string };
                  PointOfTicketingOverride?: { Code: string };
                  Priority?: {
                      DirectFlights?: { Priority: number };
                      Price?: { Priority: number };
                      Time?: { Priority: number };
                      Vendor?: { Priority: number };
                  };
                  PrivateFare?: { Ind?: boolean };
                  PublicFare?: { Ind?: boolean };
              };
          };
          TPA_Extensions?: Record<string, never>;
      };
      TravelPreferences?: {
          AncillaryFees?: {
              AncillaryFeeGroup?: { Code: string; Count?: string }[];
              Enable: boolean;
              Summary?: boolean;
          };
          Baggage?: {
              CarryOnInfo?: boolean;
              Description?: boolean;
              FreeCarryOn?: boolean;
              FreePieceRequired?: boolean;
              RequestedPieces?: number;
              RequestType?: "C"
              | "A"
              | "N";
          };
          CabinPref?: {
              Cabin?: | "PremiumFirst"
              | "First"
              | "PremiumBusiness"
              | "Business"
              | "PremiumEconomy"
              | "Economy"
              | "Y"
              | "S"
              | "C"
              | "J"
              | "F"
              | "P";
              PreferLevel?: "Preferred";
          }[];
          ETicketDesired?: boolean;
          FlightTypePref?: { MaxConnections?: number
          | boolean };
          Hybrid?: boolean;
          LookForAlternatives?: boolean;
          MaxStopsQuantity?: number;
          SpanishFamilyDiscount?: { Level: 1 | 2 };
          TPA_Extensions?: {
              AdditionalFareLimit?: { Value: number };
              AvoidCabinDowngrade?: { Mode: "All" | "Main" | "None" };
              ClassOfService?: {
                  Code: string;
                  PreferLevel?: "Unacceptable" | "Preferred";
              }[];
              CodeShareIndicator?: { ExcludeCodeshare: boolean; KeepOnlines?: boolean };
              CountryPref?: { Code: string; PreferLevel: string }[];
              DataSources?: {
                  ATPCO?: "Enable" | "Disable";
                  LCC?: "Enable" | "Disable";
                  NDC?: "Enable" | "Disable";
              };
              DiversityParameters?: {
                  AdditionalNonStopsNumber?: number;
                  AdditionalNonStopsPercentage?: number;
                  InboundOutboundPairing?: number;
                  TimeOfDayDistribution?: {
                      TimeOfDayRange: { Begin: string; End: string; Percentage: number }[];
                  };
                  Weightings?: { PriceWeight: number; TravelTimeWeight: number };
              };
              ExcludeAlliancePref?: { Code: string }[];
              ExcludeCallDirectCarriers?: { Enabled?: boolean };
              ExcludeVendorPref?: { Code?: string }[];
              ExemptAllTaxes?: { Value: boolean };
              ExemptAllTaxesAndFees?: { Value: boolean };
              ExemptTax?: { TaxCode: string }[];
              FareBasis?: { Code: string; PreferLevel?: "Unacceptable" | "Preferred" }[];
              FareFocusRules?: { Exclude?: boolean };
              FareType?: { Code: string; PreferLevel: "Unacceptable" | "Preferred" }[];
              FlexibleFares?: {
                  FareParameters: {
                      AccountCode?: { Code: string }[];
                      AvoidCabinDowngrade?: { Mode: "All" | "Main" | "None" };
                      Baggage?: { FreePieceRequired?: boolean };
                      BrandedFareIndicators?: {
                          BrandFilters?: {
                              Brand?: { Code: ...; PreferLevel: ... }[];
                              NonBrandedFares?: { PreferLevel: (...) | (...) };
                          };
                          ItinParityBrandlessLeg?: boolean;
                          ItinParityFallbackMode?: "LegParity"
                          | "LowestSingle";
                          MultipleBrandedFares?: boolean;
                          ParityMode?: "Leg" | "Itin";
                          ParityModeForLowest?: "None" | "Leg" | "Itin";
                          SingleBrandedFare?: boolean;
                          UpsellLimit?: number;
                      };
                      Cabin?: {
                          Type: | "PremiumFirst"
                          | "First"
                          | "PremiumBusiness"
                          | "Business"
                          | "PremiumEconomy"
                          | "Economy"
                          | "Y"
                          | "S"
                          | "C"
                          | "J"
                          | "F"
                          | "P";
                      };
                      ClassOfService?: {
                          Code: string;
                          PreferLevel?: "Unacceptable"
                          | "Preferred";
                      }[];
                      CorporateID?: { Code: string }[];
                      ExcludeRestricted?: { Ind: boolean };
                      FareBasis?: {
                          Code: string;
                          PreferLevel?: "Unacceptable" | "Preferred";
                      }[];
                      FareType?: { Code: string; PreferLevel: "Unacceptable"
                      | "Preferred" }[];
                      JumpCabinLogic?: { Disabled: boolean };
                      KeepSameCabin?: { Enabled: boolean };
                      Leg?: {
                          Baggage?: { FreePieceRequired?: boolean };
                          BrandFilters?: {
                              Brand?: (...)[];
                              NonBrandedFares?: { PreferLevel: ... };
                          };
                          Cabin?: {
                              Type: | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...);
                          };
                          ClassOfService?: { Code: ...; PreferLevel?: ... }[];
                          FareBasis?: { Code: ...; PreferLevel?: ... }[];
                          FareType?: { Code: ...; PreferLevel: ... }[];
                          Num: number;
                          PriorityBoarding?: Record<string, never>;
                          Seats?: Record<string, never>;
                          SeatSelection?: { FreeSeatSelection?: boolean };
                      }[];
                      MinMaxStay?: { Ind: boolean };
                      NegotiatedFaresOnly?: { Ind: boolean };
                      PassengerTypeQuantity?: { Code: string; Quantity?: number }[];
                      PriorityBoarding?: Record<string, never>;
                      PrivateFare?: { Ind: boolean };
                      PublicFare?: { Ind: boolean };
                      RefundPenalty?: { Ind: boolean };
                      ResTicketing?: { Ind: boolean };
                      Seats?: Record<string, never>;
                      SeatSelection?: { FreeSeatSelection?: boolean };
                      UseNegotiatedFares?: { Ind: boolean };
                      UsePassengerFares?: { Ind: boolean };
                      VoluntaryChanges?: {
                          Match?: "All" | "Any" | "Info";
                          Penalty?: {
                              Amount?: number;
                              Application?: (...) | (...);
                              CurrencyCode?: string;
                              Exclude?: boolean;
                              Type?: (...) | (...);
                          }[];
                      };
                      XOFares?: { Ind: boolean };
                  }[];
              };
              FlightStopsAsConnections?: { Ind: boolean };
              GoverningCarrierOverride?: { AirlineCode: string };
              IncludeAlliancePref?: { Code: string }[];
              JumpCabinLogic?: { Disabled: boolean };
              KeepSameCabin?: { Enabled: boolean };
              LongConnectPoints?: { Max?: number; Min?: number };
              LongConnectTime?: {
                  Enable?: boolean;
                  Max?: number;
                  Min?: number;
                  NumberOfSolutions?: string;
              };
              LowCostCarriersProcessing?: { Disable?: boolean };
              NDCIndicators?: {
                  CarrierSpecificQualifiers?: {
                      AccountCode?: { Code: string };
                      CarrierCode: string;
                      FrequentFlyer?: {
                          AccountNumber: string;
                          AirlineDesignator: string;
                          PassengerId: string;
                      }[];
                      Qualifier?: { Name: string; Value: string }[];
                  }[];
                  FrequentFlyer?: {
                      AccountNumber: string;
                      AirlineDesignator: string;
                      PassengerId: string;
                  }[];
                  MaxNumberOfUpsells?: { Value: number };
                  MultipleBrandedFares?: { Value: boolean };
                  ParityMode?: { Mode: "Leg" | "Itin" };
                  Qualifier?: { Name: string; Value: string }[];
                  ShowOneWays?: { Value: boolean };
                  SingleBrandedFare?: { Value: boolean };
              };
              NumTrips?: { Number?: number };
              OnlineIndicator?: { Ind?: boolean };
              PreferNDCSourceOnTie?: { Value: boolean };
              PriorityBoarding?: { FreePriorityBoarding?: boolean; Info?: boolean };
              RetailerRules?: { Force?: boolean; RetailerRule: { Code: string }[] };
              Seats?: {
                  Seat?: { AtLeast?: number; LessThan?: number; Type?: string }[];
              };
              SeatSelection?: { FreeSeatSelection?: boolean; Info?: boolean };
              SellingLevels?: {
                  SellingLevelRules?: { Ignore: boolean };
                  ShowFareAmounts?: { Adjusted?: boolean; Original?: boolean };
              };
              SettlementMethod?: string;
              Taxes?: { Tax?: { Amount?: number; TaxCode: string }[] };
              TicketingSumOfLocals?: { Enable?: boolean };
              TripType?: {
                  Value?: "OneWay" | "Return" | "Circle" | "OpenJaw" | "Other";
              };
              ValidatingCarrier?: {
                  Code?: string;
                  Preference?: { Code: string; Level: "Unacceptable"
                  | "Preferred" }[];
              };
              ValidatingCarrierCheck?: {
                  Carrier?: { Code: string }[];
                  Country?: { Code: string }[];
                  IETValidation: { Ind: boolean };
                  SettlementValidation: { Ind: boolean };
              };
              VerificationItinCallLogic?: {
                  AlwaysCheckAvailability?: boolean;
                  Value?: "L"
                  | "M"
                  | "B";
              };
              XOFares?: { Value: boolean };
          };
          ValidInterlineTicket?: boolean;
          VendorPref?: {
              Code?: string;
              PreferLevel?: "Only"
              | "Unacceptable"
              | "Preferred";
              Type?: "Marketing" | "Operating";
          }[];
          VendorPrefApplicability?: {
              Type: "Marketing"
              | "Operating";
              Value: "AllSegments" | "AtLeastOneSegment";
          }[];
          VendorPrefPairing?: {
              Applicability?: "AllSegments"
              | "AtLeastOneSegment";
              PreferLevel: "Unacceptable" | "Preferred";
              VendorPref: { Code: string; Type?: "Marketing" | "Operating" }[];
          }[];
      };
      Version: string;
  }

  Description

  The Low Fare Search Request message requests price itinerary options for flights between specific city pairs on specific dates for specific numbers and types of passengers. The optional request information can include - Time / Time Window - Connecting cities. - Client Preferences (airlines, cabin, flight types, etc.) The Low Fare Search request contains similar information to a Low Fare Search entry on an airline CRS or GDS.

  • OptionalAvailableFlightsOnly?: boolean

    Description

    Indicator for whether to consider the availability of the corresponding booking codes. true(default) - Returns fares considering the availability of the corresponding booking codes. false - Returns fares without regard to the availability of the corresponding booking codes.

    Default

    true
    Copy

    Example

    true
    Copy

  • OriginDestinationInformation: {
        ArrivalDateTime?: string;
        ArrivalWindow?: string;
        ConnectionLocations?: {
            ConnectionLocation: {
                LocationCode: string;
                PreferLevel?: "Only" | "Unacceptable";
            }[];
        };
        DepartureDateTime?: string;
        DepartureWindow?: string;
        DestinationLocation: { LocationCode?: string; LocationType?: string };
        Fixed?: boolean;
        OriginLocation: { LocationCode?: string; LocationType?: string };
        TPA_Extensions?: {
            AlternateTime?: { Minus?: number; PlusMinus?: number };
            Baggage?: { FreeCarryOn?: boolean; FreePieceRequired?: boolean };
            BrandFilters?: {
                Brand?: { Code: string; PreferLevel: "Unacceptable" | "Preferred" }[];
                NonBrandedFares?: { PreferLevel: "Unacceptable" | "Preferred" };
            };
            CabinPref?: {
                Cabin?: | "PremiumFirst"
                | "First"
                | "PremiumBusiness"
                | "Business"
                | "PremiumEconomy"
                | "Economy"
                | "Y"
                | "S"
                | "C"
                | "J"
                | "F"
                | "P";
                PreferLevel?: "Preferred";
            };
            ClassOfService?: {
                Code: string;
                PreferLevel?: "Unacceptable"
                | "Preferred";
            }[];
            ConnectionTime?: {
                EnableExcludedConnection?: boolean;
                ExcludedConnectionBegin?: string;
                ExcludedConnectionEnd?: string;
                Max?: number;
                Min?: number;
            };
            FareBasis?: { Code: string; PreferLevel?: "Unacceptable"
            | "Preferred" }[];
            FareType?: { Code: string; PreferLevel: "Unacceptable" | "Preferred" }[];
            Flight?: {
                Airline: { Marketing: string; Operating?: string };
                ArrivalDateTime: string;
                ClassOfService?: string;
                DepartureDateTime: string;
                DestinationLocation: { LocationCode?: string };
                Number: number;
                OriginLocation: { LocationCode?: string };
                Type?: string;
            }[];
            IncludeAlliancePref?: { Code: string }[];
            IncludeVendorPref?: { Code: string }[];
            MaxOneWayOptions?: { Value: number };
            PriorityBoarding?: { FreePriorityBoarding?: boolean };
            Seats?: {
                Seat?: { AtLeast?: number; LessThan?: number; Type?: string }[];
            };
            SeatSelection?: { FreeSeatSelection?: boolean };
            SegmentType?: { Code?: "ARUNK" | "O" | "X" };
            SisterDestinationLocation?: { LocationCode?: string }[];
            SisterDestinationMileage?: { AllowBorderCross?: boolean; Number: number };
            SisterOriginLocation?: { LocationCode?: string }[];
            SisterOriginMileage?: { AllowBorderCross?: boolean; Number: number };
            Stopover?: {
                DepartureDateTime?: string;
                DepartureWindow?: string;
                Stay?: { MaxHours?: number; MinHours?: number; Nights?: number };
                StopoverPoint: { LocationCode: string; LocationType?: string };
            };
            TotalTravelTime?: { Max?: number; Min?: number };
        };
    }[]

    Description

    Order of Origin Destination information.

  • POS: {
        Source: {
            FixedPCC?: boolean;
            PseudoCityCode?: string;
            RequestorID: { CompanyName?: { Code?: string }; ID: string; Type: string };
        }[];
    }

    • Source: {
          FixedPCC?: boolean;
          PseudoCityCode?: string;
          RequestorID: { CompanyName?: { Code?: string }; ID: string; Type: string };
      }[]

      Description

      Point of sale source information.

  • OptionalResponseType?: string

    Description

    Response type information.

    Example

    GIR-JSON
    Copy

  • OptionalResponseVersion?: string

    Description

    Response version information.

    Example

    V4
    Copy

  • OptionalTPA_Extensions?: {
        AlternateAirportCities?: {
            AlternateLocation: { LocationCode?: string }[];
            SpecifiedLocation: { LocationCode?: string };
        }[];
        AlternateAirportMileage?: { AllowBorderCross?: boolean; Number: string };
        AlternatePCC?: {
            FixedPCC?: boolean;
            PseudoCityCode: string;
            TravelPreferences?: {
                TPA_Extensions?: {
                    ExcludeAlliancePref?: { Code: string }[];
                    IncludeAlliancePref?: { Code: string }[];
                };
                VendorPref?: {
                    Code: string;
                    PreferLevel?: "Only"
                    | "Unacceptable"
                    | "Preferred";
                }[];
            };
        }[];
        DiversityControl?: {
            Dimensions: {
                Carrier?: {
                    Default?: { Options: string };
                    OnlineIndicator?: boolean;
                    Override?: { Code: string; Options: string }[];
                    Weight: number;
                };
                InboundOutboundPairing?: { Duplicates?: number; Weight: number };
                OperatingDuplicate?: {
                    PreferredCarrier?: { Code: string }[];
                    Weight: number;
                };
                PriceWeight?: number;
                StopsNumber?: { Weight: number };
                TimeOfDay?: {
                    Distribution?: {
                        Direction?: "Outbound" | "Inbound";
                        Endpoint?: "Departure" | "Arrival";
                        Leg?: number;
                        Range?: { Begin: string; End: string; Options?: string }[];
                    }[];
                    Weight: number;
                };
                TravelTime?: { Weight: number };
            };
            LowFareBucket: { FareCutOff?: string; Options?: string };
        };
        IntelliSellTransaction?: {
            AirStreaming?: {
                MaxItinsPerChunk: number;
                Method: "Services"
                | "WholeResponse";
            };
            CompressResponse?: { Value?: boolean };
            MultipleSourcePerItinerary?: { Value: boolean };
            RequestType?: { Name?: string };
            ResponseSorting?: { SortFaresInsideItin?: boolean };
            ServiceTag?: { Name?: string };
            TranID?: Record<string, never>;
        };
        MultiTicket?: {
            DisplayPolicy?: "SOW"
            | "GOW2RT"
            | "SCHS";
            RequestedOneWays?: number;
        };
        RichContent?: {
            FlightAmenities?: boolean;
            Language?: string;
            SeatInfo?: boolean;
            UniversalProductAttributes?: boolean;
            UniversalTicketingAttributes?: boolean;
        };
    }

    • OptionalAlternateAirportCities?: {
          AlternateLocation: { LocationCode?: string }[];
          SpecifiedLocation: { LocationCode?: string };
      }[]

      Description

      For each specified location, provide an alternate location.

    • OptionalAlternateAirportMileage?: { AllowBorderCross?: boolean; Number: string }

      Description

      Specify maximum allowed distance from specified airport.

      • OptionalAllowBorderCross?: boolean

        Description

        Parameter set from default to true. In addition to AlternateAirportMileage it enables to cross a given country border if an alternative Airport is in the range of requested mileage radius. Note- Allow to return alternate airports from other countries. Default value is true. AllowBorderCross configuration set at AlternateAirportMileage overrides values of the same parameter set at leg level.

        Example

        true
        Copy

      • Number: string

        Description

        Mileage radius range to searchfor alternate airports.

        Example

        50
        Copy

    • OptionalAlternatePCC?: {
          FixedPCC?: boolean;
          PseudoCityCode: string;
          TravelPreferences?: {
              TPA_Extensions?: {
                  ExcludeAlliancePref?: { Code: string }[];
                  IncludeAlliancePref?: { Code: string }[];
              };
              VendorPref?: {
                  Code: string;
                  PreferLevel?: "Only"
                  | "Unacceptable"
                  | "Preferred";
              }[];
          };
      }[]

      Description

      Alternate PCC information.

    • OptionalDiversityControl?: {
          Dimensions: {
              Carrier?: {
                  Default?: { Options: string };
                  OnlineIndicator?: boolean;
                  Override?: { Code: string; Options: string }[];
                  Weight: number;
              };
              InboundOutboundPairing?: { Duplicates?: number; Weight: number };
              OperatingDuplicate?: {
                  PreferredCarrier?: { Code: string }[];
                  Weight: number;
              };
              PriceWeight?: number;
              StopsNumber?: { Weight: number };
              TimeOfDay?: {
                  Distribution?: {
                      Direction?: "Outbound" | "Inbound";
                      Endpoint?: "Departure" | "Arrival";
                      Leg?: number;
                      Range?: { Begin: string; End: string; Options?: string }[];
                  }[];
                  Weight: number;
              };
              TravelTime?: { Weight: number };
          };
          LowFareBucket: { FareCutOff?: string; Options?: string };
      }

      Description

      Diversity parameters control how we should itineraries be selected based not necessarily on cheapest price, but also on other criteria that guarantee a diverse response.

      • Dimensions: {
            Carrier?: {
                Default?: { Options: string };
                OnlineIndicator?: boolean;
                Override?: { Code: string; Options: string }[];
                Weight: number;
            };
            InboundOutboundPairing?: { Duplicates?: number; Weight: number };
            OperatingDuplicate?: {
                PreferredCarrier?: { Code: string }[];
                Weight: number;
            };
            PriceWeight?: number;
            StopsNumber?: { Weight: number };
            TimeOfDay?: {
                Distribution?: {
                    Direction?: "Outbound" | "Inbound";
                    Endpoint?: "Departure" | "Arrival";
                    Leg?: number;
                    Range?: { Begin: string; End: string; Options?: string }[];
                }[];
                Weight: number;
            };
            TravelTime?: { Weight: number };
        }

        Description

        Parameters influencing diversity processin.

        • OptionalCarrier?: {
              Default?: { Options: string };
              OnlineIndicator?: boolean;
              Override?: { Code: string; Options: string }[];
              Weight: number;
          }

          Description

          Carrier preference (dimension) in diversity bucket.

          • OptionalDefault?: { Options: string }

            Description

            Indicates any carrier code not specified on "Override" element.

            • Options: string

              Description

              Number or percentage of options.

              Example

              5
              Copy

          • OptionalOnlineIndicator?: boolean

            Description

            Allows the User to decide if Carrier Diversity should be applied to online versus interline itineraries.

            Default

            false
            Copy

            Example

            true
            Copy

          • OptionalOverride?: { Code: string; Options: string }[]

            Description

            Specifies exact carrier code for diversity bucket.

          • Weight: number

            Description

            Allows the User to define how much the Carrier dimension should affect the score of an itinerary in Diversity Swapper. The range of allowed values is an integer between 0 and 10.

            Example

            1
            Copy

        • OptionalInboundOutboundPairing?: { Duplicates?: number; Weight: number }

          Description

          Defines the requested ratio of inbounds to outbounds in the response.

          • OptionalDuplicates?: number

            Description

            Default value 1. Allows the User to define the preference how many options (itineraries) containing given outbound leg should be returned.

            Default

            1
            Copy

            Example

            1
            Copy

          • Weight: number

            Description

            Allows the User to define how much the Inbound Outbound Pairing dimension should affect the score of an itinerary in Diversity Swapper.

            Example

            1
            Copy

        • OptionalOperatingDuplicate?: { PreferredCarrier?: { Code: string }[]; Weight: number }

          Description

          Provides the capability to prefer itineraries that are unique if it comes to the operating flights. This is done by penalizing itineraries with duplicated operating flights.

          • OptionalPreferredCarrier?: { Code: string }[]

            Description

            Allows the User to define Preferred Validating Carrier Codes.

          • Weight: number

            Description

            Allows the User to define how much the Operating Duplicate dimension should affect the score of an itinerary in Diversity Swapper.The range of allowed values is an integer between 0 and 10.

            Example

            1
            Copy

        • OptionalPriceWeight?: number

          Description

          This defines how important price options are, on a scale of 0 to 10.

          Default

          10
          Copy

          Example

          10
          Copy

        • OptionalStopsNumber?: { Weight: number }

          Description

          Provides the capability to prefer itineraries consisting non-stop flights over connecting ones. This dimension penalize itineraries consisting of direct and connecting flights.

          • Weight: number

            Description

            Defines how much the Stops Number dimension should affect the score of an itinerary in Diversity Swapper. The range of allowed values is an integer between 0 and 10.

            Example

            1
            Copy

        • OptionalTimeOfDay?: {
              Distribution?: {
                  Direction?: "Outbound" | "Inbound";
                  Endpoint?: "Departure" | "Arrival";
                  Leg?: number;
                  Range?: { Begin: string; End: string; Options?: string }[];
              }[];
              Weight: number;
          }

          Description

          Provides the capability to define preferred options distribution among different time ranges. Itineraries departing and/or arriving in the Time of Day range with bigger number/percentage of options specified be preferred over the others.

          • OptionalDistribution?: {
                Direction?: "Outbound" | "Inbound";
                Endpoint?: "Departure" | "Arrival";
                Leg?: number;
                Range?: { Begin: string; End: string; Options?: string }[];
            }[]

            Description

            Exactly one attribute, either Direction or Leg must be provided.

          • Weight: number

            Description

            Allows the User to define how much the Time of Day dimension should affect the score of an itinerary in Diversity Swapper. The range of allowed values is an integer between 0 and 10.

            Example

            1
            Copy

        • OptionalTravelTime?: { Weight: number }

          Description

          Allows you to prefer itineraries with shorter duration over the other ones.

          • Weight: number

            Description

            Allows the User to define how much the Travel Time dimension should affect the score of an itinerary in Diversity Swapper.

            Example

            1
            Copy

      • LowFareBucket: { FareCutOff?: string; Options?: string }

        Description

        Indicates low fare bucket options. This group of options will not be considered by diversity processing.

        • OptionalFareCutOff?: string

          Description

          FareCutOff (optional) Indicates the fare lever above with the results will be considered by diversity processing.

          Example

          25%
          Copy

        • OptionalOptions?: string

          Description

          Number or percentage of options.

          Example

          20%
          Copy

    • OptionalIntelliSellTransaction?: {
          AirStreaming?: {
              MaxItinsPerChunk: number;
              Method: "Services" | "WholeResponse";
          };
          CompressResponse?: { Value?: boolean };
          MultipleSourcePerItinerary?: { Value: boolean };
          RequestType?: { Name?: string };
          ResponseSorting?: { SortFaresInsideItin?: boolean };
          ServiceTag?: { Name?: string };
          TranID?: Record<string, never>;
      }

      Description

      IntelliSell Transaction Type.

      • OptionalAirStreaming?: { MaxItinsPerChunk: number; Method: "Services" | "WholeResponse" }

        Description

        Activates the AirStreaming functionality, which allows you to receive a chunked response. The MaxItinsPerChunk attribute is set individually by customers and configures the maximum number of itineraries per one chunk. This feature requires some development work on the customers side; therefore, more information is available in a dedicated Developer Administration Guide. The same document describes two available types of AirStreaming. Functionality is available in XML over the REST Endpoints. Applies to BargainFinderMax, Alternate Airport Shop, and Alternate Dates services.

        • MaxItinsPerChunk: number

          Description

          Atributte is set individually by the customers and configures what is the maximum amount of itineraries per one chunk in the below example the value is set to max. 10 Itineraries per chunk.

          Example

          10
          Copy

        • Method: "Services" | "WholeResponse"

          Description

          There are 2 types of streaming available, therefore the Method of AirStreaming is equal either to "Services" or "WholeResponse".

          Example

          Services
          @enum {string}
          Copy

      • OptionalCompressResponse?: { Value?: boolean }

        Description

        Indicator for whether the response should be compressed.

        • OptionalValue?: boolean

          Description

          A value of "true" returns the response payload in a Base64 encoded GZIP format. For instructions on how to decode and unzip the response, see the Response design document.

          Default

          false
          Copy

          Example

          true
          Copy

      • OptionalMultipleSourcePerItinerary?: { Value: boolean }

        Description

        This allows you to specify what to do if the same journey is returned from ATPCO and NDC channels. By default, the cheaper will stay. In the case of a tie, the previously described solution will be in place. With this attribute, you can indicate show me everything, combine ATPCO and NDC fares as additional fares, regardless of whether they are the same price. You can use this for a single NDC fare or multiple, the same for APTCO, both single and multiple. NDC Applicable.

        • Value: boolean

          Description

          Combine solutions from different services/sources as additional fares.

          Example

          true
          Copy

      • OptionalRequestType?: { Name?: string }

        Description

        Identifier of the type of request.

        • OptionalName?: string

          Description

          Type of request. It specifies the number of options returned for one-way, round-trip, single/double open jaw, and multi-destination trips with less than three legs. For complex,multi-destination, and circle trips with three or more legs, the number of options returned depends only the customer tier and with some exceptions. Name="50ITINS" Returns 50 itineraries in the response. The action code in the SOAP header must be set to BargainFinderMaxRQ.Name="100ITINS" Returns 100 itineraries. The action code in the SOAP header must be set to BargainFinderMaxRQ. Name="200ITINS" Returns 200 itineraries. The action code in the SOAP header must be set to BargainFinderMaxRQ. If a Request Type other than the ones listed above is used, the response is "No Availability". Using a Request Type name for a tier to which you are not subscribed alsoreturns a "No Availability" response.

          Example

          50ITINS
          Copy

      • OptionalResponseSorting?: { SortFaresInsideItin?: boolean }

        Description

        Settings for IntelliSell merchandising.

        • OptionalSortFaresInsideItin?: boolean

          Description

          If true, fares will be sorted inside the itinerary.

          Example

          true
          Copy

      • OptionalServiceTag?: { Name?: string }

        Description

        Identifier of the transaction path.

        • OptionalName?: string

          Description

          Service Tag name.

          Example

          ABC1
          Copy

      • OptionalTranID?: Record<string, never>

        Description

        Transaction ID.

    • OptionalMultiTicket?: { DisplayPolicy?: "SOW" | "GOW2RT" | "SCHS"; RequestedOneWays?: number }

      Description

      MultiTicket allows you to request the lowest fare for an itinerary by considering two one-way flight combinations to be issued in two separate tickets. This will reduce the number of queries (single call versus multiple) by enabling you to request both one-way (OW) and round-trip (RT) solutions for the same itinerary simplifying the process.

      • OptionalDisplayPolicy?: "SOW" | "GOW2RT" | "SCHS"

        Description

        Display Option Policy, takes values - SOW - Show OneWays separately - first show standard RT output, then show OW for 1st and 2nd legs separately. Customer receives Round Trip and OneWays (outbound and inbound) solutions for the same request. OneWay solutions will be presented as 2 separate sections (OneWay Outbound and OneWay Inbound) and not as combination of two OneWay solutions combined into one round trip itinerary. Customer will be able to build the RT solution by choosing the most applicable, comfortable and cheapest OneWay solutions. SCHS - Group OneWays, match to RoundTrip and show cheaper solution. Customer receives cheapest solutions between Round Trip and 2 OneWay solution for the same request. OW solutions will be presented as combination of separate one way tickets into one round trip Itinerary.

        Example

        SOW
        @enum {string}
        Copy

      • OptionalRequestedOneWays?: number

        Description

        Allow to set requested number of OneWays in MultiTicket processing.

        Example

        30
        Copy

    • OptionalRichContent?: {
          FlightAmenities?: boolean;
          Language?: string;
          SeatInfo?: boolean;
          UniversalProductAttributes?: boolean;
          UniversalTicketingAttributes?: boolean;
      }

      Description

      ATPCO RH content (Flight Amenities UTA, UPA). Control over which Rich Content elements should be returned in the response. Available for consumption based on approval and activation only. Please refer to your account manager for information.

      • OptionalFlightAmenities?: boolean

        Description

        FlightAmenities parameter allows to specify if a list of available flight amenities such as Seat Comfort, WiFi, Power etc. should be included in the response.

        Default

        false
        Copy

        Example

        true
        Copy

      • OptionalLanguage?: string

        Description

        Language(optional) (Default = English) allows specifying the desired language translations for Universal Ticketing and Product Attributes. If the language is not specified, it defaults to EN. If the translations are not available in provided language or the provided language code is incorrect, it defaults to EN.

        Example

        EN
        Copy

      • OptionalSeatInfo?: boolean

        Description

        SeatInfo(optional) supports to return Seat Type and Seat Pitch information about what is included in the offer regarding seat type and seat pitch.

        Default

        false
        Copy

        Example

        true
        Copy

      • OptionalUniversalProductAttributes?: boolean

        Description

        UniversalProductAttributes(optional) parameter allows to return ATPCO Route Happy Universal Product Attributes content in the response.

        Default

        false
        Copy

        Example

        true
        Copy

      • OptionalUniversalTicketingAttributes?: boolean

        Description

        UniversalTicketingAttributes(optional) parameter allows to return ATPCO Route Happy Universal Ticket Attributes content in the response.

        Default

        false
        Copy

        Example

        true
        Copy

  • TravelerInfoSummary: {
        AirTravelerAvail: {
            PassengerTypeQuantity: {
                Code: string;
                Quantity?: number;
                TPA_Extensions?: {
                    VoluntaryChanges?: {
                        Match?: "All" | "Any" | "Info";
                        Penalty?: {
                            Amount?: ...;
                            Application?: ...;
                            CurrencyCode?: ...;
                            Exclude?: ...;
                            Type?: ...;
                        }[];
                    };
                };
            }[];
        }[];
        PriceRequestInformation?: {
            AccountCode?: { Code: string }[];
            CurrencyCode?: string;
            NegotiatedFareCode?: { Code?: string; Supplier?: { Code?: string }[] }[];
            NegotiatedFaresOnly?: boolean;
            ProcessThruFaresOnly?: boolean;
            PurchaseDate?: string;
            TPA_Extensions?: {
                BrandedFareIndicators?: {
                    BrandFilters?: {
                        Brand?: { Code: string; PreferLevel: "Unacceptable" | "Preferred" }[];
                        NonBrandedFares?: { PreferLevel: "Unacceptable" | "Preferred" };
                    };
                    ItinParityBrandlessLeg?: boolean;
                    ItinParityFallbackMode?: "LegParity"
                    | "LowestSingle";
                    MultipleBrandedFares?: boolean;
                    ParityMode?: "Leg" | "Itin";
                    ParityModeForLowest?: "None" | "Leg" | "Itin";
                    ReturnBrandAncillaries?: boolean;
                    SingleBrandedFare?: boolean;
                    UpsellLimit?: number;
                };
                Indicators?: {
                    MinMaxStay?: { Ind: boolean };
                    RefundPenalty?: { Ind: boolean };
                    ResTicketing?: { Ind: boolean };
                };
                OBFees?: Record<string, never>;
                PassengerStatus?: {
                    CityCode?: string;
                    CountryCode?: string;
                    StateCode?: string;
                    Type: "N" | "R" | "E";
                };
                PointOfSaleOverride?: { Code: string };
                PointOfTicketingOverride?: { Code: string };
                Priority?: {
                    DirectFlights?: { Priority: number };
                    Price?: { Priority: number };
                    Time?: { Priority: number };
                    Vendor?: { Priority: number };
                };
                PrivateFare?: { Ind?: boolean };
                PublicFare?: { Ind?: boolean };
            };
        };
        TPA_Extensions?: Record<string, never>;
    }

    • AirTravelerAvail: {
          PassengerTypeQuantity: {
              Code: string;
              Quantity?: number;
              TPA_Extensions?: {
                  VoluntaryChanges?: {
                      Match?: "All" | "Any" | "Info";
                      Penalty?: {
                          Amount?: ...;
                          Application?: ...;
                          CurrencyCode?: ...;
                          Exclude?: ...;
                          Type?: ...;
                      }[];
                  };
              };
          }[];
      }[]

      Description

      Passenger numbers and types.

    • OptionalPriceRequestInformation?: {
          AccountCode?: { Code: string }[];
          CurrencyCode?: string;
          NegotiatedFareCode?: { Code?: string; Supplier?: { Code?: string }[] }[];
          NegotiatedFaresOnly?: boolean;
          ProcessThruFaresOnly?: boolean;
          PurchaseDate?: string;
          TPA_Extensions?: {
              BrandedFareIndicators?: {
                  BrandFilters?: {
                      Brand?: { Code: string; PreferLevel: "Unacceptable" | "Preferred" }[];
                      NonBrandedFares?: { PreferLevel: "Unacceptable" | "Preferred" };
                  };
                  ItinParityBrandlessLeg?: boolean;
                  ItinParityFallbackMode?: "LegParity"
                  | "LowestSingle";
                  MultipleBrandedFares?: boolean;
                  ParityMode?: "Leg" | "Itin";
                  ParityModeForLowest?: "None" | "Leg" | "Itin";
                  ReturnBrandAncillaries?: boolean;
                  SingleBrandedFare?: boolean;
                  UpsellLimit?: number;
              };
              Indicators?: {
                  MinMaxStay?: { Ind: boolean };
                  RefundPenalty?: { Ind: boolean };
                  ResTicketing?: { Ind: boolean };
              };
              OBFees?: Record<string, never>;
              PassengerStatus?: {
                  CityCode?: string;
                  CountryCode?: string;
                  StateCode?: string;
                  Type: "N" | "R" | "E";
              };
              PointOfSaleOverride?: { Code: string };
              PointOfTicketingOverride?: { Code: string };
              Priority?: {
                  DirectFlights?: { Priority: number };
                  Price?: { Priority: number };
                  Time?: { Priority: number };
                  Vendor?: { Priority: number };
              };
              PrivateFare?: { Ind?: boolean };
              PublicFare?: { Ind?: boolean };
          };
      }

      Description

      Pricing source, if it is a reprice request with negotiated fares.

      • OptionalAccountCode?: { Code: string }[]

        Description

        The unique code used to represent the account.

      • OptionalCurrencyCode?: string

        Description

        Currency preferred for reviewing monetary values, in ISO 4217. NDC Applicable. codes.

        Example

        USD
        Copy

      • OptionalNegotiatedFareCode?: { Code?: string; Supplier?: { Code?: string }[] }[]

        Description

        The unique code used to represent the negotiaded Fare.

      • OptionalNegotiatedFaresOnly?: boolean

        Description

        A value of "true" returns only the designated corporate ID fares, even if a less expensive fare exists.

        Example

        true
        Copy

      • OptionalProcessThruFaresOnly?: boolean

        Description

        A value of "true" returns only Through fares.

        Example

        true
        Copy

      • OptionalPurchaseDate?: string

        Format: date

        Description

        Alternate purchase date to retrieve the fares.

        Example

        2020-12-23
        Copy

      • OptionalTPA_Extensions?: {
            BrandedFareIndicators?: {
                BrandFilters?: {
                    Brand?: { Code: string; PreferLevel: "Unacceptable" | "Preferred" }[];
                    NonBrandedFares?: { PreferLevel: "Unacceptable" | "Preferred" };
                };
                ItinParityBrandlessLeg?: boolean;
                ItinParityFallbackMode?: "LegParity"
                | "LowestSingle";
                MultipleBrandedFares?: boolean;
                ParityMode?: "Leg" | "Itin";
                ParityModeForLowest?: "None" | "Leg" | "Itin";
                ReturnBrandAncillaries?: boolean;
                SingleBrandedFare?: boolean;
                UpsellLimit?: number;
            };
            Indicators?: {
                MinMaxStay?: { Ind: boolean };
                RefundPenalty?: { Ind: boolean };
                ResTicketing?: { Ind: boolean };
            };
            OBFees?: Record<string, never>;
            PassengerStatus?: {
                CityCode?: string;
                CountryCode?: string;
                StateCode?: string;
                Type: "N" | "R" | "E";
            };
            PointOfSaleOverride?: { Code: string };
            PointOfTicketingOverride?: { Code: string };
            Priority?: {
                DirectFlights?: { Priority: number };
                Price?: { Priority: number };
                Time?: { Priority: number };
                Vendor?: { Priority: number };
            };
            PrivateFare?: { Ind?: boolean };
            PublicFare?: { Ind?: boolean };
        }

        Description

        Additional elements and attributes to be included, if required.

        • OptionalBrandedFareIndicators?: {
              BrandFilters?: {
                  Brand?: { Code: string; PreferLevel: "Unacceptable" | "Preferred" }[];
                  NonBrandedFares?: { PreferLevel: "Unacceptable" | "Preferred" };
              };
              ItinParityBrandlessLeg?: boolean;
              ItinParityFallbackMode?: "LegParity"
              | "LowestSingle";
              MultipleBrandedFares?: boolean;
              ParityMode?: "Leg" | "Itin";
              ParityModeForLowest?: "None" | "Leg" | "Itin";
              ReturnBrandAncillaries?: boolean;
              SingleBrandedFare?: boolean;
              UpsellLimit?: number;
          }

          Description

          Indicators for branded fares.

          • OptionalBrandFilters?: {
                Brand?: { Code: string; PreferLevel: "Unacceptable" | "Preferred" }[];
                NonBrandedFares?: { PreferLevel: "Unacceptable" | "Preferred" };
            }

            Description

            Preferred or excluded brand type codes for the flexible fare leg.

            • OptionalBrand?: { Code: string; PreferLevel: "Unacceptable" | "Preferred" }[]

              Description

              Brand information.

            • OptionalNonBrandedFares?: { PreferLevel: "Unacceptable" | "Preferred" }

              Description

              Allows you to exclude non-branded fares in the shopping response. When the PreferLevel is set to Preferred," this means Use non-branded fares. If this is single filter (no other preferred elements), the meaning is Use ONLY non-branded fares. If other preferred filters are also used, the meaning is Use non-branded fares or fares with given (in filters) brands. When the PreferLevel is set to Unacceptable," this means Do not use non-branded fares. If this is single filter (no other unacceptable elements), the meaning is Use ONLY branded fares skip all non-branded. If other unacceptable filters are also used, the meaning is Use only branded fares excluding fares matching given (in filters) brands.

              • PreferLevel: "Unacceptable" | "Preferred"

                Description

                Preference level for all combinations inside one element.

                Example

                Preferred
                @enum {string}
                Copy

          • OptionalItinParityBrandlessLeg?: boolean

            Description

            Parameter to Allow for Brand-less Leg Solutions when Itinerary parity is requested.

            Example

            true
            Copy

          • OptionalItinParityFallbackMode?: "LegParity" | "LowestSingle"

            Description

            Parameter to choose the Fall Back Mode when brand Itinerary parity cannot be met (Lowest single Brand or Leg Parity).

            Example

            LegParity
            @enum {string}
            Copy

          • OptionalMultipleBrandedFares?: boolean

            Description

            Return multiple brand options per itin. NDC Applicable.

            Example

            true
            Copy

          • OptionalParityMode?: "Leg" | "Itin"

            Description

            Parameter to control the Brand Parity calculation logic preference (Leg Parity or Itinerary Parity). When specifying the ParityMode="Itin" at the request level without specifying the ItinParityFallbackMode, then the default (BFS) single lowest brand will be applied and single branded options returned.

            Example

            Itin
            @enum {string}
            Copy

          • OptionalParityModeForLowest?: "None" | "Leg" | "Itin"

            Description

            Parameter which gives the ability to apply parity mode for the main/primary fare. Possible Values: Leg or Itinerary. If set, given parity mode will be forced on the cheapest branded fare solution. If not specified, no parity (None) is forced on the cheapest branded fare solution. NOTE: It"s designed to work with MultipleBrandedFares feature only.

            Example

            Leg
            @enum {string}
            Copy

          • OptionalReturnBrandAncillaries?: boolean

            Description

            Parameter to request brand attributes, allows Sabre agencies to return additional brand attributes in the response it returns the structured data filed in table 166. Brand attributes is a feature within the Branded fares capabilities and will be returned with single and multiple branded fares request.

            Example

            true
            Copy

          • OptionalSingleBrandedFare?: boolean

            Description

            Return single brand option per itin.

            Example

            true
            Copy

          • OptionalUpsellLimit?: number

            Description

            Parameter to Limit of the Number of Upsell solutions to be returned.

            Example

            2
            Copy

        • OptionalIndicators?: {
              MinMaxStay?: { Ind: boolean };
              RefundPenalty?: { Ind: boolean };
              ResTicketing?: { Ind: boolean };
          }

          Description

          Restricts fares that can be returned in the response. If you use this element, you must provide all children.

          • OptionalMinMaxStay?: { Ind: boolean }

            Description

            Indicator for whether to include fares that have a min/max stay requirement. Valid values are:true or 1 Includes fares with a min/max stay requirement in the response. false or 0 Do not include fares with a min/max stay requirement in the response. Note This is negation of the XS qualifier.

            • Ind: boolean

              Description

              Indicator for whether the fare can contain a Minimum Maximum Stay restriction. If the value is "true", the response can contain fares that have a min/max stay restriction. If the value is "false", no fares that include a min/max stay requirement will be included in the response.

              Example

              true
              Copy

          • OptionalRefundPenalty?: { Ind: boolean }

            Description

            Indicator for whether to include fares that have a refund penalty. Note This is negation of the XS qualifier.

            • Ind: boolean

              Description

              Indicator for whether the fare can contain a refund penalty. If the value is "true", the response can contain fares that have a refund penalty. If the value is "false", no fares that include a refund penalty requirement will be included in the response.

              Example

              true
              Copy

          • OptionalResTicketing?: { Ind: boolean }

            Description

            Indicator for whether to include fares that have a reservation/ticketing requirement.

            • Ind: boolean

              Description

              Indicator for whether the fare can contain a ticketing policy. If the value is "true", the response can contain fares that have a reservation/ticketing requirement. If the value is "false", no fares that include a reservation/ticketing requirement will be included in the response.

              Example

              true
              Copy

        • OptionalOBFees?: Record<string, never>

          Description

          Collection of OB fees.

        • OptionalPassengerStatus?: {
              CityCode?: string;
              CountryCode?: string;
              StateCode?: string;
              Type: "N" | "R" | "E";
          }

          Description

          Address information and passenger type for the passenger.

          • OptionalCityCode?: string

            Description

            Three-character city code.Cannot combine with StateCode or CountryCode.

            Example

            DFW
            Copy

          • OptionalCountryCode?: string

            Description

            Two-character ISO Country code. Cannot combine with CityCode.

            Example

            US
            Copy

          • OptionalStateCode?: string

            Description

            Postal service standard code or abbreviation for the state, province, or region. Cannot combine with CityCode.

            Example

            123456
            Copy

          • Type: "N" | "R" | "E"

            Description

            Passenger type.Type="R" -Residency.Type="E" - Employee .Type="N" - Nationality.

            Example

            N
            @enum {string}
            Copy

        • OptionalPointOfSaleOverride?: { Code: string }

          Description

          Returns the fares available for the specified point of sale. These fares will be priced in the currency of the specified point of sale. This allows you to override the point of origin country and validate applicable fare restrictions to selling a fare in the requested country. The currency is overridden by PriceRequestInformation@CurrencyCode.

          • Code: string

            Description

            Three-character city code.

            Example

            DFW
            Copy

        • OptionalPointOfTicketingOverride?: { Code: string }

          Description

          Point Of Ticketing Override information.

          • Code: string

            Description

            Three-character city code.

            Example

            AAA
            Copy

        • OptionalPriority?: {
              DirectFlights?: { Priority: number };
              Price?: { Priority: number };
              Time?: { Priority: number };
              Vendor?: { Priority: number };
          }

          Description

          Governs the order in which flights are returned.

          • OptionalDirectFlights?: { Priority: number }

            Description

            Priority level the user puts on receiving direct flights.

            • Priority: number

              Description

              Priority order of direct flights. Valid values are: 1 through 4.

              Example

              2
              Copy

          • OptionalPrice?: { Priority: number }

            Description

            Priority level the user puts on receiving lower prices.

            • Priority: number

              Description

              Priority order of price. Valid values are: 1 through 4.

              Example

              1
              Copy

          • OptionalTime?: { Priority: number }

            Description

            Priority level the user puts on having the flights at a desired time. Prefer itineraries departing closer to requested departure time.

            • Priority: number

              Description

              Priority order of departure time. Valid values are: 1 through 4.

              Example

              3
              Copy

          • OptionalVendor?: { Priority: number }

            Description

            Promote certain marketing carriers over all the others in the returning results (configured in rules).

            • Priority: number

              Description

              Priority order of specified carrier. Valid values are: 1 through 4.

              Example

              4
              Copy

        • OptionalPrivateFare?: { Ind?: boolean }

          Description

          Indicator for whether to search only private fares.

          • OptionalInd?: boolean

            Description

            A value of "true" returns only private fares.

            Default

            false
            Copy

            Example

            true
            Copy

        • OptionalPublicFare?: { Ind?: boolean }

          Description

          Indicator for whether to search only public fares.

          • OptionalInd?: boolean

            Description

            A value of "true" returns only public fares.

            Default

            false
            Copy

            Example

            true
            Copy

    • OptionalTPA_Extensions?: Record<string, never>

      Description

      Additional elements and attributes to be included if required.

  • OptionalTravelPreferences?: {
        AncillaryFees?: {
            AncillaryFeeGroup?: { Code: string; Count?: string }[];
            Enable: boolean;
            Summary?: boolean;
        };
        Baggage?: {
            CarryOnInfo?: boolean;
            Description?: boolean;
            FreeCarryOn?: boolean;
            FreePieceRequired?: boolean;
            RequestedPieces?: number;
            RequestType?: "C"
            | "A"
            | "N";
        };
        CabinPref?: {
            Cabin?: | "PremiumFirst"
            | "First"
            | "PremiumBusiness"
            | "Business"
            | "PremiumEconomy"
            | "Economy"
            | "Y"
            | "S"
            | "C"
            | "J"
            | "F"
            | "P";
            PreferLevel?: "Preferred";
        }[];
        ETicketDesired?: boolean;
        FlightTypePref?: { MaxConnections?: number
        | boolean };
        Hybrid?: boolean;
        LookForAlternatives?: boolean;
        MaxStopsQuantity?: number;
        SpanishFamilyDiscount?: { Level: 1 | 2 };
        TPA_Extensions?: {
            AdditionalFareLimit?: { Value: number };
            AvoidCabinDowngrade?: { Mode: "All" | "Main" | "None" };
            ClassOfService?: {
                Code: string;
                PreferLevel?: "Unacceptable" | "Preferred";
            }[];
            CodeShareIndicator?: { ExcludeCodeshare: boolean; KeepOnlines?: boolean };
            CountryPref?: { Code: string; PreferLevel: string }[];
            DataSources?: {
                ATPCO?: "Enable" | "Disable";
                LCC?: "Enable" | "Disable";
                NDC?: "Enable" | "Disable";
            };
            DiversityParameters?: {
                AdditionalNonStopsNumber?: number;
                AdditionalNonStopsPercentage?: number;
                InboundOutboundPairing?: number;
                TimeOfDayDistribution?: {
                    TimeOfDayRange: { Begin: string; End: string; Percentage: number }[];
                };
                Weightings?: { PriceWeight: number; TravelTimeWeight: number };
            };
            ExcludeAlliancePref?: { Code: string }[];
            ExcludeCallDirectCarriers?: { Enabled?: boolean };
            ExcludeVendorPref?: { Code?: string }[];
            ExemptAllTaxes?: { Value: boolean };
            ExemptAllTaxesAndFees?: { Value: boolean };
            ExemptTax?: { TaxCode: string }[];
            FareBasis?: { Code: string; PreferLevel?: "Unacceptable" | "Preferred" }[];
            FareFocusRules?: { Exclude?: boolean };
            FareType?: { Code: string; PreferLevel: "Unacceptable" | "Preferred" }[];
            FlexibleFares?: {
                FareParameters: {
                    AccountCode?: { Code: string }[];
                    AvoidCabinDowngrade?: { Mode: "All" | "Main" | "None" };
                    Baggage?: { FreePieceRequired?: boolean };
                    BrandedFareIndicators?: {
                        BrandFilters?: {
                            Brand?: { Code: ...; PreferLevel: ... }[];
                            NonBrandedFares?: { PreferLevel: (...) | (...) };
                        };
                        ItinParityBrandlessLeg?: boolean;
                        ItinParityFallbackMode?: "LegParity"
                        | "LowestSingle";
                        MultipleBrandedFares?: boolean;
                        ParityMode?: "Leg" | "Itin";
                        ParityModeForLowest?: "None" | "Leg" | "Itin";
                        SingleBrandedFare?: boolean;
                        UpsellLimit?: number;
                    };
                    Cabin?: {
                        Type: | "PremiumFirst"
                        | "First"
                        | "PremiumBusiness"
                        | "Business"
                        | "PremiumEconomy"
                        | "Economy"
                        | "Y"
                        | "S"
                        | "C"
                        | "J"
                        | "F"
                        | "P";
                    };
                    ClassOfService?: {
                        Code: string;
                        PreferLevel?: "Unacceptable"
                        | "Preferred";
                    }[];
                    CorporateID?: { Code: string }[];
                    ExcludeRestricted?: { Ind: boolean };
                    FareBasis?: { Code: string; PreferLevel?: "Unacceptable" | "Preferred" }[];
                    FareType?: { Code: string; PreferLevel: "Unacceptable" | "Preferred" }[];
                    JumpCabinLogic?: { Disabled: boolean };
                    KeepSameCabin?: { Enabled: boolean };
                    Leg?: {
                        Baggage?: { FreePieceRequired?: boolean };
                        BrandFilters?: {
                            Brand?: (...)[];
                            NonBrandedFares?: { PreferLevel: ... };
                        };
                        Cabin?: {
                            Type: | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...);
                        };
                        ClassOfService?: { Code: ...; PreferLevel?: ... }[];
                        FareBasis?: { Code: ...; PreferLevel?: ... }[];
                        FareType?: { Code: ...; PreferLevel: ... }[];
                        Num: number;
                        PriorityBoarding?: Record<string, never>;
                        Seats?: Record<string, never>;
                        SeatSelection?: { FreeSeatSelection?: boolean };
                    }[];
                    MinMaxStay?: { Ind: boolean };
                    NegotiatedFaresOnly?: { Ind: boolean };
                    PassengerTypeQuantity?: { Code: string; Quantity?: number }[];
                    PriorityBoarding?: Record<string, never>;
                    PrivateFare?: { Ind: boolean };
                    PublicFare?: { Ind: boolean };
                    RefundPenalty?: { Ind: boolean };
                    ResTicketing?: { Ind: boolean };
                    Seats?: Record<string, never>;
                    SeatSelection?: { FreeSeatSelection?: boolean };
                    UseNegotiatedFares?: { Ind: boolean };
                    UsePassengerFares?: { Ind: boolean };
                    VoluntaryChanges?: {
                        Match?: "All" | "Any" | "Info";
                        Penalty?: {
                            Amount?: number;
                            Application?: (...) | (...);
                            CurrencyCode?: string;
                            Exclude?: boolean;
                            Type?: (...) | (...);
                        }[];
                    };
                    XOFares?: { Ind: boolean };
                }[];
            };
            FlightStopsAsConnections?: { Ind: boolean };
            GoverningCarrierOverride?: { AirlineCode: string };
            IncludeAlliancePref?: { Code: string }[];
            JumpCabinLogic?: { Disabled: boolean };
            KeepSameCabin?: { Enabled: boolean };
            LongConnectPoints?: { Max?: number; Min?: number };
            LongConnectTime?: {
                Enable?: boolean;
                Max?: number;
                Min?: number;
                NumberOfSolutions?: string;
            };
            LowCostCarriersProcessing?: { Disable?: boolean };
            NDCIndicators?: {
                CarrierSpecificQualifiers?: {
                    AccountCode?: { Code: string };
                    CarrierCode: string;
                    FrequentFlyer?: {
                        AccountNumber: string;
                        AirlineDesignator: string;
                        PassengerId: string;
                    }[];
                    Qualifier?: { Name: string; Value: string }[];
                }[];
                FrequentFlyer?: {
                    AccountNumber: string;
                    AirlineDesignator: string;
                    PassengerId: string;
                }[];
                MaxNumberOfUpsells?: { Value: number };
                MultipleBrandedFares?: { Value: boolean };
                ParityMode?: { Mode: "Leg" | "Itin" };
                Qualifier?: { Name: string; Value: string }[];
                ShowOneWays?: { Value: boolean };
                SingleBrandedFare?: { Value: boolean };
            };
            NumTrips?: { Number?: number };
            OnlineIndicator?: { Ind?: boolean };
            PreferNDCSourceOnTie?: { Value: boolean };
            PriorityBoarding?: { FreePriorityBoarding?: boolean; Info?: boolean };
            RetailerRules?: { Force?: boolean; RetailerRule: { Code: string }[] };
            Seats?: {
                Seat?: { AtLeast?: number; LessThan?: number; Type?: string }[];
            };
            SeatSelection?: { FreeSeatSelection?: boolean; Info?: boolean };
            SellingLevels?: {
                SellingLevelRules?: { Ignore: boolean };
                ShowFareAmounts?: { Adjusted?: boolean; Original?: boolean };
            };
            SettlementMethod?: string;
            Taxes?: { Tax?: { Amount?: number; TaxCode: string }[] };
            TicketingSumOfLocals?: { Enable?: boolean };
            TripType?: {
                Value?: "OneWay" | "Return" | "Circle" | "OpenJaw" | "Other";
            };
            ValidatingCarrier?: {
                Code?: string;
                Preference?: { Code: string; Level: "Unacceptable"
                | "Preferred" }[];
            };
            ValidatingCarrierCheck?: {
                Carrier?: { Code: string }[];
                Country?: { Code: string }[];
                IETValidation: { Ind: boolean };
                SettlementValidation: { Ind: boolean };
            };
            VerificationItinCallLogic?: {
                AlwaysCheckAvailability?: boolean;
                Value?: "L"
                | "M"
                | "B";
            };
            XOFares?: { Value: boolean };
        };
        ValidInterlineTicket?: boolean;
        VendorPref?: {
            Code?: string;
            PreferLevel?: "Only"
            | "Unacceptable"
            | "Preferred";
            Type?: "Marketing" | "Operating";
        }[];
        VendorPrefApplicability?: {
            Type: "Marketing"
            | "Operating";
            Value: "AllSegments" | "AtLeastOneSegment";
        }[];
        VendorPrefPairing?: {
            Applicability?: "AllSegments"
            | "AtLeastOneSegment";
            PreferLevel: "Unacceptable" | "Preferred";
            VendorPref: { Code: string; Type?: "Marketing" | "Operating" }[];
        }[];
    }

    Description

    If present, will validate options on base of interline ticketing agreement.

    • OptionalAncillaryFees?: {
          AncillaryFeeGroup?: { Code: string; Count?: string }[];
          Enable: boolean;
          Summary?: boolean;
      }

      Description

      Ancillary Fees processing options.

      • OptionalAncillaryFeeGroup?: { Code: string; Count?: string }[]

        Description

        List of requested groups of ancillary fees.

      • Enable: boolean

        Description

        Indicator for whether to enable the ancillary fees. Enable="true" Enable ancillary fees. Enable="false" Do not enable ancillary fees.

        Example

        true
        Copy

      • OptionalSummary?: boolean

        Description

        Indicator for whether this is a summary request. Summary="true" Indicates the request is a summary request. Summary="false" Indicates the request is not a summary request.

        Example

        true
        Copy

    • OptionalBaggage?: {
          CarryOnInfo?: boolean;
          Description?: boolean;
          FreeCarryOn?: boolean;
          FreePieceRequired?: boolean;
          RequestedPieces?: number;
          RequestType?: "C" | "A" | "N";
      }

      Description

      This element allows user to get baggage information.

      • OptionalCarryOnInfo?: boolean

        Description

        Show Carry-on baggage info in response - available on Main Fare.

        Example

        true
        Copy

      • OptionalDescription?: boolean

        Description

        Indicates whether baggage text information should be returned. If set to "true" - baggage text information returned in response (if applicable). If "false" baggage text information is not returned in response. If RequestType="N", "Description" parameter will be ignored.

        Default

        false
        Copy

        Example

        true
        Copy

      • OptionalFreeCarryOn?: boolean

        Description

        Freilter solution by availability with Free Carry-On baggage - available on Main Fare, Main Fare Leg, Flex Fares, Flex Fares Leg.

        Example

        true
        Copy

      • OptionalFreePieceRequired?: boolean

        Description

        Free baggage piece is required on the whole journey.

        Example

        true
        Copy

      • OptionalRequestedPieces?: number

        Format: int16

        Description

        Number of baggage pieces requested.

        Example

        4
        Copy

      • OptionalRequestType?: "C" | "A" | "N"

        Description

        Specifies baggage information type. "A" - allowance only; "C" - allowance and charges; "N" - no baggage information.

        Example

        A
        @enum {string}
        Copy

    • OptionalCabinPref?: {
          Cabin?:
              | "PremiumFirst"
              | "First"
              | "PremiumBusiness"
              | "Business"
              | "PremiumEconomy"
              | "Economy"
              | "Y"
              | "S"
              | "C"
              | "J"
              | "F"
              | "P";
          PreferLevel?: "Preferred";
      }[]

      Description

      Preferred cabin(s) to be used in a search for this leg level (if SegmentType is O) or segment (if SegmentType is X). The cabin type you specify in this element will override the cabin type specified at the request level for this leg/segment. If you do not specify a cabin type at both the leg/segment level and request level, the default cabin is Economy.

    • OptionalETicketDesired?: boolean

      Description

      Indicator for whether to include e-ticketable flights in the response. Valid values are "true or "false". If set to "true", return only flights that are e-ticketable, when set to "false" return only flights that are non e-ticketable.

      Default

      false
      Copy

      Example

      true
      Copy

    • OptionalFlightTypePref?: { MaxConnections?: number | boolean }

      Description

      Preferred flight characteristics to be used in a search.

      • OptionalMaxConnections?: number | boolean

        Description

        Maximum number of connections requested in each leg. Itineraries with more connections than the specified value will not be returned. NDC Applicable.

        Example

        1
        Copy

    • OptionalHybrid?: boolean

      Description

      If set to "true", returned shopping results will contain hybrid carriers content, if available on the market.

      Default

      true
      Copy

      Example

      true
      Copy

    • OptionalLookForAlternatives?: boolean

      Description

      Indicator to specify to return alternative options or the lowest fare in the response. If false no alternative solutions will be returned in response.

      Default

      true
      Copy

      Example

      true
      Copy

    • OptionalMaxStopsQuantity?: number

      Description

      Indicates the max number of stops requested in each leg. Itineraries with more stops than the specified value will not be returned. MaxStopsQuantity should not be used with "FlightTypePref@MaxConnections"option or other way around. NDC Applicable.

      Example

      2
      Copy

    • OptionalSpanishFamilyDiscount?: { Level: 1 | 2 }

      Description

      Spanish Large Family Discount processing options.

      • Level: 1 | 2

        Format: int16

        Description

        Spanish Large Family Discount Level. Valid values are 1 or 2. Spanish Large Family Discount Level 1 - 5 % of the base fare. Spanish Large Family Discount Level 2 - 10% of the base fare.

        Example

        1
        @enum {integer}
        Copy

    • OptionalTPA_Extensions?: {
          AdditionalFareLimit?: { Value: number };
          AvoidCabinDowngrade?: { Mode: "All" | "Main" | "None" };
          ClassOfService?: {
              Code: string;
              PreferLevel?: "Unacceptable" | "Preferred";
          }[];
          CodeShareIndicator?: { ExcludeCodeshare: boolean; KeepOnlines?: boolean };
          CountryPref?: { Code: string; PreferLevel: string }[];
          DataSources?: {
              ATPCO?: "Enable" | "Disable";
              LCC?: "Enable" | "Disable";
              NDC?: "Enable" | "Disable";
          };
          DiversityParameters?: {
              AdditionalNonStopsNumber?: number;
              AdditionalNonStopsPercentage?: number;
              InboundOutboundPairing?: number;
              TimeOfDayDistribution?: {
                  TimeOfDayRange: { Begin: string; End: string; Percentage: number }[];
              };
              Weightings?: { PriceWeight: number; TravelTimeWeight: number };
          };
          ExcludeAlliancePref?: { Code: string }[];
          ExcludeCallDirectCarriers?: { Enabled?: boolean };
          ExcludeVendorPref?: { Code?: string }[];
          ExemptAllTaxes?: { Value: boolean };
          ExemptAllTaxesAndFees?: { Value: boolean };
          ExemptTax?: { TaxCode: string }[];
          FareBasis?: { Code: string; PreferLevel?: "Unacceptable" | "Preferred" }[];
          FareFocusRules?: { Exclude?: boolean };
          FareType?: { Code: string; PreferLevel: "Unacceptable" | "Preferred" }[];
          FlexibleFares?: {
              FareParameters: {
                  AccountCode?: { Code: string }[];
                  AvoidCabinDowngrade?: { Mode: "All" | "Main" | "None" };
                  Baggage?: { FreePieceRequired?: boolean };
                  BrandedFareIndicators?: {
                      BrandFilters?: {
                          Brand?: { Code: ...; PreferLevel: ... }[];
                          NonBrandedFares?: { PreferLevel: (...) | (...) };
                      };
                      ItinParityBrandlessLeg?: boolean;
                      ItinParityFallbackMode?: "LegParity"
                      | "LowestSingle";
                      MultipleBrandedFares?: boolean;
                      ParityMode?: "Leg" | "Itin";
                      ParityModeForLowest?: "None" | "Leg" | "Itin";
                      SingleBrandedFare?: boolean;
                      UpsellLimit?: number;
                  };
                  Cabin?: {
                      Type: | "PremiumFirst"
                      | "First"
                      | "PremiumBusiness"
                      | "Business"
                      | "PremiumEconomy"
                      | "Economy"
                      | "Y"
                      | "S"
                      | "C"
                      | "J"
                      | "F"
                      | "P";
                  };
                  ClassOfService?: {
                      Code: string;
                      PreferLevel?: "Unacceptable"
                      | "Preferred";
                  }[];
                  CorporateID?: { Code: string }[];
                  ExcludeRestricted?: { Ind: boolean };
                  FareBasis?: { Code: string; PreferLevel?: "Unacceptable" | "Preferred" }[];
                  FareType?: { Code: string; PreferLevel: "Unacceptable" | "Preferred" }[];
                  JumpCabinLogic?: { Disabled: boolean };
                  KeepSameCabin?: { Enabled: boolean };
                  Leg?: {
                      Baggage?: { FreePieceRequired?: boolean };
                      BrandFilters?: {
                          Brand?: (...)[];
                          NonBrandedFares?: { PreferLevel: ... };
                      };
                      Cabin?: {
                          Type: | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...);
                      };
                      ClassOfService?: { Code: ...; PreferLevel?: ... }[];
                      FareBasis?: { Code: ...; PreferLevel?: ... }[];
                      FareType?: { Code: ...; PreferLevel: ... }[];
                      Num: number;
                      PriorityBoarding?: Record<string, never>;
                      Seats?: Record<string, never>;
                      SeatSelection?: { FreeSeatSelection?: boolean };
                  }[];
                  MinMaxStay?: { Ind: boolean };
                  NegotiatedFaresOnly?: { Ind: boolean };
                  PassengerTypeQuantity?: { Code: string; Quantity?: number }[];
                  PriorityBoarding?: Record<string, never>;
                  PrivateFare?: { Ind: boolean };
                  PublicFare?: { Ind: boolean };
                  RefundPenalty?: { Ind: boolean };
                  ResTicketing?: { Ind: boolean };
                  Seats?: Record<string, never>;
                  SeatSelection?: { FreeSeatSelection?: boolean };
                  UseNegotiatedFares?: { Ind: boolean };
                  UsePassengerFares?: { Ind: boolean };
                  VoluntaryChanges?: {
                      Match?: "All" | "Any" | "Info";
                      Penalty?: {
                          Amount?: number;
                          Application?: (...) | (...);
                          CurrencyCode?: string;
                          Exclude?: boolean;
                          Type?: (...) | (...);
                      }[];
                  };
                  XOFares?: { Ind: boolean };
              }[];
          };
          FlightStopsAsConnections?: { Ind: boolean };
          GoverningCarrierOverride?: { AirlineCode: string };
          IncludeAlliancePref?: { Code: string }[];
          JumpCabinLogic?: { Disabled: boolean };
          KeepSameCabin?: { Enabled: boolean };
          LongConnectPoints?: { Max?: number; Min?: number };
          LongConnectTime?: {
              Enable?: boolean;
              Max?: number;
              Min?: number;
              NumberOfSolutions?: string;
          };
          LowCostCarriersProcessing?: { Disable?: boolean };
          NDCIndicators?: {
              CarrierSpecificQualifiers?: {
                  AccountCode?: { Code: string };
                  CarrierCode: string;
                  FrequentFlyer?: {
                      AccountNumber: string;
                      AirlineDesignator: string;
                      PassengerId: string;
                  }[];
                  Qualifier?: { Name: string; Value: string }[];
              }[];
              FrequentFlyer?: {
                  AccountNumber: string;
                  AirlineDesignator: string;
                  PassengerId: string;
              }[];
              MaxNumberOfUpsells?: { Value: number };
              MultipleBrandedFares?: { Value: boolean };
              ParityMode?: { Mode: "Leg" | "Itin" };
              Qualifier?: { Name: string; Value: string }[];
              ShowOneWays?: { Value: boolean };
              SingleBrandedFare?: { Value: boolean };
          };
          NumTrips?: { Number?: number };
          OnlineIndicator?: { Ind?: boolean };
          PreferNDCSourceOnTie?: { Value: boolean };
          PriorityBoarding?: { FreePriorityBoarding?: boolean; Info?: boolean };
          RetailerRules?: { Force?: boolean; RetailerRule: { Code: string }[] };
          Seats?: { Seat?: { AtLeast?: number; LessThan?: number; Type?: string }[] };
          SeatSelection?: { FreeSeatSelection?: boolean; Info?: boolean };
          SellingLevels?: {
              SellingLevelRules?: { Ignore: boolean };
              ShowFareAmounts?: { Adjusted?: boolean; Original?: boolean };
          };
          SettlementMethod?: string;
          Taxes?: { Tax?: { Amount?: number; TaxCode: string }[] };
          TicketingSumOfLocals?: { Enable?: boolean };
          TripType?: { Value?: "OneWay" | "Return" | "Circle" | "OpenJaw" | "Other" };
          ValidatingCarrier?: {
              Code?: string;
              Preference?: { Code: string; Level: "Unacceptable" | "Preferred" }[];
          };
          ValidatingCarrierCheck?: {
              Carrier?: { Code: string }[];
              Country?: { Code: string }[];
              IETValidation: { Ind: boolean };
              SettlementValidation: { Ind: boolean };
          };
          VerificationItinCallLogic?: {
              AlwaysCheckAvailability?: boolean;
              Value?: "L"
              | "M"
              | "B";
          };
          XOFares?: { Value: boolean };
      }

      Description

      Diversity paremeter.

      • OptionalAdditionalFareLimit?: { Value: number }

        Description

        Additional fare limit.

        • Value: number

          Description

          Additional fare limit.

          Example

          0
          Copy

      • OptionalAvoidCabinDowngrade?: { Mode: "All" | "Main" | "None" }

        Description

        Guarantees that a lower cabin class will not be applied within a single shopping option, depending on the chosen mode.

        • Mode: "All" | "Main" | "None"

          Description

          Guarantees that lower cabin class won't be applied within single shopping option depending on the chosen mode. All - Apply Avoid Cabin Downgrade logic on the entire itinerary. Main - Apply Avoid Cabin Downgrade logic on the main flight of every leg. None - Disable Avoid Cabin Downgrade logic (default value).

          Example

          None
          @enum {string}
          Copy

      • OptionalClassOfService?: { Code: string; PreferLevel?: "Unacceptable" | "Preferred" }[]

        Description

        Class of service inforamtion.

      • OptionalCodeShareIndicator?: { ExcludeCodeshare: boolean; KeepOnlines?: boolean }

        Description

        Ability to filter out codeshare flights. The option is available with two attributes ExcludeCodeshare removes codeshare flights. The same Marketing/Operating (base flights), can be combined with KeepOnlines to also return the online flights that are codeshare, for more diversity.

        • ExcludeCodeshare: boolean

          Description

          Exclude Codeshares.

          Example

          true
          Copy

        • OptionalKeepOnlines?: boolean

          Description

          Keep onlines.

          Example

          false
          Copy

      • OptionalCountryPref?: { Code: string; PreferLevel: string }[]

        Description

        Country in which you want to exclude all via airports.

      • OptionalDataSources?: {
            ATPCO?: "Enable" | "Disable";
            LCC?: "Enable" | "Disable";
            NDC?: "Enable" | "Disable";
        }

        Description

        Data sources e.g. ATPCO.

        • OptionalATPCO?: "Enable" | "Disable"

          Description

          Toggle processing of ATPCO data source.

          Example

          Enable
          @enum {string}
          Copy

        • OptionalLCC?: "Enable" | "Disable"

          Description

          Toggle processing of Low Cost Carriers data source.

          Example

          Disable
          @enum {string}
          Copy

        • OptionalNDC?: "Enable" | "Disable"

          Description

          Toggle processing of New Distribution Capability data source.

          Example

          Enable
          @enum {string}
          Copy

      • OptionalDiversityParameters?: {
            AdditionalNonStopsNumber?: number;
            AdditionalNonStopsPercentage?: number;
            InboundOutboundPairing?: number;
            TimeOfDayDistribution?: {
                TimeOfDayRange: { Begin: string; End: string; Percentage: number }[];
            };
            Weightings?: { PriceWeight: number; TravelTimeWeight: number };
        }

        Description

        Diversity Parameters.

        • OptionalAdditionalNonStopsNumber?: number

          Format: int16

          Description

          Defines how many additional non-stop options should be added to response. Overrides @Percentage.

          Example

          9
          Copy

        • OptionalAdditionalNonStopsPercentage?: number

          Format: int16

          Description

          Defines how many additional non-stop options should be added to response as a percentage of requested number of options.

          Example

          10
          Copy

        • OptionalInboundOutboundPairing?: number

          Format: int16

          Description

          Defines the requested ratio of inbounds to outbounds in the response.

          Example

          1
          Copy

        • OptionalTimeOfDayDistribution?: { TimeOfDayRange: { Begin: string; End: string; Percentage: number }[] }

          Description

          Defines how the options in the response should be distributed between certain departure time of day ranges. All defined TimeOfDayRanges must cover the whole day, and the sum of all Percentages must equal 100.

          • TimeOfDayRange: { Begin: string; End: string; Percentage: number }[]

            Description

            Time Of Day Range.

        • OptionalWeightings?: { PriceWeight: number; TravelTimeWeight: number }

          Description

          Defines how important various parameter options are in the response. The sum of all weightings needs to equal 10.

          • PriceWeight: number

            Format: int16

            Description

            Defines how important price options are on a scale from 0 to 10.

            Example

            7
            Copy

          • TravelTimeWeight: number

            Format: int16

            Description

            Defines how important travel time options are on a scale from 0 to 10.

            Example

            3
            Copy

      • OptionalExcludeAlliancePref?: { Code: string }[]

        Description

        Do not consider these alliances.

      • OptionalExcludeCallDirectCarriers?: { Enabled?: boolean }

        Description

        Forces Dynamic Schedules Finder (DSF) to return schedules only for carriers bookable in the Sabre system.

        • OptionalEnabled?: boolean

          Description

          Force DSF to return schedules only for carriers bookable by Sabre.

          Example

          true
          Copy

      • OptionalExcludeVendorPref?: { Code?: string }[]

        Description

        Codes for the carrier(s) to exclude from the search.

      • OptionalExemptAllTaxes?: { Value: boolean }

        Description

        Exempts all taxes (/TE).

        • Value: boolean

          Description

          Indicator for whether to exempt all taxes and include applicable fees and passenger facility charges (PFCs). Cannot combine ExemptAllTaxes with ExemptAllTaxesAndFees, Taxes, and ExemptTax.

          Example

          true
          Copy

      • OptionalExemptAllTaxesAndFees?: { Value: boolean }

        Description

        Exempts all taxes and fees (/TN).

        • Value: boolean

          Description

          Indicator for whether to exempt all taxes and fees and include applicable passenger facility charges (PFCs). Cannot combine ExemptAllTaxesAndFees with ExemptAllTaxes, Taxes, and ExemptTax.

          Example

          true
          Copy

      • OptionalExemptTax?: { TaxCode: string }[]

        Description

        Exempts the specified tax(es) (/TE). You cannot combine ExemptTax with ExemptAllTaxesAndFees, ExemptAllTaxes, and Taxes.

      • OptionalFareBasis?: { Code: string; PreferLevel?: "Unacceptable" | "Preferred" }[]

        Description

        Fare Basis Codes information.

      • OptionalFareFocusRules?: { Exclude?: boolean }

        Description

        Rules in the Fare Focus application.

        • OptionalExclude?: boolean

          Description

          When set to "true" fare focus business rules will be ignored. In order to use this parameter EPR keyword-FFOCUS is required.

          Example

          true
          Copy

      • OptionalFareType?: { Code: string; PreferLevel: "Unacceptable" | "Preferred" }[]

        Description

        Defines preferred or excluded fare type codes.

      • OptionalFlexibleFares?: {
            FareParameters: {
                AccountCode?: { Code: string }[];
                AvoidCabinDowngrade?: { Mode: "All" | "Main" | "None" };
                Baggage?: { FreePieceRequired?: boolean };
                BrandedFareIndicators?: {
                    BrandFilters?: {
                        Brand?: { Code: ...; PreferLevel: ... }[];
                        NonBrandedFares?: { PreferLevel: (...) | (...) };
                    };
                    ItinParityBrandlessLeg?: boolean;
                    ItinParityFallbackMode?: "LegParity"
                    | "LowestSingle";
                    MultipleBrandedFares?: boolean;
                    ParityMode?: "Leg" | "Itin";
                    ParityModeForLowest?: "None" | "Leg" | "Itin";
                    SingleBrandedFare?: boolean;
                    UpsellLimit?: number;
                };
                Cabin?: {
                    Type: | "PremiumFirst"
                    | "First"
                    | "PremiumBusiness"
                    | "Business"
                    | "PremiumEconomy"
                    | "Economy"
                    | "Y"
                    | "S"
                    | "C"
                    | "J"
                    | "F"
                    | "P";
                };
                ClassOfService?: {
                    Code: string;
                    PreferLevel?: "Unacceptable"
                    | "Preferred";
                }[];
                CorporateID?: { Code: string }[];
                ExcludeRestricted?: { Ind: boolean };
                FareBasis?: { Code: string; PreferLevel?: "Unacceptable" | "Preferred" }[];
                FareType?: { Code: string; PreferLevel: "Unacceptable" | "Preferred" }[];
                JumpCabinLogic?: { Disabled: boolean };
                KeepSameCabin?: { Enabled: boolean };
                Leg?: {
                    Baggage?: { FreePieceRequired?: boolean };
                    BrandFilters?: {
                        Brand?: (...)[];
                        NonBrandedFares?: { PreferLevel: ... };
                    };
                    Cabin?: {
                        Type: | (...)
                        | (...)
                        | (...)
                        | (...)
                        | (...)
                        | (...)
                        | (...)
                        | (...)
                        | (...)
                        | (...)
                        | (...)
                        | (...);
                    };
                    ClassOfService?: { Code: ...; PreferLevel?: ... }[];
                    FareBasis?: { Code: ...; PreferLevel?: ... }[];
                    FareType?: { Code: ...; PreferLevel: ... }[];
                    Num: number;
                    PriorityBoarding?: Record<string, never>;
                    Seats?: Record<string, never>;
                    SeatSelection?: { FreeSeatSelection?: boolean };
                }[];
                MinMaxStay?: { Ind: boolean };
                NegotiatedFaresOnly?: { Ind: boolean };
                PassengerTypeQuantity?: { Code: string; Quantity?: number }[];
                PriorityBoarding?: Record<string, never>;
                PrivateFare?: { Ind: boolean };
                PublicFare?: { Ind: boolean };
                RefundPenalty?: { Ind: boolean };
                ResTicketing?: { Ind: boolean };
                Seats?: Record<string, never>;
                SeatSelection?: { FreeSeatSelection?: boolean };
                UseNegotiatedFares?: { Ind: boolean };
                UsePassengerFares?: { Ind: boolean };
                VoluntaryChanges?: {
                    Match?: "All" | "Any" | "Info";
                    Penalty?: {
                        Amount?: number;
                        Application?: (...) | (...);
                        CurrencyCode?: string;
                        Exclude?: boolean;
                        Type?: (...) | (...);
                    }[];
                };
                XOFares?: { Ind: boolean };
            }[];
        }

        Description

        Multiple Fares Per Itinerary group creation tags.

        • FareParameters: {
              AccountCode?: { Code: string }[];
              AvoidCabinDowngrade?: { Mode: "All" | "Main" | "None" };
              Baggage?: { FreePieceRequired?: boolean };
              BrandedFareIndicators?: {
                  BrandFilters?: {
                      Brand?: { Code: ...; PreferLevel: ... }[];
                      NonBrandedFares?: { PreferLevel: (...) | (...) };
                  };
                  ItinParityBrandlessLeg?: boolean;
                  ItinParityFallbackMode?: "LegParity"
                  | "LowestSingle";
                  MultipleBrandedFares?: boolean;
                  ParityMode?: "Leg" | "Itin";
                  ParityModeForLowest?: "None" | "Leg" | "Itin";
                  SingleBrandedFare?: boolean;
                  UpsellLimit?: number;
              };
              Cabin?: {
                  Type: | "PremiumFirst"
                  | "First"
                  | "PremiumBusiness"
                  | "Business"
                  | "PremiumEconomy"
                  | "Economy"
                  | "Y"
                  | "S"
                  | "C"
                  | "J"
                  | "F"
                  | "P";
              };
              ClassOfService?: {
                  Code: string;
                  PreferLevel?: "Unacceptable"
                  | "Preferred";
              }[];
              CorporateID?: { Code: string }[];
              ExcludeRestricted?: { Ind: boolean };
              FareBasis?: { Code: string; PreferLevel?: "Unacceptable" | "Preferred" }[];
              FareType?: { Code: string; PreferLevel: "Unacceptable" | "Preferred" }[];
              JumpCabinLogic?: { Disabled: boolean };
              KeepSameCabin?: { Enabled: boolean };
              Leg?: {
                  Baggage?: { FreePieceRequired?: boolean };
                  BrandFilters?: { Brand?: (...)[]; NonBrandedFares?: { PreferLevel: ... } };
                  Cabin?: {
                      Type:
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...)
                          | (...);
                  };
                  ClassOfService?: { Code: ...; PreferLevel?: ... }[];
                  FareBasis?: { Code: ...; PreferLevel?: ... }[];
                  FareType?: { Code: ...; PreferLevel: ... }[];
                  Num: number;
                  PriorityBoarding?: Record<string, never>;
                  Seats?: Record<string, never>;
                  SeatSelection?: { FreeSeatSelection?: boolean };
              }[];
              MinMaxStay?: { Ind: boolean };
              NegotiatedFaresOnly?: { Ind: boolean };
              PassengerTypeQuantity?: { Code: string; Quantity?: number }[];
              PriorityBoarding?: Record<string, never>;
              PrivateFare?: { Ind: boolean };
              PublicFare?: { Ind: boolean };
              RefundPenalty?: { Ind: boolean };
              ResTicketing?: { Ind: boolean };
              Seats?: Record<string, never>;
              SeatSelection?: { FreeSeatSelection?: boolean };
              UseNegotiatedFares?: { Ind: boolean };
              UsePassengerFares?: { Ind: boolean };
              VoluntaryChanges?: {
                  Match?: "All" | "Any" | "Info";
                  Penalty?: {
                      Amount?: number;
                      Application?: (...) | (...);
                      CurrencyCode?: string;
                      Exclude?: boolean;
                      Type?: (...) | (...);
                  }[];
              };
              XOFares?: { Ind: boolean };
          }[]

          Description

          Parameters for the desired fare.

      • OptionalFlightStopsAsConnections?: { Ind: boolean }

        Description

        Identifies all stops as connections.

        • Ind: boolean

          Description

          FlightStopsAsConnections indicator.

          Example

          true
          Copy

      • OptionalGoverningCarrierOverride?: { AirlineCode: string }

        Description

        Airline carrier code override the governing carrier to get the fare filed by that carrier. Note One carrier can be specified per request.

        • AirlineCode: string

          Description

          Airline Carrier Code - override the GOVERNING CARRIER to get the fare filed by that carrier.

          Example

          Airline Code Goes Here
          Copy

      • OptionalIncludeAlliancePref?: { Code: string }[]

        Description

        Considers only the specified alliances.

      • OptionalJumpCabinLogic?: { Disabled: boolean }

        Description

        Controls whether the response contains options with a different cabin class than requested.

        • Disabled: boolean

          Description

          Controls if response could contain options with cabin class different than requested.

          Example

          true
          Copy

      • OptionalKeepSameCabin?: { Enabled: boolean }

        Description

        Indicator for whether you want to guarantee that all segments within a single shopping option belong to the requested cabin.

        • Enabled: boolean

          Description

          Set to "true" guarantees that all segments within single shopping option belong to the requested cabin.

          Example

          true
          Copy

      • OptionalLongConnectPoints?: { Max?: number; Min?: number }

        Description

        Minimum and maximum number of connection points (not necessarily long) for Long Connections.

        • OptionalMax?: number

          Format: int16

          Description

          Although system will accept a wide range of values, this value should be limited to 3 and not lower than the @"Min".

          Example

          3
          Copy

        • OptionalMin?: number

          Format: int16

          Description

          Although system will accept a wide range of values, this value should be at least 1 and not higher than the @"Max".

          Example

          1
          Copy

      • OptionalLongConnectTime?: { Enable?: boolean; Max?: number; Min?: number; NumberOfSolutions?: string }

        Description

        Change minimum and maximum connect time per connection in long connection schedules if Long Connect Time logic is enabled. Valid values are less than 1440 minutes (24 hours).

        • OptionalEnable?: boolean

          Description

          Enable long connection schedules.

          Example

          true
          Copy

        • OptionalMax?: number

          Format: int16

          Description

          Maximum connect time in minutes per connection in long connection schedules, default is 1439.

          Example

          1200
          Copy

        • OptionalMin?: number

          Format: int16

          Description

          Minimum connect time in minutes per connection in long connection schedules, default is 780.

          Example

          780
          Copy

        • OptionalNumberOfSolutions?: string

          Description

          Specify the desired number of solutions to be returned in the response either in percentage or a number.

          Example

          23%
          Copy

      • OptionalLowCostCarriersProcessing?: { Disable?: boolean }

        Description

        Allows you to exclude all the Low Cost Carriers from shopping via request. You can use this element instead of listing each Low Cost Carrier as unacceptable via the VendorPref element. Note When you use LowCostCarriersProcessing, no Low Cost Carriers options will be returned even if the low-cost carrier is specified as the preferred carrier at the IncludeVendorPref or VendorPref level.

        • OptionalDisable?: boolean

          Description

          Disable low cost carriers processing.

          Example

          true
          Copy

      • OptionalNDCIndicators?: {
            CarrierSpecificQualifiers?: {
                AccountCode?: { Code: string };
                CarrierCode: string;
                FrequentFlyer?: {
                    AccountNumber: string;
                    AirlineDesignator: string;
                    PassengerId: string;
                }[];
                Qualifier?: { Name: string; Value: string }[];
            }[];
            FrequentFlyer?: {
                AccountNumber: string;
                AirlineDesignator: string;
                PassengerId: string;
            }[];
            MaxNumberOfUpsells?: { Value: number };
            MultipleBrandedFares?: { Value: boolean };
            ParityMode?: { Mode: "Leg" | "Itin" };
            Qualifier?: { Name: string; Value: string }[];
            ShowOneWays?: { Value: boolean };
            SingleBrandedFare?: { Value: boolean };
        }

        Description

        NDC Indicators.

        • OptionalCarrierSpecificQualifiers?: {
              AccountCode?: { Code: string };
              CarrierCode: string;
              FrequentFlyer?: {
                  AccountNumber: string;
                  AirlineDesignator: string;
                  PassengerId: string;
              }[];
              Qualifier?: { Name: string; Value: string }[];
          }[]

          Description

          Carrier specific qualifiers. If an attribute is specified in both places, the general qualifier will be overwritten with the carrier specific value.

        • OptionalFrequentFlyer?: { AccountNumber: string; AirlineDesignator: string; PassengerId: string }[]

          Description

          Frequent Flyer status information. NDC Applicable.

        • OptionalMaxNumberOfUpsells?: { Value: number }

          Description

          Allows you to display additional upsells for the journeys. The system cannot request upsells explicitly; the system can only do something with them if provided by the carrier. By default, the system does a low fare search, so only the lowest fare is presented. With this element, you can tell the system if the carrier returns upsells, return them as additional fares, but no more than X.

          • Value: number

            Format: int16

            Description

            Indicates maximum number of NDC upsells per itinerary.

            Example

            1
            Copy

        • OptionalMultipleBrandedFares?: { Value: boolean }

          Description

          Indicates whether NDC upsells are allowed.

          • Value: boolean

            Description

            Indicates whether NDC upsells are allowed.

            Example

            true
            Copy

        • OptionalParityMode?: { Mode: "Leg" | "Itin" }

          Description

          Parity mode for the PriceClasses.

          • Mode: "Leg" | "Itin"

            Description

            Parity mode for the PriceClasses.

            Example

            Leg
            @enum {string}
            Copy

        • OptionalQualifier?: { Name: string; Value: string }[]

          Description

          General qualifiers.

        • OptionalShowOneWays?: { Value: boolean }

          Description

          Show One Ways indicator.

          • Value: boolean

            Description

            For carriers supporting Brand Based Shopping (returning two lists of one ways instead of round trip) display the one ways (do not combine those into round trips).

            Example

            true
            Copy

        • OptionalSingleBrandedFare?: { Value: boolean }

          Description

          Indicator for whether price class information is displayed.

          • Value: boolean

            Description

            Indicates whether price class information is displayed.

            Example

            true
            Copy

      • OptionalNumTrips?: { Number?: number }

        Description

        Number of itineraries returned.

        • OptionalNumber?: number

          Format: int16

          Description

          Default 9, minimum 1.

          Default

          9
          Copy

          Example

          19
          Copy

      • OptionalOnlineIndicator?: { Ind?: boolean }

        Description

        OnlineIndicator and InterlineIndicator are mutually exclusive. One of the two is required.

        • OptionalInd?: boolean

          Description

          A value of "true" returns only online itineraries.

          Example

          true
          Copy

      • OptionalPreferNDCSourceOnTie?: { Value: boolean }

        Description

        Select content from the New Distribution Capability (NDC) Content Source in case of identical offers.

        • Value: boolean

          Description

          Select content from NDC Content Source in case of identical offers.

          Example

          true
          Copy

      • OptionalPriorityBoarding?: { FreePriorityBoarding?: boolean; Info?: boolean }

        Description

        Filter mode for free priority boarding only.

        • OptionalFreePriorityBoarding?: boolean

          Description

          Filter mode for free priority boarding only.

          Example

          true
          Copy

        • OptionalInfo?: boolean

          Description

          Priority boarding info.

          Example

          true
          Copy

      • OptionalRetailerRules?: { Force?: boolean; RetailerRule: { Code: string }[] }

        Description

        Allows you to request fares matching the specified retailer rules.

        • OptionalForce?: boolean

          Description

          If set to true, only one Retailer Rule Code can be specified in the request. Only fares with a matched Business Rule containing the specified Retailer Rule Qualifier will be returned.

          Default

          false
          Copy

          Example

          true
          Copy

        • RetailerRule: { Code: string }[]

          Description

          Retailer Rule code information.

      • OptionalSeats?: { Seat?: { AtLeast?: number; LessThan?: number; Type?: string }[] }

        Description

        Optional seat comfort seats filter. This allows a more modernized way to display relevant offers from the same or different airlines for easy comparison to travelers.

        • OptionalSeat?: { AtLeast?: number; LessThan?: number; Type?: string }[]

          Description

          Optional seat comfort seats filter information.

      • OptionalSeatSelection?: { FreeSeatSelection?: boolean; Info?: boolean }

        Description

        Allows you to return pre-reserved seat data and filter by free pre-reserved seat.

        • OptionalFreeSeatSelection?: boolean

          Description

          Filter mode for free seats only.

          Example

          false
          Copy

        • OptionalInfo?: boolean

          Description

          Seat selection info.

          Example

          true
          Copy

      • OptionalSellingLevels?: {
            SellingLevelRules?: { Ignore: boolean };
            ShowFareAmounts?: { Adjusted?: boolean; Original?: boolean };
        }

        Description

        Element controlling Mark Up Any Fare functionality. When the SellingLevels element is defined, one of its sub-elements must be provided, either SellingLevelRules or ShowFareAmounts.

        • OptionalSellingLevelRules?: { Ignore: boolean }

          Description

          Apies to Agency Retailer customers only.

          • Ignore: boolean

            Description

            Force ignore adjustment selling level rules.

            Example

            true
            Copy

        • OptionalShowFareAmounts?: { Adjusted?: boolean; Original?: boolean }

          Description

          The ShowFareAmounts element defines which FareLevel should be returned in the response. When the ShowFareAmounts element is defined, only one of its attributes can be defined, either Original or Adjusted. At least one is required.

          • OptionalAdjusted?: boolean

            Description

            When set to "true" selling fare level amount and total adjusted fare amount will be returned.To use this attribute AGYRET EPR keyword is required.

            Example

            true
            Copy

          • OptionalOriginal?: boolean

            Description

            When set to "true", original fare amount will be returned in total fare amount, and additional MarkUp information will be returned in "SellingFareData" element. To use this attribute ORGFQD EPR keyword is required.

            Example

            true
            Copy

      • OptionalSettlementMethod?: string

        Description

        Overrides settlement method. This element provides users with ability to override the default settlement method selected (based on Agency POS or settlement method hierarchy). Invalid settlement method will return an error "INVALID SETTLEMENT METHOD" or "INVALID SETTLEMENT METHOD FOR POINT OF SALE". Supported codes for settlement method BSP, ARC, TCH, GEN (Generic TAT), RUT (Russian TAT), PRT (Philippines TAT), SAT (SATA), KRY (Killroy).

        Example

        ARC
        Copy

      • OptionalTaxes?: { Tax?: { Amount?: number; TaxCode: string }[] }

        Description

        Taxes (/TX).

        • OptionalTax?: { Amount?: number; TaxCode: string }[]

          Description

          Tax amount and code information.

      • OptionalTicketingSumOfLocals?: { Enable?: boolean }

        Description

        Settings specific to Ticketing Sum of Locals processing.

        • OptionalEnable?: boolean

          Description

          Enable Sum of Locals processing NOT USED BY BFM Enable="true/false" required, default is false.

          Default

          false
          Copy

          Example

          true
          Copy

      • OptionalTripType?: { Value?: "OneWay" | "Return" | "Circle" | "OpenJaw" | "Other" }

        Description

        Air trip type.

        • OptionalValue?: "OneWay" | "Return" | "Circle" | "OpenJaw" | "Other"

          Description

          Type of trip. Value="OneWay" One-way trip. Value="Return" (default) Round-trip. Value="Circle" Circle trip. Value="OpenJaw" Open jaw trip. Value="Other" Complex trip.

          Example

          Return
          @enum {string}
          Copy

      • OptionalValidatingCarrier?: {
            Code?: string;
            Preference?: { Code: string; Level: "Unacceptable" | "Preferred" }[];
        }

        Description

        Validating Carrier.

        • OptionalCode?: string

          Description

          Validating Carrier code.

          Example

          XX
          Copy

        • OptionalPreference?: { Code: string; Level: "Unacceptable" | "Preferred" }[]

          Description

          Allows you to specify the preferred or excluded validating carrier.

      • OptionalValidatingCarrierCheck?: {
            Carrier?: { Code: string }[];
            Country?: { Code: string }[];
            IETValidation: { Ind: boolean };
            SettlementValidation: { Ind: boolean };
        }

        Description

        Allows you to override local settlement method validation and Interline Electronic Ticketing agreements.

        • OptionalCarrier?: { Code: string }[]

          Description

          Carrier code information.

        • OptionalCountry?: { Code: string }[]

          Description

          Country code information.

        • IETValidation: { Ind: boolean }

          Description

          IETValidation allows you to disable Electronic Ticketing agreements validation or specify in which points of sale and for which carriers Electronic Ticketing agreements should be checked. If set to "true," the IET agreement will be validated for the listed countries.

          • Ind: boolean

            Description

            Set to "false" disables interline electronic ticket (IET) agreement validation for validating carriers. Set to "true" along with SettlementValidation set to "false" and at least one Country Code specified will trigger the responses with no settlement validation performed on Validating Carriers returned but with IET validation performed in the specified countries. Set to "true" along with SettlementValidation set to "true" will trigger the response with settlement validation and IET check performed in specified country.

            Example

            true
            Copy

        • SettlementValidation: { Ind: boolean }

          Description

          The SettlementValidation parameter allows you to override the local settlement plan check. Note When SettlementValidation/@Ind is set to false, it disables the settlement method validation in the local point of sale. When SettlementValidation/@Ind is set to true, it validates the settlement method in the local POS. If specified along with Carrier Code, the settlement validation will be disabled.

          • Ind: boolean

            Description

            Set to "false" disables settlement method validation for local Point Of Sale. Set to "true" enables settlement method validation for specified country code.

            Example

            true
            Copy

      • OptionalVerificationItinCallLogic?: { AlwaysCheckAvailability?: boolean; Value?: "L" | "M" | "B" }

        Description

        Indicates how the current itinerary is priced. Valid values are L Look for the lowest fare (default). M Look in the requested RBD and requested pricing qualifiers. B Perform both L and M searches, and return both fares.

        • OptionalAlwaysCheckAvailability?: boolean

          Description

          Check availability for repriced itin.

          Example

          true
          Copy

        • OptionalValue?: "L" | "M" | "B"

          Description

          Define how the current itinerary is priced.

          Example

          L
          @enum {string}
          Copy

      • OptionalXOFares?: { Value: boolean }

        Description

        Indicator for whether to return only fares with a passenger type the same as the passenger type specified in the request.

        • Value: boolean

          Description

          Indicator for whether to return only fares with a passenger type the same as the passenger type specified in the request. Value="true" Returns only fares with a passenger type the same as the passenger type specified in the request. Value="false" (default) Uses standard Bargain Finder Max logic.

          Example

          true
          Copy

    • OptionalValidInterlineTicket?: boolean

      Description

      If present, will validate options on base of interline ticketing agreement. ValidInterlineTicket="true" Return only options with valid interline ticketing agreement. ValidInterlineTicket="false" Return both options with and without valid interline ticketing agreement. Mark each option whether it has interline ticketing agreement or not.

      Default

      false
      Copy

      Example

      true
      Copy

    • OptionalVendorPref?: {
          Code?: string;
          PreferLevel?: "Only" | "Unacceptable" | "Preferred";
          Type?: "Marketing" | "Operating";
      }[]

      Description

      Vendors to include and exclude from the response.

    • OptionalVendorPrefApplicability?: { Type: "Marketing" | "Operating"; Value: "AllSegments" | "AtLeastOneSegment" }[]

      Description

      Indicates whether online or interline carrier selection logic should be applied for the specified carrier type. One instance per carrier type is allowed.

    • OptionalVendorPrefPairing?: {
          Applicability?: "AllSegments" | "AtLeastOneSegment";
          PreferLevel: "Unacceptable" | "Preferred";
          VendorPref: { Code: string; Type?: "Marketing" | "Operating" }[];
      }[]

      Description

      Specifies which marketing and operating carrier pairs are preferred or unacceptable.

  • Version: string

    Description

    The version of the service.

    Example

    V4
    Copy