CreateBargainFinderMax
CreateBargainFinderMax: {
requestBody?: {
content: {
"application/json": {
OTA_AirLowFareSearchRQ: {
AvailableFlightsOnly?: boolean;
OriginDestinationInformation: {
ArrivalDateTime?: string;
ArrivalWindow?: string;
ConnectionLocations?: {
ConnectionLocation: {
LocationCode: string;
PreferLevel?: (...) | (...);
}[];
};
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: ...; PreferLevel: ... }[];
NonBrandedFares?: { PreferLevel: (...) | (...) };
};
CabinPref?: {
Cabin?: | "PremiumFirst"
| "First"
| "PremiumBusiness"
| "Business"
| "PremiumEconomy"
| "Economy"
| "Y"
| "S"
| "C"
| "J"
| "F"
| "P";
PreferLevel?: "Preferred";
};
ClassOfService?: { Code: string; PreferLevel?: (...)
| (...) }[];
ConnectionTime?: {
EnableExcludedConnection?: boolean;
ExcludedConnectionBegin?: string;
ExcludedConnectionEnd?: string;
Max?: number;
Min?: number;
};
FareBasis?: { Code: string; PreferLevel?: (...)
| (...) }[];
FareType?: { Code: string; PreferLevel: (...) | (...) }[];
Flight?: {
Airline: { Marketing: ...; Operating?: ... };
ArrivalDateTime: string;
ClassOfService?: string;
DepartureDateTime: string;
DestinationLocation: { LocationCode?: ... };
Number: number;
OriginLocation: { LocationCode?: ... };
Type?: string;
}[];
IncludeAlliancePref?: { Code: string }[];
IncludeVendorPref?: { Code: string }[];
MaxOneWayOptions?: { Value: number };
PriorityBoarding?: { FreePriorityBoarding?: boolean };
Seats?: { Seat?: { AtLeast?: ...; LessThan?: ...; Type?: ... }[] };
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?: (...)[];
IncludeAlliancePref?: (...)[];
};
VendorPref?: { Code: ...; PreferLevel?: ... }[];
};
}[];
DiversityControl?: {
Dimensions: {
Carrier?: {
Default?: { Options: string };
OnlineIndicator?: boolean;
Override?: { Code: ...; Options: ... }[];
Weight: number;
};
InboundOutboundPairing?: { Duplicates?: number; Weight: number };
OperatingDuplicate?: {
PreferredCarrier?: { Code: ... }[];
Weight: number;
};
PriceWeight?: number;
StopsNumber?: { Weight: number };
TimeOfDay?: {
Distribution?: {
Direction?: ...;
Endpoint?: ...;
Leg?: ...;
Range?: ...;
}[];
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?: ... };
}[];
}[];
PriceRequestInformation?: {
AccountCode?: { Code: string }[];
CurrencyCode?: string;
NegotiatedFareCode?: { Code?: string; Supplier?: { Code?: ... }[] }[];
NegotiatedFaresOnly?: boolean;
ProcessThruFaresOnly?: boolean;
PurchaseDate?: string;
TPA_Extensions?: {
BrandedFareIndicators?: {
BrandFilters?: {
Brand?: (...)[];
NonBrandedFares?: { PreferLevel: ... };
};
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: ...; End: ...; Percentage: ... }[];
};
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?: (...)[];
AvoidCabinDowngrade?: { Mode: ... };
Baggage?: { FreePieceRequired?: ... };
BrandedFareIndicators?: {
BrandFilters?: ...;
ItinParityBrandlessLeg?: ...;
ItinParityFallbackMode?: ...;
MultipleBrandedFares?: ...;
ParityMode?: ...;
ParityModeForLowest?: ...;
SingleBrandedFare?: ...;
UpsellLimit?: ...;
};
Cabin?: { Type: ... };
ClassOfService?: (...)[];
CorporateID?: (...)[];
ExcludeRestricted?: { Ind: ... };
FareBasis?: (...)[];
FareType?: (...)[];
JumpCabinLogic?: { Disabled: ... };
KeepSameCabin?: { Enabled: ... };
Leg?: (...)[];
MinMaxStay?: { Ind: ... };
NegotiatedFaresOnly?: { Ind: ... };
PassengerTypeQuantity?: (...)[];
PriorityBoarding?: Record<(...), (...)>;
PrivateFare?: { Ind: ... };
PublicFare?: { Ind: ... };
RefundPenalty?: { Ind: ... };
ResTicketing?: { Ind: ... };
Seats?: Record<(...), (...)>;
SeatSelection?: { FreeSeatSelection?: ... };
UseNegotiatedFares?: { Ind: ... };
UsePassengerFares?: { Ind: ... };
VoluntaryChanges?: { Match?: ...; Penalty?: ... };
XOFares?: { Ind: ... };
}[];
};
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: ... };
CarrierCode: string;
FrequentFlyer?: (...)[];
Qualifier?: (...)[];
}[];
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: (...)
| (...) }[];
};
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?: (...) | (...) }[];
}[];
};
Version: string;
};
};
};
};
responses: {
"200": {
content: {
"application/json": {
groupedItineraryResponse: {
baggageAllowanceDescs?: {
description1?: string;
description2?: string;
id: number;
pieceCount?: number;
unit?: string;
weight?: number;
}[];
baggageChargeDescs?: {
description1?: string;
description2?: string;
equivalentAmount?: number;
equivalentCurrency?: string;
firstPiece?: number;
id: number;
lastPiece?: number;
noChargeNotAvailable?: string;
}[];
brandFeatureDescs?: {
application: string;
commercialName: string;
id: number;
serviceGroup: string;
serviceType: string;
subCode: string;
vendor: string;
}[];
fareComponentDescs?: {
applicablePricingCategories?: string;
aslRetailerRuleCode?: string;
brand?: {
brandName?: string;
code: string;
priceClassDescriptionRef?: number;
programCode?: string;
programDescription?: string;
programId?: string;
programSystemCode?: string;
};
cabinCode?: string;
corporateIdMatched?: boolean;
direction?: | "AF"
| "AL"
| "AP"
| "AT"
| "CA"
| "CT"
| "DI"
| "DO"
| "DU"
| "EH"
| "EM"
| "EU"
| "FE"
| "IN"
| "ME"
| "NA"
| "NP"
| "PA"
| "PE"
| "PN"
| "PO"
| "PV"
| "RU"
| "RW"
| "SA"
| "SN"
| "SP"
| "TB"
| "TS"
| "TT"
| "US"
| "WH"
| "XX";
directionality?: string;
displayCategoryType?: string;
fareAmount?: number;
fareBasisCode: string;
fareCode?: string;
fareComponentReferenceId?: number;
fareCurrency?: string;
fareDescription?: string;
farePassengerType: string;
fareRule?: string;
fareTariff?: string;
fareType?: string;
fareTypeBitmap?: string;
generalRetailerRuleCode?: string;
governingCarrier?: string;
handlingMarkupDetails?: {
amountCurrency?: string;
fareAmountAfterMarkup?: number;
markupAmount?: number;
markupHandlingFeeAppId?: string;
markupRuleItemNumber?: number;
markupRuleSourcePcc?: string;
markupTypeCode?: string;
retailerRuleQualifier?: string;
}[];
higherIntermediatePoints?: {
amount?: number;
cabinHigh?: string;
cabinLow?: string;
destination?: string;
fareClassHigh?: string;
fareClassLow?: string;
highDestination?: string;
highOrigin?: string;
lowDestination?: string;
lowOrigin?: string;
mileageSurchargePercentage?: number;
origin?: string;
}[];
id: number;
matchedAccountCode?: string;
mileage?: boolean;
mileageSurcharge?: number;
milesAmount?: number;
negotiatedFare?: boolean;
notValidAfter?: string;
notValidBefore?: string;
oneWayFare?: boolean;
plusUps?: {
amount: number;
countryOfPayment?: string;
destination: string;
fareDestination?: string;
fareOrigin?: string;
message: string;
origin: string;
viaCity?: string;
}[];
privateFare?: boolean;
publishedFareAmount?: number;
publishedFareCurrency?: string;
segments: {
segment?: {
extraMileageAllowance?: ...;
sideTrip?: ...;
stopover?: ...;
stopoverCharge?: ...;
stopoverChargeCurrency?: ...;
surcharges?: ...;
transferCharge?: ...;
};
surface?: {
extraMileageAllowance?: ...;
stopover?: ...;
stopoverCharge?: ...;
stopoverChargeCurrency?: ...;
unchargeable?: ...;
};
}[];
ticketDesignator?: string;
vendorCode?: string;
webBasedFare?: boolean;
}[];
flightAmenities?: {
beverage?: {
alcoholicCost?: "free"
| "paid";
exists?: boolean;
id: number;
nonAlcoholicCost?: "free" | "paid";
}[];
entertainment?: {
cost?: "free"
| "paid";
exists?: boolean;
id: number;
type?: string;
}[];
food?: {
cost?: "free"
| "paid";
exists?: boolean;
id: number;
type?: string;
}[];
layout?: {
directAisleAccess?: boolean;
id: number;
rowLayout?: string;
}[];
power?: {
cost?: "free"
| "paid";
distribution?: string;
id: number;
type?: string;
}[];
seat?: { id: number; pitch?: string; type?: string }[];
wifi?: {
cost?: "free" | "paid";
exists?: boolean;
id: number;
type?: string;
}[];
};
itineraryGroups?: {
groupDescription: {
itineraryType?: string;
legDescriptions: {
arrivalLocation?: ...;
departureDate: ...;
departureLocation?: ...;
}[];
};
itineraries?: {
currentItinerary?: boolean;
diversitySwapper?: { weighedPrice: ... };
failed?: { minimumConnectTime?: ... };
id: number;
itinSource?: string;
legs?: (...)[];
originDestinationInformationRef?: number;
pricingInformation?: (...)[];
pricingSource: string;
routingItinerary?: boolean;
sabreConnectLite?: boolean;
}[];
processingMessages?: { pricingSource: string; text: string }[];
}[];
legDescs?: {
elapsedTime?: number;
id?: number;
schedules: {
departureDateAdjustment?: number;
ref: number;
requestedStopover?: boolean;
}[];
}[];
messages: {
code?: string;
numberOfOccurences?: number;
severity?: string;
shortCode?: string;
text?: string;
type?: string;
value?: string;
}[];
obFeeDescs?: {
amount: number;
currency: string;
description?: string;
id: number;
type?: string;
}[];
originalItineraryDesc?: {
taxes: {
passengerIndex: number;
tax: { refundable?: ...; taxCode: ... }[];
}[];
};
passengerDescs?: {
givenName?: string;
id: number;
passengerId?: string;
surname?: string;
}[];
priceClassDescriptions?: {
descriptions: { id?: string; text: string }[];
id: number;
}[];
scheduleDescs?: {
arrival: {
airport: string;
city?: string;
country?: string;
dateAdjustment?: number;
state?: string;
terminal?: string;
time: string;
};
bookingDetails?: { classOfService?: string; mealCodeList?: string };
carrier: {
alliances?: string;
basicBookingRequest?: boolean;
callDirect?: boolean;
codeShared?: string;
disclosure?: string;
equipment?: {
change?: boolean;
code?: string;
typeForFirstLeg?: string;
typeForLastLeg?: string;
};
marketing: string;
marketingFlightNumber: number;
operating?: string;
operatingFlightNumber?: number;
};
departure: {
airport: string;
city?: string;
country?: string;
state?: string;
terminal?: string;
time: string;
};
dotRating?: string;
elapsedTime?: number;
eTicketable?: boolean;
flightStatused?: number;
frequency?: string;
funnel?: boolean;
governmentApproval?: boolean;
hiddenStops?: {
airMiles?: number;
airport: string;
arrivalDateAdjustment?: number;
arrivalTime?: string;
city?: string;
country?: string;
departureDateAdjustment?: number;
departureTime?: string;
elapsedLayoverTime?: number;
elapsedTime?: number;
equipment?: string;
state?: string;
}[];
id: number;
message?: string;
messageType?: string;
onTimePerformance?: number;
smokingAllowed?: boolean;
stopCount?: number;
totalMilesFlown?: number;
trafficRestriction?: string;
}[];
scheduleMessages?: {
destination: string;
origin: string;
pricingSource: string;
text?: string;
type?: string;
}[];
statistics?: {
branded?: number;
departed?: number;
itineraryCount?: number;
legMissed?: number;
oneWay?: number;
soldOut?: number;
};
taxDescs?: {
amount: number;
carrier?: string;
code: string;
country?: string;
currency: string;
description?: string;
id: number;
publishedAmount?: number;
publishedCurrency?: string;
station?: string;
taxReissue?: {
maxAmount?: number;
maxCurrency?: string;
refundable?: boolean;
restrictionApply?: boolean;
taxType?: string;
};
taxRestrictions?: {
currency?: string;
maxAmount?: number;
minAmount?: number;
rate?: number;
};
}[];
taxSummaryDescs?: {
amount: number;
code: string;
country?: string;
currency: string;
description?: string;
id: number;
publishedAmount?: number;
publishedCurrency?: string;
station?: string;
}[];
upaCategoryDescs?: { id: number; name: string }[];
upaDescs?: {
attributeDescription?: string;
categories?: { ref: number }[];
ctaText?: string;
ctaUrl?: string;
description?: string;
headline?: string;
id: number;
largeIconUrl?: string;
photos?: { ref: number }[];
smallIconUrl?: string;
tour?: { ref: number };
video?: { ref: number };
}[];
upaPhotoDescs?: {
caption: string;
id: number;
largeUrl: string;
mediumSquareUrl: string;
thumbUrl: string;
url: string;
}[];
upaTourDescs?: {
caption: string;
embedUrl: string;
id: number;
mediumSquareUrl: string;
thumbUrl: string;
}[];
upaVideoDescs?: {
caption: string;
embedUrl: string;
id: number;
mediumSquareUrl: string;
thumbUrl: string;
}[];
utaDescs?: {
application?: string;
assessment: string;
categoryId: string;
commercialName?: string;
descriptions: string;
groupCode?: string;
headline: string;
id: number;
largeIconUrl: string;
smallIconUrl: string;
subCode?: string;
}[];
validatingCarrierDescs?: {
alternates?: {
code?: string;
ietCountryWobsp?: { country?: ... };
}[];
country?: string;
default?: { code?: string; ietCountryWobsp?: { country?: (...)[] } };
id: number;
newVcxProcess?: boolean;
otherTicketings?: {
code?: string;
ietCountryWobsp?: { country?: ... };
}[];
settlementMethod?: string;
}[];
version: string;
};
};
};
};
};
}
Description
Create Bargain Finder Max Request.