# Fare Rules for Existing Reservation (after Booking) Fare rules are the conditions and restrictions that apply to any booking based on its fare type. These determine the price of the fare. Generally, less expensive fares have more restrictions and more expensive fares have fewer restrictions. Fare rules can include blackout dates, advanced reservation requirements, minimum and maximum stay requirements, and cancellation and change penalties. Endpoint: GET /air/farerule/farerules/fromreservation Version: 11.34.0 Security: bearerAuth ## Query parameters: - `reservationIdentifier` (string, required) Reservation locator code. Example: "49f58f5f-c443-43b4-9f5d-be405fd00a01" - `fareRuleCategories` (array) Send only if requesting structured fare rules. If fareRuleType=Structured and fareRuleCategories is not sent, all structured fare rules are returned. Supported values: AdvanceReservationTicketing (GDS only), MinimumStay (GDS only), MaximumStay (GDS only), Stopovers (GDS only), Penalties. Example: ["[\"Penalties\"]"] - `fareRuleType` (string, required) The type of fare rules requested. Supported values: ShortText, LongText (GDS only), Structured. (For NDC, structured fare rules are supported only for Penalties. A warning message returned if no penalties are applicable to the fare). Example: "Structured" - `offerIDs` (array) Deprecated. Not supported in rules from reservation. Example: ["[\"offer_1\"]"] - `productIDs` (array) Deprecated. Not supported in rules from reservation. Example: ["[\"product_1\"]"] - `flightIDs` (array) Deprecated. Not supported in rules from reservation. Example: ["[\"flight_1\"]"] ## Header parameters: - `travelportPlusSessionIdentifier` (string) travelportPlusSessionIdentifier used to maintain an established agency session Example: "49f58f5f-c443-43b4-9f5d-be405fd00a01" - `TraceId` (string) Identifier used to correlate Air API invocations across a multi-call business flows. Example: "TraceID_123456789" - `XAUTH_TRAVELPORT_ACCESSGROUP` (string) Identifies the Travelport access group with which the caller is associated Example: "19Y88702-C27A-4E5D-829A-89D7016688B1" - `TVP-PCC-Core` (string) Allows user to pass PCC instead of Access Group ID Example: "DU7_1G" - `Accept-Encoding` (string, required) Comma-separated list of acceptable encodings like gzip and/or deflate Example: "gzip, deflate" ## Response 200 fields (application/json): - `FareRuleListResponse` (object) The response of a Fare rule list endpoint request. - `FareRuleListResponse.@type` (string) Example: "FareRuleListResponse" - `FareRuleListResponse.FareRule` (array) — one of (discriminator: @type): - FareRuleStructured: - `StructuredFareRules` (array, required) - `StructuredFareRules.@type` (string) Example: "StructuredFareRules" - `StructuredFareRules.passengerTypeCodes` (array) List of passenger type codes Example: ["[\"ADT\",\"CHD\"]"] - `StructuredFareRules.fareClassCode` (string) The code of the fare class to which the rule applies, or the generic fare Example: "QVM0Z0H" - `StructuredFareRules.fareTypeCode` (string) ATPCO fare type code Example: "ERU" - `StructuredFareRules.seasonType` (string) Enum: "Basic", "High/Peak", "HolidaySurcharge", "Low/OffPeak", "SecondWinter", "Shoulder" - `StructuredFareRules.dayOfWeekType` (string) Enum: "Midweek", "MidweekNight", "Night", "OffPeak", "Weekend", "WeekendNight" - `StructuredFareRules.oneWayRoundTripRestrictions` (string) Enum: "OneWay", "RoundTrip", "All" - `StructuredFareRules.routingNumber` (integer) 00000 - 09999; 00000 = MPM; 88888 = Specified Routing Example: 9999 - `StructuredFareRules.effectiveDate` (string) - `StructuredFareRules.discontinueDate` (string) - `StructuredFareRules.inboundOutboundApplication` (string) Enum: "InboundTravelOnly", "OutboundTravelOnly", "AlwaysApplies" - `StructuredFareRules.geographicDirectionApplication` (string) Enum: "FromLocation1ToLocation2", "ToLocation1FromLocation2", "OriginatingFromLocation1ToLocation2", "OriginatingFromLocation2ToLocation1" - `StructuredFareRules.Penalties` (array) - `StructuredFareRules.Penalties.@type` (string, required) Discriminator. No child classes. Example: "Penalties" - `StructuredFareRules.Penalties.Change` (array) — one of (discriminator: @type): Details about maximum or minimum change fees charged for changes to this itinerary. Returned in Penalties object with type ChangePermitted if a change is permitted after booking. - ChangeIndeterminate: - `IndeterminateInd` (string) Structured fare rules could not be determined for this category. Example: "true" - ChangePermitted: - `penaltyTypes` (array, required) Enum: "BeforeDeparture", "AfterDeparture", "Anytime", "NoShow", "Minimum", "Maximum", "ExchangeRequired", "ExchangeNotRequired" - `PenaltyAppliesTo` (string) Returned in Change and Cancel objects to specify what the change or cancel penalty applies to. Enum: "OneWay", "RoundTrip", "PerTicket", "PerCoupon", "PerDirectionOfTravel" - `Penalty` (array) — one of (discriminator: @type): - PenaltyAmount: - `Amount` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - PenaltyPercent: - `Percent` (number) Percent of the fare charges for the penalty Example: 20 - `higherPenatltyAppliesInd` (boolean) If true, when an amount and a percent are specified in the Penalty then the higher of these apply Example: true - `MinimumAdcolAmount` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `MinimumAdcolAmount.value` (number) The amount of a given currency. Example: 124.56 - `MinimumAdcolAmount.code` (string) An ISO 4217 alpha character code (3 characters) that specifies a money unit. Example: "USD" - `MinimumAdcolAmount.minorUnit` (integer) Minor units are a mechanism for expressing the relationship between a major currency unit and its corresponding minor currency unit. It is the smallest unit of a given currency. For example; the smallest denomination in USD is the cent, which is 1/100 of a USD, and the minor unit value is 2. Not all currencies have a minor unit. Example: 2 - `MinimumAdcolAmount.currencySource` (string) The system requesting or returning the currency code specified in the attribute Enum: "Supplier", "Charged", "Requested" - `MinimumAdcolAmount.approximateInd` (boolean) "If true, the currency amount has been converted from the original amount. For Air Exchange Eligibility, returned only if a currency is converted. If returned, the value is always true, indicating that the fee is approximate because of currency conversion. For Hotel Availability and Rules, true indicates this is a calculated value; false indicates this is the value returned by the property." Example: true - `ChangeMethod` (string) Ticket must be reissued, revalidated or both Enum: "Reissue", "Revalidation", "Both" - `ResidualValuePenalty` (string) List of Residual Value Penalty types. Enum: "Ignore", "Refund", "Subtract", "SubtractFromNonRefundable" - `PeriodBeforeDeparture` (object) The first occurrence (if day of week) or the unit of time - `PeriodBeforeDeparture.value` (integer) Example: 1 - `PeriodBeforeDeparture.period` (string) Defines the Units that can be applied to Stay restrictions. Enum: "Minutes", "Hours", "Days", "Months", "MON", "TUES", "WED", "THU", "FRI", "SAT", "SUN" - `PenaltyException` (object) The first occurrence (if day of week) or the unit of time - `PenaltyException.value` (integer) Example: 1 - `PenaltyException.period` (string) Defines the Units that can be applied to Stay restrictions. Enum: same as `PeriodBeforeDeparture.period` in "ChangePermitted" (11 values) - `PenaltyException.appliesAfterReservationInd` (boolean) If true, exception applies after reservation has been made - `PenaltyException.appliesAfterTicketingInd` (boolean) If true, exception applies after ticketing - ChangeNotPermitted: - `NotPermittedInd` (string) Changes are not permitted Example: "true" - `penaltyTypes` (array) Enum: same as `penaltyTypes` in "ChangePermitted" (8 values) - `PeriodBeforeDeparture` (object) The first occurrence (if day of week) or the unit of time - `PeriodBeforeDeparture.value` (integer) Example: 1 - `PeriodBeforeDeparture.period` (string) Defines the Units that can be applied to Stay restrictions. Enum: same as `PeriodBeforeDeparture.period` in "ChangePermitted" (11 values) - `taxesNonRefundableInd` (boolean) if true, for non-refundable fares taxes are also non-refundable. Example: true - `StructuredFareRules.Penalties.Change.@type` (string, required) Discriminator. Child classes ChangePermitted, ChangeNotPermitted, and ChangeIndeterminate. Example: "ChangePermitted" - `StructuredFareRules.Penalties.Change.ProductRefs` (array) List of product reference ids to which these penalties apply, if applicable only to specific products. Example: ["p1","p2"] - `StructuredFareRules.Penalties.Change.SegmentSequence` (array) List of segment sequence numbers to which these penalties apply, if applicable only to specific segments. Example: [1] - `StructuredFareRules.Penalties.Cancel` (array) — one of (discriminator: @type): Returned in Penalties object with type CancelPermitted if a cancellation is permitted after booking. - CancelIndeterminate: - `IndeterminateInd` (string) structured fare rules could not be determined for this category Example: "true" - CancelPermitted: - `penaltyTypes` (array, required) Enum: same as `penaltyTypes` in "ChangePermitted" (8 values) - `PenaltyAppliesTo` (string) Returned in Change and Cancel objects to specify what the change or cancel penalty applies to. Enum: same as `PenaltyAppliesTo` in "ChangePermitted" (5 values) - `Penalty` (array) — one of (discriminator: @type): - PenaltyAmount: - `Amount` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - PenaltyPercent: - `Percent` (number) Percent of the fare charges for the penalty Example: 20 - `higherPenatltyAppliesInd` (boolean) If true, when an amount and a percent are specified in the Penalty then the higher of these apply Example: true - `MinimumAdcolAmount` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `MinimumAdcolAmount.value` (number) The amount of a given currency. Example: 124.56 - `MinimumAdcolAmount.code` (string) An ISO 4217 alpha character code (3 characters) that specifies a money unit. Example: "USD" - `MinimumAdcolAmount.minorUnit` (integer) Minor units are a mechanism for expressing the relationship between a major currency unit and its corresponding minor currency unit. It is the smallest unit of a given currency. For example; the smallest denomination in USD is the cent, which is 1/100 of a USD, and the minor unit value is 2. Not all currencies have a minor unit. Example: 2 - `MinimumAdcolAmount.currencySource` (string) The system requesting or returning the currency code specified in the attribute Enum: same as `MinimumAdcolAmount.currencySource` in "ChangePermitted" (3 values) - `MinimumAdcolAmount.approximateInd` (boolean) "If true, the currency amount has been converted from the original amount. For Air Exchange Eligibility, returned only if a currency is converted. If returned, the value is always true, indicating that the fee is approximate because of currency conversion. For Hotel Availability and Rules, true indicates this is a calculated value; false indicates this is the value returned by the property." Example: true - `ChangeMethod` (string) Ticket must be reissued, revalidated or both Enum: same as `ChangeMethod` in "ChangePermitted" (3 values) - `ResidualValuePenalty` (string) List of Residual Value Penalty types. Enum: same as `ResidualValuePenalty` in "ChangePermitted" (4 values) - `PeriodBeforeDeparture` (object) The first occurrence (if day of week) or the unit of time - `PeriodBeforeDeparture.value` (integer) Example: 1 - `PeriodBeforeDeparture.period` (string) Defines the Units that can be applied to Stay restrictions. Enum: same as `PeriodBeforeDeparture.period` in "ChangePermitted" (11 values) - `PenaltyException` (object) The first occurrence (if day of week) or the unit of time - `PenaltyException.value` (integer) Example: 1 - `PenaltyException.period` (string) Defines the Units that can be applied to Stay restrictions. Enum: same as `PeriodBeforeDeparture.period` in "ChangePermitted" (11 values) - `PenaltyException.appliesAfterReservationInd` (boolean) If true, exception applies after reservation has been made - `PenaltyException.appliesAfterTicketingInd` (boolean) If true, exception applies after ticketing - CancelNotPermitted: - `NotPermittedInd` (string) Cancel is not permitted Example: "true" - `penaltyTypes` (array) Enum: same as `penaltyTypes` in "ChangePermitted" (8 values) - `PeriodBeforeDeparture` (object) The first occurrence (if day of week) or the unit of time - `PeriodBeforeDeparture.value` (integer) Example: 1 - `PeriodBeforeDeparture.period` (string) Defines the Units that can be applied to Stay restrictions. Enum: same as `PeriodBeforeDeparture.period` in "ChangePermitted" (11 values) - `taxesNonRefundableInd` (boolean) if true, for non-refundable fares taxes are also non-refundable Example: true - `StructuredFareRules.Penalties.Cancel.@type` (string, required) discriminator Example: "CancelPermitted" - `StructuredFareRules.Penalties.Cancel.ProductRefs` (array) The product ids this cancel information applies to. Example: ["p1","p2"] - `StructuredFareRules.Penalties.Cancel.SegmentSequence` (array) The list of any segment sequence numbers this cancelation information applies to. Example: [1] - `StructuredFareRules.Penalties.Waiver` (array) Enum: "DeathOfPassenger", "IllnessOfPassenger", "DeathOfImmediateFamilyMember", "IllnessOfImmediateFamilyMember", "TicketUpgrade", "ScheduleChange" - `StructuredFareRules.Penalties.PenaltySourceCode` (object) The source of the penalty applied. - `StructuredFareRules.Penalties.PenaltySourceCode.value` (string) Example: "Properties of the penalty" - `StructuredFareRules.Penalties.PenaltySourceCode.codeContext` (string) Penalty source code context Example: "Context of the penalty source" - `StructuredFareRules.Penalties.PassengerTypeCodes` (array) The passenger type codes that the penalties apply to. Example: ["ADT","CHD"] - `StructuredFareRules.Penalties.involuntaryInd` (boolean) Penalties apply for involuntary changes initiated by the airline. Example: true - `StructuredFareRules.Penalties.applyLeastRestrictiveInd` (boolean) If true, the least restrictive of the rule hierarchy is applied. Example: true - `StructuredFareRules.Penalties.ruleNumber` (string) The rule number associated to this fare rule info. Example: "D38" - `StructuredFareRules.Penalties.tariffNumber` (string) The tariff number associated to this fare rule info. Example: "01634" - `StructuredFareRules.MinimumStay` (array) — one of (discriminator: @type): - MinimumStayApplies: - `mustIncludeDayOfWeek` (string) The names of the days of the week. Enum: "Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday" - `originDayOfWeek` (string) The names of the days of the week. Enum: same as `mustIncludeDayOfWeek` in "MinimumStayApplies" (7 values) - `returnTime` (string) Return time in local time zone Example: "43200" - `Duration` (string, required) Minimum duration Example: "5 days" - MinimumStayIndeterminate: - `IndeterminateInd` (string) Structured fare rules could not be determined for this category Example: "true" - `StructuredFareRules.MinimumStay.@type` (string, required) Example: "MinimumStayApplies" - `StructuredFareRules.MinimumStay.ruleNumber` (string) The rule number associated to this fare rule info Example: "D38" - `StructuredFareRules.MinimumStay.tariffNumber` (string) The tariff number associated to this fare rule info Example: "01634" - `StructuredFareRules.MaximumStay` (array) — one of (discriminator: @type): - MaximumStayApplies: - `maximumStayDuration` (string) - `maximumStayDate` (string) - `returnTime` (string) Return time in local time zone Example: "64800" - `mustCommenceByInd` (boolean) Indicates if travel must commence by this date/duration Example: true - `mustCompleteByInd` (boolean) Indicates if travel must complete by this date/duration Example: true - `fromDateOfIssueInd` (boolean) If true the Maximum stay is calculated from the date of ticket issuance Example: true - `earliestAppliesInd` (boolean) If true, the earlier of the Maximum stay conditions apply Example: true - `latestAppliesInd` (boolean) If true, the later of the Maximum stay conditions apply Example: true - MaximumStayIndeterminate: - `IndeterminateInd` (string) Structured fare rules could not be determined for this category Example: "true" - `StructuredFareRules.MaximumStay.@type` (string, required) Discriminator Example: "MaximumStayApplies" - `StructuredFareRules.MaximumStay.ruleNumber` (string) The rule number associated to this fare rule info Example: "D38" - `StructuredFareRules.MaximumStay.tariffNumber` (string) The tariff number associated to this fare rule info Example: "01634" - `StructuredFareRules.AdvanceReservation` (array) — one of (discriminator: @type): - AdvanceReservationRequired: - `instantPurchase` (string, required) Yes , No , Unknown Enum: "Yes", "No", "Unknown" - `standby` (string, required) Yes , No , Unknown Enum: same as `instantPurchase` in "AdvanceReservationRequired" (3 values) - `waiverDate` (string) Waiver date Example: "2026/3/12" - `ReservationTravelSegmentIndicatorATPCO` (integer) The ATPCO travel segment geographic indicator. Example= 1st segment over the water Example: 55 - `ConfirmedStatus` (array) Example: ["AllFlightsMustBeConfirmed","OpenReturnsNotPermitted","FirstFlightMustBeConfirmed","OpenReturnsArePermitted","Other_"] - `ConfirmedStatus.value` (string) Enum: "AllFlightsMustBeConfirmed", "OpenReturnsNotPermitted", "FirstFlightMustBeConfirmed", "OpenReturnsArePermitted" - `WaitlistStandbyCondition` (array) Example: ["WaitlistStandbyNotPermitted","WaitlistNotPermitted","WaitlistStandbyNotPermittedOrigin","StandbyNotPermittedOrigin","WaitlistNotPermittedOrigin","WaitlistNotPermittedOnAny","StandbyPermittedEarlierLaterSameDayElseWaitlistStandbyNotPermitted","StandbyPermittedEarlierLaterSameDayElseStandbyNotPermitted","StandbyPermittedEarlierLaterSameDayElseWaitlistStandbyNotPermittedOrigin"] - `WaitlistStandbyCondition.value` (string) Enum: "WaitlistStandbyNotPermitted", "WaitlistNotPermitted", "WaitlistStandbyNotPermittedOrigin", "StandbyNotPermittedOrigin", "WaitlistNotPermittedOrigin", "WaitlistNotPermittedOnAny", "StandbyPermittedEarlierLaterSameDayElseWaitlistStandbyNotPermitted", "StandbyPermittedEarlierLaterSameDayElseStandbyNotPermitted", "StandbyPermittedEarlierLaterSameDayElseWaitlistStandbyNotPermittedOrigin", "WaitlistPermittedEarlierLaterSameDayElseWaitlistStandbyNotPermittedOrigin", "StandbyPermittedSameDateOriginallyTicketedProvidedFlightTimeSpecificRulesMet", "StandbyNotPermitted" - `FirstReservation` (object, required) — one of (discriminator: @type): Discriminator classes FirstReservationDuration or FirstReservationDayOfWeek - FirstReservationDuration: - `Duration` (string, required) The advance duration the Offer can be reserved. Example: "50 days in advance of the first flight" - FirstReservationDayOfWeek: - `DayOfWeek` (string, required) The names of the days of the week. Enum: same as `mustIncludeDayOfWeek` in "MinimumStayApplies" (7 values) - `FirstReservation.@type` (string, required) Example: "FirstReservation" - `FirstReservation.TimeOfDay` (string) The time of day indicates the earliest time the Offer can be reserved. Used in conjunction with DayOfWeek or Duration Example: "07:00" - `LastReservation` (object, required) — one of (discriminator: @type): Discriminator classes LastReservationDuration or LastReservationDayOfWeek - LastReservationDuration: - `Duration` (string, required) The advance duration the Offer can be reserved. Example: "50 days in advance of the first flight" - LastReservationDayOfWeek: - `DayOfWeek` (string, required) The names of the days of the week. Enum: same as `mustIncludeDayOfWeek` in "MinimumStayApplies" (7 values) - `LastReservation.@type` (string, required) Example: "LastReservation" - `LastReservation.TimeOfDay` (string) The time of day indicates the earliest time the Offer can be reserved. Used in conjunction with DayOfWeek or Duration Example: "07:00" - AdvanceReservationIndeterminate: - `IndeterminateInd` (string) If true the advance Reservation restrictions could not be determined Example: "true" - `StructuredFareRules.AdvanceReservation.@type` (string, required) Discriminator. Example: "AdvanceReservationRequired" - `StructuredFareRules.AdvanceReservation.ruleNumber` (string) The rule number associated to this fare rule info Example: "D38" - `StructuredFareRules.AdvanceReservation.tariffNumber` (string) The tariff number associated to this fare rule info Example: "01634" - `StructuredFareRules.AdvancePayment` (array) — one of (discriminator: @type): - AdvancePaymentRequired: - `waverDate` (string) Waver date Example: "2024-05-20" - `PaymentAfterReservation` (object, required) — one of (discriminator: @type): Discriminator classes PaymentAfterReservationDuration or PaymentAfterReservationDayOfWeek - PaymentAfterReservationDuration: - `Duration` (string, required) The advance duration the Offer can be reserved. Example: "50 days in advance of the first flight" - PaymentAfterReservationDayOfWeek: - `DayOfWeek` (string, required) The names of the days of the week. Enum: same as `mustIncludeDayOfWeek` in "MinimumStayApplies" (7 values) - `PaymentAfterReservation.@type` (string, required) Example: "PaymentAfterReservation" - `PaymentAfterReservation.TimeOfDay` (string) The time of day indicates the earliest time the Offer can be reserved. Used in conjunction with DayOfWeek or Duration Example: "07:00" - `PaymentBeforeDeparture` (object, required) — one of (discriminator: @type): Discriminator classes PaymentBeforeDepartureDuration or PaymentBeforeDepartureDayOfWeek - PaymentBeforeDepartureDuration: - `Duration` (string, required) The advance duration the Offer can be reserved. Example: "50 days in advance of the first flight" - PaymentBeforeDepartureDayOfWeek: - `DayOfWeek` (string, required) The names of the days of the week. Enum: same as `mustIncludeDayOfWeek` in "MinimumStayApplies" (7 values) - `PaymentBeforeDeparture.@type` (string, required) Example: "PaymentBeforeDeparture" - `PaymentBeforeDeparture.TimeOfDay` (string) The time of day indicates the earliest time the Offer can be reserved. Used in conjunction with DayOfWeek or Duration Example: "07:00" - `PaymentTravelSegmentIndicatorATPCO` (integer) The ATPCO paymentgeographic indicator. Example = 1st segment over the water between area 2 and 3 Example: 55 - `instantPaymentInd` (boolean) if true, the Offer must be paid at the same time as the reservation is created Example: true - `ealierAppliesInd` (boolean) If true, the earlier of the payment restrictions apply Example: true - `laterAppliesInd` (boolean) If true, the later of the payment restrictions apply Example: true - AdvancePaymentIndeterminate: - `IndeterminateInd` (string) If true the advance Payment restrictions could not be determined Example: "true" - `StructuredFareRules.AdvancePayment.@type` (string, required) Example: "AdvancePayment" - `StructuredFareRules.AdvancePayment.ruleNumber` (string) The rule number associated to this fare rule info Example: "D38" - `StructuredFareRules.AdvancePayment.tariffNumber` (string) The tariff number associated to this fare rule info Example: "01634" - `StructuredFareRules.Stopover` (array) — one of (discriminator: @type): - StopoverPermitted: - `journeyTypes` (array) Enum: "OpenJaw", "RoundTrip", "CircleTrip", "Outbound", "Inbound" - `minimumDuration` (string, required) The minimum amount of time permitted for a stopover Example: "1 hour" - `maximumDuration` (string, required) The maximum amount of time permitted for a stopover Example: "12 hours" - `minimum` (integer, required) The minimum permitted for a stopover Example: 3 - `maximum` (integer, required) The maximum permitted for a stopover Example: 5 - `outbound` (integer) Stopover outbound Example: 2 - `inbound` (integer) Stopover inbound Example: 3 - `StopoverCharge` (array, required) - `StopoverCharge.@type` (string) Example: "StopoverCharge" - `StopoverCharge.id` (string, required) The ID of the stopoverCharge Example: "125" - `StopoverCharge.quantity` (integer, required) The quantity of stopovers permitted at this charge Example: 2 - `StopoverCharge.Amount` (object, required) A monetary amount, up to 4 decimal places. Decimal place must be included. - `StopoverCharge.Amount.value` (number) The amount of a given currency. Example: 124.56 - `StopoverCharge.Amount.code` (string) An ISO 4217 alpha character code (3 characters) that specifies a money unit. Example: "USD" - `StopoverCharge.Amount.minorUnit` (integer) Minor units are a mechanism for expressing the relationship between a major currency unit and its corresponding minor currency unit. It is the smallest unit of a given currency. For example; the smallest denomination in USD is the cent, which is 1/100 of a USD, and the minor unit value is 2. Not all currencies have a minor unit. Example: 2 - `StopoverCharge.Amount.currencySource` (string) The system requesting or returning the currency code specified in the attribute Enum: same as `MinimumAdcolAmount.currencySource` in "ChangePermitted" (3 values) - `StopoverCharge.Amount.approximateInd` (boolean) "If true, the currency amount has been converted from the original amount. For Air Exchange Eligibility, returned only if a currency is converted. If returned, the value is always true, indicating that the fee is approximate because of currency conversion. For Hotel Availability and Rules, true indicates this is a calculated value; false indicates this is the value returned by the property." Example: true - `StopoverCharge.AlternativeAmount` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `StopoverRestriction` (array) - `StopoverRestriction.@type` (string) Example: "StopoverRestrictions" - `StopoverRestriction.stopoverChargeRef` (string, required) Reference to the Stopover Charge Example: "Reference1" - `StopoverRestriction.journeyTypes` (array) Enum: same as `journeyTypes` in "StopoverPermitted" (5 values) - `StopoverRestriction.departureCarrier` (string) Departure carrier airline code Example: "XPE" - `StopoverRestriction.arrivalAirline` (string) Arrival carrier airline code Example: "AEH" - `StopoverRestriction.GeographicRestriction` (array) Example: ["Airport","City","Country","StateProvince","Zone"] - `StopoverRestriction.onlineStopoverOnlyInd` (boolean) If true, the stopover may only take place when the arriving and departing airline are the same Example: true - `permittedAtGatewayOnlyInd` (boolean) If true, stopovers are permitted at gateway points only Example: true - StopoverNotPermitted: - `NotPermittedInd` (string) if true, stopovers are not permitted Example: "true" - StopoverIndeterminate: - `IndeterminatedInd` (string) If true the stopover restrictions could not be determined Example: "true" - `StructuredFareRules.Stopover.@type` (string, required) Discriminator. Example: "StopoverPermitted" - `StructuredFareRules.Stopover.ruleNumber` (string) The rule number associated to this fare rule info Example: "D38" - `StructuredFareRules.Stopover.tariffNumber` (string) The tariff number associated to this fare rule info Example: "01634" - `StructuredFareRules.Location1GeographicSpecification` (object) The type of geographic specification. AREA-a one-digit numeric area designator. 1= Western Hemisphere 2 = Europe, Africa & Near East 3 = Far East, Australia and Pacific, ZONE-a numeric value assigned to a non-standard geographic description of cities, states, countries, sub-continents, and/or traffic conferences COUNTRY- The standard IATA country code,CITY-The standard industry city code STATE -the standard Postal state code. Two-character alpha codes. When used, it will always be preceded by a country code - `StructuredFareRules.Location1GeographicSpecification.value` (string) - `StructuredFareRules.Location1GeographicSpecification.geographicSpecificationType` (string) Enum: "Area", "City", "Country", "State", "Zone" - `StructuredFareRules.Location2GeographicSpecification` (object) The type of geographic specification. AREA-a one-digit numeric area designator. 1= Western Hemisphere 2 = Europe, Africa and Near East 3 = Far East, Australia and Pacific, ZONE-a numeric value assigned to a non-standard geographic description of cities, states, countries, sub-continents, and/or traffic conferences COUNTRY- The standard IATA country code,CITY-The standard industry city code STATE -the standard Postal state code. Two-character alpha codes. When used, it will always be preceded by a country code - `StructuredFareRules.Location2GeographicSpecification.value` (string) - `StructuredFareRules.Location2GeographicSpecification.geographicSpecificationType` (string) Enum: same as `StructuredFareRules.Location1GeographicSpecification.geographicSpecificationType` in "FareRuleStructured" (5 values) - `StructuredFareRules.generalRuleDoesNotApplyInd` (boolean) if true, general rule does not apply. Specific data in this rule overrides general rule application. - FareRuleText: - `TextFareRule` (array, required) - `TextFareRule.value` (string) Example: "Fare cannot be changed. Refundable before departure with 4100.00 penalty" - `TextFareRule.language` (string) A three letter code for the representation of names of languages defined by ISO639-3 Example: "ENG" - `TextFareRule.name` (string) The name of the text fare rule Example: "Penalties" - `FareRuleListResponse.FareRule.@type` (string, required) Discriminator. Example: "FareRuleText" - `FareRuleListResponse.FareRule.id` (string) - `FareRuleListResponse.FareRule.Identifier` (object) A globally unique identifier key often used to reference a given option (such as Pricing, Booking, Rules, or additional workflows) or to retrieve information (such as Hotel pagination). - `FareRuleListResponse.FareRule.Identifier.value` (string) Unique offer identifier that can be sent in subsequent payload requests to reference this offer. When used for reference flight calls, the CatalogProductOfferingsIdentifier will be the transaction identifier from the Search, Next Leg Search, or Flight Specific Search response in CatalogProductOfferings/Identifier/value. If you choose to pull the CatalogProductOfferingsIdentifier from the Price response instead (OfferListResponse/Identifier/value), either full or reference payload, please note for subsequent Add Offer requests you must remove the _PC appended to the end of the value in the AirPrice response (e.g., change value: '93d2091d-3d04-48ab-8091-6ae1525f02ea_PC' to value: '93d2091d-3d04-48ab-8091-6ae1525f02ea'). When building an AirPrice or Add Offer reference payload request: - Look for the CatalogProductOfferingIdentifier (ex: o1) in a Search response at CatalogProductOfferings/CatalogProductOffering/id or a Price response at OfferListResponse/OfferID/id. - Look for the ProductIdentifier (ex: p0) in a Search response at CatalogProductOfferings/CatalogProductOffering/ProductBrandOptions/ProductBrandOffering/Product/productRef or from a Price response at OfferListResponse/OfferID/Product/id. When returned from a Workbench, this value is the workbench identifier that must be sent in all subsequent requests for this workbench session. When returned from Air Exchange Eligibility, value is the ticket number sent with the eligibility request. When used specifically for form of payment, the value will begin with the characters 'FOP'. Similarly, the OfferIdentifier associated will begin with the character 'O'. For Hotel Create Reservation (Reference Payload), send the value from the Availability response in CatalogOffering/id or the value from SearchComplete returned in propertyItems/lowestPublicAvailableRate/rateKey/value. Results from Hotel Availability and Hotel SearchComplete are stored in the cache for 30 minutes. If the offers expire before booking, you must send a new request. Example: "A0656EFF-FAF4-456F-B061-0161008D7C4E" - `FareRuleListResponse.FareRule.Identifier.authority` (string) "Name of the supplier system that created this identifier - the source of information. For AirPrice, please note that GDS offers return the value 'Travelport' in authority while NDC offers return the carrier code of the issuing NDC carrier. When returned from Air Exchange Eligibility, authority is always 'Travelport' as the transaction issuer. For Hotels, authority indicates which supplier returned the lowest available rate for that property: either 'TVPT' (Travelport) or 'BKNG' (booking.com). Booking.com access requires additional provisioning and a direct agreement with the supplier. Authority is not returned if the property is closed or returns an error. For Hotel Create Reservation (Full Payload) and Sync Reservation send the value from the Availability response in CatalogOffering/Identifier/authority for the instance you want to book." Example: "TVPT" - `FareRuleListResponse.FareRule.Flight` (array, required) - `distance` (integer) Distance covered by the flight. Example: 6574 - `stops` (integer) Number of stops Example: 2 - `duration` (string) Elapsed flight time. Represented in hours (H) and minutes (M) OR the format PT{x}H{x}M, in which P is the duration designator, T is the time designator, {x}H is the number of hours for the connection, and {x}H is the number of minutes for the connection. Example: "PT1H40M" - `carrier` (string, required) The airline code. Example: "BA" - `number` (string, required) The marketing carrier flight number. Example: "98" - `operatingCarrier` (string) The operating airline code. Shown in codeshare situations when the operating carrier is different to the marketing carrier. Example: "BA" - `operatingCarrierName` (string) The operating carrier name Example: "Liberty Aerospace" - `operatingCarrierNumber` (string) Operating airline flight number. If there is no operating carrier number, then CO2 emission estimates for operating carriers is not supported. GDS only; not returned for NDC. Returned only in Search response. Example: "091" - `equipment` (string) Equipment model. Note that TRN, TRS, and BUS equipment codes indicate ground transportation. Example: "777" - `Departure` (object, required) Departure details for a given leg. - `terminal` (string) Departure terminal, returned when available. Example: "Terminal 1" - `country` (string) Country of to departure or arrival Example: "US" - `Departure.@type` (string, required) Discriminator classes Departure or DepartureDetail Example: "DepartureDetail" - `Departure.location` (string, required) IATA code for departure airport or city for this leg of the itinerary. Example: "AMS" - `Departure.date` (string, required) Departure date in YYYY-MM-DD format. Example: "0011-10-17" - `Departure.time` (string, required) Departure date in HH:mm:ss (24-hour format). Example: "04:45:00" - `Arrival` (object, required) - `terminal` (string) Arrival terminal, returned when available. Example: "Terminal 1" - `country` (string) Country of to departure or arrival Example: "US" - `Arrival.@type` (string, required) Discriminator classes Arrival or ArrivalDetail Example: "ArrivalDetail" - `Arrival.location` (string, required) IATA code for arrival airport or city for this leg of the itinerary. Example: "MAD" - `Arrival.date` (string, required) Arrival date in YYYY-MM-DD format. Example: "0011-10-17" - `Arrival.time` (string) Arrival date in HH:mm:ss (24-hour format). Example: "04:45:00" - `IntermediateStop` (array) - `IntermediateStop.value` (string) The IATA airport code for the airport where the intermediate stop occurs. - `IntermediateStop.arrivalFlightDuration` (string) Duration in hours and minutes of the flight arriving at the intermediate stop. ISO 8601 format Example: "PT2H35M" - `IntermediateStop.departureFlightDuration` (string) Duration in hours and minutes of the flight departing the intermediate stop. ISO 8601 format Example: "PT1H35M" - `IntermediateStop.duration` (string) Duration in hours and minutes between the arrival and departure at the intermediate stop. ISO 8601 format Example: "PT1H35M" - `IntermediateStop.equipment` (string) Equipment model, if there is a change of equipment during the stop. Example: "777" - `IntermediateStop.arrivalDate` (string) The local date the aircraft arrives at the intermediate stop Example: "2026-04-30" - `IntermediateStop.departureDate` (string) The local date the aircraft departs from the intermediate stop Example: "2026-04-30" - `IntermediateStop.arrivalTime` (string) The local time the aircraft arrives at the intermediate stop Example: "68400" - `IntermediateStop.departurelTime` (string) The local time the aircraft departs from the intermediate stop Example: "72000" - `IntermediateStop.arrivalTerminal` (string) Arrival terminal of the intermediate stop airport Example: "Terminal2" - `IntermediateStop.departureTerminal` (string) Departure terminal of the intermediate stop airport Example: "Terminal4" - `subjectToGovernmentApprovalInd` (boolean) If true, the airline has filed in its schedule that availability for a specific flight is subject to government approval. GDS only, not supported for NDC. Returned only in the Air Search API response. Example: true - `FareRuleListResponse.FareRule.Flight.@type` (string, required) Discriminator. Child classes Flight and FlightDetail. Example: "FlightDetail" - `FareRuleListResponse.FareRule.Flight.id` (string) Local id within a given message to support referencing this object - an internal flight identifier. Example: "126" - `FareRuleListResponse.FareRule.Flight.FlightRef` (string) Reference id that corresponds to the flight 'id' in ReferenceListFlight.Flight. Example: "s1" - `FareRuleListResponse.FareRule.Flight.Identifier` (object) A globally unique identifier key often used to reference a given option (such as Pricing, Booking, Rules, or additional workflows) or to retrieve information (such as Hotel pagination). - `FareRuleListResponse.FareRule.ruleNumber` (string) The rule number of fare rule Example: "34" - `FareRuleListResponse.FareRule.tariffNumber` (string) Fare rule tarrif number Example: "56" - `FareRuleListResponse.transactionId` (string) Unique transaction, correlation or tracking id for a single request and reply i.e. for a single transaction. Should be a 128 bit GUID format. Also know as E2ETrackingId. Example: "6570ed7b-89fe-4334-9c78-af282a977ba6" - `FareRuleListResponse.traceId` (string) Optional ID for internal child transactions created for processing a single request (single transaction). Should be a 128 bit GUID format. Also known as ChildTrackingId. Example: "c009a53c-48f6-4084-b7b6-3043fa9fec67" - `FareRuleListResponse.Result` (object) Returns the error and/or warning message information, if applicable. - `FareRuleListResponse.Result.@type` (string) Discriminator class Result only Example: "Result" - `FareRuleListResponse.Result.status` (string) The status of an error or warning Enum: "Not processed", "Incomplete", "Complete", "Unknown" - `FareRuleListResponse.Result.Error` (array) A list of error information returned at the provider level for a response. - `category` (string) A category to assist in identifying the error Example: "VALIDATION" - `SourceID` (string) The identifier of the source system sending the error or warning Example: "1G" - `SourceCode` (string) The error or warning code returned by the source airline or host system Example: "1234" - `SourceDescription` (string) The error or warning message as it is returned by the source airline or host system - `FareRuleListResponse.Result.Error.@type` (string, required) Discriminator classes Error or ErrorDetail Example: "ErrorDetail" - `FareRuleListResponse.Result.Error.Message` (string) The Travelport standardized error or warning message Example: "No flights found." - `FareRuleListResponse.Result.Error.NameValuePair` (array) - `FareRuleListResponse.Result.Error.NameValuePair.value` (string) Text directly related to name description, providing more detail. May have character restrictions based on remark type (e.g. Free Text limitations: 84 characters, alphanumeric and some special characters). Example: "Sunday" - `FareRuleListResponse.Result.Error.NameValuePair.id` (string) Optional internally referenced id Example: "6" - `FareRuleListResponse.Result.Error.NameValuePair.name` (string, required) Key, categorizing the of type of remark or error. Example: "Day1" - `FareRuleListResponse.Result.Error.StatusCode` (integer) Http standard response code Example: 200 - `FareRuleListResponse.Result.Warning` (array) A list of warning information returned at the provider level for a response. - `category` (string) A category to assist in identifying the error Example: "INFORMATION" - `SourceID` (string) The identifier of the source system sending the error or warning Example: "1G" - `SourceCode` (string) The error or warning code returned by the source airline or host system Example: "1234" - `SourceDescription` (string) The error or warning message as it is returned by the source airline or host system - `FareRuleListResponse.Result.Warning.@type` (string, required) Discriminator classes Warning or WarningDetail Example: "WarningDetail" - `FareRuleListResponse.Result.Warning.Message` (string) The Travelport standardized error or warning message Example: "Customer Loyalty could not be applied." - `FareRuleListResponse.Result.Warning.NameValuePair` (array) - `FareRuleListResponse.Result.Warning.StatusCode` (integer) Http standard response code Example: 200 - `FareRuleListResponse.Identifier` (object) A globally unique identifier key often used to reference a given option (such as Pricing, Booking, Rules, or additional workflows) or to retrieve information (such as Hotel pagination). - `FareRuleListResponse.ReferenceList` (array) — one of (discriminator: @type): - ReferenceListSeatingChart: - `SeatingChart` (array) - `SeatingChart.@type` (string, required) Discriminator. Example: "SeatingChart" - `SeatingChart.id` (string) Internally reference id - `SeatingChart.Cabin` (array, required) - `SeatingChart.Cabin.@type` (string) Example: "Cabin" - `SeatingChart.Cabin.name` (string, required) The name of the cabin Example: "Economy" - `SeatingChart.Cabin.Layout` (array, required) - `SeatingChart.Cabin.Layout.value` (string) - `SeatingChart.Cabin.Layout.position` (array, required) Enum: "W", "C", "A", "WA", "U", "L", "M" - `SeatingChart.Cabin.Layout.startRow` (integer, required) Start row for this Cabin Layout - `SeatingChart.Cabin.Layout.endRow` (integer, required) End row for this Cabin Layout - `SeatingChart.Cabin.Row` (array, required) - `SeatingChart.Cabin.Row.@type` (string) Example: "Row" - `SeatingChart.Cabin.Row.label` (string) The identifier for the row Example: "78" - `SeatingChart.Cabin.Row.Space` (array, required) - `SeatingChart.Cabin.Row.Characteristic` (array) - ReferenceListFlight: - `Flight` (array, required) - `AvailabilitySourceCode` (string) GDS only; not supported for NDC. Optional but Recommended to send in the full payload request. Returned to assist in troubleshooting. Returned in the Search, Air Availability, Exchange Search, AirPrice, and Workbench Commit responses. Not returned for Ancillary Shop or Fare Rules. Recommended to send in the AirPrice Full Payload and Add Offer Full Payload requests. Enum: "A", "B", "C", "D", "E", "F", "G", "H", "I", "J", "K", "L", "M", "N", "O", "P", "Q", "S", "T", "U", "X", "Y", "Z" - `Flight.@type` (string, required) Discriminator. Child classes Flight and FlightDetail. Example: "FlightDetail" - `Flight.id` (string) Local id within a given message to support referencing this object - an internal flight identifier. Example: "126" - `Flight.FlightRef` (string) Reference id that corresponds to the flight 'id' in ReferenceListFlight.Flight. Example: "s1" - `Flight.Identifier` (object) A globally unique identifier key often used to reference a given option (such as Pricing, Booking, Rules, or additional workflows) or to retrieve information (such as Hotel pagination). - `Flight.distance` (integer) Distance covered by the flight. Example: 6574 - `Flight.stops` (integer) Number of stops Example: 2 - `Flight.duration` (string) Elapsed flight time. Represented in hours (H) and minutes (M) OR the format PT{x}H{x}M, in which P is the duration designator, T is the time designator, {x}H is the number of hours for the connection, and {x}H is the number of minutes for the connection. Example: "PT1H40M" - `Flight.carrier` (string, required) The airline code. Example: "BA" - `Flight.number` (string, required) The marketing carrier flight number. Example: "98" - `Flight.operatingCarrier` (string) The operating airline code. Shown in codeshare situations when the operating carrier is different to the marketing carrier. Example: "BA" - `Flight.operatingCarrierName` (string) The operating carrier name Example: "Liberty Aerospace" - `Flight.operatingCarrierNumber` (string) Operating airline flight number. If there is no operating carrier number, then CO2 emission estimates for operating carriers is not supported. GDS only; not returned for NDC. Returned only in Search response. Example: "091" - `Flight.equipment` (string) Equipment model. Note that TRN, TRS, and BUS equipment codes indicate ground transportation. Example: "777" - `Flight.Departure` (object, required) Departure details for a given leg. - `terminal` (string) Departure terminal, returned when available. Example: "Terminal 1" - `country` (string) Country of to departure or arrival Example: "US" - `Flight.Departure.@type` (string, required) Discriminator classes Departure or DepartureDetail Example: "DepartureDetail" - `Flight.Departure.location` (string, required) IATA code for departure airport or city for this leg of the itinerary. Example: "AMS" - `Flight.Departure.date` (string, required) Departure date in YYYY-MM-DD format. Example: "0011-10-17" - `Flight.Departure.time` (string, required) Departure date in HH:mm:ss (24-hour format). Example: "04:45:00" - `Flight.Arrival` (object, required) - `terminal` (string) Arrival terminal, returned when available. Example: "Terminal 1" - `country` (string) Country of to departure or arrival Example: "US" - `Flight.Arrival.@type` (string, required) Discriminator classes Arrival or ArrivalDetail Example: "ArrivalDetail" - `Flight.Arrival.location` (string, required) IATA code for arrival airport or city for this leg of the itinerary. Example: "MAD" - `Flight.Arrival.date` (string, required) Arrival date in YYYY-MM-DD format. Example: "0011-10-17" - `Flight.Arrival.time` (string) Arrival date in HH:mm:ss (24-hour format). Example: "04:45:00" - `Flight.IntermediateStop` (array) - `Flight.IntermediateStop.value` (string) The IATA airport code for the airport where the intermediate stop occurs. - `Flight.IntermediateStop.arrivalFlightDuration` (string) Duration in hours and minutes of the flight arriving at the intermediate stop. ISO 8601 format Example: "PT2H35M" - `Flight.IntermediateStop.departureFlightDuration` (string) Duration in hours and minutes of the flight departing the intermediate stop. ISO 8601 format Example: "PT1H35M" - `Flight.IntermediateStop.duration` (string) Duration in hours and minutes between the arrival and departure at the intermediate stop. ISO 8601 format Example: "PT1H35M" - `Flight.IntermediateStop.equipment` (string) Equipment model, if there is a change of equipment during the stop. Example: "777" - `Flight.IntermediateStop.arrivalDate` (string) The local date the aircraft arrives at the intermediate stop Example: "2026-04-30" - `Flight.IntermediateStop.departureDate` (string) The local date the aircraft departs from the intermediate stop Example: "2026-04-30" - `Flight.IntermediateStop.arrivalTime` (string) The local time the aircraft arrives at the intermediate stop Example: "68400" - `Flight.IntermediateStop.departurelTime` (string) The local time the aircraft departs from the intermediate stop Example: "72000" - `Flight.IntermediateStop.arrivalTerminal` (string) Arrival terminal of the intermediate stop airport Example: "Terminal2" - `Flight.IntermediateStop.departureTerminal` (string) Departure terminal of the intermediate stop airport Example: "Terminal4" - `Flight.subjectToGovernmentApprovalInd` (boolean) If true, the airline has filed in its schedule that availability for a specific flight is subject to government approval. GDS only, not supported for NDC. Returned only in the Air Search API response. Example: true - ReferenceListAmenity: - `Amenity` (array, required) One instance for each specific amenity. - `Amenity.@type` (string, required) Discriminator. No child classes. Example: "Amenity" - `Amenity.id` (string, required) A unique Travelport-assigned amenity id used for cross-referencing by each flight with this amenity. Example: "amenity_001" - `Amenity.Category` (string, required) Flight amenity categories may include the following data as provided by ATPCO. - Aircraft: cabin pressure, model and type. - Beverage: alcoholic and non-alcoholic beverages and whether available for a fee or free; highlights premium beverages in business/first. - Entertainment: passenger entertainment options. - Flight: airline flight schedules and equipment types with the associated amenities ID for each carrier. - Food: food per flight and flight cabin and whether available for a fee or free; food is classified as breakfast, lunch, dinner, snacks, and light meals, and as premium when available in business/first. - Layout: seating layout such as classic layouts to premium cabin configurations. - Power: availability of AC power outlets, USB ports, or both. - Seat: physical seat type for every sub fleet in every cabin of the aircraft, including legroom, pitch, width, flatness and type. Note that seat metrics are returned in centimeters because the default language is English. - WiFi: availability, type, coverage, rollout, performance, and whether available free or for a fee. Example: "Entertainment" - `Amenity.Text` (object) A free text description of the amenity. - `Amenity.Text.value` (string) A short free text description. - `Amenity.Text.language` (string) The language the text is provided in. ISO639 format. Example: "EN" - ReferenceListProduct: - `Product` (array) — one of (discriminator: @type): - ProductAir: - `totalDuration` (string) Total duration of the combined segments in hours (H) and minutes (M). ISO 8601 format. Example: "PT2H40M" - `FlightSegment` (array, required) One instance for each flight segment in the product. - `FlightSegment.@type` (string) Discriminator. No child classes. Example: "FlightSegment" - `FlightSegment.id` (string) Local identifier within a given message for this object. For AirPrice this identifier starts with s as in s1, s2, etc. Example: "flightSegment_01" - `FlightSegment.sequence` (integer, required) Order of the flight segment. e.g. 1 for the first segment on the leg. Example: 1 - `FlightSegment.connectionDuration` (string) When a flight connection exists, this is the lapsed time between the connecting flights in the format PT{x}H{x}M, in which P is the duration designator, T is the time designator, {x}H is the number of hours for the connection, and {x}M is the number of minutes for the connection. Example: "PT1H3M" - `FlightSegment.amenityRefs` (array) If RouteHappy flight amenities were requested (includeFlightAmenitiesInd=true), amenityRefs is returned to cross-reference the amenities available on this flight and listed in ReferenceList/ReferenceListAmenity. Example: ["[\"amenity_1\",\"amenity_2\"]"] - `FlightSegment.universalProductAttributeRefs` (array) If universal product attributes (UPAs) for RouteHappy data were requested (includeUniversalProductAttributesInd=true) along with RouteHappy flight amenities, universalProductAttributeRefs is returned. Cross-reference the universalProductAttributeRef with the universalProductAttribute 'id' in ReferenceListUniversalProductAttribute.UniversalProductAttribute. UPAs provide images, icons, and URLs as provided by ATPCO. RouteHappy data must have also been requested per amenityRefs above. Example: ["[\"upa_1\",\"upa_2\"]"] - `FlightSegment.Flight` (object, required) Flight common schema. Used across Air workflow. One instance for each flight in the FlightSegment. A direct flight option has one Flight object while connecting flights have a Flight object for each flight on the leg. - `distance` (integer) Distance covered by the flight. Example: 6574 - `stops` (integer) Number of stops Example: 2 - `duration` (string) Elapsed flight time. Represented in hours (H) and minutes (M) OR the format PT{x}H{x}M, in which P is the duration designator, T is the time designator, {x}H is the number of hours for the connection, and {x}H is the number of minutes for the connection. Example: "PT1H40M" - `carrier` (string, required) The airline code. Example: "BA" - `number` (string, required) The marketing carrier flight number. Example: "98" - `operatingCarrier` (string) The operating airline code. Shown in codeshare situations when the operating carrier is different to the marketing carrier. Example: "BA" - `operatingCarrierName` (string) The operating carrier name Example: "Liberty Aerospace" - `operatingCarrierNumber` (string) Operating airline flight number. If there is no operating carrier number, then CO2 emission estimates for operating carriers is not supported. GDS only; not returned for NDC. Returned only in Search response. Example: "091" - `equipment` (string) Equipment model. Note that TRN, TRS, and BUS equipment codes indicate ground transportation. Example: "777" - `Departure` (object, required) Departure details for a given leg. - `terminal` (string) Departure terminal, returned when available. Example: "Terminal 1" - `country` (string) Country of to departure or arrival Example: "US" - `Departure.@type` (string, required) Discriminator classes Departure or DepartureDetail Example: "DepartureDetail" - `Departure.location` (string, required) IATA code for departure airport or city for this leg of the itinerary. Example: "AMS" - `Departure.date` (string, required) Departure date in YYYY-MM-DD format. Example: "0011-10-17" - `Departure.time` (string, required) Departure date in HH:mm:ss (24-hour format). Example: "04:45:00" - `Arrival` (object, required) - `terminal` (string) Arrival terminal, returned when available. Example: "Terminal 1" - `country` (string) Country of to departure or arrival Example: "US" - `Arrival.@type` (string, required) Discriminator classes Arrival or ArrivalDetail Example: "ArrivalDetail" - `Arrival.location` (string, required) IATA code for arrival airport or city for this leg of the itinerary. Example: "MAD" - `Arrival.date` (string, required) Arrival date in YYYY-MM-DD format. Example: "0011-10-17" - `Arrival.time` (string) Arrival date in HH:mm:ss (24-hour format). Example: "04:45:00" - `IntermediateStop` (array) - `IntermediateStop.value` (string) The IATA airport code for the airport where the intermediate stop occurs. - `IntermediateStop.arrivalFlightDuration` (string) Duration in hours and minutes of the flight arriving at the intermediate stop. ISO 8601 format Example: "PT2H35M" - `IntermediateStop.departureFlightDuration` (string) Duration in hours and minutes of the flight departing the intermediate stop. ISO 8601 format Example: "PT1H35M" - `IntermediateStop.duration` (string) Duration in hours and minutes between the arrival and departure at the intermediate stop. ISO 8601 format Example: "PT1H35M" - `IntermediateStop.equipment` (string) Equipment model, if there is a change of equipment during the stop. Example: "777" - `IntermediateStop.arrivalDate` (string) The local date the aircraft arrives at the intermediate stop Example: "2026-04-30" - `IntermediateStop.departureDate` (string) The local date the aircraft departs from the intermediate stop Example: "2026-04-30" - `IntermediateStop.arrivalTime` (string) The local time the aircraft arrives at the intermediate stop Example: "68400" - `IntermediateStop.departurelTime` (string) The local time the aircraft departs from the intermediate stop Example: "72000" - `IntermediateStop.arrivalTerminal` (string) Arrival terminal of the intermediate stop airport Example: "Terminal2" - `IntermediateStop.departureTerminal` (string) Departure terminal of the intermediate stop airport Example: "Terminal4" - `subjectToGovernmentApprovalInd` (boolean) If true, the airline has filed in its schedule that availability for a specific flight is subject to government approval. GDS only, not supported for NDC. Returned only in the Air Search API response. Example: true - `FlightSegment.IntermediateStopAmenities` (array) - `FlightSegment.IntermediateStopAmenities.@type` (string, required) Discriminator. No child classes. Example: "IntermediateStopAmenities" - `FlightSegment.IntermediateStopAmenities.departureLocation` (string, required) The departure location. Example: "NYC" - `FlightSegment.IntermediateStopAmenities.arrivalLocation` (string, required) The arrival location. Example: "DEN" - `FlightSegment.IntermediateStopAmenities.amenityRefs` (array) List of amenity references for this portion of the flight. Example: ["amenity_1"] - `FlightSegment.IntermediateStopAmenities.universalProductAttributeRefs` (array) List of UPA references for this portion of the flight. Example: ["upa_1"] - `FlightSegment.OperationalStatus` (object) The operational status of the flight - `FlightSegment.OperationalStatus.value` (string) List of operational flight status Enum: "FlightBoarding", "FlightCancelled", "FlightDeparted", "FlightPastScheduledDeparture", "NotAvailableUseSearch" - `FlightSegment.boundFlightsInd` (boolean) GDS only; not supported for NDC. Indicates flight segments are married/bound. When 'true', indicates the flight segments in a single or double connection must be sold together. When true, the indicator is returned for all leading segments on one leg of the flight, and not returned for the last segment of the bound flight leg journey, indicating where the bound flights end. For example, if an origin and destination pair has 3 flight segments, boundFlightsInd is returned for the first two segments on that leg. If the segments are not bound, boundFlightsInd is false and not returned. Example: true - `FlightSegment.CO2Actual` (object) Used for dimensional units (width, height, depth) or weight - `FlightSegment.CO2Actual.value` (number) Example: 2.22 - `FlightSegment.CO2Actual.measurementType` (string) The type of measurement such as width, height, weight Enum: "Width", "Height", "Depth", "Weight", "OverallDimension" - `FlightSegment.CO2Actual.unit` (string) The unit of measure in a code format. Refer to OpenTravel Code List Unit of Measure Code (UOM). Enum: "Miles", "Kilometers", "Meters", "Millimeters", "Centimeters", "Yards", "Feet", "Inches", "Pixels", "Block", "Megabytes", "Gigabytes", "Square feet", "Square meters", "Pounds", "Kilograms", "Square inch", "Square yard", "Acre", "Square millimeter", "Square centimeter", "Hectare", "Ounce", "Gram", "Gallons", "Liters", "Kilowatts", "Cubic meters" - `PassengerFlight` (array, required) - `PassengerFlight.@type` (string) Discriminator. No child classes. Example: "PassengerFlight" - `PassengerFlight.passengerQuantity` (integer) Number of passengers of the specified passenger type code. Example: 26 - `PassengerFlight.passengerTypeCode` (string) Passenger type code applicable to the offer/offering. This may be different to the requested passenger type code sent in PassengerCriteria. Example: "ADT" - `PassengerFlight.FlightProduct` (array) - `PassengerFlight.FlightProduct.@type` (string) Discriminator. No child classes. Example: "FlightProduct" - `PassengerFlight.FlightProduct.segmentSequence` (array, required) Order of the corresponding flight in the sequence. Note that the segmentSequence value for connecting flights is the same; for example, for two connecting flights on the outbound or first leg of the itinerary, both flights have the segmentSequence value 1. Example: [1] - `PassengerFlight.FlightProduct.classOfService` (string) The class of service code. Example: "F" - `PassengerFlight.FlightProduct.cabin` (string) Specifies the cabin type. If sent for Flight Specific Search, this field is ignored. Many carriers use Business and First as the same cabin. If the request is for Business and only First is available, the response returns only First and returns a message that the cabin class may differ from the class requested. Some carriers do not support lowFareFinderInd with Premium First cabin class. Enum: "PremiumFirst", "First", "Business", "PremiumEconomy", "Economy" - `PassengerFlight.FlightProduct.fareBasisCode` (string) Fare basis code for the flight. For NDC, also returns the ticket designator after a slash (/) following the fare basis code. GDS ticket designators are returned in ticketDesignator." Example: "YEE1Y" - `PassengerFlight.FlightProduct.fareType` (string) Indicates the type of fare that applies to this Offer/Offering. NetFare is not supported for NDC. Enum: "PublicFare", "AgencyPrivateFare", "AirlinePrivateFare", "NetFare" - `PassengerFlight.FlightProduct.carCode` (string) The car code or deal code. Net remit. May be a Commercial Airline Agreement number." AirPrice returns the net ticket data (NTD) if a fare returned has a private fare component and private fares were requested (fareType of AgencyPrivateFare). GDS only; not supported for NDC. Example: "P1234" - `PassengerFlight.FlightProduct.valueCode` (string) The value code for the fare. Net remit. AirPrice returns the net ticket data (NTD) if a fare returned has a private fare component and private fares were requested (fareType of AgencyPrivateFare). GDS only; not supported for NDC. Example: "365" - `PassengerFlight.FlightProduct.Brand` (object) Brand ID parent class, returned for branded fares. - `name` (string, required) Brand name from the supplier. Example: "Main Cabin Extra" - `tier` (integer) The brand tier. Not returned for NDC. Example: 2 - `shelfNumbers` (array) ATPCO shelf number. If the carrier has provided it for this brand, the shelf number is the number for a grouping of comparable brands that share similar ticket and flight attributes. Example: [1,4,5] - `code` (string) The ATPCO Brand Code. Example: "REFMAIN" - `BrandAttribute` (array) A list of enumerated features that are included, chargeable, or not offered for this brand. Contains one or more instances of the two paired key value pairs classification and inclusion. The return of brand attributes can be disabled in the AirPrice Reference Payload request. - `AdditionalBrandAttribute` (array) Array of non-enumerated features that are included, chargeable, or not offered for this brand. Contains one or more instances of the two paired key value pairs classification and inclusion. - `ImageURL` (array) Example: ["http:/imageurl.com"] - `PassengerFlight.FlightProduct.Brand.@type` (string, required) Discriminator. Child classes BrandID and Brand. BrandCompleteInfo is no longer in use. Example: "BrandID" - `PassengerFlight.FlightProduct.Brand.id` (string) Local id within a given message to support referencing this object. Example: "brand_001" - `PassengerFlight.FlightProduct.Brand.BrandRef` (string) Reference id that corresponds to the brand 'id' in ReferenceListBrand.Brand. Example: "brandRef_001" - `PassengerFlight.FlightProduct.Brand.Identifier` (object) A globally unique identifier key often used to reference a given option (such as Pricing, Booking, Rules, or additional workflows) or to retrieve information (such as Hotel pagination). - `PassengerFlight.FlightProduct.CustomerLoyaltyCredit` (array) - `PassengerFlight.FlightProduct.ClassOfServiceAvailability` (array) - `PassengerFlight.FlightProduct.stopoverPriced` (string) Yes , No , Unknown Enum: same as `instantPurchase` in "AdvanceReservationRequired" (3 values) - `PassengerFlight.FlightProduct.ticketDesignator` (string) GDS only; not supported for NDC. (NDC ticket designators are returned in fareBasisCode after a slash (/), following the fare basis code.) Returns the ticket designator for GDS. The ticket designator is a code used by airlines to indicate the type of discount applied to a fare. An airline may have a specific ticket designator used to differentiate its fares, which may also signify anything from private fares, wholesale, promotion, or discounted fares." Example: "BB5662Y" - `PassengerFlight.FlightProduct.fareTypeCode` (string) GDS only; not supported for NDC. Identifies whether the fare is bundled or unbundled by providing the ATPCO defined fare type code when the coresponding response includes unbundled fares." Example: "ERU" - `PassengerFlight.FlightProduct.FareQualifierString` (string) NDC only. Not supported for GDS. Fare qualifier of a private leisure fares. Example: "[\"Tour\"]" - `PassengerFlight.FlightProduct.FareQualifier` (object) deprecated - do not use - `PassengerFlight.FlightProduct.FareQualifier.value` (string) Deprecated - do not use. Replaced by FareQualiferString Enum: "Consolidator", "Government", "Marine", "Military", "Reward", "StandBy", "Staff", "Student", "Tour", "Youth", "VistFriendsAndRelatives" - ProductAncillary: - `Ancillary` (object) - `FlightRef` (array) The list of travel segments the ancillary applies to - `Ancillary.@type` (string, required) Discriminator classes Ancillary, AncillaryAir, AncillaryAirBaggage, and AncillaryAirSeat Example: "AncillaryAir" - `Ancillary.quantity` (integer) The quantity value - `Ancillary.Description` (array) - `Ancillary.Description.value` (string) The text description of the ancillary. Example: "Vegetarian Meal" - `Ancillary.Description.code` (string) The ATPCO group code. Example: "BG" - `Ancillary.Description.subCode` (string) The ATPCO RFISC subcode. Example: "0D4" - `Ancillary.Description.subGroup` (string) The ATPCO sub group code. Example: "SP" - `Ancillary.Description.codeContext` (string) The code context value. Example: "ATPCO" - `Ancillary.Description.ssrCode` (string) The four character AIRIMP SSR code for this ancillary. Example: "VGML" - `Ancillary.Description.issuanceReasonCode` (string) The airline provided reason for issuance code. Example: "C" - `Ancillary.Description.geographicSpecification` (string) How the ancillary is applied across the itinerary. Enum: "Sector", "Portion", "Journey" - `Ancillary.Comments` (object) Comments object to relay free text information In ProductAncillary.Ancillary this is used to expose when additional comments are required to book the ancillary. In BuildAncillaryOffersFromCatalogOfferings this is used to pass additional ancillary text required to book the ancillary. - `Ancillary.Comments.@type` (string) Example: "Comments" - `Ancillary.Comments.Comment` (array) - `Ancillary.Comments.Comment.value` (string) Actual text. May be restricted by character limits based on the type of comment (e.g. Notepad remarks limited to 87 characters). Example: "Additional comments" - `Ancillary.Comments.Comment.id` (string) Local identifier within a given message for this object. Example: "comment_1" - `Ancillary.Comments.Comment.name` (string) Title of comment or type of remark. Example: "Comment name" - `Ancillary.Comments.Comment.language` (string) Language code using ISO-639 standard Example: "EN" - `selectedByDefaultInd` (boolean) - `bundledInd` (boolean) If true, this product is the lead ancillary bundle and is followed by a list of individual ancillary products. - ProductSeatAvailability: - `SeatAvailability` (array, required) - `SeatAvailability.value` (array) - `SeatAvailability.seatAvailabilityStatus` (string) The list of availabile statuses of the seat for a traveler. Enum: "Available", "Blocked", "Reserved", "Unavailable", "Requested", "NoSeat", "Pending" - `SeatAvailability.codeContext` (string) The code context value Example: "ATPCO" - `SeatAvailability.paidSeatInd` (boolean) If true, the seat is a paid ancillary seat. This seat may be zero value due to traveler specific conditions - `Brand` (object) Brand ID parent class, returned for branded fares. - `name` (string, required) Brand name from the supplier. Example: "Main Cabin Extra" - `tier` (integer) The brand tier. Not returned for NDC. Example: 2 - `shelfNumbers` (array) ATPCO shelf number. If the carrier has provided it for this brand, the shelf number is the number for a grouping of comparable brands that share similar ticket and flight attributes. Example: [1,4,5] - `code` (string) The ATPCO Brand Code. Example: "REFMAIN" - `BrandAttribute` (array) A list of enumerated features that are included, chargeable, or not offered for this brand. Contains one or more instances of the two paired key value pairs classification and inclusion. The return of brand attributes can be disabled in the AirPrice Reference Payload request. - `BrandAttribute.@type` (string, required) Discriminator. No child classes. Example: "BrandAttribute" - `BrandAttribute.classification` (string, required) The Travelport classification used for a category of ancillaries. Additional items can be sent in AdditionalClassification Enum: "CheckedBag", "CarryOn", "PersonalItem", "Rebooking", "Refund", "SeatAssignment", "PremiumSeat", "LieFlatSeat", "Meals", "WiFi", "Other" - `BrandAttribute.inclusion` (string, required) The indicator as to how the brand and the product are associated. Enum: "Included", "Chargeable", "Not Offered" - `BrandAttribute.ImageURL` (array) URL for an image for the brand, when available. Example: ["http:/imageurl.com"] - `BrandAttribute.matchedAttributeInd` (boolean) Returned only if true for any attribute requested in ProductInclusionPreference.Classification. Example: true - `BrandAttribute.groupCode` (string) Carrier group code. Returned if filed by the carrier. Example: "BG" - `BrandAttribute.subGroupCode` (string) Carrier sub group code. Returned if filed by the carrier. Example: "CY" - `BrandAttribute.subCode` (string) Carrier sub code. Returned if filed by the carrier. Example: "08A" - `AdditionalBrandAttribute` (array) Array of non-enumerated features that are included, chargeable, or not offered for this brand. Contains one or more instances of the two paired key value pairs classification and inclusion. - `AdditionalBrandAttribute.@type` (string, required) Discriminator. No child classes. Example: "AdditionalBrandAttribute" - `AdditionalBrandAttribute.Classification` (string, required) The Travelport classification used for categories of ancillaries. Supported attributes currently include ChauffeurTransfer, ExtraLegroom, InFlightEntertainment, LoungeAccess, PriorityBaggage, PriorityBoarding, PriorityCheckIn, PrioritySecurity, PriorityServices,MileageAccrual, Upgrades, USB. Example: "ChauffeurTransfer" - `AdditionalBrandAttribute.Inclusion` (string, required) The indicator as to how the brand and the product are associated. Enum: same as `BrandAttribute.inclusion` (3 values) - `AdditionalBrandAttribute.ImageURL` (array) URL for an image for the brand, when available. Example: ["https:/travelport/image/profile/firstviewimage"] - `AdditionalBrandAttribute.matchedAttributeInd` (boolean) Returned only if true for any attribute requested in ProductInclusionPreference.Classification. Example: true - `AdditionalBrandAttribute.groupCode` (string) Carrier group code. Returned if filed by the carrier. Example: "BG" - `AdditionalBrandAttribute.subGroupCode` (string) Carrier sub group code. Returned if filed by the carrier. Example: "CY" - `AdditionalBrandAttribute.subCode` (string) Carrier sub code. Returned if filed by the carrier. Example: "08A" - `ImageURL` (array) Example: ["http:/imageurl.com"] - `Brand.@type` (string, required) Discriminator. Child classes BrandID and Brand. BrandCompleteInfo is no longer in use. Example: "BrandID" - `Brand.id` (string) Local id within a given message to support referencing this object. Example: "brand_001" - `Brand.BrandRef` (string) Reference id that corresponds to the brand 'id' in ReferenceListBrand.Brand. Example: "brandRef_001" - `Brand.Identifier` (object) A globally unique identifier key often used to reference a given option (such as Pricing, Booking, Rules, or additional workflows) or to retrieve information (such as Hotel pagination). - `SeatingChartRef` (string) The reference id of the SeatingChart in the reference list - ProductHospitality: - `bookingCode` (string) Send the value returned from the Availability response ProductOptions/ProductBooking. - `passiveBookingReasonCode` (string) Enum: "G", "H", "I", "N", "P", "R", "U", "V" - `guests` (integer) Total number of guests. Numeric values 1-9 inclusive supported. - `moreRatesToken` (string) More rates token - `adaCompliant` (string) Yes , No , Unknown Enum: same as `instantPurchase` in "AdvanceReservationRequired" (3 values) - `propertyName` (string) Name of property offering this product. Example: "Hilton Garden Inn Brighton" - `associatedCityCode` (string) The logistically closest city associated to the property Example: "LON" - `associatedAirportCode` (string) The logistically closest airport associated to the property Example: "LGW" - `PropertyAddress` (object) The property or billing address information. - `addressType` (string) OTA code for address type Example: "CLT" - `use` (string) OTA code for address use Example: "AUT" - `Comment` (object) Textual information. - `Comment.value` (string) Actual text. May be restricted by character limits based on the type of comment (e.g. Notepad remarks limited to 87 characters). Example: "Additional comments" - `Comment.id` (string) Local identifier within a given message for this object. Example: "comment_1" - `Comment.name` (string) Title of comment or type of remark. Example: "Comment name" - `Comment.language` (string) Language code using ISO-639 standard Example: "EN" - `Privacy` (object) Confidential details for marketing purpose - `Privacy.id` (string) Optional internally referenced id Example: "2" - `Privacy.shareMarketing` (string) Used to indicate marketing preferences, Yes, No, Inherit Enum: "Yes", "No", "Inherit" - `Privacy.shareSync` (string) Used to indicate marketing preferences, Yes, No, Inherit Enum: same as `Privacy.shareMarketing` (3 values) - `Privacy.optOutInd` (string) Used to indicate marketing preferences, Yes, No, Inherit Enum: same as `Privacy.shareMarketing` (3 values) - `Privacy.optInStatus` (string) Used to indicate marketing preferences, OptIn, OptOut Enum: "OptedIn", "OptedOut", "Unknown" - `Privacy.optInDate` (string) The datetime of receiving the opt in notice Example: "2026-08-07T12:12:00Z" - `Privacy.optOutDate` (string) The datetime the opt out notice was received Example: "2026-08-07T12:12:00Z" - `Priority` (integer) The priority ranking within the group Example: 1 - `validInd` (boolean) If true, this is a valid and complete mailing address that has been verified through an address verification service or previously mailed materials have not been returned. - `provisionedInd` (boolean) If true, this address came into the system through provisioning - `PropertyAddress.@type` (string, required) Discriminator classes Address or AddressDetail Example: "AddressDetail" - `PropertyAddress.id` (string) unique address id Example: "Address_1" - `PropertyAddress.BldgRoom` (object) Address with building and room number - `PropertyAddress.BldgRoom.value` (string) Example: "Moore House" - `PropertyAddress.BldgRoom.buldingInd` (boolean) When true, the information is a building name. When false, it is an apartment or room # Example: true - `PropertyAddress.Number` (object) The street number alone is the numerical number that precedes the street name in the address. - `PropertyAddress.Number.value` (string) Street number value. Example: "23B" - `PropertyAddress.Number.streetNmbrSuffix` (string) Street Number Suffix Example: "B" - `PropertyAddress.Number.streetDirection` (string) Direction of the Street Example: "NW" - `PropertyAddress.Number.ruralRouteNmbr` (string) RuralRoute Number Example: "76" - `PropertyAddress.Number.po_Box` (string) PO Box Number Example: "1001" - `PropertyAddress.Street` (string) Street name. May also contain the street number when the Number element is missing. Example: "ABC Street" - `PropertyAddress.AddressLine` (array) Property street address. Used in place of Street and Number. Each element of the array represents an address line. Example: ["2035 S Havana street"] - `PropertyAddress.City` (string, required) Full name of the city, town, or postal station (i.e., a postal service territory, often used in a military address). Example: "Dublin" - `PropertyAddress.County` (string) County or Region Name. Example: "Berkshire" - `PropertyAddress.StateProv` (object) The standard code or abbreviation for the state, province, or region. May also include full length name. - `PropertyAddress.StateProv.value` (string) State, province, or region code needed to identify location (typically two characters). Example: "CA" - `PropertyAddress.StateProv.name` (string) State, province, or region name needed to identify location. Example: "California" - `PropertyAddress.Country` (object) Contains the information needed to identify a country. - `PropertyAddress.Country.value` (string) The ISO 3166 code for the property's address. Example: "US" - `PropertyAddress.Country.id` (string) Custom user-assigned identifier for the country. Example: "23" - `PropertyAddress.Country.name` (string) The full name of the country for the property's address. Example: "United States" - `PropertyAddress.Country.codeContext` (string) The source of a code, such as the organization that provided the id number Example: "IATA" - `PropertyAddress.PostalCode` (string) Postal code for the address. Example: "Sl6 1AB" - `PropertyAddress.Addressee` (string) The name of the company or person to be addressed Example: "ACME INC" - `PropertyAddress.role` (string) Defines the type of location the address is assigned to. For TravelAgency address leave blank or use "Other". Enum: "Home", "Business", "Mailing", "Delivery", "Destination", "Other", "Billing" - `Telephone` (object) - `phoneLocationType` (string) Location of the phone Example: "Agency" - `phoneTechType` (string) Indicates the type of technology associated with the telephone number Example: "Voice" - `phoneUseType` (string) Agency code for how phone is used (e.g., Home, Business, Emergency Contact, Travel Arranger, Day, Evening). Example: "Home" - `pin` (string) Additional codes used for telephone Example: "3456" - `priority` (integer) Priority Example: 1 - `Privacy` (object) Confidential details for marketing purpose - `Privacy.id` (string) Optional internally referenced id Example: "2" - `Privacy.shareMarketing` (string) Used to indicate marketing preferences, Yes, No, Inherit Enum: same as `Privacy.shareMarketing` (3 values) - `Privacy.shareSync` (string) Used to indicate marketing preferences, Yes, No, Inherit Enum: same as `Privacy.shareMarketing` (3 values) - `Privacy.optOutInd` (string) Used to indicate marketing preferences, Yes, No, Inherit Enum: same as `Privacy.shareMarketing` (3 values) - `Privacy.optInStatus` (string) Used to indicate marketing preferences, OptIn, OptOut Enum: same as `Privacy.optInStatus` (3 values) - `Privacy.optInDate` (string) The datetime of receiving the opt in notice Example: "2026-08-07T12:12:00Z" - `Privacy.optOutDate` (string) The datetime the opt out notice was received Example: "2026-08-07T12:12:00Z" - `Enum_TelephoneRole` (string) Defines the type of location the Telephone is assigned to. For Travel Agency telephone select "Other" or leave blank. Enum: "Mobile", "Home", "Work", "Office", "Fax", "Other" - `Comment` (object) Textual information. - `Comment.value` (string) Actual text. May be restricted by character limits based on the type of comment (e.g. Notepad remarks limited to 87 characters). Example: "Additional comments" - `Comment.id` (string) Local identifier within a given message for this object. Example: "comment_1" - `Comment.name` (string) Title of comment or type of remark. Example: "Comment name" - `Comment.language` (string) Language code using ISO-639 standard Example: "EN" - `defaultInd` (boolean) When true, indicates a default value should be used. Example: true - `provisionedInd` (boolean) true indicates this phone number was created through provisioned - `Telephone.@type` (string, required) Discriminator classes Telephone or TelephoneDetail Example: "Telephone" - `Telephone.countryAccessCode` (string) Phone country code Example: "1" - `Telephone.areaCityCode` (string) Phone local area code Example: "972" - `Telephone.phoneNumber` (string, required) Mobile/Telephone Number. Accepted characters are numeric, dash, space, and period. Example: "972-000-787" - `Telephone.extension` (string) Telephone extension number Example: "234" - `Telephone.id` (string) Optional internally referenced id Example: "3" - `Telephone.cityCode` (string) IATA city code if referenced by phone number. Example: "DEN" - `Telephone.role` (string) Defines the type of location the Telephone is assigned to. For Travel Agency telephone select "Other" or leave blank. Enum: same as `Enum_TelephoneRole` (6 values) - `Email` (object) Electronic email addresses, in IETF specified format. Booking.com requires a traveler email address in the Hotel Create Reservation and Add Reservation requests. A system-generated confirmation email is sent to the traveler after the booking completes. - `Email.value` (string) Example: "exampledomain@example.com" - `Email.id` (string) Electronic email addresses, in IETF specified format. Example: "email_1" - `Email.emailType` (string) Use email type to specify if the email is to be sent "TO" or sent "FROM" Example: "FROM" - `Email.comment` (string) Comments associated to the email - `Email.preferredFormat` (string) Mime media type Example: "text/html" - `Email.shareMarketing` (string) Used to indicate marketing preferences, Yes, No, Inherit Enum: same as `Privacy.shareMarketing` (3 values) - `Email.shareSync` (string) Used to indicate marketing preferences, Yes, No, Inherit Enum: same as `Privacy.shareMarketing` (3 values) - `Email.optOutInd` (string) Used to indicate marketing preferences, Yes, No, Inherit Enum: same as `Privacy.shareMarketing` (3 values) - `Email.optInStatus` (string) Used to indicate marketing preferences, OptIn, OptOut Enum: same as `Privacy.optInStatus` (3 values) - `Email.optInDate` (string) The datetime of receiving the opt in notice Example: "2026-03-03T11:11:00Z" - `Email.optOutDate` (string) The datetime the opt out notice was received Example: "2026-03-03T11:11:00Z" - `Email.validInd` (boolean) If true, this is a valid email address that has been system verified via a successful email transmission. Example: true - `Email.provisionedInd` (boolean) If true then the email address came from the provisioning process Example: true - `GuestCounts` (object) The number and age(s) of guests within the room. - `GuestCounts.@type` (string) Example: "GuestCounts" - `GuestCounts.GuestCount` (array, required) - `GuestCounts.GuestCount.@type` (string) Example: "GuestCount" - `GuestCounts.GuestCount.age` (integer) The age of the guest. Required only when request includes a child in the room. Example: 21 - `GuestCounts.GuestCount.count` (integer) Number of guests. Supports numeric values 1-9 inclusive. Example: 2 - `GuestCounts.GuestCount.ageQualifyingCode` (string) "Required only for children or if traveler age is relevant, such as for a senior discount. Supported values include '8' and '10'. 8: Traveler in this GuestCount is a child. 10: Traveler in this GuestCount is an adult." Example: "10" - `PropertyKey` (object, required) Contains up to 250 PropertyKey objects. Each PropertyKey object identifies one property. - `PropertyKey.@type` (string) - `PropertyKey.chainCode` (string, required) Code for the hotel chain (typically 2 characters) Example: "UR" - `PropertyKey.propertyCode` (string, required) The property code of the requested property (typically 5 characters). Example: "G3375" - `TravelerContact` (object) Identifies the traveler contact information delivered to the hotel supplier for this segment - `TravelerContact.@type` (string, required) Example: "TravelerContact" - `TravelerContact.Email` (object) Electronic email addresses, in IETF specified format. Booking.com requires a traveler email address in the Hotel Create Reservation and Add Reservation requests. A system-generated confirmation email is sent to the traveler after the booking completes. - `TravelerContact.Telephone` (object) - `phoneLocationType` (string) Location of the phone Example: "Agency" - `phoneTechType` (string) Indicates the type of technology associated with the telephone number Example: "Voice" - `phoneUseType` (string) Agency code for how phone is used (e.g., Home, Business, Emergency Contact, Travel Arranger, Day, Evening). Example: "Home" - `pin` (string) Additional codes used for telephone Example: "3456" - `priority` (integer) Priority Example: 1 - `Privacy` (object) Confidential details for marketing purpose - `Privacy.id` (string) Optional internally referenced id Example: "2" - `Privacy.shareMarketing` (string) Used to indicate marketing preferences, Yes, No, Inherit Enum: same as `Privacy.shareMarketing` (3 values) - `Privacy.shareSync` (string) Used to indicate marketing preferences, Yes, No, Inherit Enum: same as `Privacy.shareMarketing` (3 values) - `Privacy.optOutInd` (string) Used to indicate marketing preferences, Yes, No, Inherit Enum: same as `Privacy.shareMarketing` (3 values) - `Privacy.optInStatus` (string) Used to indicate marketing preferences, OptIn, OptOut Enum: same as `Privacy.optInStatus` (3 values) - `Privacy.optInDate` (string) The datetime of receiving the opt in notice Example: "2026-08-07T12:12:00Z" - `Privacy.optOutDate` (string) The datetime the opt out notice was received Example: "2026-08-07T12:12:00Z" - `Enum_TelephoneRole` (string) Defines the type of location the Telephone is assigned to. For Travel Agency telephone select "Other" or leave blank. Enum: same as `Enum_TelephoneRole` (6 values) - `Comment` (object) Textual information. - `Comment.value` (string) Actual text. May be restricted by character limits based on the type of comment (e.g. Notepad remarks limited to 87 characters). Example: "Additional comments" - `Comment.id` (string) Local identifier within a given message for this object. Example: "comment_1" - `Comment.name` (string) Title of comment or type of remark. Example: "Comment name" - `Comment.language` (string) Language code using ISO-639 standard Example: "EN" - `defaultInd` (boolean) When true, indicates a default value should be used. Example: true - `provisionedInd` (boolean) true indicates this phone number was created through provisioned - `RoomType` (object) Provides details regarding rooms, such as characteristics, descriptions, and amenities. - `numberOfUnits` (integer) The number of rooms that have been combined to create this room type. - `reqdGuaranteeType` (string) TODO-(Should this be Guarantee?)Denotes the form of guarantee for this room. - `AdditionalDetails` (object) A collection of AdditionalDetail. - `AdditionalDetails.@type` (string) Example: "AdditionalDetails" - `AdditionalDetails.AdditionalDetail` (array, required) - `AdditionalDetails.AdditionalDetail.@type` (string) Example: "AdditionalDetail" - `AdditionalDetails.AdditionalDetail.detailType` (string) OTA Code - `AdditionalDetails.AdditionalDetail.code` (string) Partner code - `AdditionalDetails.AdditionalDetail.Amount` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `AdditionalDetails.AdditionalDetail.Amount.value` (number) The amount of a given currency. Example: 124.56 - `AdditionalDetails.AdditionalDetail.Amount.code` (string) An ISO 4217 alpha character code (3 characters) that specifies a money unit. Example: "USD" - `AdditionalDetails.AdditionalDetail.Amount.minorUnit` (integer) Minor units are a mechanism for expressing the relationship between a major currency unit and its corresponding minor currency unit. It is the smallest unit of a given currency. For example; the smallest denomination in USD is the cent, which is 1/100 of a USD, and the minor unit value is 2. Not all currencies have a minor unit. Example: 2 - `AdditionalDetails.AdditionalDetail.Amount.currencySource` (string) The system requesting or returning the currency code specified in the attribute Enum: same as `MinimumAdcolAmount.currencySource` in "ChangePermitted" (3 values) - `AdditionalDetails.AdditionalDetail.Amount.approximateInd` (boolean) "If true, the currency amount has been converted from the original amount. For Air Exchange Eligibility, returned only if a currency is converted. If returned, the value is always true, indicating that the fee is approximate because of currency conversion. For Hotel Availability and Rules, true indicates this is a calculated value; false indicates this is the value returned by the property." Example: true - `AdditionalDetails.AdditionalDetail.Description` (object) A descriptive text string and the related language. - `RoomOccupancy` (array) - `RoomOccupancy.@type` (string) - `RoomOccupancy.minOccupancy` (integer) The minimum occupancy - `RoomOccupancy.maxOccupancy` (integer) The maximum number of room occupants. - `RoomOccupancy.AgeQualifying` (array) - `RoomOccupancy.AgeQualifying.@type` (string) Example: "AgeQualifying" - `RoomOccupancy.AgeQualifying.minAge` (integer) MinAge: The minimum age to qualify for AgeQualifyingCode. - `RoomOccupancy.AgeQualifying.maxAge` (integer) Max Age: The maximum age to qualify for AgeQualifyingCode. - `RoomOccupancy.AgeQualifying.ageBucket` (string) The age bucket - `RoomOccupancy.AgeQualifying.count` (integer) The number of age qualifying - `RoomOccupancy.AgeQualifying.ageQualifyingCode` (string) Enter 10 for an adult or 08 for a child Example: "10" - `roomInd` (boolean) Indicates the room is a sleeping room when true. - `convertedInd` (boolean) Indicates the room is converted when true. - `alternateInd` (boolean) Indicates the room is an alternate room type to the requested room type when true. - `RoomType.@type` (string, required) Example: "RoomType" - `RoomType.RoomCharacteristics` (object) Used to define a room (eg. its location, configuration, view). - `RoomType.RoomCharacteristics.@type` (string) - `RoomType.RoomCharacteristics.typeCode` (string) OTA room type code. - `RoomType.RoomCharacteristics.viewCode` (string) OTA code describing the view. - `RoomType.RoomCharacteristics.viewDescription` (string) Free text describing the view Example: "Mountain View" - `RoomType.RoomCharacteristics.smokingAllowed` (string) Yes , No , Unknown Enum: same as `instantPurchase` in "AdvanceReservationRequired" (3 values) - `RoomType.RoomCharacteristics.wifiIncluded` (string) Yes , No , Unknown Enum: same as `instantPurchase` in "AdvanceReservationRequired" (3 values) - `RoomType.RoomCharacteristics.BedConfiguration` (array) - `RoomType.RoomCharacteristics.BedConfiguration.quantity` (integer) The number of beds of a specified type in the room. - `RoomType.RoomCharacteristics.BedConfiguration.bedType` (string) Bed type. Possible values include King Bed(s), Queen Bed(s), Twin Bed(s), Sofa Bed(s), and OTHER Bed(s). - `RoomType.RoomCharacteristics.BedConfiguration.size` (string) Approximate measurement/size of the bed(s) in the room. - `RoomType.RoomCharacteristics.nonSmokingInd` (boolean) - `RoomType.RoomCharacteristics.accessibleRoom` (string) Yes , No , Unknown Enum: same as `instantPurchase` in "AdvanceReservationRequired" (3 values) - `RoomType.RoomCharacteristics.category` (string) Category of the room. - `RoomType.RoomCharacteristics.shortRoomDescription` (string) Normalized text for grouping rates against similar room types. Example: "2 Queen bed(s) Standard Room Smoking" - `RoomType.Description` (object) A descriptive text string and the related language. - `RoomType.Description.value` (string) Descriptive text provided by the supplier. Example: "Ticket exchanged, room description text, or check in/out policy details." - `RoomType.Description.languages` (array) The language code of the description text. Example: ["English"] - `RoomType.Description.title` (string) Title of the Text Example: "Group details." - `RoomType.RoomAmenity` (array) - `RoomType.RoomAmenity.@type` (string) - `RoomType.RoomAmenity.description` (string) Description of amenity received from supplier. Example: "WiFi" - `RoomType.RoomAmenity.quantity` (integer) quantity of amenity - `RoomType.RoomAmenity.Name` (string) Room Amenity Name Example: "24 hour Room Service" - `RoomType.RoomAmenity.Inclusion` (array) - `RoomType.RoomAmenity.includedInd` (boolean) Represents if the amenity is included with the rate - `RoomType.RoomAmenity.surchargeInd` (boolean) Represents if the amenity attracts a surcharge. - `RoomType.RoomAmenity.code` (string) OTA code used to describe the room amenity. This is optional in the Properties Search request but mandatory in the response. - `DateRange` (object) Specifies the begin and end date of an event, such as check-in and check-out dates. - `DateRange.start` (string, required) Specifies the start date for an event, such as a booking or check-in date in YYYY-MM-DD format. Example: "2026-03-03" - `DateRange.end` (string, required) Specifies the end date an event, such as a booking or check-out date in YYYY-MM-DD format. Example: "2026-03-03" - `SpecialInstruction` (string) Customer generated special instructions transmitted to the hotel. Example: "Guest prefers room on first floor." - ProductVehicle: - `Vehicle` (object) Vehicles such as rental cars, buses, trams, motorcycles. - `Vehicle.@type` (string, required) Example: "VehicleDetail" - `Vehicle.TransmissionTypeCode` (object) Any code used to specify an item, for example a type of traveler, service code, room amenity, etc. - `Vehicle.TransmissionTypeCode.value` (string) Example: "INS" - `Vehicle.TransmissionTypeCode.codeContext` (string) Code Context Example: "ACRISS" - `Vehicle.VehicleCategoryCode` (object) Any code used to specify an item, for example a type of traveler, service code, room amenity, etc. - `Vehicle.FuelTypeCode` (object) Any code used to specify an item, for example a type of traveler, service code, room amenity, etc. - `Vehicle.VehicleSizeCode` (object) Any code used to specify an item, for example a type of traveler, service code, room amenity, etc. - `Vehicle.VehicleClassCode` (object) Any code used to specify an item, for example a type of traveler, service code, room amenity, etc. - `Vehicle.baggageQuantity` (integer) Baggage Quantity that is able to fit into the car with passengers - `Vehicle.passengerQuantity` (string) Assigned Type: c-1100:StringTiny - `Vehicle.doorCount` (string) The number of doors for the vehicle - `Vehicle.Image` (object) Each instance is one image and its accompanying details, including a link to the image. Key value pairs; not all may be returned. - `Vehicle.Image.value` (string) URL of the image - `Vehicle.Image.dimensionCategory` (string) Deprecated and replaced by imageSize - `Vehicle.Image.width` (integer) Image width Example: 42 - `Vehicle.Image.height` (integer) Image height Example: 43 - `Vehicle.Image.caption` (string) Image caption Example: "Ticket" - `Vehicle.Image.pictureCategory` (integer) deprecated and replaced by pictureOf Example: 5 - `Vehicle.Image.imageSize` (string) A size for the image to return, allowing you to set image quality. Hospitality APIs no longer support thumbnail. Enum: "Large", "Medium", "Small", "Thumbnail", "ExtraLarge" - `Vehicle.Image.pictureOf` (string) The image category Enum: "Exterior", "Lobby", "Pool", "Restaurant", "HealthClub", "GuestRoom", "Suite", "ConferenceRoom", "Ballroom", "Golf", "Beach", "Spa", "Bar", "Recreational", "RoomAmenity", "PropertyAmenity", "BusinessCentre", "Map", "Promotional", "Undefined", "Studio", "Attraction", "Other", "Amenity", "Logo", "MeetingRoom" - `Vehicle.VehicleMakeModel` (object) The make and model of the vehicle along with a description - `Vehicle.VehicleMakeModel.value` (string) - `Vehicle.VehicleMakeModel.code` (string) The 4 character code for the make and model of the vehicle. Example: "ECMR" - `Vehicle.VehicleMakeModel.supplierReference` (string) - `Vehicle.VehicleMakeModel.codeContext` (string) Code context Example: "ISO" - `Vehicle.VehicleMakeModel.vendorCode` (string) The 2 character vendor code Example: "ZI" - `Vehicle.VehicleMakeModel.operatingSupplierCode` (string) - `Vehicle.VehicleMakeModel.operatingSupplierName` (string) - `Vehicle.airConditioningInd` (boolean) True if vehicle has air conditioning - `Vehicle.VehicleDateLocation` (object) Pickup, return and vendor datetime and locations. - `Vehicle.VehicleDateLocation.@type` (string, required) Example: "VehicleDateLocation" - `Vehicle.VehicleDateLocation.RentalPickup` (object, required) - `Vehicle.VehicleDateLocation.RentalPickup.@type` (string, required) Example: "RentalPickup" - `Vehicle.VehicleDateLocation.RentalPickup.date` (string, required) The local date of the pickup or return Example: "2024-10-23" - `Vehicle.VehicleDateLocation.RentalPickup.time` (string, required) The local time of the pickup or return - `Vehicle.VehicleDateLocation.RentalPickup.VendorLocation` (object, required) The vendor's location number for pickup or return - `Vehicle.VehicleDateLocation.RentalPickup.VendorLocation.@type` (string, required) Example: "VendorLocation" - `Vehicle.VehicleDateLocation.RentalPickup.VendorLocation.rentalLocationNumber` (string) Assigned Type: ctvh-1100:RentalLocationNumber - `Vehicle.VehicleDateLocation.RentalPickup.VendorLocation.vendorCode` (string) The two character vendor code Example: "ZI" - `Vehicle.VehicleDateLocation.RentalPickup.VendorLocation.RentalLocationCode` (object) Locations based on the OTA VWF list - `Vehicle.VehicleDateLocation.RentalPickup.VendorLocation.RentalLocationCode.value` (string) Example: "INS" - `Vehicle.VehicleDateLocation.RentalPickup.VendorLocation.RentalLocationCode.codeContext` (string) Code Context Example: "ACRISS" - `Vehicle.VehicleDateLocation.RentalPickup.VendorLocation.CounterLocationCode` (object) Counter location of the vehicle rental - `Vehicle.VehicleDateLocation.RentalPickup.VendorLocation.CounterLocationCode.value` (string) Example: "INS" - `Vehicle.VehicleDateLocation.RentalPickup.VendorLocation.CounterLocationCode.codeContext` (string) Code Context Example: "ACRISS" - `Vehicle.VehicleDateLocation.RentalPickup.VendorLocation.rentalLocationName` (string) Assigned Type: c-1100:StringShort - `Vehicle.VehicleDateLocation.RentalPickup.VendorLocation.code` (string, required) The vendor location code - `Vehicle.VehicleDateLocation.RentalPickup.VendorLocation.Address` (object) The property or billing address information. - `addressType` (string) OTA code for address type Example: "CLT" - `use` (string) OTA code for address use Example: "AUT" - `Comment` (object) Textual information. - `Privacy` (object) Confidential details for marketing purpose - `Priority` (integer) The priority ranking within the group Example: 1 - `validInd` (boolean) If true, this is a valid and complete mailing address that has been verified through an address verification service or previously mailed materials have not been returned. - `provisionedInd` (boolean) If true, this address came into the system through provisioning - `Vehicle.VehicleDateLocation.RentalPickup.VendorLocation.Address.@type` (string, required) Discriminator classes Address or AddressDetail Example: "AddressDetail" - `Vehicle.VehicleDateLocation.RentalPickup.VendorLocation.Address.id` (string) unique address id Example: "Address_1" - `Vehicle.VehicleDateLocation.RentalPickup.VendorLocation.Address.BldgRoom` (object) Address with building and room number - `Vehicle.VehicleDateLocation.RentalPickup.VendorLocation.Address.Number` (object) The street number alone is the numerical number that precedes the street name in the address. - `Vehicle.VehicleDateLocation.RentalPickup.VendorLocation.Address.Street` (string) Street name. May also contain the street number when the Number element is missing. Example: "ABC Street" - `Vehicle.VehicleDateLocation.RentalPickup.VendorLocation.Address.AddressLine` (array) Property street address. Used in place of Street and Number. Each element of the array represents an address line. Example: ["2035 S Havana street"] - `Vehicle.VehicleDateLocation.RentalPickup.VendorLocation.Address.City` (string, required) Full name of the city, town, or postal station (i.e., a postal service territory, often used in a military address). Example: "Dublin" - `Vehicle.VehicleDateLocation.RentalPickup.VendorLocation.Address.County` (string) County or Region Name. Example: "Berkshire" - `Vehicle.VehicleDateLocation.RentalPickup.VendorLocation.Address.StateProv` (object) The standard code or abbreviation for the state, province, or region. May also include full length name. - `Vehicle.VehicleDateLocation.RentalPickup.VendorLocation.Address.Country` (object) Contains the information needed to identify a country. - `Vehicle.VehicleDateLocation.RentalPickup.VendorLocation.Address.PostalCode` (string) Postal code for the address. Example: "Sl6 1AB" - `Vehicle.VehicleDateLocation.RentalPickup.VendorLocation.Address.Addressee` (string) The name of the company or person to be addressed Example: "ACME INC" - `Vehicle.VehicleDateLocation.RentalPickup.VendorLocation.Address.role` (string) Defines the type of location the address is assigned to. For TravelAgency address leave blank or use "Other". Enum: same as `PropertyAddress.role` in "ProductHospitality" (7 values) - `Vehicle.VehicleDateLocation.RentalPickup.VendorLocation.Telephone` (array) - `phoneLocationType` (string) Location of the phone Example: "Agency" - `phoneTechType` (string) Indicates the type of technology associated with the telephone number Example: "Voice" - `phoneUseType` (string) Agency code for how phone is used (e.g., Home, Business, Emergency Contact, Travel Arranger, Day, Evening). Example: "Home" - `pin` (string) Additional codes used for telephone Example: "3456" - `priority` (integer) Priority Example: 1 - `Privacy` (object) Confidential details for marketing purpose - `Enum_TelephoneRole` (string) Defines the type of location the Telephone is assigned to. For Travel Agency telephone select "Other" or leave blank. Enum: same as `Enum_TelephoneRole` (6 values) - `Comment` (object) Textual information. - `defaultInd` (boolean) When true, indicates a default value should be used. Example: true - `provisionedInd` (boolean) true indicates this phone number was created through provisioned - `Vehicle.VehicleDateLocation.RentalPickup.VendorLocation.Description` (string) Detailed location information on where to pick up and return a vehicle - `Vehicle.VehicleDateLocation.RentalPickup.VendorLocation.OperationTimes` (array) - `Vehicle.VehicleDateLocation.RentalPickup.VendorLocation.Directions` (string) Directions for collecting the vehicle - `Vehicle.VehicleDateLocation.RentalPickup.VendorLocation.AdditionalInstructions` (string) Additional instructions regarding the vendor location - `Vehicle.VehicleDateLocation.RentalPickup.VendorLocation.ShuttleService` (string) Information on shuttle service - `Vehicle.VehicleDateLocation.RentalPickup.GeoLocation` (object) For Hotel: the geographic coordinates of the property. - `Vehicle.VehicleDateLocation.RentalPickup.GeoLocation.latitude` (number, required) Numeric value representing latitude of search center point in degrees and decimal minutes. Example: 38.8951 - `Vehicle.VehicleDateLocation.RentalPickup.GeoLocation.longitude` (number, required) Numeric value representing longitude of search center point in degrees and decimal minutes. Example: -77.0364 - `Vehicle.VehicleDateLocation.RentalPickup.GeoLocation.altitude` (number) The height of a location, typically measured above sea level Example: 5280 - `Vehicle.VehicleDateLocation.RentalPickup.GeoLocation.altitudeUnitOfDistance` (string) For Hotels: Optional object to request either miles or kilometers for the search radius from the specified location. If unitOfDistance is not specified, the search defaults to miles for properties in the United States, Myanmar, and Liberia. The search defaults to kilometers in all other countries. Enum: "Miles", "Kilometers" - `Vehicle.VehicleDateLocation.RentalPickup.GeoLocation.positionAccuracy` (string) Specifies the level of accuracy for the position Enum: "Zip9Code", "Zip7Code", "Zip5Code", "Street", "State", "Property", "Intersection", "Exact", "County", "City", "Block" - `Vehicle.VehicleDateLocation.RentalPickup.GeoLocation.mapURL` (string) link for embedded map showing location Example: "www.destinationmap.com" - `Vehicle.VehicleDateLocation.RentalPickup.GeoLocation.formatURL` (string) The URL to the format for the latitude and longitude for this location. Example: "www.destinationmap.com" - `Vehicle.VehicleDateLocation.RentalPickup.timeString` (string) - `Vehicle.VehicleDateLocation.RentalReturn` (object, required) - `Vehicle.VehicleDateLocation.RentalReturn.@type` (string, required) Example: "RentalReturn" - `Vehicle.VehicleDateLocation.RentalReturn.date` (string, required) The local date of the pickup or return Example: "2024-10-23" - `Vehicle.VehicleDateLocation.RentalReturn.time` (string, required) The local time of the pickup or return Example: "54000" - `Vehicle.VehicleDateLocation.RentalReturn.VendorLocation` (object, required) The vendor's location number for pickup or return - `Vehicle.VehicleDateLocation.RentalReturn.GeoLocation` (object) For Hotel: the geographic coordinates of the property. - `Product.@type` (string, required) Discriminator. - Air Search child classes are ProductAir and ProductAncillary. - Exchange Search child class is ProductAir. - Ancillary Search child class is ProductAncillary. - Seat Map child class is ProductSeatAvailability. - Air Price child classes are ProductAir and ProductAncillary. - Hotel Availability child classes are ProductHospitality and ProductHospitalityOffer. - Hotel Rules and HotelReservation child classes are ProductHospitality. - All Vehicle APIs child classes are ProductVehicle and ProductAncillaryVehicle. - Reservation and Reservation Workbench child classes are ProductAir, ProductAncillary, ProductHospitality, ProductVehicle, and ProductAncillaryVehicle. Example: "ProductAir" - `Product.id` (string) Local id within a given message to support referencing this object. Example: "product_1" - `Product.productRef` (string) Reference id that corresponds to the product 'id' in ReferenceListProduct.Product. To find flight details for a product, use the ProductRef id to identify the product in ReferenceListProduct.Product, and use the Flight id's (e.g., s3, s4) to match to flight information in ReferenceListFlight.Flight. Example: "product_1" - `Product.Identifier` (object) A globally unique identifier key often used to reference a given option (such as Pricing, Booking, Rules, or additional workflows) or to retrieve information (such as Hotel pagination). - `Product.Quantity` (integer) "The quantity of the product. For Hotel Create Reservation (Full Payload) request, the number of rooms requested; 1-9 inclusive supported. If not provided, default is 1. For Hotel responses, the number of rooms currently available matching this rate. In Air Search quantity represents the number of seats available for that Product. If the Product has connecting flights, Quantity returns the lowest number available. For example, if the first flight has 9 seats in Y class and the connecting flight has 4 seats in Y class, Quantity returns a value of 4." Example: 2 - ReferenceListTraveler: - `Traveler` (array) - `Traveler.@type` (string, required) Discriminator classes TravelerID or Traveler Example: "Traveler" - `Traveler.id` (string) - `Traveler.TravelerRef` (string) - `Traveler.Identifier` (object) A globally unique identifier key often used to reference a given option (such as Pricing, Booking, Rules, or additional workflows) or to retrieve information (such as Hotel pagination). - `Traveler.birthDate` (string) Date of Birth YYYY-MM-DD Example: "2021-06-05" - `Traveler.gender` (string) Gender Type Male, Female etc. This field is not used by Hotel APIs and will be ignored. Enum: "Male", "Female", "Unknown", "Undisclosed" - `Traveler.PersonName` (object, required) Travelport+ limits the combination of Given and Surname to 22 characters. Given name must have at least one character. Any PersonName exceeding 22 characters is truncated in the response. - `personNameType` (string) OTA Code Enum: "Former", "Nickname", "Alternate", "Maiden" - `language` (string) 'ISO639 code of the language the name is represented Example: "EN" - `SurnamePrefix` (string) The surname prefix Example: "Von" - `Suffix` (string) Hold various name suffixes and letters Example: "Jr." - `Title` (string) Degree or honors Example: "DR" - `Privacy` (object) Confidential details for marketing purpose - `Privacy.id` (string) Optional internally referenced id Example: "2" - `Privacy.shareMarketing` (string) Used to indicate marketing preferences, Yes, No, Inherit Enum: same as `Privacy.shareMarketing` (3 values) - `Privacy.shareSync` (string) Used to indicate marketing preferences, Yes, No, Inherit Enum: same as `Privacy.shareMarketing` (3 values) - `Privacy.optOutInd` (string) Used to indicate marketing preferences, Yes, No, Inherit Enum: same as `Privacy.shareMarketing` (3 values) - `Privacy.optInStatus` (string) Used to indicate marketing preferences, OptIn, OptOut Enum: same as `Privacy.optInStatus` (3 values) - `Privacy.optInDate` (string) The datetime of receiving the opt in notice Example: "2026-08-07T12:12:00Z" - `Privacy.optOutDate` (string) The datetime the opt out notice was received Example: "2026-08-07T12:12:00Z" - `defaultInd` (boolean) If true, this is the default or primary name within a collection of names. Example: true - `Traveler.PersonName.@type` (string, required) Discriminator classes PersonName or PersonNameDetail Example: "PersonNameDetail" - `Traveler.PersonName.Prefix` (string) Salutation of honorific (e.g. Mr., Mrs., Ms., Miss, Dr.) Example: "Mr" - `Traveler.PersonName.Given` (string) Given name, first name or names. Example: "John" - `Traveler.PersonName.Middle` (string) The middle name of the person name. Example: "Erick" - `Traveler.PersonName.Surname` (string, required) Family name, last name. Example: "Smith" - `Traveler.Address` (array) - `addressType` (string) OTA code for address type Example: "CLT" - `use` (string) OTA code for address use Example: "AUT" - `Comment` (object) Textual information. - `Comment.value` (string) Actual text. May be restricted by character limits based on the type of comment (e.g. Notepad remarks limited to 87 characters). Example: "Additional comments" - `Comment.id` (string) Local identifier within a given message for this object. Example: "comment_1" - `Comment.name` (string) Title of comment or type of remark. Example: "Comment name" - `Comment.language` (string) Language code using ISO-639 standard Example: "EN" - `Privacy` (object) Confidential details for marketing purpose - `Privacy.id` (string) Optional internally referenced id Example: "2" - `Privacy.shareMarketing` (string) Used to indicate marketing preferences, Yes, No, Inherit Enum: same as `Privacy.shareMarketing` (3 values) - `Privacy.shareSync` (string) Used to indicate marketing preferences, Yes, No, Inherit Enum: same as `Privacy.shareMarketing` (3 values) - `Privacy.optOutInd` (string) Used to indicate marketing preferences, Yes, No, Inherit Enum: same as `Privacy.shareMarketing` (3 values) - `Privacy.optInStatus` (string) Used to indicate marketing preferences, OptIn, OptOut Enum: same as `Privacy.optInStatus` (3 values) - `Privacy.optInDate` (string) The datetime of receiving the opt in notice Example: "2026-08-07T12:12:00Z" - `Privacy.optOutDate` (string) The datetime the opt out notice was received Example: "2026-08-07T12:12:00Z" - `Priority` (integer) The priority ranking within the group Example: 1 - `validInd` (boolean) If true, this is a valid and complete mailing address that has been verified through an address verification service or previously mailed materials have not been returned. - `provisionedInd` (boolean) If true, this address came into the system through provisioning - `Traveler.Address.@type` (string, required) Discriminator classes Address or AddressDetail Example: "AddressDetail" - `Traveler.Address.id` (string) unique address id Example: "Address_1" - `Traveler.Address.BldgRoom` (object) Address with building and room number - `Traveler.Address.BldgRoom.value` (string) Example: "Moore House" - `Traveler.Address.BldgRoom.buldingInd` (boolean) When true, the information is a building name. When false, it is an apartment or room # Example: true - `Traveler.Address.Number` (object) The street number alone is the numerical number that precedes the street name in the address. - `Traveler.Address.Number.value` (string) Street number value. Example: "23B" - `Traveler.Address.Number.streetNmbrSuffix` (string) Street Number Suffix Example: "B" - `Traveler.Address.Number.streetDirection` (string) Direction of the Street Example: "NW" - `Traveler.Address.Number.ruralRouteNmbr` (string) RuralRoute Number Example: "76" - `Traveler.Address.Number.po_Box` (string) PO Box Number Example: "1001" - `Traveler.Address.Street` (string) Street name. May also contain the street number when the Number element is missing. Example: "ABC Street" - `Traveler.Address.AddressLine` (array) Property street address. Used in place of Street and Number. Each element of the array represents an address line. Example: ["2035 S Havana street"] - `Traveler.Address.City` (string, required) Full name of the city, town, or postal station (i.e., a postal service territory, often used in a military address). Example: "Dublin" - `Traveler.Address.County` (string) County or Region Name. Example: "Berkshire" - `Traveler.Address.StateProv` (object) The standard code or abbreviation for the state, province, or region. May also include full length name. - `Traveler.Address.StateProv.value` (string) State, province, or region code needed to identify location (typically two characters). Example: "CA" - `Traveler.Address.StateProv.name` (string) State, province, or region name needed to identify location. Example: "California" - `Traveler.Address.Country` (object) Contains the information needed to identify a country. - `Traveler.Address.Country.value` (string) The ISO 3166 code for the property's address. Example: "US" - `Traveler.Address.Country.id` (string) Custom user-assigned identifier for the country. Example: "23" - `Traveler.Address.Country.name` (string) The full name of the country for the property's address. Example: "United States" - `Traveler.Address.Country.codeContext` (string) The source of a code, such as the organization that provided the id number Example: "IATA" - `Traveler.Address.PostalCode` (string) Postal code for the address. Example: "Sl6 1AB" - `Traveler.Address.Addressee` (string) The name of the company or person to be addressed Example: "ACME INC" - `Traveler.Address.role` (string) Defines the type of location the address is assigned to. For TravelAgency address leave blank or use "Other". Enum: same as `PropertyAddress.role` in "ProductHospitality" (7 values) - `Traveler.Telephone` (array) - `phoneLocationType` (string) Location of the phone Example: "Agency" - `phoneTechType` (string) Indicates the type of technology associated with the telephone number Example: "Voice" - `phoneUseType` (string) Agency code for how phone is used (e.g., Home, Business, Emergency Contact, Travel Arranger, Day, Evening). Example: "Home" - `pin` (string) Additional codes used for telephone Example: "3456" - `priority` (integer) Priority Example: 1 - `Privacy` (object) Confidential details for marketing purpose - `Privacy.id` (string) Optional internally referenced id Example: "2" - `Privacy.shareMarketing` (string) Used to indicate marketing preferences, Yes, No, Inherit Enum: same as `Privacy.shareMarketing` (3 values) - `Privacy.shareSync` (string) Used to indicate marketing preferences, Yes, No, Inherit Enum: same as `Privacy.shareMarketing` (3 values) - `Privacy.optOutInd` (string) Used to indicate marketing preferences, Yes, No, Inherit Enum: same as `Privacy.shareMarketing` (3 values) - `Privacy.optInStatus` (string) Used to indicate marketing preferences, OptIn, OptOut Enum: same as `Privacy.optInStatus` (3 values) - `Privacy.optInDate` (string) The datetime of receiving the opt in notice Example: "2026-08-07T12:12:00Z" - `Privacy.optOutDate` (string) The datetime the opt out notice was received Example: "2026-08-07T12:12:00Z" - `Enum_TelephoneRole` (string) Defines the type of location the Telephone is assigned to. For Travel Agency telephone select "Other" or leave blank. Enum: same as `Enum_TelephoneRole` (6 values) - `Comment` (object) Textual information. - `Comment.value` (string) Actual text. May be restricted by character limits based on the type of comment (e.g. Notepad remarks limited to 87 characters). Example: "Additional comments" - `Comment.id` (string) Local identifier within a given message for this object. Example: "comment_1" - `Comment.name` (string) Title of comment or type of remark. Example: "Comment name" - `Comment.language` (string) Language code using ISO-639 standard Example: "EN" - `defaultInd` (boolean) When true, indicates a default value should be used. Example: true - `provisionedInd` (boolean) true indicates this phone number was created through provisioned - `Traveler.Telephone.@type` (string, required) Discriminator classes Telephone or TelephoneDetail Example: "Telephone" - `Traveler.Telephone.countryAccessCode` (string) Phone country code Example: "1" - `Traveler.Telephone.areaCityCode` (string) Phone local area code Example: "972" - `Traveler.Telephone.phoneNumber` (string, required) Mobile/Telephone Number. Accepted characters are numeric, dash, space, and period. Example: "972-000-787" - `Traveler.Telephone.extension` (string) Telephone extension number Example: "234" - `Traveler.Telephone.id` (string) Optional internally referenced id Example: "3" - `Traveler.Telephone.cityCode` (string) IATA city code if referenced by phone number. Example: "DEN" - `Traveler.Telephone.role` (string) Defines the type of location the Telephone is assigned to. For Travel Agency telephone select "Other" or leave blank. Enum: same as `Enum_TelephoneRole` (6 values) - `Traveler.Email` (array) - `Traveler.Email.value` (string) Example: "exampledomain@example.com" - `Traveler.Email.id` (string) Electronic email addresses, in IETF specified format. Example: "email_1" - `Traveler.Email.emailType` (string) Use email type to specify if the email is to be sent "TO" or sent "FROM" Example: "FROM" - `Traveler.Email.comment` (string) Comments associated to the email - `Traveler.Email.preferredFormat` (string) Mime media type Example: "text/html" - `Traveler.Email.shareMarketing` (string) Used to indicate marketing preferences, Yes, No, Inherit Enum: same as `Privacy.shareMarketing` (3 values) - `Traveler.Email.shareSync` (string) Used to indicate marketing preferences, Yes, No, Inherit Enum: same as `Privacy.shareMarketing` (3 values) - `Traveler.Email.optOutInd` (string) Used to indicate marketing preferences, Yes, No, Inherit Enum: same as `Privacy.shareMarketing` (3 values) - `Traveler.Email.optInStatus` (string) Used to indicate marketing preferences, OptIn, OptOut Enum: same as `Privacy.optInStatus` (3 values) - `Traveler.Email.optInDate` (string) The datetime of receiving the opt in notice Example: "2026-03-03T11:11:00Z" - `Traveler.Email.optOutDate` (string) The datetime the opt out notice was received Example: "2026-03-03T11:11:00Z" - `Traveler.Email.validInd` (boolean) If true, this is a valid email address that has been system verified via a successful email transmission. Example: true - `Traveler.Email.provisionedInd` (boolean) If true then the email address came from the provisioning process Example: true - `Traveler.passengerTypeCode` (string) Passenger type code Example: "CHD" - `Traveler.nationality` (string) Nationality on country code ISO Example: "AL" - `Traveler.age` (integer) The age of the traveller at the time of travel Example: 13 - `Traveler.CustomerLoyalty` (array) - `Traveler.CustomerLoyalty.value` (string, required) Number on loyalty card. Example: "132456" - `Traveler.CustomerLoyalty.id` (string) Optional Customer Loyalty Id. Not saved Example: "Loyalty_1" - `Traveler.CustomerLoyalty.priority` (integer) Optional Numeric Priority Code Example: 2 - `Traveler.CustomerLoyalty.programId` (string) "Specifies an identifier to indicate the company owner of the loyalty program. Typically two characters. For frequent guest number, the hotel supplier or brand code. For frequent flyer number, the air supplier code of the loyalty program." Example: "HY" - `Traveler.CustomerLoyalty.programName` (string) Supplier's loyalty program name. Example: "Frontier-EarlyReturns" - `Traveler.CustomerLoyalty.supplierType` (string) The type of supplier of a loyalty program. Uses 'hotel' for frequent guest number or 'air' for frequent flyer number. Example: "Hotel" - `Traveler.CustomerLoyalty.supplier` (string) Supplier of a loyalty program (typically 2 characters representing the hotel, brand, or airline). Example: "UA" - `Traveler.CustomerLoyalty.tier` (string) Customer Loyalty tier Example: "Silver" - `Traveler.CustomerLoyalty.shareWithSupplier` (array) The list of suppliers that the CustomerLoyalty number is shared. Used for cross accrual. Example: ["LH"] - `Traveler.CustomerLoyalty.cardHolderName` (string) Customer loyalty member name; up to 128 characters are supported. In Air Search, for discounted offers to be returned, the name must be sent as LAST FIRST; e.g.,if SMITH is the last name and JORDAN the first name, send as SMITH JORDAN Example: "John Smith" - `Traveler.CustomerLoyalty.validatedInd` (boolean) Customer loyalty number has been validated by the supplier Example: true - `Traveler.CustomerLoyalty.prefix` (string) The cardholder name prefix title like Mr, Mrs, Dr Example: "Dr" - `Traveler.CustomerLoyalty.given` (string) The First Name of the Cardholder Example: "John" - `Traveler.CustomerLoyalty.middle` (string) Middle Name of the Cardholder Example: "Wilkinson" - `Traveler.CustomerLoyalty.surname` (string) Last Name of the Cardholder Example: "Smith" - `Traveler.AlternateContact` (array) - `Traveler.AlternateContact.@type` (string) Example: "AlternateContact" - `Traveler.AlternateContact.id` (string) - `Traveler.AlternateContact.contactType` (string) Contact type value Example: "Relative" - `Traveler.AlternateContact.relation` (string) Relation value Example: "Mother" - `Traveler.AlternateContact.PersonName` (object, required) Travelport+ limits the combination of Given and Surname to 22 characters. Given name must have at least one character. Any PersonName exceeding 22 characters is truncated in the response. - `personNameType` (string) OTA Code Enum: same as `personNameType` (4 values) - `language` (string) 'ISO639 code of the language the name is represented Example: "EN" - `SurnamePrefix` (string) The surname prefix Example: "Von" - `Suffix` (string) Hold various name suffixes and letters Example: "Jr." - `Title` (string) Degree or honors Example: "DR" - `Privacy` (object) Confidential details for marketing purpose - `Privacy.id` (string) Optional internally referenced id Example: "2" - `Privacy.shareMarketing` (string) Used to indicate marketing preferences, Yes, No, Inherit Enum: same as `Privacy.shareMarketing` (3 values) - `Privacy.shareSync` (string) Used to indicate marketing preferences, Yes, No, Inherit Enum: same as `Privacy.shareMarketing` (3 values) - `Privacy.optOutInd` (string) Used to indicate marketing preferences, Yes, No, Inherit Enum: same as `Privacy.shareMarketing` (3 values) - `Privacy.optInStatus` (string) Used to indicate marketing preferences, OptIn, OptOut Enum: same as `Privacy.optInStatus` (3 values) - `Privacy.optInDate` (string) The datetime of receiving the opt in notice Example: "2026-08-07T12:12:00Z" - `Privacy.optOutDate` (string) The datetime the opt out notice was received Example: "2026-08-07T12:12:00Z" - `defaultInd` (boolean) If true, this is the default or primary name within a collection of names. Example: true - `Traveler.AlternateContact.Address` (array) - `addressType` (string) OTA code for address type Example: "CLT" - `use` (string) OTA code for address use Example: "AUT" - `Comment` (object) Textual information. - `Comment.value` (string) Actual text. May be restricted by character limits based on the type of comment (e.g. Notepad remarks limited to 87 characters). Example: "Additional comments" - `Comment.id` (string) Local identifier within a given message for this object. Example: "comment_1" - `Comment.name` (string) Title of comment or type of remark. Example: "Comment name" - `Comment.language` (string) Language code using ISO-639 standard Example: "EN" - `Privacy` (object) Confidential details for marketing purpose - `Privacy.id` (string) Optional internally referenced id Example: "2" - `Privacy.shareMarketing` (string) Used to indicate marketing preferences, Yes, No, Inherit Enum: same as `Privacy.shareMarketing` (3 values) - `Privacy.shareSync` (string) Used to indicate marketing preferences, Yes, No, Inherit Enum: same as `Privacy.shareMarketing` (3 values) - `Privacy.optOutInd` (string) Used to indicate marketing preferences, Yes, No, Inherit Enum: same as `Privacy.shareMarketing` (3 values) - `Privacy.optInStatus` (string) Used to indicate marketing preferences, OptIn, OptOut Enum: same as `Privacy.optInStatus` (3 values) - `Privacy.optInDate` (string) The datetime of receiving the opt in notice Example: "2026-08-07T12:12:00Z" - `Privacy.optOutDate` (string) The datetime the opt out notice was received Example: "2026-08-07T12:12:00Z" - `Priority` (integer) The priority ranking within the group Example: 1 - `validInd` (boolean) If true, this is a valid and complete mailing address that has been verified through an address verification service or previously mailed materials have not been returned. - `provisionedInd` (boolean) If true, this address came into the system through provisioning - `Traveler.AlternateContact.Telephone` (array) - `phoneLocationType` (string) Location of the phone Example: "Agency" - `phoneTechType` (string) Indicates the type of technology associated with the telephone number Example: "Voice" - `phoneUseType` (string) Agency code for how phone is used (e.g., Home, Business, Emergency Contact, Travel Arranger, Day, Evening). Example: "Home" - `pin` (string) Additional codes used for telephone Example: "3456" - `priority` (integer) Priority Example: 1 - `Privacy` (object) Confidential details for marketing purpose - `Privacy.id` (string) Optional internally referenced id Example: "2" - `Privacy.shareMarketing` (string) Used to indicate marketing preferences, Yes, No, Inherit Enum: same as `Privacy.shareMarketing` (3 values) - `Privacy.shareSync` (string) Used to indicate marketing preferences, Yes, No, Inherit Enum: same as `Privacy.shareMarketing` (3 values) - `Privacy.optOutInd` (string) Used to indicate marketing preferences, Yes, No, Inherit Enum: same as `Privacy.shareMarketing` (3 values) - `Privacy.optInStatus` (string) Used to indicate marketing preferences, OptIn, OptOut Enum: same as `Privacy.optInStatus` (3 values) - `Privacy.optInDate` (string) The datetime of receiving the opt in notice Example: "2026-08-07T12:12:00Z" - `Privacy.optOutDate` (string) The datetime the opt out notice was received Example: "2026-08-07T12:12:00Z" - `Enum_TelephoneRole` (string) Defines the type of location the Telephone is assigned to. For Travel Agency telephone select "Other" or leave blank. Enum: same as `Enum_TelephoneRole` (6 values) - `Comment` (object) Textual information. - `Comment.value` (string) Actual text. May be restricted by character limits based on the type of comment (e.g. Notepad remarks limited to 87 characters). Example: "Additional comments" - `Comment.id` (string) Local identifier within a given message for this object. Example: "comment_1" - `Comment.name` (string) Title of comment or type of remark. Example: "Comment name" - `Comment.language` (string) Language code using ISO-639 standard Example: "EN" - `defaultInd` (boolean) When true, indicates a default value should be used. Example: true - `provisionedInd` (boolean) true indicates this phone number was created through provisioned - `Traveler.AlternateContact.Email` (array) - `Traveler.AlternateContact.emergencyInd` (boolean) This is the contact in case of an emergency Example: true - `Traveler.AlternateContact.defaultInd` (boolean) This is the default contact Example: true - `Traveler.TravelDocument` (array) - `IssuedForGeoPoliticalArea` (object) The location code of the geographical location. Codes from Ref Pub - `IssuedForGeoPoliticalArea.value` (string) Example: "G" - `IssuedForGeoPoliticalArea.level` (string) Represents the type of geopolitical area (country, Continent, State etc) Enum: "World", "Global Area", "Continent Group", "Continent", "Country", "StateProvince", "City", "Airport" - `IssuedForGeoPoliticalArea.id` (string) Optional internally referenced id Example: "2" - `Address` (object) The property or billing address information. - `addressType` (string) OTA code for address type Example: "CLT" - `use` (string) OTA code for address use Example: "AUT" - `Comment` (object) Textual information. - `Comment.value` (string) Actual text. May be restricted by character limits based on the type of comment (e.g. Notepad remarks limited to 87 characters). Example: "Additional comments" - `Comment.id` (string) Local identifier within a given message for this object. Example: "comment_1" - `Comment.name` (string) Title of comment or type of remark. Example: "Comment name" - `Comment.language` (string) Language code using ISO-639 standard Example: "EN" - `Privacy` (object) Confidential details for marketing purpose - `Privacy.id` (string) Optional internally referenced id Example: "2" - `Privacy.shareMarketing` (string) Used to indicate marketing preferences, Yes, No, Inherit Enum: same as `Privacy.shareMarketing` (3 values) - `Privacy.shareSync` (string) Used to indicate marketing preferences, Yes, No, Inherit Enum: same as `Privacy.shareMarketing` (3 values) - `Privacy.optOutInd` (string) Used to indicate marketing preferences, Yes, No, Inherit Enum: same as `Privacy.shareMarketing` (3 values) - `Privacy.optInStatus` (string) Used to indicate marketing preferences, OptIn, OptOut Enum: same as `Privacy.optInStatus` (3 values) - `Privacy.optInDate` (string) The datetime of receiving the opt in notice Example: "2026-08-07T12:12:00Z" - `Privacy.optOutDate` (string) The datetime the opt out notice was received Example: "2026-08-07T12:12:00Z" - `Priority` (integer) The priority ranking within the group Example: 1 - `validInd` (boolean) If true, this is a valid and complete mailing address that has been verified through an address verification service or previously mailed materials have not been returned. - `provisionedInd` (boolean) If true, this address came into the system through provisioning - `Traveler.TravelDocument.@type` (string, required) Discriminator classes TravelDocument or TravelDocumentDetail Example: "TravelDocumentDetail" - `Traveler.TravelDocument.docNumber` (string) Document number value Example: "B37201" - `Traveler.TravelDocument.docType` (string) Codes from OTA DOC - Document Type Enum: "Visa", "Passport", "MilitaryIdentification", "DriversLicense", "NationalIdentityDocument", "VaccinationCertificate", "AlienRegistrationNumber", "InsurancePolicyNumber", "TaxExemptionNumber", "VehicleRegistrationLicenseNumber", "BoderCrossingCard", "RefugeeTravelDocument", "PilotsLicense", "PermanentResidentCard", "RedressNumber", "KnownTravelerNumber", "Non-Standard", "MerchantNumber", "AirNexusCard", "CrewMemberCertificate", "PassportCard", "NaturalizationCertificate", "TicketNumber", "LargeFamilyDiscountCard", "IdentityCardTypeA", "IdentityCardTypeC", "IdentityCardTypeI" - `Traveler.TravelDocument.issueDate` (string) Date of Issue Example: "2002-10-13" - `Traveler.TravelDocument.expireDate` (string) Date of expiration Example: "2002-11-13" - `Traveler.TravelDocument.stateProvCode` (string) State Province Code value Example: "44" - `Traveler.TravelDocument.placeOfIssue` (string) Place of issue value Example: "Birmingham" - `Traveler.TravelDocument.issueCountry` (string) Issue country on Country Code ISO Example: "CA" - `Traveler.TravelDocument.birthDate` (string) The date of birth of the document holder Example: "1995-04-22" - `Traveler.TravelDocument.birthCountry` (string) Birth country on Country Code ISO value Example: "AR" - `Traveler.TravelDocument.birthPlace` (string) Birth place value Example: "Ontario" - `Traveler.TravelDocument.residence` (string) Residence value Example: "1st section 8th st" - `Traveler.TravelDocument.id` (string) Locally referenced id Example: "34" - `Traveler.TravelDocument.Gender` (string, required) Gender Type Male, Female etc. This field is not used by Hotel APIs and will be ignored. Enum: same as `Traveler.gender` in "ReferenceListTraveler" (4 values) - `Traveler.TravelDocument.Nationality` (string) Specifies a 2 character country code as defined in ISO3166. Example: "BR" - `Traveler.TravelDocument.PersonName` (object, required) Travelport+ limits the combination of Given and Surname to 22 characters. Given name must have at least one character. Any PersonName exceeding 22 characters is truncated in the response. - `personNameType` (string) OTA Code Enum: same as `personNameType` (4 values) - `language` (string) 'ISO639 code of the language the name is represented Example: "EN" - `SurnamePrefix` (string) The surname prefix Example: "Von" - `Suffix` (string) Hold various name suffixes and letters Example: "Jr." - `Title` (string) Degree or honors Example: "DR" - `Privacy` (object) Confidential details for marketing purpose - `Privacy.id` (string) Optional internally referenced id Example: "2" - `Privacy.shareMarketing` (string) Used to indicate marketing preferences, Yes, No, Inherit Enum: same as `Privacy.shareMarketing` (3 values) - `Privacy.shareSync` (string) Used to indicate marketing preferences, Yes, No, Inherit Enum: same as `Privacy.shareMarketing` (3 values) - `Privacy.optOutInd` (string) Used to indicate marketing preferences, Yes, No, Inherit Enum: same as `Privacy.shareMarketing` (3 values) - `Privacy.optInStatus` (string) Used to indicate marketing preferences, OptIn, OptOut Enum: same as `Privacy.optInStatus` (3 values) - `Privacy.optInDate` (string) The datetime of receiving the opt in notice Example: "2026-08-07T12:12:00Z" - `Privacy.optOutDate` (string) The datetime the opt out notice was received Example: "2026-08-07T12:12:00Z" - `defaultInd` (boolean) If true, this is the default or primary name within a collection of names. Example: true - `Traveler.Comments` (object) Comments object to relay free text information In ProductAncillary.Ancillary this is used to expose when additional comments are required to book the ancillary. In BuildAncillaryOffersFromCatalogOfferings this is used to pass additional ancillary text required to book the ancillary. - `Traveler.Comments.@type` (string) Example: "Comments" - `Traveler.Comments.Comment` (array) - `Traveler.Comments.Comment.value` (string) Actual text. May be restricted by character limits based on the type of comment (e.g. Notepad remarks limited to 87 characters). Example: "Additional comments" - `Traveler.Comments.Comment.id` (string) Local identifier within a given message for this object. Example: "comment_1" - `Traveler.Comments.Comment.name` (string) Title of comment or type of remark. Example: "Comment name" - `Traveler.Comments.Comment.language` (string) Language code using ISO-639 standard Example: "EN" - `Traveler.RailDiscountCard` (array) - `Traveler.RailDiscountCard.value` (string) Example: "Rail1234546" - `Traveler.RailDiscountCard.supplierCode` (string, required) Code of the Supplier Example: "Enco" - `Traveler.RailDiscountCard.referenceNumber` (string) ReferenceNumber Example: "134256" - `Traveler.accompaniedByInfantInd` (boolean) Example: true - ReferenceListOffer: - `Offer` (array) — one of (discriminator: @type): - OfferAncillaryModify: - `ModifyPrice` (object) - `PriceBreakdown` (array) — one of (discriminator: @type): - PriceBreakdownAir: - `quantity` (integer) Quantity of passengers in that PTC. Example: 2 - `requestedPassengerType` (string) The PTC to which the PriceBreakdown applies. Example: "CHD" - `FiledAmount` (object) Returned only in the Price APIs. GDS only; not supported for NDC. The base amount of a ticket price or net price that is filed in local currency. Returned when the origin currency is not the same as the PCC currency to show the currency in which the base fare has been filed. When used for NetBaseAmount: Net ticket data (NTD) is returned in the AirPrice, AirReservation, Exchange Search, and Reservation Retrieve responses for any GDS fare that has a private fare component (fareType=AgencyPrivateFare). When NTD is returned, TermsAndConditionsFuill includes FareGuaranteePolicy to return the fare calculation indicator for the fare. When NTD is returned, PriceBreakdown may include NetBaseAmount. - `FiledAmount.value` (number) Filed amount value Example: 43.3422 - `FiledAmount.currencyCode` (string) Code for the currency in which the base fare was filed. Example: "USD" - `FiledAmount.codeAuthority` (string) Filed amount currency code authority Example: "Australian Dollar" - `FiledAmount.decimalPlace` (integer, required) Number of decimal places in the currency in ISO 4217 standard format. Example: 3 - `FiledAmount.decimalAuthority` (string) ISO 4217 standard decimal authority Example: "ISO 4217" - `Discount` (object) NDC only; not supported for GDS. Returned for a fare discounted from the published price, such as a promotional discount. Not returned for privately negotiated discounts such as private fares. - `Discount.value` (number) The amount value of the discount Example: 20.22 - `Discount.description` (string) The text description for the discount. Example: "Spring discount on group bookings" - `Discount.currencyCode` (string, required) Currency code discount is returned in. Example: "USD" - `Discount.codeAuthority` (string, required) Not used. Currency code Authority. Example: "ISO" - `Discount.decimalPlace` (integer, required) Number of decimal places in the currency the discount is returned in. Example: 2 - `Discount.decimalAuthority` (string) Not used. Decimal Authority. Example: "ISO" - `NetFareInfo` (object) Detailed information on the net fare used. - `NetFareInfo.@type` (string, required) Example: "NetFareInfo" - `NetFareInfo.passengerTypeCode` (string) PassengerTypeCode Example: "ADT" - `NetFareInfo.NetFareBreakdownConstruction` (array) - `NetFareInfo.NetFareBreakdownConstruction.value` (string) - `NetFareInfo.NetFareBreakdownConstruction.fareType` (string) Assigned Type: c-1100:StringTiny - `NetFareInfo.NetFareBreakdownConstruction.rateOfExchange` (number) The rate of exchange applied to the fare breakdown - `NetFareInfo.TicketBaseAudit` (object) Returned only in the Price APIs. GDS only; not supported for NDC. The base amount of a ticket price or net price that is filed in local currency. Returned when the origin currency is not the same as the PCC currency to show the currency in which the base fare has been filed. When used for NetBaseAmount: Net ticket data (NTD) is returned in the AirPrice, AirReservation, Exchange Search, and Reservation Retrieve responses for any GDS fare that has a private fare component (fareType=AgencyPrivateFare). When NTD is returned, TermsAndConditionsFuill includes FareGuaranteePolicy to return the fare calculation indicator for the fare. When NTD is returned, PriceBreakdown may include NetBaseAmount. - `NetFareInfo.TicketBasePassenger` (object) The monetary value - `NetFareInfo.TicketBasePassenger.value` (number) - `NetFareInfo.TicketBasePassenger.currencyCode` (string) Assigned Type: c-1100:CurrencyCode - `NetFareInfo.TicketBasePassenger.codeAuthority` (string, required) Assigned Type: c-1100:CodeContext - `NetFareInfo.TicketBasePassenger.decimalPlace` (integer, required) Assigned Type: c-1100:CurrencyMinorUnit - `NetFareInfo.TicketBasePassenger.decimalAuthority` (string) Assigned Type: c-1100:CodeContext - `NetFareInfo.TicketBasePassenger.bTInd` (boolean) If true, this is a bulk ticket fare - `NetFareInfo.TicketBasePassenger.iTInd` (boolean) If true, this is an inclusive tour fare - `TravelerIdentifierRef` (object) Identifier references as object both within a message payload or an object held in cache that may be used for subsequent workflows. Returned for NDC in the Price response if age was sent for this traveler in the previous workflow requests. - `TravelerIdentifierRef.name` (string) Traveler identifier - `TravelerIdentifierRef.passengerTypeCode` (string) Passenger Type code Example: "ADT" - `TravelerIdentifierRef.ages` (array) The ages of the travelers associated to a particular ptc. For NDC, this value will be returned in PriceBreakdownAir if sent as part of the PassengerCriteria in the Air Search request. Example: [15] - `TravelerIdentifierRef.passengerCriteriaRef` (string) Allows the user to associate passenger criteria information. Example: "passengerCriteria_1" - `TravelerIdentifierRef.value` (string) - `TravelerIdentifierRef.id` (string) A locally referenced ID - `TravelerIdentifierRef.description` (string) Descriptive text used to identify the contents of a target object - `TravelerIdentifierRef.uris` (array) Uniform Resource Identifier Example: ["google.com"] - `TravelerIdentifierRef.age` (integer) Replaced with ages array. The age of the traveler. Example: 11 - `NetBaseAmount` (object) Returned only in the Price APIs. GDS only; not supported for NDC. The base amount of a ticket price or net price that is filed in local currency. Returned when the origin currency is not the same as the PCC currency to show the currency in which the base fare has been filed. When used for NetBaseAmount: Net ticket data (NTD) is returned in the AirPrice, AirReservation, Exchange Search, and Reservation Retrieve responses for any GDS fare that has a private fare component (fareType=AgencyPrivateFare). When NTD is returned, TermsAndConditionsFuill includes FareGuaranteePolicy to return the fare calculation indicator for the fare. When NTD is returned, PriceBreakdown may include NetBaseAmount. - `FareCalculation` (string) GDS only; not supported for NDC. For each PTC, when available, FareCalculation returns the fare calculation ladder for all public and private fare types filed by an agency or an airline. Example: "LON BA SYD R564.00YEE1Y BA LON R564.00YEE1Y NUC1128.00END ROE0.787855" - `Surcharges` (object) In AirSearch workflow this applies to GDS only. Not supported for NDC, which does not return surcharges. Returned if surcharges apply to this offer. For GDS only, for a multi-city offer with stopovers (see multi-city offers with stopovers for details), surcharges and commission amounts are for the entire journey. For all other offers, the surcharges and commission amounts are for each leg (origin and destination pair). A multi-city offer can be identified by the jc in its CombinabilityCode: jc1, jc2. Surcharges can be omitted from the Search response with excludeSurchargesInd. - `Surcharge` (array, required) - `Surcharge.value` (number) Surcharge amount Example: 12 - `Surcharge.currencyCode` (string) ISO 4217 currency code for the surcharge. Example: "USD" - `Surcharge.surchargeCode` (string) Surcharge code Example: "ADDITIONAL COSTS" - `Surcharge.reportingAuthority` (string) Not used. Surcharge reporting authority Example: "Federal register" - `Surcharge.purpose` (string) Surcharge purpose. For Air workflows possible values include Weekend Surcharge, Stopover Charge, Multiple Stopover Charges, Other (default value that covers all other surcharges such as fuel surcharges). Example: "Weekend Surcharge" - `Surcharge.description` (string) Description of the surcharge. Example: "Rollaway Surcharge" - `Surcharge.surchargeApplication` (string) Application values (such as the application of a fee) like per person or per room. Enum: "PerPerson", "PerRoom", "PerAccommodation", "PerHouse", "PerApartment", "PerAdult", "PerChild" - `Surcharge.surchargeFrequency` (string) The frequency of a fee such as per night or per stay. Enum: "PerNight", "PerDay", "PerStay", "PerWeek", "RoundTrip", "OneWay" - `Surcharge.codeAuthority` (string) Not used. Currency code authority. Example: "ISO 4217" - `Surcharge.decimalPlace` (integer) Decimal place for the currency unit. Example: 4 - `Surcharge.decimalAuthority` (string) Not used. Currency code decimal authority. Example: "ISO 4217" - `Surcharges.@type` (string, required) Discriminator class is SurchargesDetail Example: "SurchargesDetail" - `Surcharges.TotalSurcharges` (number) A monetary amount, up to 4 decimal places. Example: 211.11 - `Surcharges.approximateInd` (boolean) If true, the surcharge amounts are approximate. - `TravelerRefs` (array) Returned only in Reservation Retrieve to identify the traveler associated with this instance of PriceBreakdown in case of multiple offers on the booking. Example: ["[\"traveler_1\",\"traveler2\"]"] - `PaidTaxes` (object) Summary Taxes object - `Tax` (array) - `Tax.value` (number) Amount of the tax. Returned as 0 if a tax was marked as exempt with TaxExemption. Example: 12.2 - `Tax.currencyCode` (string) A ISO 4217 currency code associated to the value. Example: "USD" - `Tax.taxCode` (string) "Code for the tax. For Hotels this is the OTA code." Example: "XF2" - `Tax.reportingAuthority` (string) Identifies the reporting authority such as airport code for XF taxes Example: "JFK1" - `Tax.purpose` (string) Supplier returned description of tax. Example: "Fuel surcharge" - `Tax.description` (string) "Short summary of the tax. In Air workflows this is returned only for NDC. Note that descriptions are not returned for tax codes YQ and YR, which are fees charged by airlines and not government-imposed taxes. For Hotels this is the OTA tax description." Example: "Lodging tax" - `Tax.includedInBase` (string) Yes , No , Unknown Enum: same as `instantPurchase` in "AdvanceReservationRequired" (3 values) - `Tax.codeAuthority` (string) Not used. Currency Code Authority Example: "ISO" - `Tax.decimalPlace` (integer) Permitted number of decimals. Associated to the currency value. Example: 2 - `Tax.decimalAuthority` (string) Not used. Currency decimal authority Example: "ISO" - `Tax.exemptInd` (boolean) GDS only; not supported for NDC. Returned if a tax was marked exempt in a prior request with the TaxExemption pricing modifer. If true, this tax is exempt" Example: true - `Tax.nonRefundableInd` (boolean) If true, the tax is non refundable. This indicator is only supported for exchange search and exchange price quote transactions. Example: true - `Tax.excludedFromTotalPriceInd` (boolean) Returned in Hotel APIs when a tax is not included in the TotalPrice. Default behavior is for taxes to be included in TotalPrice. Example: true - `TaxPercent` (object) Returned when the tax is expressed as a percentage of the amount. - `TaxPercent.value` (number) The tax percentage amount. Example: 5.5 - `TaxPercent.taxCode` (string) Any code for the tax. Example: "971 - IRS Notice" - `TaxPercent.reportingAuthority` (string) Tax reporting authority Example: "Georgia Department of Revenue" - `TaxPercent.purpose` (string) Purpose of tax Example: "statutory tax" - `TaxPercent.description` (string) Description Example: "1.5% of SGST" - `TaxPercent.includedInBase` (string) Yes , No , Unknown Enum: same as `instantPurchase` in "AdvanceReservationRequired" (3 values) - `PaidTaxes.@type` (string, required) Discriminator classes PaidTaxes or PaidTaxesDetail Example: "PaidTaxesDetail" - `PaidTaxes.TotalTaxes` (number) A monetary amount, up to 4 decimal places. Decimal place needs to be included. Example: 220.12 - `RequestedPricingModifiers` (array) - `RequestedPricingModifiers.@type` (string, required) Discriminator. Example: "RequestedPricingModifiers" - `RequestedPricingModifiers.PassengerCriteria` (object) Defines the passenger criteria. Send one PassengerCriteria for each passenger type code (PTC). Search supports up to 9 total passengers. A maximum of 6 PTCs are supported for GDS. NDC does not have a PTC limitation. AirPrice supports up to nine total passengers across all PTCs. - `TravelerIdentifierRef` (object, required) Identifier references as object both within a message payload or an object held in cache that may be used for subsequent workflows. Returned for NDC in the Price response if age was sent for this traveler in the previous workflow requests. - `RequestedPricingModifiers.PassengerCriteria.@type` (string, required) Discriminator. No child classes. Example: "PassengerCriteria" - `RequestedPricingModifiers.PassengerCriteria.number` (integer, required) The amount of passengers associated with this passenger type code. Default is 1. Example: 1 - `RequestedPricingModifiers.PassengerCriteria.age` (integer) The age of the passenger. Notes on PTC and age: - Travelport recommends sending age only with PTCs that require age for pricing. - If the age is sent in the request, for NDC only, the age is returned in the pricing response. - For child passengers, Travelport recommends sending the age of the child in the age attribute plus the PTC CNN. Travelport recommends against sending CNN without age, or the CHD PTC. Not all fares cannot be quoted for CHD. - The age for CNN is generally between 2 and 11 inclusive, with ADT fares returned for ages 12 and up; however, this can vary by airline and country. - The age for INF must be either 0 or 1. - During booking, date of birth is required for all child and infant PTCs (Add Traveler payload in Traveler/birthDate). Example: 26 - `RequestedPricingModifiers.PassengerCriteria.passengerTypeCode` (string) The passenger type code (PTC) for the passengers on the itinerary. Required field for Air Search and Flight specific search. Common PTCs are: - ADT: adult - CHD: child of unknown age - For child passengers, Travelport recommends sending the age of the child in the age attribute plus the PTC CNN. Travelport recommends against sending CNN without age, or the CHD PTC. Many fares cannot be quoted for CHD. - CNN: child when age is known - The age for CNN is generally between 2 and 11 inclusive, with ADT fares returned for ages 12 and up; however, this can vary by airline and country. - INF: infant without a seat - INS: infant with a seat - UNN: unaccompanied child. See API guides to download a full list of PTCs. NDC carriers BA, SQ, AV, AA, and AF/KLM offer teen/young adult tax exemptions from the UK Air Passenger Duty (GB tax). Send PTC with the value YTH and send the passengers age per below. The PTC may be returned as ADT, or Cxx in which xx is the age, but the tax exemption is applied in the pricing on these NDC carriers. For marine fares, send the PTC value SEA. You must also send OSI remarks at Add Traveler with the vessel name and location. Marine fares are private fares for travelers going to or from a vessel. NDC only; not supported for GDS. When running a multiple passenger search for NDC on Qantas, Qantas supports only these PTCs: ADT, CHD, CNN, INF. Sending any other PTC may result in an error at ticketing. Any traveler sent without a PTC value is defaulted to ADT. PTC can be sent or omitted for ADT passenger. AirReservation defaults the PTC to ADT and returns it in the Reservation Retrieve. Example: "ADT" - `RequestedPricingModifiers.PassengerCriteria.birthDate` (string) The date of birth of the passenger. May be used in age validation for fares with age restrictions. Example: "2020-01-16" - `RequestedPricingModifiers.PassengerCriteria.id` (string) Unique id to support referencing of this specific passenger criteria. Example: "passengercriteria_001" - `RequestedPricingModifiers.PassengerCriteria.CustomerLoyalty` (array) NDC only; not supported for GDS. Optional object for sending customer loyalty information, such as for a frequent flyer program. If CustomerLoyalty is sent in the Search request, it must also be sent in the Air Price request and the Add Traveler request. As some carriers validate frequent traveler data through the workflow, failing to send the same CustomerLoyalty details, even if invalid, may cause a booking failure. If an invalid number is sent, the response returns a warning message that the FQTV is invalid, and the invalid number is cached to prevent a potential booking failure. - `RequestedPricingModifiers.PassengerCriteria.TravelerGeographicLocation` (object) For AirSearch: supported/validated only for NDC to support local citizen fares. For AirPrice and AirReservation: GDS only; not supported for NDC. Optional object for requesting local citizen/local resident fares for Spain and associated islands. You must also send a PTC relevant to the local resident fares; e.g., ADR for adult resident, CHR for child resident. Any discount applied through TravelerGeographicLocation applies to all travelers, not only to the traveler in this instance of PassengerCriteria. If the discount must apply only to an individual traveler, that traveler requires a separate search and book workflow. - `RequestedPricingModifiers.PassengerCriteria.specifiedPassengerTypeCodeOnlyInd` (boolean) GDS only; not supported for NDC. - If true: returns only offers for the specified PTC. If no fares are available for the specified PTC, returns an error message that there is no valid fare. - If false (default behavior): If no fares are available for the specified PTC, returns fares for the default ADT (adult) PTC instead. Example: true - `RequestedPricingModifiers.PricingModifiersAir` (object) A selection of Pricing Modifiers that can be used to influence the Price of an Offer. - For the AirPrice reference payload request, if any price modifiers were included in the preceding Search request and no price modifiers are sent in the AirPrice request, the cached price modifiers sent at Search are sent with the AirPrice request. If any price modifiers are sent in the AirPrice reference payload request, all cached Search modifiers are discarded and only the modifiers sent in that AirPrice request are used. - For the Add Offer request, you may optionally store fares with one or more pricing modifiers. If a pricing modifier is not added, the auto stored fare is added to the reservation. There is no change in the AirReservation response when pricing modifiers are requested. AirReservation applies modifiers from Add Offer and earlier steps as follows: - Modifiers sent in the Add Offer request (supported for both full and reference payload). - If no modifiers are sent in Add Offer, any pricing modifiers sent in AirPrice are applied. - If no modifiers were sent in AirPrice, or if AirPrice was not sent, any pricing modifiers sent in Search are applied. GDS only; pricing modifiers not supported for NDC. If the requested modifier does not have any fares associated with it, the workbench commit fails and returns the error message 'No Fare Found'. Pricing happens at commit, not at Add Offer. - `Brand` (object) Information on airline Brand offerings. If brand attributes were not excluded with inhibitBrandContentInd=true (GDS only), then brand attributes are returned and consolidated in ReferenceList/ReferenceListBrand. In this case Brand does not return the name or Identifier objects but instead returns only BrandRef, which matches to the brand identifier (e.g., b1) in ReferenceListBrand. - `RequestedPricingModifiers.PricingModifiersAir.@type` (string, required) Discriminator. Child classes PricingModifiersAir and PricingModifersAirDetail Example: "PricingModifiersAir" - `RequestedPricingModifiers.PricingModifiersAir.currencyCode` (string) In an API request, send the currency type to return if you want to override the default currency specified with your PCC. Example: "GBP" - `RequestedPricingModifiers.PricingModifiersAir.FareSelection` (object) Requests the return of fare types including private fares (negotiated), public fares (published), or net fares (consolidator fares, or any negotiated wholesale price that is further marked up for sale to customers). May be used to request fares with specific restrictions, change, or refund options. - `RequestedPricingModifiers.PricingModifiersAir.OrganizationInformation` (object) Use to send account codes for negotiated fares or to send optional India GST SSR Remarks in GSTRegistrationNumber. For NDC supports corporate loyalty program and GST Information. This information is returned in TermsAndConditions." - `RequestedPricingModifiers.PricingModifiersAir.TaxExemption` (object) GDS only, not supported for NDC. Use to mark some or all taxes as exempt. Specify all taxes, only specific tax codes, or all taxes in specific countries. Must include either allTaxesExemptInd OR both countries and taxCodes. TaxExemption supports up to nine values for countries, taxCodes, or both combined. The response returns any exempt taxes with exemptInd=true and value=0. - `RequestedPricingModifiers.PricingModifiersAir.PromotionalCode` (array) - `RequestedPricingModifiers.PricingModifiersAir.SellCity` (string) GDS only, not supported for NDC. The IATA location code for a city. Overrides the sell city of the requester to specify an alternate sale location and return fares based on that location. The response returns pricing in the local currency for the specified sell city instead of the PCC's default currency. Example: "NYC" - `RequestedPricingModifiers.PricingModifiersAir.TicketCity` (string) GDS only, not supported for NDC. The IATA location code for a city. Overrides the ticketing city of the requester to specify an alternate ticket location and return fares based on that location; the response returns pricing in the local currency for the specified ticket city instead of the PCC's default currency. Example: "NYC" - `RequestedPricingModifiers.PricingModifiersAir.PricingPCC` (string) GDS only, not supported for NDC. Use to send a faring PCC for which a selective access or code group agreement exists between that PCC and the PCC associated with your account. The following combinations of PricingPCC and FareSelection/fareType=PrivateFaresOnly return results as follows: - PricingPCC sent and PrivateFaresOnly not requested: If a selective access or group agreement exists, both public and any available private fares are returned for the requesting and providing PCC. - If no selective access or group agreement exists, only public fares are returned. - PricingPCC sent and PrivateFaresOnly is requested: If a selective access or group agreement exists that allows private fare access, only available private fares are returned for the requesting and providing PCC. - If no agreement exists, or if an agreement exists but does not allow private fares access, an error is returned. Example: "0Bx3" - `RequestedPricingModifiers.PricingModifiersAir.FareBasisCodeOverride` (array) - `RequestedPricingModifiers.PricingModifiersAir.MultiPricingAgency` (array) The customer can send up to 3 Pseudo City Codes (PCCs) in PricingModifiersAir, MultiPricingAgency. If a customer sends more than 3 PCCs in MultiPricingAgency, only the first 3 are validated. If a customer sends both PricingPCC and MultiPricingAgency with PCCs, the PCC in PricingPCC is ignored. Example: ["[\"0XS4\",\"0YBZ\",\"J80K\"]"] - `RequestedPricingModifiers.PricingModifiersAir.TicketingPCC` (string) GDS only, not supported for NDC. In an API request, overrides the ticketing PCC associated with your account to specify an alternate PCC and return fares based on that PCC. Example: "0XS4" - `RequestedPricingModifiers.PricingModifiersAir.CalculatedFareAdjustment` (object) Used in Exchange Search to modify the Price of the Fare. Discriminator classes CalculatedFareAdjustmentDiscount or CalculatedFareAdjustmentIncrease - `RequestedPricingModifiers.PricingModifiersAir.ManualFareAdjustment` (array) Send to manually adjust the base fare amount on all fares for a specific PTC. - `RequestedPricingModifiers.PricingModifiersAir.BrandPreference` (array) - `RequestedPricingModifiers.PricingModifiersAir.includeSplitPaymentInd` (boolean) Requests request split ticketing, which returns outbound and inbound one-way fares in addition to round trip options in the Search API response. This may result in lower fares than the same or similar round-trip itinerary. If true, requests split ticketing. If false or omitted split ticketing options are not returned. Default is false. GDS only, not supported for NDC. When split ticketing is requested, the Search response returns offers in the following order: Outbound one-way offers, Inbound one-way offers, Round trip offers. The response identifies all one-way outbound and inbound offers with CombinabilityCode j0. CombinabilityCode values for round trip offers start at j1 and increment by one for each offer. Only the following are in scope for split ticketing: Search (not supported for Next Leg Search or Flight Specific Search), Round-trip journey-based offerings ( isJourney header not sent or sent as true, or CustomResponseModifiersAir/SearchRepresentation not sent or sent with value Journey ) Upsells. Split ticketing is not supported for round-trip leg-based searches, virtual interlining, or NDC. Split ticketing is available only for customers specifically provisioned for split ticketing. Split ticketing returns one-way outbound and one-way inbound fares in addition to round-trip offers. Split ticket offers are identified with CombinabilityCode j0. If your account is not configured for split ticketing, sending includeSplitPaymentInd returns a response without split ticket offers and a warning message. GDS only, not supported for NDC. In Air Price, For split ticketing, the request must send offers that are identified in the Search response with CombinabilityCode j0, which identifies those offers as one-way outbound and one-way inbound split ticketing offers. A combination of j0 and any non-j0 value offer returns an error message that split pricing is not supported - `RequestedPricingModifiers.PricingModifiersAir.returnMostRestrictiveBrandInd` (boolean) In Search API, when there are different brands on a connecting flight, return information for either the most restrictive brand or the brand on the most significant segment on the itinerary. If true, return the offer brand of the most restrictive brand. If false or omitted, return the offer brand of the most significant segment of the itinerary. GDS only, not supported for NDC. - `RequestedPricingModifiers.PricingModifiersAir.splitPaymentOfferings` (number) Number between 0 and 99. Send with includeSplitPaymentInd to configure the percentage of round trip offers to return in a split ticketing response. By default, Search divides the split ticketing response into 34% round-trip offerings and the remainder as split ticketing offers, which are combined outbound and inbound one-way fares. To change this percentage, send SplitPaymentOfferings with the percentage value of round trip offers to return. Example: 25 - `RequestedPricingModifiers.CabinPreference` (object) Requests a fare based on the cabin class. Only one cabin preferenceType (Permitted, Preferred, PreferredWithUpgrade) is allowed per request, but there is no limit to the number of cabins that can be sent. Any CabinPreference in the initial Search request is applied to any subsequent Next Leg Search and reference Flight Specific Search requests. In AirPrice and AirReservation only one cabin preference type is allowed per request, but there is no limit to the number of cabins that can be sent. If CabinPreference was sent in the Search request, it is cached and sent with the AirPrice reference payload request. If you send CabinPreference in the AirPrice request, all cached modifiers are discarded and only the modifiers sent in the AirPrice request are used. Can be combined with lowFareFinderInd=true to return lowest fare in the requested cabin or cabins. When using CabinPreference and lowFareFinderInd, if both CabinPreference and a class of service are sent, class of service is ignored. If CabinPreference is sent without a class of service, the response returns the lowest fare in the cabin requested. If that cabin is not available, the response may upgrade or downgrade to a different cabin. If a different cabin than requested is returned, the response returns the message that the cabin class may differ from the class requested. If lowFareFinderInd=false and CabinPreference are sent in the request, AirPrice ignores the preferred cabin and returns a message that the preferred cabin was ignored. If CabinPreference is set to All, no cabin preference is applied." - `RequestedPricingModifiers.CabinPreference.@type` (string, required) Discriminator. No child classes exist Example: "CabinPreference" - `RequestedPricingModifiers.CabinPreference.preferenceType` (string) Type of cabin preference. Sending a mix of preferenceType values is not supported. For example, you cannot send an instance of CabinPreference with a preferenceType of Permitted and another instance with preferenceType of Prohibited. In this case the results default to the Preferred preference. Note that if lowFareFinderInd is sent with true and CabinPreference is sent, the only supported value for CabinPreference/type is Permitted. Enum: "Preferred", "Permitted", "PreferredWithUpgrade", "Prohibited" - `RequestedPricingModifiers.CabinPreference.cabins` (array) A space-delimited list of cabins. Enum: same as `PassengerFlight.FlightProduct.cabin` in "ProductAir" (5 values) - `RequestedPricingModifiers.CabinPreference.legSequence` (array) Limits preference to the specified leg referenced in SearchCriteriaFlight. You can apply the preference to only some legs of the itinerary, or different preferences to different legs. To apply preference to the entire itinerary, do not send legSequence. GDS only, not supported for NDC. Not supported at Price or Book. Example: [1,2] - `RequestedPricingModifiers.FlightType` (object) The type of flight connection - `RequestedPricingModifiers.FlightType.@type` (string, required) Discriminator. No child classes. Example: "FlightType" - `RequestedPricingModifiers.FlightType.connectionType` (string) Limits the connection type returned. Each value returns the specified type and all higher types. For example, StopDirect could return both flights that stop without a change of planes (StopDirect) and non-stop direct flights (NonStopDirect). SingleConnection or DoubleConnection will not exclude StopDirect flights from the journey. For example, SingleConnection could return an itinerary with two flight numbers, and either of these flights could have intermediate stops. Enum: "NonStopDirect", "StopDirect", "SingleConnection", "DoubleConnection", "TripleConnection" - `RequestedPricingModifiers.FlightType.excludeInterlineConnectionsInd` (boolean) Excludes interline connectionsClosed from results. If true, does not return offers with interline connections. If false or omitted, may return interline connections in results. Default is false. GDS only, not supported for NDC. When a product contains multiple interline air segments, brand details return only the brand of the significant carrier, not the validating/plating carrier brand information. The IATA rules for determining the significant carrier on an itinerary are based on the areas in which the transportation takes place. Example: true - `RequestedPricingModifiers.CustomResponseModifiersAir` (object) Contains additional modifiers to customize the result set. Includes optional indicators for returning or excluding specified response content. Values sent at Search can carry forward into the Next Leg Search request and are not re-sent. - `RequestedPricingModifiers.CustomResponseModifiersAir.@type` (string, required) discriminator Example: "CustomResponseModifiersAir" - `RequestedPricingModifiers.CustomResponseModifiersAir.BrandAttributeInclusion` (array) Supported in AirSearch and AirPrice. Returns only information about the brand attributes specified and does not return any other brand attributes. - `RequestedPricingModifiers.CustomResponseModifiersAir.SearchRepresentation` (string) Specifies either a journey or leg-based response. Journey returns offers for all legs of the itinerary. Journey is the default. Leg returns offers for only the first leg of the itinerary. Must be followed with a Next Leg Search to select an offer for the first leg and return offers on the subsequent leg to combine with it.Customize search result set as leg or journey based. Next Leg Search requests, and Flight Specific Search requests for less than the full itinerary, are supported only after a leg-based Search, not a journey-based Search. If these requests follow a journey-based Search request, an error message is returned. Enum: "Leg", "Journey", "LegWithJourneyData" - `RequestedPricingModifiers.CustomResponseModifiersAir.excludePenaltiesInd` (boolean) GDS only; not supported for NDC. Indicator to omit change and cancel penalties. - If true: omits all penalty information from the response. - If false (default behavior): returns any change and penalty details provided by carrier for each offer in TermsAndConditionsFullAir/Penalties. If sent in Search but not in AirPrice, the value sent in Search is cached and applied to the AirPrice results. However, you can override the value sent in Search by sending excludePenaltiesInd in the AirPrice request with the opposite value. For example, if the Search request sends excludePenaltiesInd=true and the AirPrice request sends excludePenaltiesInd=false, the Search response does not return penalties and the AirPrice response does return penalties. Example: true - `RequestedPricingModifiers.CustomResponseModifiersAir.excludeBaggageFeesInd` (boolean) GDS only; not supported for NDC. Indicator to exclude baggage details. - If true: excludes baggage fees, carry on fees, and embargo information from the response. Baggage quantity or weight is returned instead. - If false (default behavior): baggage details returned in response. Default is false. Example: true - `RequestedPricingModifiers.CustomResponseModifiersAir.includeFareCalculationInd` (boolean) GDS only; not supported for NDC or in the Flight Specific Search full payload request. Indicator to request the return of the fare calculation ladder. - If true: returns the fare calculation ladder in BestCombinablePrice.PriceBreakdownAir.FareCalculation. - If false (default behavior): fare calculation ladder is not returned. Example: true - `RequestedPricingModifiers.CustomResponseModifiersAir.excludeSurchargesInd` (boolean) GDS only; not supported for NDC. Indicator to exclude a surcharge breakdown. - If true: excludes a surcharge breakdown from the response. Baggage quantity or kilos is returned instead. - If false (default behavior): surcharge breakdown returned in response. Example: true - `RequestedPricingModifiers.CustomResponseModifiersAir.excludeUnbundledFaresInd` (boolean) GDS only, not supported for NDC. Sets whether to return unbundled fares. Supported in AirSearch and AirPrice. - If true: does not return unbundled fares. - If false (default behavior): returns unbundled and bundled fares as available. Example: true - `RequestedPricingModifiers.CustomResponseModifiersAir.includeCO2EmissionsDataInd` (boolean) Indicator to return CO2 emission data in the Search and Next Leg Search responses. - If true: returns CO2 emission data. - If false (default behavior): CO2 emission data not returned. Example: true - `RequestedPricingModifiers.CustomResponseModifiersAir.includeFlightAmenitiesInd` (boolean) Indicator to return flight amenities from ATPCO RouteHappy data. - If true: includes amenities in the response if available. - If false: Does not return ATPCO RouteHappy amenities. Example: true - `RequestedPricingModifiers.CustomResponseModifiersAir.includeUniversalProductAttributesInd` (boolean) Indicator to return universal product attributes (UPAs), which include images, icons, and URLs as provided by ATPCO. Must also send includeFlightAmenitiesInd=true. - If true: returns universal product attributes if available. - If false (default behavior): Universal product attributes not returned. UPAs are not returned for direct flights with intermediate stops, non-flight segments such as trains, or for Premium Business class. Example: true - `RequestedPricingModifiers.CustomResponseModifiersAir.includeBundledAncillariesInd` (boolean) NDC only. If true: the search and price response will include bundled air and ancillary offerings/offers. Search and Price response will contain both ProductAir and ProductAncillary plus a new child class of PriceBreakdown: PriceBreakdownAncillaryAir to define the ancillary inclusion and pricing. Example: true - `RequestedPricingModifiers.CustomResponseModifiersAir.includeFullPenaltyDisclosureInd` (boolean) If true, penalty information sourced from ATPCO Cat 31 and 33 will be disclosed. Penalties may be exposed at fare component level and include time windows. - `RequestedPricingModifiers.PricingModifiersAirChange` (object) Pricing Modifiers that can be used to influence the Price of an Exchanged Offer - `RequestedPricingModifiers.PricingModifiersAirChange.@type` (string) Example: "PricingModifiersAirChange" - `RequestedPricingModifiers.PricingModifiersAirChange.currencyCode` (string) ISO 4217 currency code Example: "USD" - `RequestedPricingModifiers.PricingModifiersAirChange.FareSelection` (object) Requests the return of fare types including private fares (negotiated), public fares (published), or net fares (consolidator fares, or any negotiated wholesale price that is further marked up for sale to customers). May be used to request fares with specific restrictions, change, or refund options. - `RequestedPricingModifiers.PricingModifiersAirChange.OrganizationInformation` (object) Use to send account codes for negotiated fares or to send optional India GST SSR Remarks in GSTRegistrationNumber. For NDC supports corporate loyalty program and GST Information. This information is returned in TermsAndConditions." - `RequestedPricingModifiers.PricingModifiersAirChange.WaiverCode` (object) A code assigned by an airline to support waiver of fees or ticket value as a result of disruption to the passenger. - `RequestedPricingModifiers.PricingModifiersAirChange.TaxExemption` (object) GDS only, not supported for NDC. Use to mark some or all taxes as exempt. Specify all taxes, only specific tax codes, or all taxes in specific countries. Must include either allTaxesExemptInd OR both countries and taxCodes. TaxExemption supports up to nine values for countries, taxCodes, or both combined. The response returns any exempt taxes with exemptInd=true and value=0. - `RequestedPricingModifiers.PricingModifiersAirChange.PromotionalCode` (object) NDC only. Not supported for GDS. Any NDC airline designated promotional code. - `RequestedPricingModifiers.PricingModifiersAirChange.SellCity` (string) Overrides the sell city of the requestor Example: "MEX" - `RequestedPricingModifiers.PricingModifiersAirChange.TicketCity` (string) Overrides the ticket city of the requestor Example: "MEX" - `RequestedPricingModifiers.PricingModifiersAirChange.PricingPCC` (string) Overrides the pricing PCC of the requestor Example: "0XS4" - `RequestedPricingModifiers.PricingModifiersAirChange.TicketingPCC` (string) Overrides the ticketing PCC of the requestor Example: "0XCD" - `RequestedPricingModifiers.PricingModifiersAirChange.CalculatedFareAdjustment` (object) Used in Exchange Search to modify the Price of the Fare. Discriminator classes CalculatedFareAdjustmentDiscount or CalculatedFareAdjustmentIncrease - `RequestedPricingModifiers.PricingModifiersAirChange.BrandPreference` (array) - `RequestedPricingModifiers.PricingModifiersAirChange.keepToBrandInd` (boolean) If true, the offerings returned will be of the same brand as the original Offer Example: true - `RequestedPricingModifiers.PricingModifiersAirChange.returnMostRestrictiveBrandInd` (boolean) if true, the most restrictive brand will be returned in the response when there are different brands present in the Offering Example: true - `RequestedPricingModifiers.PricingModifiersAirChange.doNotNetInd` (boolean) If true, this exchange will not net any residual/refundable amounts against due amounts. - `RequestedPricingModifiers.lowFareFinderInd` (boolean) Provides pricing flexibility around class of service. If not sent, the response returns fares only in the requested class of service. If true, returns the lowest fares available in any class of service available, which may not be the same as the requested class. Note that if lowFareFinderInd is sent with true and CabinPreference is sent, the only supported value for CabinPreference/type is Permitted. When lowFareFindInd=true and brand attributes are not disabled (inhibitBrandContentInd), AirPrice uses only the brand tier (and any other pricing modifiers) to find the lowest fare within a brand tier regardless of class of service. GDS only; not supported for NDC. Example: true - `RequestedPricingModifiers.keepToBrandInd` (boolean) If true, the original brand will be maintained during the exchange process. Example: true - `RequestedPricingModifiers.lowFareFindAndRebookInd` (boolean) If true, the original flights in the reservation will be rebooked or replaced with the new exchanged flights. - `PassengerCriteriaRefs` (array) NDC only; not supported for GDS. Returned for NDC if a traveler identifier was sent for this traveler in the previous workflow requests. Example: ["passengerCriteria_1"] - `FlightPassCredits` (integer) The number of flight pass credits consumed for this pricebreakdown. Example: 1 - PriceBreakdownAncillary: - `inclusiveOfTaxInd` (boolean) If true, this ancillary is sold inclusive of tax. Example: true - `quantity` (integer) The quantity of ancillary items included in this PriceBreakdown. Example: 1 - `Description` (object) A description of the ancillary with description codes. - `Description.value` (string) The text description of the ancillary. Example: "Vegetarian Meal" - `Description.code` (string) The ATPCO group code. Example: "BG" - `Description.subCode` (string) The ATPCO RFISC subcode. Example: "0D4" - `Description.subGroup` (string) The ATPCO sub group code. Example: "SP" - `Description.codeContext` (string) The code context value. Example: "ATPCO" - `Description.ssrCode` (string) The four character AIRIMP SSR code for this ancillary. Example: "VGML" - `Description.issuanceReasonCode` (string) The airline provided reason for issuance code. Example: "C" - `Description.geographicSpecification` (string) How the ancillary is applied across the itinerary. Enum: same as `Ancillary.Description.geographicSpecification` in "ProductAncillary" (3 values) - `ProductRef` (string) The product ref this PriceBreakdown applies to. If no productRef exists then the PriceBreakdown applies to all Products within the Offer. Example: "p_1" - `Discount` (object) NDC only; not supported for GDS. Returned for a fare discounted from the published price, such as a promotional discount. Not returned for privately negotiated discounts such as private fares. - `Discount.value` (number) The amount value of the discount Example: 20.22 - `Discount.description` (string) The text description for the discount. Example: "Spring discount on group bookings" - `Discount.currencyCode` (string, required) Currency code discount is returned in. Example: "USD" - `Discount.codeAuthority` (string, required) Not used. Currency code Authority. Example: "ISO" - `Discount.decimalPlace` (integer, required) Number of decimal places in the currency the discount is returned in. Example: 2 - `Discount.decimalAuthority` (string) Not used. Decimal Authority. Example: "ISO" - `TravelerIdentifierRef` (object) Identifier references as object both within a message payload or an object held in cache that may be used for subsequent workflows. Returned for NDC in the Price response if age was sent for this traveler in the previous workflow requests. - `TravelerIdentifierRef.name` (string) Traveler identifier - `TravelerIdentifierRef.passengerTypeCode` (string) Passenger Type code Example: "ADT" - `TravelerIdentifierRef.ages` (array) The ages of the travelers associated to a particular ptc. For NDC, this value will be returned in PriceBreakdownAir if sent as part of the PassengerCriteria in the Air Search request. Example: [15] - `TravelerIdentifierRef.passengerCriteriaRef` (string) Allows the user to associate passenger criteria information. Example: "passengerCriteria_1" - `TravelerIdentifierRef.value` (string) - `TravelerIdentifierRef.id` (string) A locally referenced ID - `TravelerIdentifierRef.description` (string) Descriptive text used to identify the contents of a target object - `TravelerIdentifierRef.uris` (array) Uniform Resource Identifier Example: ["google.com"] - `TravelerIdentifierRef.age` (integer) Replaced with ages array. The age of the traveler. Example: 11 - `AncillaryPriceApplicationCode` (object) Determines how an ancillary price has been built. - `AncillaryPriceApplicationCode.value` (string) Example: "3" - `AncillaryPriceApplicationCode.application` (string) Associated text. Example: "PerItem" - PriceBreakdownHospitality: - `roomPricingType` (string) A string provided by the hotel to describe how a service is priced, such as per night or per stay. Enum: "Per stay", "Per person", "Per night", "Per person per night", "Per use" - `Description` (string) Example: "Advance Purchase-Ro-Free WiFi" - `NightlyRate` (array) - `NightlyRate.@type` (string) - `NightlyRate.startDate` (string, required) Start date for the nightly rate in YYYY-MM-DD format. - `NightlyRate.nights` (integer) Number of nights the nightly rate is valid. - `NightlyRate.Amount` (object, required) Amount represents the cost applied - `AverageNightlyRate` (array) The average nightly rate for a given offer. - `AverageNightlyRate.value` (number) The amount of a given currency. Example: 124.56 - `AverageNightlyRate.code` (string) An ISO 4217 alpha character code (3 characters) that specifies a money unit. Example: "USD" - `AverageNightlyRate.minorUnit` (integer) Minor units are a mechanism for expressing the relationship between a major currency unit and its corresponding minor currency unit. It is the smallest unit of a given currency. For example; the smallest denomination in USD is the cent, which is 1/100 of a USD, and the minor unit value is 2. Not all currencies have a minor unit. Example: 2 - `AverageNightlyRate.currencySource` (string) The system requesting or returning the currency code specified in the attribute Enum: same as `MinimumAdcolAmount.currencySource` in "ChangePermitted" (3 values) - `AverageNightlyRate.approximateInd` (boolean) "If true, the currency amount has been converted from the original amount. For Air Exchange Eligibility, returned only if a currency is converted. If returned, the value is always true, indicating that the fee is approximate because of currency conversion. For Hotel Availability and Rules, true indicates this is a calculated value; false indicates this is the value returned by the property." Example: true - `AmenitySurcharges` (object) Amenity Surcharges information. - `AmenitySurcharges.@type` (string, required) Discriminator classes AmenitySurcharges or AmenitySurchargesDetail Example: "AmenitySurchargesDetail" - `AmenitySurcharges.TotalSurcharges` (number) A monetary amount, up to 4 decimal places. Decimal place needs to be included. Example: 211.11 - `AmenitySurcharges.approximateInd` (boolean) if true, the surcharge amounts are approximate - `AmenitySurcharges.Surcharge` (array, required) - `AmenitySurcharges.Surcharge.value` (number) Surcharge amount Example: 12 - `AmenitySurcharges.Surcharge.currencyCode` (string) ISO 4217 currency code for the surcharge. Example: "USD" - `AmenitySurcharges.Surcharge.surchargeCode` (string) Surcharge code Example: "ADDITIONAL COSTS" - `AmenitySurcharges.Surcharge.reportingAuthority` (string) Not used. Surcharge reporting authority Example: "Federal register" - `AmenitySurcharges.Surcharge.purpose` (string) Surcharge purpose. For Air workflows possible values include Weekend Surcharge, Stopover Charge, Multiple Stopover Charges, Other (default value that covers all other surcharges such as fuel surcharges). Example: "Weekend Surcharge" - `AmenitySurcharges.Surcharge.description` (string) Description of the surcharge. Example: "Rollaway Surcharge" - `AmenitySurcharges.Surcharge.surchargeApplication` (string) Application values (such as the application of a fee) like per person or per room. Enum: same as `Surcharge.surchargeApplication` (7 values) - `AmenitySurcharges.Surcharge.surchargeFrequency` (string) The frequency of a fee such as per night or per stay. Enum: same as `Surcharge.surchargeFrequency` (6 values) - `AmenitySurcharges.Surcharge.codeAuthority` (string) Not used. Currency code authority. Example: "ISO 4217" - `AmenitySurcharges.Surcharge.decimalPlace` (integer) Decimal place for the currency unit. Example: 4 - `AmenitySurcharges.Surcharge.decimalAuthority` (string) Not used. Currency code decimal authority. Example: "ISO 4217" - `priceChangesDuringStayInd` (boolean) "If true, indicates the price changes at least once during requested dates. If roomPricingType = Per night, multiple instances of priceChangesDuringStayInd are returned." - `shortRateDescription` (string) A normalized rate description for comparing rates across multiple aggregators. Example: "Flexible Rate" - PriceBreakdownVehiclePrice: - `VehiclePrice` (object, required) Rate summary for rental of the vehicle. - `VehiclePrice.@type` (string, required) Example: "VehiclePrice" - `VehiclePrice.id` (string) Internal ID - `VehiclePrice.rateSource` (string) Assigned Type: c-1100:StringTiny - `VehiclePrice.rateGuaranteedInd` (boolean) Assigned Type: c-1100:OptionalIndicator - `VehiclePrice.ratePeriod` (string) The time period for a rate such as daily, weekly, monthly Enum: "Hour", "Day", "Week", "Month", "Year", "Total", "RentalPeriod", "Weekend", "Bundle", "Package", "ExtraHour", "ExtraDay", "ExtraWeek", "ExtraMonth", "Other" - `VehiclePrice.RateDistance` (object) Rate for the period defined by the attributes - `VehiclePrice.RateDistance.value` (number) - `VehiclePrice.RateDistance.unlimitedDistanceInd` (boolean) if true unlimited miles is included with the rental - `VehiclePrice.RateDistance.requestedCodeAppliedInd` (boolean) if true, the requested code has been applied - `VehiclePrice.RateDistance.allowance` (integer) The distance allowance permitted with this rate. Use in combination with distanceUnits and ratePeriod - `VehiclePrice.RateDistance.distanceUnits` (string) For Hotels: Optional object to request either miles or kilometers for the search radius from the specified location. If unitOfDistance is not specified, the search defaults to miles for properties in the United States, Myanmar, and Liberia. The search defaults to kilometers in all other countries. Enum: same as `Vehicle.VehicleDateLocation.RentalPickup.GeoLocation.altitudeUnitOfDistance` in "ProductVehicle" (2 values) - `VehiclePrice.RateDistance.ratePeriod` (string) The time period for a rate such as daily, weekly, monthly Enum: same as `VehiclePrice.ratePeriod` in "PriceBreakdownVehiclePrice" (15 values) - `VehiclePrice.RateDescription` (array) - `sequence` (integer) The order of the text block, if there are more than one block. Example: 2 - `description` (string) Text block detail description Example: "description" - `Image` (object) Each instance is one image and its accompanying details, including a link to the image. Key value pairs; not all may be returned. - `Image.value` (string) URL of the image - `Image.dimensionCategory` (string) Deprecated and replaced by imageSize - `Image.width` (integer) Image width Example: 42 - `Image.height` (integer) Image height Example: 43 - `Image.caption` (string) Image caption Example: "Ticket" - `Image.pictureCategory` (integer) deprecated and replaced by pictureOf Example: 5 - `Image.imageSize` (string) A size for the image to return, allowing you to set image quality. Hospitality APIs no longer support thumbnail. Enum: same as `Vehicle.Image.imageSize` in "ProductVehicle" (5 values) - `Image.pictureOf` (string) The image category Enum: same as `Vehicle.Image.pictureOf` in "ProductVehicle" (26 values) - `URL` (string) A URL for this block - `DateCreateModify` (object, required) Time stamp of the creation. - `DateCreateModify.value` (string) Example: "2026-03-04T11:22:00Z" - `DateCreateModify.creatorID` (string) ID of creator. Software system identifier or an employee id Example: "c1234563" - `DateCreateModify.lastModify` (string) Time stamp of last modification. Example: "2026-03-04T11:24:00Z" - `DateCreateModify.lastModifierID` (string) Identifies the last software system or person to modify a record Example: "m346789" - `DateCreateModify.purge` (string) Date an item will be purged from a system of record Example: "2026-03-03" - `VehiclePrice.RateDescription.@type` (string, required) Discriminator classes TextBlock or TextBlockDetail Example: "TextBlockDetail" - `VehiclePrice.RateDescription.title` (string) "The title of the rule or information. For TermsAndConditionsFullHospitality, may include any of the following Rule Types; Promotional Data, Rate Description, Room Rate Data, Rate Text, Guarantee, Cancellation, Deposit, Check in/out, Room detail, Extra charges, Packages, Property, Location, Miscellaneous, Rate Amount, Alternate Rate Amount, Rate Comment, FAX, Phone, Special Information, Information, Room Hold Expiration Time. Not every property returns all of these types. Some properties do not return any title. Only English is supported for these values." Example: "Baggage Details" - `VehiclePrice.RateDescription.id` (string) Internally referenced id Example: "2" - `VehiclePrice.RateDescription.TextFormatted` (array, required) - `VehiclePrice.RateAvailability` (string) Options are available to sell, need to call, or closed Enum: "Available", "NeedToCall", "Closed" - `VehiclePrice.SupplierRate` (object, required) Estimated total amount - Monetary amounts expressed in another currency. - `VehiclePrice.SupplierRate.@type` (string, required) Example: "SupplierRate" - `VehiclePrice.SupplierRate.BaseRate` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.SupplierRate.BaseRate.value` (number) The amount of a given currency. Example: 124.56 - `VehiclePrice.SupplierRate.BaseRate.code` (string) An ISO 4217 alpha character code (3 characters) that specifies a money unit. Example: "USD" - `VehiclePrice.SupplierRate.BaseRate.minorUnit` (integer) Minor units are a mechanism for expressing the relationship between a major currency unit and its corresponding minor currency unit. It is the smallest unit of a given currency. For example; the smallest denomination in USD is the cent, which is 1/100 of a USD, and the minor unit value is 2. Not all currencies have a minor unit. Example: 2 - `VehiclePrice.SupplierRate.BaseRate.currencySource` (string) The system requesting or returning the currency code specified in the attribute Enum: same as `MinimumAdcolAmount.currencySource` in "ChangePermitted" (3 values) - `VehiclePrice.SupplierRate.BaseRate.approximateInd` (boolean) "If true, the currency amount has been converted from the original amount. For Air Exchange Eligibility, returned only if a currency is converted. If returned, the value is always true, indicating that the fee is approximate because of currency conversion. For Hotel Availability and Rules, true indicates this is a calculated value; false indicates this is the value returned by the property." Example: true - `VehiclePrice.SupplierRate.RateForPeriod` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.SupplierRate.DropOffCharge` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.SupplierRate.ExtraMileageCharge` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.SupplierRate.EstimatedTotalAmount` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.ApproximateRate` (object) Estimated total amount - Monetary amounts expressed in another currency. - `VehiclePrice.ApproximateRate.@type` (string, required) Example: "ApproximateRate" - `VehiclePrice.ApproximateRate.BaseRate` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.ApproximateRate.RateForPeriod` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.ApproximateRate.DropOffCharge` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.ApproximateRate.ExtraMileageCharge` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.ApproximateRate.EstimatedTotalAmount` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.CustomerLoyalty` (object) Specifies the ID for the membership program. Object for sending customer loyalty information, such as for a frequent flyer program. For Hotel send the loyalty card number in the value field, followed by programID with the hotel chain code, and supplierType: Hotel. For Air send the loyalty card number in the value field, followed by airline code in "supplier". For cross accrual use the "shareWithSupplier" field to submit to partner airlines. - `VehiclePrice.CustomerLoyalty.value` (string, required) Number on loyalty card. Example: "132456" - `VehiclePrice.CustomerLoyalty.id` (string) Optional Customer Loyalty Id. Not saved Example: "Loyalty_1" - `VehiclePrice.CustomerLoyalty.priority` (integer) Optional Numeric Priority Code Example: 2 - `VehiclePrice.CustomerLoyalty.programId` (string) "Specifies an identifier to indicate the company owner of the loyalty program. Typically two characters. For frequent guest number, the hotel supplier or brand code. For frequent flyer number, the air supplier code of the loyalty program." Example: "HY" - `VehiclePrice.CustomerLoyalty.programName` (string) Supplier's loyalty program name. Example: "Frontier-EarlyReturns" - `VehiclePrice.CustomerLoyalty.supplierType` (string) The type of supplier of a loyalty program. Uses 'hotel' for frequent guest number or 'air' for frequent flyer number. Example: "Hotel" - `VehiclePrice.CustomerLoyalty.supplier` (string) Supplier of a loyalty program (typically 2 characters representing the hotel, brand, or airline). Example: "UA" - `VehiclePrice.CustomerLoyalty.tier` (string) Customer Loyalty tier Example: "Silver" - `VehiclePrice.CustomerLoyalty.shareWithSupplier` (array) The list of suppliers that the CustomerLoyalty number is shared. Used for cross accrual. Example: ["LH"] - `VehiclePrice.CustomerLoyalty.cardHolderName` (string) Customer loyalty member name; up to 128 characters are supported. In Air Search, for discounted offers to be returned, the name must be sent as LAST FIRST; e.g.,if SMITH is the last name and JORDAN the first name, send as SMITH JORDAN Example: "John Smith" - `VehiclePrice.CustomerLoyalty.validatedInd` (boolean) Customer loyalty number has been validated by the supplier Example: true - `VehiclePrice.CustomerLoyalty.prefix` (string) The cardholder name prefix title like Mr, Mrs, Dr Example: "Dr" - `VehiclePrice.CustomerLoyalty.given` (string) The First Name of the Cardholder Example: "John" - `VehiclePrice.CustomerLoyalty.middle` (string) Middle Name of the Cardholder Example: "Wilkinson" - `VehiclePrice.CustomerLoyalty.surname` (string) Last Name of the Cardholder Example: "Smith" - `VehiclePrice.RateQualifier` (string) A closed enumeration of possible rate qualifiers for vehicle rental Enum: "Other", "PostPayment", "Guarantee", "PrePayment", "Deposit" - `rateGuaranteedInd` (boolean) - PriceBreakdownVehicleDeposit: - `totalPayableNowInd` (boolean) If True the Amount is the total amount payable now - `totalPayableLaterInd` (boolean) If True the Amount is the total amount payable later - PriceBreakdownVehicleCharges: - `VehicleCharges` (object) - `VehicleCharges.@type` (string, required) Example: "VehicleCharges" - `VehicleCharges.description` (string) Assigned Type: c-1100:String - `VehicleCharges.VehicleChargePurposeCode` (object) Any code used to specify an item, for example a type of traveler, service code, room amenity, etc. - `VehicleCharges.VehicleChargePurposeCode.value` (string) Example: "INS" - `VehicleCharges.VehicleChargePurposeCode.codeContext` (string) Code Context Example: "ACRISS" - `VehicleCharges.ratePeriod` (string) The time period for a rate such as daily, weekly, monthly Enum: same as `VehiclePrice.ratePeriod` in "PriceBreakdownVehiclePrice" (15 values) - `VehicleCharges.rateChargeInfo` (string) Assigned Type: c-1100:String - `VehicleCharges.RateCategory` (string) For Hotel Search, request a rate category by sending up to 8 OTA rate categories to search for. If the supplier has rates available for the requested category, the response contains those rates and indicates them as such. Some properties do not return these rates unless explicitly requested. For a Hotel Rules request, this value can be found, if returned, in the Availability response's ProductRateCodeInfo/RateCodeInfo/rateCategory. Enum: "All", "Association", "Business", "BusinessStandard", "Club", "Convention", "Corporate", "Consortiums", "Discount", "Credential", "Employee", "FamilyPlan", "FullInclusive", "Government", "Inclusive", "Industry/TravelAgentRate", "Leisure", "Military", "Monthly", "Multi-DayPackage", "MultLevel/Negotiated/Secure", "Other", "Package", "PrePaid", "Promotional", "RackGeneral", "SeniorCitizen", "Standard", "Tour", "VIP", "Weekend", "Weekly" - `VehicleCharges.VehicleCoverageTypeCode` (object) The OTA code defined for the Vehicle Coverage Type - `VehicleCharges.VehicleCoverageTypeCode.value` (string) Example: "INS" - `VehicleCharges.VehicleCoverageTypeCode.codeContext` (string) Code Context Example: "ACRISS" - `VehicleCharges.Calculation` (array) - `VehicleCharges.Calculation.@type` (string, required) Example: "Calculation" - `VehicleCharges.Calculation.UnitAmount` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehicleCharges.Calculation.UnitName` (string) The time period for a rate such as daily, weekly, monthly Enum: same as `VehiclePrice.ratePeriod` in "PriceBreakdownVehiclePrice" (15 values) - `VehicleCharges.Calculation.Quantity` (integer) The quantity used in the calculation of the vehicle charge e.g 2 x $500 per week - `VehicleCharges.Calculation.MaxQuantity` (integer) The maximum quantity allowed for a charge e.g Baby seat charged at $10 per day for a maximum of 10 days - `VehicleCharges.Calculation.TotalAmount` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehicleCharges.Calculation.Percent` (number) Used when the charge is based on a percentage of a TotalAmount - `VehicleCharges.Calculation.Applicability` (object) Textual information. - `VehicleCharges.taxInclusiveInd` (boolean) - `VehicleCharges.guaranteedInd` (boolean) - `VehicleCharges.payNowInd` (boolean) If true the vehicle charge must be paid now and is included in the totalPrice calculation - `VehicleCharges.includedInEstimatedTotalInd` (boolean) - `VehicleCharges.includedInBaseRateInd` (boolean) If true the Vehicle Charge has been included in the base rate of the Vehicle price - `PriceBreakdown.@type` (string, required) Discriminator - Air Search and Air Price APIs child classes are PriceBreakdownAir and PriceBreakdownAncillary. - Search Ancillaries and Seat Availabilities child classes are PriceBreakdown, PriceBreakdownAncillary, and PriceBreakdownAncillaryAir. - All Hotel API child classes are PriceBreakdownHospitality. - Vehicle API child classes are PriceBreakdownVehicleCharges, PriceBreakdownVehicleDeposit, PriceBreakdownVehiclePrice, and PriceBreakdownAncillaryVehicle. - Reservation and Reservation Workbench APIs are PriceBreakdownAir, PriceBreakdownAncillary, PriceBreakdownHospitality, PriceBreakdownVehicleCharges, PriceBreakdownVehicleDeposit, PriceBreakdownVehiclePrice, and PriceBreakdownAncillaryVehicle. Example: "PriceBreakdownAir" - `PriceBreakdown.Amount` (object) Amount represents the cost applied - `PriceBreakdown.Amount.@type` (string) - `PriceBreakdown.Amount.currencySource` (string) The system requesting or returning the currency code specified in the attribute Enum: same as `MinimumAdcolAmount.currencySource` in "ChangePermitted" (3 values) - `PriceBreakdown.Amount.CurrencyCode` (object) Currency codes are the three-letter alphabetic codes that represent the various currencies used throughout the world. Unless changed in the request, the currency is the default associated with your provisioned PCC from Travelport. For Hotel: SourceCurrency is based on the location of the hotel and used for all rates in the response. TargetCurrency is the currency code sent in the request in requestedCurrency. - `PriceBreakdown.Amount.Base` (number) The base price prior to all applicable taxes or fees of a product, such as the amount for a room or fare for a flight (one passenger). Example: 120.2 - `PriceBreakdown.Amount.Taxes` (object) Summary of all individual taxes. Child class TaxesDetail provides the breakdown of individual taxes. - `Tax` (array) - `TaxPercent` (object) Returned when the tax is expressed as a percentage of the amount. - `PriceBreakdown.Amount.Fees` (object) Includes TotalFees object to return the sum total of any fees. May include array of Fee objects to break down individual fees. Child class FeesDetail may also include a breakdown of the individual fees. - `Fee` (array) Array of individual fees. - `PriceBreakdown.Amount.Total` (number) "Specifies the total price including base + taxes + fees. In PriceBreakdownHospitality, this total is for a given group of nights. In PriceBreakdownAir this is the total of base cost and all fees and taxes for one passenger of this PTC type." Example: 230.13 - `PriceBreakdown.Amount.approximateInd` (boolean) if true this amount has been converted from the original amount Example: true - `PriceBreakdown.Commission` (object) — one of (discriminator: @type): GDS only; not supported for NDC. Commission information. Any commission filed by an airline in a CAT35 fare is returned in PriceBreakdownAir/Commission. The amount is either a percent of the fare component (@type CommissionPercent and the Percent object) or an amount (@type CommissionAmount and the Amount object)." - CommissionAmount: - `Amount` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `Amount.value` (number) The amount of a given currency. Example: 124.56 - `Amount.code` (string) An ISO 4217 alpha character code (3 characters) that specifies a money unit. Example: "USD" - `Amount.minorUnit` (integer) Minor units are a mechanism for expressing the relationship between a major currency unit and its corresponding minor currency unit. It is the smallest unit of a given currency. For example; the smallest denomination in USD is the cent, which is 1/100 of a USD, and the minor unit value is 2. Not all currencies have a minor unit. Example: 2 - `Amount.currencySource` (string) The system requesting or returning the currency code specified in the attribute Enum: same as `MinimumAdcolAmount.currencySource` in "ChangePermitted" (3 values) - `Amount.approximateInd` (boolean) "If true, the currency amount has been converted from the original amount. For Air Exchange Eligibility, returned only if a currency is converted. If returned, the value is always true, indicating that the fee is approximate because of currency conversion. For Hotel Availability and Rules, true indicates this is a calculated value; false indicates this is the value returned by the property." Example: true - CommissionPercent: - `Percent` (number) Percent amount of commission Example: 20 - `PriceBreakdown.Commission.@type` (string, required) Discriminator. Child classes CommissionAmount or CommissionPercent Example: "CommissionAmount" - `PriceBreakdown.Commission.application` (string) Type of commission Enum: "Full", "Partial", "Non-paying", "No-show", "Adjustment", "Commissionable" - `ModifyPrice.@type` (string, required) Discriminator classes ModifyPrice or ModifyPriceDetail Example: "ModifyPriceDetail" - `ModifyPrice.id` (string) Internally referenced id Example: "2" - `ModifyPrice.CurrencyCode` (object) Currency codes are the three-letter alphabetic codes that represent the various currencies used throughout the world. Unless changed in the request, the currency is the default associated with your provisioned PCC from Travelport. For Hotel: SourceCurrency is based on the location of the hotel and used for all rates in the response. TargetCurrency is the currency code sent in the request in requestedCurrency. - `ModifyPrice.Base` (number) The total amount not including taxes and\/or fees Example: 20.2 - `ModifyPrice.TotalTaxes` (number) The total of the taxes included in the total price Example: 34.4 - `ModifyPrice.TotalFees` (number) The total of the fees included in the total price Example: 201 - `ModifyPrice.TotalPrice` (number) The total price of the product in the currency indicated Example: 34 - `ModifyPrice.VendorCurrencyTotal` (object) No longer used. Previously used to expose the local vendor currency when it is different to the purchased currency - OfferModify: - `isNetted` (string) Used to indicate if all, some, or none of the fare components can be exchanged or refunded. Enum: "All", "Some", "None" - `OfferIdentifier` (object) Travelport-generated offer identifier number. - `OfferIdentifier.id` (string) Local identifier within a given message for this object. Example: "offer_1" - `OfferIdentifier.offerRef` (string) Used to reference another instance of this object in the same message Example: "offer_1" - `OfferIdentifier.Identifier` (object) A globally unique identifier key often used to reference a given option (such as Pricing, Booking, Rules, or additional workflows) or to retrieve information (such as Hotel pagination). - `ModifyPrice` (object, required) The extended class of Modify Price. - `ModifyPrice.@type` (string, required) Discriminator classes ModifyPrice or ModifyPriceDetail Example: "ModifyPriceDetail" - `ModifyPrice.id` (string) Internally referenced id Example: "2" - `ModifyPrice.CurrencyCode` (object) Currency codes are the three-letter alphabetic codes that represent the various currencies used throughout the world. Unless changed in the request, the currency is the default associated with your provisioned PCC from Travelport. For Hotel: SourceCurrency is based on the location of the hotel and used for all rates in the response. TargetCurrency is the currency code sent in the request in requestedCurrency. - `ModifyPrice.Base` (number) The total amount not including taxes and\/or fees Example: 20.2 - `ModifyPrice.TotalTaxes` (number) The total of the taxes included in the total price Example: 34.4 - `ModifyPrice.TotalFees` (number) The total of the fees included in the total price Example: 201 - `ModifyPrice.TotalPrice` (number) The total price of the product in the currency indicated Example: 34 - `ModifyPrice.PriceBreakdown` (array) — one of (discriminator: @type): - PriceBreakdownAir: - `quantity` (integer) Quantity of passengers in that PTC. Example: 2 - `requestedPassengerType` (string) The PTC to which the PriceBreakdown applies. Example: "CHD" - `FiledAmount` (object) Returned only in the Price APIs. GDS only; not supported for NDC. The base amount of a ticket price or net price that is filed in local currency. Returned when the origin currency is not the same as the PCC currency to show the currency in which the base fare has been filed. When used for NetBaseAmount: Net ticket data (NTD) is returned in the AirPrice, AirReservation, Exchange Search, and Reservation Retrieve responses for any GDS fare that has a private fare component (fareType=AgencyPrivateFare). When NTD is returned, TermsAndConditionsFuill includes FareGuaranteePolicy to return the fare calculation indicator for the fare. When NTD is returned, PriceBreakdown may include NetBaseAmount. - `FiledAmount.value` (number) Filed amount value Example: 43.3422 - `FiledAmount.currencyCode` (string) Code for the currency in which the base fare was filed. Example: "USD" - `FiledAmount.codeAuthority` (string) Filed amount currency code authority Example: "Australian Dollar" - `FiledAmount.decimalPlace` (integer, required) Number of decimal places in the currency in ISO 4217 standard format. Example: 3 - `FiledAmount.decimalAuthority` (string) ISO 4217 standard decimal authority Example: "ISO 4217" - `Discount` (object) NDC only; not supported for GDS. Returned for a fare discounted from the published price, such as a promotional discount. Not returned for privately negotiated discounts such as private fares. - `Discount.value` (number) The amount value of the discount Example: 20.22 - `Discount.description` (string) The text description for the discount. Example: "Spring discount on group bookings" - `Discount.currencyCode` (string, required) Currency code discount is returned in. Example: "USD" - `Discount.codeAuthority` (string, required) Not used. Currency code Authority. Example: "ISO" - `Discount.decimalPlace` (integer, required) Number of decimal places in the currency the discount is returned in. Example: 2 - `Discount.decimalAuthority` (string) Not used. Decimal Authority. Example: "ISO" - `NetFareInfo` (object) Detailed information on the net fare used. - `NetFareInfo.@type` (string, required) Example: "NetFareInfo" - `NetFareInfo.passengerTypeCode` (string) PassengerTypeCode Example: "ADT" - `NetFareInfo.NetFareBreakdownConstruction` (array) - `NetFareInfo.NetFareBreakdownConstruction.value` (string) - `NetFareInfo.NetFareBreakdownConstruction.fareType` (string) Assigned Type: c-1100:StringTiny - `NetFareInfo.NetFareBreakdownConstruction.rateOfExchange` (number) The rate of exchange applied to the fare breakdown - `NetFareInfo.TicketBaseAudit` (object) Returned only in the Price APIs. GDS only; not supported for NDC. The base amount of a ticket price or net price that is filed in local currency. Returned when the origin currency is not the same as the PCC currency to show the currency in which the base fare has been filed. When used for NetBaseAmount: Net ticket data (NTD) is returned in the AirPrice, AirReservation, Exchange Search, and Reservation Retrieve responses for any GDS fare that has a private fare component (fareType=AgencyPrivateFare). When NTD is returned, TermsAndConditionsFuill includes FareGuaranteePolicy to return the fare calculation indicator for the fare. When NTD is returned, PriceBreakdown may include NetBaseAmount. - `NetFareInfo.TicketBasePassenger` (object) The monetary value - `NetFareInfo.TicketBasePassenger.value` (number) - `NetFareInfo.TicketBasePassenger.currencyCode` (string) Assigned Type: c-1100:CurrencyCode - `NetFareInfo.TicketBasePassenger.codeAuthority` (string, required) Assigned Type: c-1100:CodeContext - `NetFareInfo.TicketBasePassenger.decimalPlace` (integer, required) Assigned Type: c-1100:CurrencyMinorUnit - `NetFareInfo.TicketBasePassenger.decimalAuthority` (string) Assigned Type: c-1100:CodeContext - `NetFareInfo.TicketBasePassenger.bTInd` (boolean) If true, this is a bulk ticket fare - `NetFareInfo.TicketBasePassenger.iTInd` (boolean) If true, this is an inclusive tour fare - `TravelerIdentifierRef` (object) Identifier references as object both within a message payload or an object held in cache that may be used for subsequent workflows. Returned for NDC in the Price response if age was sent for this traveler in the previous workflow requests. - `TravelerIdentifierRef.name` (string) Traveler identifier - `TravelerIdentifierRef.passengerTypeCode` (string) Passenger Type code Example: "ADT" - `TravelerIdentifierRef.ages` (array) The ages of the travelers associated to a particular ptc. For NDC, this value will be returned in PriceBreakdownAir if sent as part of the PassengerCriteria in the Air Search request. Example: [15] - `TravelerIdentifierRef.passengerCriteriaRef` (string) Allows the user to associate passenger criteria information. Example: "passengerCriteria_1" - `TravelerIdentifierRef.value` (string) - `TravelerIdentifierRef.id` (string) A locally referenced ID - `TravelerIdentifierRef.description` (string) Descriptive text used to identify the contents of a target object - `TravelerIdentifierRef.uris` (array) Uniform Resource Identifier Example: ["google.com"] - `TravelerIdentifierRef.age` (integer) Replaced with ages array. The age of the traveler. Example: 11 - `NetBaseAmount` (object) Returned only in the Price APIs. GDS only; not supported for NDC. The base amount of a ticket price or net price that is filed in local currency. Returned when the origin currency is not the same as the PCC currency to show the currency in which the base fare has been filed. When used for NetBaseAmount: Net ticket data (NTD) is returned in the AirPrice, AirReservation, Exchange Search, and Reservation Retrieve responses for any GDS fare that has a private fare component (fareType=AgencyPrivateFare). When NTD is returned, TermsAndConditionsFuill includes FareGuaranteePolicy to return the fare calculation indicator for the fare. When NTD is returned, PriceBreakdown may include NetBaseAmount. - `FareCalculation` (string) GDS only; not supported for NDC. For each PTC, when available, FareCalculation returns the fare calculation ladder for all public and private fare types filed by an agency or an airline. Example: "LON BA SYD R564.00YEE1Y BA LON R564.00YEE1Y NUC1128.00END ROE0.787855" - `Surcharges` (object) In AirSearch workflow this applies to GDS only. Not supported for NDC, which does not return surcharges. Returned if surcharges apply to this offer. For GDS only, for a multi-city offer with stopovers (see multi-city offers with stopovers for details), surcharges and commission amounts are for the entire journey. For all other offers, the surcharges and commission amounts are for each leg (origin and destination pair). A multi-city offer can be identified by the jc in its CombinabilityCode: jc1, jc2. Surcharges can be omitted from the Search response with excludeSurchargesInd. - `Surcharge` (array, required) - `Surcharge.value` (number) Surcharge amount Example: 12 - `Surcharge.currencyCode` (string) ISO 4217 currency code for the surcharge. Example: "USD" - `Surcharge.surchargeCode` (string) Surcharge code Example: "ADDITIONAL COSTS" - `Surcharge.reportingAuthority` (string) Not used. Surcharge reporting authority Example: "Federal register" - `Surcharge.purpose` (string) Surcharge purpose. For Air workflows possible values include Weekend Surcharge, Stopover Charge, Multiple Stopover Charges, Other (default value that covers all other surcharges such as fuel surcharges). Example: "Weekend Surcharge" - `Surcharge.description` (string) Description of the surcharge. Example: "Rollaway Surcharge" - `Surcharge.surchargeApplication` (string) Application values (such as the application of a fee) like per person or per room. Enum: same as `Surcharge.surchargeApplication` (7 values) - `Surcharge.surchargeFrequency` (string) The frequency of a fee such as per night or per stay. Enum: same as `Surcharge.surchargeFrequency` (6 values) - `Surcharge.codeAuthority` (string) Not used. Currency code authority. Example: "ISO 4217" - `Surcharge.decimalPlace` (integer) Decimal place for the currency unit. Example: 4 - `Surcharge.decimalAuthority` (string) Not used. Currency code decimal authority. Example: "ISO 4217" - `Surcharges.@type` (string, required) Discriminator class is SurchargesDetail Example: "SurchargesDetail" - `Surcharges.TotalSurcharges` (number) A monetary amount, up to 4 decimal places. Example: 211.11 - `Surcharges.approximateInd` (boolean) If true, the surcharge amounts are approximate. - `TravelerRefs` (array) Returned only in Reservation Retrieve to identify the traveler associated with this instance of PriceBreakdown in case of multiple offers on the booking. Example: ["[\"traveler_1\",\"traveler2\"]"] - `PaidTaxes` (object) Summary Taxes object - `Tax` (array) - `Tax.value` (number) Amount of the tax. Returned as 0 if a tax was marked as exempt with TaxExemption. Example: 12.2 - `Tax.currencyCode` (string) A ISO 4217 currency code associated to the value. Example: "USD" - `Tax.taxCode` (string) "Code for the tax. For Hotels this is the OTA code." Example: "XF2" - `Tax.reportingAuthority` (string) Identifies the reporting authority such as airport code for XF taxes Example: "JFK1" - `Tax.purpose` (string) Supplier returned description of tax. Example: "Fuel surcharge" - `Tax.description` (string) "Short summary of the tax. In Air workflows this is returned only for NDC. Note that descriptions are not returned for tax codes YQ and YR, which are fees charged by airlines and not government-imposed taxes. For Hotels this is the OTA tax description." Example: "Lodging tax" - `Tax.includedInBase` (string) Yes , No , Unknown Enum: same as `instantPurchase` in "AdvanceReservationRequired" (3 values) - `Tax.codeAuthority` (string) Not used. Currency Code Authority Example: "ISO" - `Tax.decimalPlace` (integer) Permitted number of decimals. Associated to the currency value. Example: 2 - `Tax.decimalAuthority` (string) Not used. Currency decimal authority Example: "ISO" - `Tax.exemptInd` (boolean) GDS only; not supported for NDC. Returned if a tax was marked exempt in a prior request with the TaxExemption pricing modifer. If true, this tax is exempt" Example: true - `Tax.nonRefundableInd` (boolean) If true, the tax is non refundable. This indicator is only supported for exchange search and exchange price quote transactions. Example: true - `Tax.excludedFromTotalPriceInd` (boolean) Returned in Hotel APIs when a tax is not included in the TotalPrice. Default behavior is for taxes to be included in TotalPrice. Example: true - `TaxPercent` (object) Returned when the tax is expressed as a percentage of the amount. - `TaxPercent.value` (number) The tax percentage amount. Example: 5.5 - `TaxPercent.taxCode` (string) Any code for the tax. Example: "971 - IRS Notice" - `TaxPercent.reportingAuthority` (string) Tax reporting authority Example: "Georgia Department of Revenue" - `TaxPercent.purpose` (string) Purpose of tax Example: "statutory tax" - `TaxPercent.description` (string) Description Example: "1.5% of SGST" - `TaxPercent.includedInBase` (string) Yes , No , Unknown Enum: same as `instantPurchase` in "AdvanceReservationRequired" (3 values) - `PaidTaxes.@type` (string, required) Discriminator classes PaidTaxes or PaidTaxesDetail Example: "PaidTaxesDetail" - `PaidTaxes.TotalTaxes` (number) A monetary amount, up to 4 decimal places. Decimal place needs to be included. Example: 220.12 - `RequestedPricingModifiers` (array) - `RequestedPricingModifiers.@type` (string, required) Discriminator. Example: "RequestedPricingModifiers" - `RequestedPricingModifiers.PassengerCriteria` (object) Defines the passenger criteria. Send one PassengerCriteria for each passenger type code (PTC). Search supports up to 9 total passengers. A maximum of 6 PTCs are supported for GDS. NDC does not have a PTC limitation. AirPrice supports up to nine total passengers across all PTCs. - `TravelerIdentifierRef` (object, required) Identifier references as object both within a message payload or an object held in cache that may be used for subsequent workflows. Returned for NDC in the Price response if age was sent for this traveler in the previous workflow requests. - `RequestedPricingModifiers.PassengerCriteria.@type` (string, required) Discriminator. No child classes. Example: "PassengerCriteria" - `RequestedPricingModifiers.PassengerCriteria.number` (integer, required) The amount of passengers associated with this passenger type code. Default is 1. Example: 1 - `RequestedPricingModifiers.PassengerCriteria.age` (integer) The age of the passenger. Notes on PTC and age: - Travelport recommends sending age only with PTCs that require age for pricing. - If the age is sent in the request, for NDC only, the age is returned in the pricing response. - For child passengers, Travelport recommends sending the age of the child in the age attribute plus the PTC CNN. Travelport recommends against sending CNN without age, or the CHD PTC. Not all fares cannot be quoted for CHD. - The age for CNN is generally between 2 and 11 inclusive, with ADT fares returned for ages 12 and up; however, this can vary by airline and country. - The age for INF must be either 0 or 1. - During booking, date of birth is required for all child and infant PTCs (Add Traveler payload in Traveler/birthDate). Example: 26 - `RequestedPricingModifiers.PassengerCriteria.passengerTypeCode` (string) The passenger type code (PTC) for the passengers on the itinerary. Required field for Air Search and Flight specific search. Common PTCs are: - ADT: adult - CHD: child of unknown age - For child passengers, Travelport recommends sending the age of the child in the age attribute plus the PTC CNN. Travelport recommends against sending CNN without age, or the CHD PTC. Many fares cannot be quoted for CHD. - CNN: child when age is known - The age for CNN is generally between 2 and 11 inclusive, with ADT fares returned for ages 12 and up; however, this can vary by airline and country. - INF: infant without a seat - INS: infant with a seat - UNN: unaccompanied child. See API guides to download a full list of PTCs. NDC carriers BA, SQ, AV, AA, and AF/KLM offer teen/young adult tax exemptions from the UK Air Passenger Duty (GB tax). Send PTC with the value YTH and send the passengers age per below. The PTC may be returned as ADT, or Cxx in which xx is the age, but the tax exemption is applied in the pricing on these NDC carriers. For marine fares, send the PTC value SEA. You must also send OSI remarks at Add Traveler with the vessel name and location. Marine fares are private fares for travelers going to or from a vessel. NDC only; not supported for GDS. When running a multiple passenger search for NDC on Qantas, Qantas supports only these PTCs: ADT, CHD, CNN, INF. Sending any other PTC may result in an error at ticketing. Any traveler sent without a PTC value is defaulted to ADT. PTC can be sent or omitted for ADT passenger. AirReservation defaults the PTC to ADT and returns it in the Reservation Retrieve. Example: "ADT" - `RequestedPricingModifiers.PassengerCriteria.birthDate` (string) The date of birth of the passenger. May be used in age validation for fares with age restrictions. Example: "2020-01-16" - `RequestedPricingModifiers.PassengerCriteria.id` (string) Unique id to support referencing of this specific passenger criteria. Example: "passengercriteria_001" - `RequestedPricingModifiers.PassengerCriteria.CustomerLoyalty` (array) NDC only; not supported for GDS. Optional object for sending customer loyalty information, such as for a frequent flyer program. If CustomerLoyalty is sent in the Search request, it must also be sent in the Air Price request and the Add Traveler request. As some carriers validate frequent traveler data through the workflow, failing to send the same CustomerLoyalty details, even if invalid, may cause a booking failure. If an invalid number is sent, the response returns a warning message that the FQTV is invalid, and the invalid number is cached to prevent a potential booking failure. - `RequestedPricingModifiers.PassengerCriteria.TravelerGeographicLocation` (object) For AirSearch: supported/validated only for NDC to support local citizen fares. For AirPrice and AirReservation: GDS only; not supported for NDC. Optional object for requesting local citizen/local resident fares for Spain and associated islands. You must also send a PTC relevant to the local resident fares; e.g., ADR for adult resident, CHR for child resident. Any discount applied through TravelerGeographicLocation applies to all travelers, not only to the traveler in this instance of PassengerCriteria. If the discount must apply only to an individual traveler, that traveler requires a separate search and book workflow. - `RequestedPricingModifiers.PassengerCriteria.specifiedPassengerTypeCodeOnlyInd` (boolean) GDS only; not supported for NDC. - If true: returns only offers for the specified PTC. If no fares are available for the specified PTC, returns an error message that there is no valid fare. - If false (default behavior): If no fares are available for the specified PTC, returns fares for the default ADT (adult) PTC instead. Example: true - `RequestedPricingModifiers.PricingModifiersAir` (object) A selection of Pricing Modifiers that can be used to influence the Price of an Offer. - For the AirPrice reference payload request, if any price modifiers were included in the preceding Search request and no price modifiers are sent in the AirPrice request, the cached price modifiers sent at Search are sent with the AirPrice request. If any price modifiers are sent in the AirPrice reference payload request, all cached Search modifiers are discarded and only the modifiers sent in that AirPrice request are used. - For the Add Offer request, you may optionally store fares with one or more pricing modifiers. If a pricing modifier is not added, the auto stored fare is added to the reservation. There is no change in the AirReservation response when pricing modifiers are requested. AirReservation applies modifiers from Add Offer and earlier steps as follows: - Modifiers sent in the Add Offer request (supported for both full and reference payload). - If no modifiers are sent in Add Offer, any pricing modifiers sent in AirPrice are applied. - If no modifiers were sent in AirPrice, or if AirPrice was not sent, any pricing modifiers sent in Search are applied. GDS only; pricing modifiers not supported for NDC. If the requested modifier does not have any fares associated with it, the workbench commit fails and returns the error message 'No Fare Found'. Pricing happens at commit, not at Add Offer. - `Brand` (object) Information on airline Brand offerings. If brand attributes were not excluded with inhibitBrandContentInd=true (GDS only), then brand attributes are returned and consolidated in ReferenceList/ReferenceListBrand. In this case Brand does not return the name or Identifier objects but instead returns only BrandRef, which matches to the brand identifier (e.g., b1) in ReferenceListBrand. - `RequestedPricingModifiers.PricingModifiersAir.@type` (string, required) Discriminator. Child classes PricingModifiersAir and PricingModifersAirDetail Example: "PricingModifiersAir" - `RequestedPricingModifiers.PricingModifiersAir.currencyCode` (string) In an API request, send the currency type to return if you want to override the default currency specified with your PCC. Example: "GBP" - `RequestedPricingModifiers.PricingModifiersAir.FareSelection` (object) Requests the return of fare types including private fares (negotiated), public fares (published), or net fares (consolidator fares, or any negotiated wholesale price that is further marked up for sale to customers). May be used to request fares with specific restrictions, change, or refund options. - `RequestedPricingModifiers.PricingModifiersAir.OrganizationInformation` (object) Use to send account codes for negotiated fares or to send optional India GST SSR Remarks in GSTRegistrationNumber. For NDC supports corporate loyalty program and GST Information. This information is returned in TermsAndConditions." - `RequestedPricingModifiers.PricingModifiersAir.TaxExemption` (object) GDS only, not supported for NDC. Use to mark some or all taxes as exempt. Specify all taxes, only specific tax codes, or all taxes in specific countries. Must include either allTaxesExemptInd OR both countries and taxCodes. TaxExemption supports up to nine values for countries, taxCodes, or both combined. The response returns any exempt taxes with exemptInd=true and value=0. - `RequestedPricingModifiers.PricingModifiersAir.PromotionalCode` (array) - `RequestedPricingModifiers.PricingModifiersAir.SellCity` (string) GDS only, not supported for NDC. The IATA location code for a city. Overrides the sell city of the requester to specify an alternate sale location and return fares based on that location. The response returns pricing in the local currency for the specified sell city instead of the PCC's default currency. Example: "NYC" - `RequestedPricingModifiers.PricingModifiersAir.TicketCity` (string) GDS only, not supported for NDC. The IATA location code for a city. Overrides the ticketing city of the requester to specify an alternate ticket location and return fares based on that location; the response returns pricing in the local currency for the specified ticket city instead of the PCC's default currency. Example: "NYC" - `RequestedPricingModifiers.PricingModifiersAir.PricingPCC` (string) GDS only, not supported for NDC. Use to send a faring PCC for which a selective access or code group agreement exists between that PCC and the PCC associated with your account. The following combinations of PricingPCC and FareSelection/fareType=PrivateFaresOnly return results as follows: - PricingPCC sent and PrivateFaresOnly not requested: If a selective access or group agreement exists, both public and any available private fares are returned for the requesting and providing PCC. - If no selective access or group agreement exists, only public fares are returned. - PricingPCC sent and PrivateFaresOnly is requested: If a selective access or group agreement exists that allows private fare access, only available private fares are returned for the requesting and providing PCC. - If no agreement exists, or if an agreement exists but does not allow private fares access, an error is returned. Example: "0Bx3" - `RequestedPricingModifiers.PricingModifiersAir.FareBasisCodeOverride` (array) - `RequestedPricingModifiers.PricingModifiersAir.MultiPricingAgency` (array) The customer can send up to 3 Pseudo City Codes (PCCs) in PricingModifiersAir, MultiPricingAgency. If a customer sends more than 3 PCCs in MultiPricingAgency, only the first 3 are validated. If a customer sends both PricingPCC and MultiPricingAgency with PCCs, the PCC in PricingPCC is ignored. Example: ["[\"0XS4\",\"0YBZ\",\"J80K\"]"] - `RequestedPricingModifiers.PricingModifiersAir.TicketingPCC` (string) GDS only, not supported for NDC. In an API request, overrides the ticketing PCC associated with your account to specify an alternate PCC and return fares based on that PCC. Example: "0XS4" - `RequestedPricingModifiers.PricingModifiersAir.CalculatedFareAdjustment` (object) Used in Exchange Search to modify the Price of the Fare. Discriminator classes CalculatedFareAdjustmentDiscount or CalculatedFareAdjustmentIncrease - `RequestedPricingModifiers.PricingModifiersAir.ManualFareAdjustment` (array) Send to manually adjust the base fare amount on all fares for a specific PTC. - `RequestedPricingModifiers.PricingModifiersAir.BrandPreference` (array) - `RequestedPricingModifiers.PricingModifiersAir.includeSplitPaymentInd` (boolean) Requests request split ticketing, which returns outbound and inbound one-way fares in addition to round trip options in the Search API response. This may result in lower fares than the same or similar round-trip itinerary. If true, requests split ticketing. If false or omitted split ticketing options are not returned. Default is false. GDS only, not supported for NDC. When split ticketing is requested, the Search response returns offers in the following order: Outbound one-way offers, Inbound one-way offers, Round trip offers. The response identifies all one-way outbound and inbound offers with CombinabilityCode j0. CombinabilityCode values for round trip offers start at j1 and increment by one for each offer. Only the following are in scope for split ticketing: Search (not supported for Next Leg Search or Flight Specific Search), Round-trip journey-based offerings ( isJourney header not sent or sent as true, or CustomResponseModifiersAir/SearchRepresentation not sent or sent with value Journey ) Upsells. Split ticketing is not supported for round-trip leg-based searches, virtual interlining, or NDC. Split ticketing is available only for customers specifically provisioned for split ticketing. Split ticketing returns one-way outbound and one-way inbound fares in addition to round-trip offers. Split ticket offers are identified with CombinabilityCode j0. If your account is not configured for split ticketing, sending includeSplitPaymentInd returns a response without split ticket offers and a warning message. GDS only, not supported for NDC. In Air Price, For split ticketing, the request must send offers that are identified in the Search response with CombinabilityCode j0, which identifies those offers as one-way outbound and one-way inbound split ticketing offers. A combination of j0 and any non-j0 value offer returns an error message that split pricing is not supported - `RequestedPricingModifiers.PricingModifiersAir.returnMostRestrictiveBrandInd` (boolean) In Search API, when there are different brands on a connecting flight, return information for either the most restrictive brand or the brand on the most significant segment on the itinerary. If true, return the offer brand of the most restrictive brand. If false or omitted, return the offer brand of the most significant segment of the itinerary. GDS only, not supported for NDC. - `RequestedPricingModifiers.PricingModifiersAir.splitPaymentOfferings` (number) Number between 0 and 99. Send with includeSplitPaymentInd to configure the percentage of round trip offers to return in a split ticketing response. By default, Search divides the split ticketing response into 34% round-trip offerings and the remainder as split ticketing offers, which are combined outbound and inbound one-way fares. To change this percentage, send SplitPaymentOfferings with the percentage value of round trip offers to return. Example: 25 - `RequestedPricingModifiers.CabinPreference` (object) Requests a fare based on the cabin class. Only one cabin preferenceType (Permitted, Preferred, PreferredWithUpgrade) is allowed per request, but there is no limit to the number of cabins that can be sent. Any CabinPreference in the initial Search request is applied to any subsequent Next Leg Search and reference Flight Specific Search requests. In AirPrice and AirReservation only one cabin preference type is allowed per request, but there is no limit to the number of cabins that can be sent. If CabinPreference was sent in the Search request, it is cached and sent with the AirPrice reference payload request. If you send CabinPreference in the AirPrice request, all cached modifiers are discarded and only the modifiers sent in the AirPrice request are used. Can be combined with lowFareFinderInd=true to return lowest fare in the requested cabin or cabins. When using CabinPreference and lowFareFinderInd, if both CabinPreference and a class of service are sent, class of service is ignored. If CabinPreference is sent without a class of service, the response returns the lowest fare in the cabin requested. If that cabin is not available, the response may upgrade or downgrade to a different cabin. If a different cabin than requested is returned, the response returns the message that the cabin class may differ from the class requested. If lowFareFinderInd=false and CabinPreference are sent in the request, AirPrice ignores the preferred cabin and returns a message that the preferred cabin was ignored. If CabinPreference is set to All, no cabin preference is applied." - `RequestedPricingModifiers.CabinPreference.@type` (string, required) Discriminator. No child classes exist Example: "CabinPreference" - `RequestedPricingModifiers.CabinPreference.preferenceType` (string) Type of cabin preference. Sending a mix of preferenceType values is not supported. For example, you cannot send an instance of CabinPreference with a preferenceType of Permitted and another instance with preferenceType of Prohibited. In this case the results default to the Preferred preference. Note that if lowFareFinderInd is sent with true and CabinPreference is sent, the only supported value for CabinPreference/type is Permitted. Enum: same as `RequestedPricingModifiers.CabinPreference.preferenceType` in "PriceBreakdownAir" (4 values) - `RequestedPricingModifiers.CabinPreference.cabins` (array) A space-delimited list of cabins. Enum: same as `PassengerFlight.FlightProduct.cabin` in "ProductAir" (5 values) - `RequestedPricingModifiers.CabinPreference.legSequence` (array) Limits preference to the specified leg referenced in SearchCriteriaFlight. You can apply the preference to only some legs of the itinerary, or different preferences to different legs. To apply preference to the entire itinerary, do not send legSequence. GDS only, not supported for NDC. Not supported at Price or Book. Example: [1,2] - `RequestedPricingModifiers.FlightType` (object) The type of flight connection - `RequestedPricingModifiers.FlightType.@type` (string, required) Discriminator. No child classes. Example: "FlightType" - `RequestedPricingModifiers.FlightType.connectionType` (string) Limits the connection type returned. Each value returns the specified type and all higher types. For example, StopDirect could return both flights that stop without a change of planes (StopDirect) and non-stop direct flights (NonStopDirect). SingleConnection or DoubleConnection will not exclude StopDirect flights from the journey. For example, SingleConnection could return an itinerary with two flight numbers, and either of these flights could have intermediate stops. Enum: same as `RequestedPricingModifiers.FlightType.connectionType` in "PriceBreakdownAir" (5 values) - `RequestedPricingModifiers.FlightType.excludeInterlineConnectionsInd` (boolean) Excludes interline connectionsClosed from results. If true, does not return offers with interline connections. If false or omitted, may return interline connections in results. Default is false. GDS only, not supported for NDC. When a product contains multiple interline air segments, brand details return only the brand of the significant carrier, not the validating/plating carrier brand information. The IATA rules for determining the significant carrier on an itinerary are based on the areas in which the transportation takes place. Example: true - `RequestedPricingModifiers.CustomResponseModifiersAir` (object) Contains additional modifiers to customize the result set. Includes optional indicators for returning or excluding specified response content. Values sent at Search can carry forward into the Next Leg Search request and are not re-sent. - `RequestedPricingModifiers.CustomResponseModifiersAir.@type` (string, required) discriminator Example: "CustomResponseModifiersAir" - `RequestedPricingModifiers.CustomResponseModifiersAir.BrandAttributeInclusion` (array) Supported in AirSearch and AirPrice. Returns only information about the brand attributes specified and does not return any other brand attributes. - `RequestedPricingModifiers.CustomResponseModifiersAir.SearchRepresentation` (string) Specifies either a journey or leg-based response. Journey returns offers for all legs of the itinerary. Journey is the default. Leg returns offers for only the first leg of the itinerary. Must be followed with a Next Leg Search to select an offer for the first leg and return offers on the subsequent leg to combine with it.Customize search result set as leg or journey based. Next Leg Search requests, and Flight Specific Search requests for less than the full itinerary, are supported only after a leg-based Search, not a journey-based Search. If these requests follow a journey-based Search request, an error message is returned. Enum: same as `RequestedPricingModifiers.CustomResponseModifiersAir.SearchRepresentation` in "PriceBreakdownAir" (3 values) - `RequestedPricingModifiers.CustomResponseModifiersAir.excludePenaltiesInd` (boolean) GDS only; not supported for NDC. Indicator to omit change and cancel penalties. - If true: omits all penalty information from the response. - If false (default behavior): returns any change and penalty details provided by carrier for each offer in TermsAndConditionsFullAir/Penalties. If sent in Search but not in AirPrice, the value sent in Search is cached and applied to the AirPrice results. However, you can override the value sent in Search by sending excludePenaltiesInd in the AirPrice request with the opposite value. For example, if the Search request sends excludePenaltiesInd=true and the AirPrice request sends excludePenaltiesInd=false, the Search response does not return penalties and the AirPrice response does return penalties. Example: true - `RequestedPricingModifiers.CustomResponseModifiersAir.excludeBaggageFeesInd` (boolean) GDS only; not supported for NDC. Indicator to exclude baggage details. - If true: excludes baggage fees, carry on fees, and embargo information from the response. Baggage quantity or weight is returned instead. - If false (default behavior): baggage details returned in response. Default is false. Example: true - `RequestedPricingModifiers.CustomResponseModifiersAir.includeFareCalculationInd` (boolean) GDS only; not supported for NDC or in the Flight Specific Search full payload request. Indicator to request the return of the fare calculation ladder. - If true: returns the fare calculation ladder in BestCombinablePrice.PriceBreakdownAir.FareCalculation. - If false (default behavior): fare calculation ladder is not returned. Example: true - `RequestedPricingModifiers.CustomResponseModifiersAir.excludeSurchargesInd` (boolean) GDS only; not supported for NDC. Indicator to exclude a surcharge breakdown. - If true: excludes a surcharge breakdown from the response. Baggage quantity or kilos is returned instead. - If false (default behavior): surcharge breakdown returned in response. Example: true - `RequestedPricingModifiers.CustomResponseModifiersAir.excludeUnbundledFaresInd` (boolean) GDS only, not supported for NDC. Sets whether to return unbundled fares. Supported in AirSearch and AirPrice. - If true: does not return unbundled fares. - If false (default behavior): returns unbundled and bundled fares as available. Example: true - `RequestedPricingModifiers.CustomResponseModifiersAir.includeCO2EmissionsDataInd` (boolean) Indicator to return CO2 emission data in the Search and Next Leg Search responses. - If true: returns CO2 emission data. - If false (default behavior): CO2 emission data not returned. Example: true - `RequestedPricingModifiers.CustomResponseModifiersAir.includeFlightAmenitiesInd` (boolean) Indicator to return flight amenities from ATPCO RouteHappy data. - If true: includes amenities in the response if available. - If false: Does not return ATPCO RouteHappy amenities. Example: true - `RequestedPricingModifiers.CustomResponseModifiersAir.includeUniversalProductAttributesInd` (boolean) Indicator to return universal product attributes (UPAs), which include images, icons, and URLs as provided by ATPCO. Must also send includeFlightAmenitiesInd=true. - If true: returns universal product attributes if available. - If false (default behavior): Universal product attributes not returned. UPAs are not returned for direct flights with intermediate stops, non-flight segments such as trains, or for Premium Business class. Example: true - `RequestedPricingModifiers.CustomResponseModifiersAir.includeBundledAncillariesInd` (boolean) NDC only. If true: the search and price response will include bundled air and ancillary offerings/offers. Search and Price response will contain both ProductAir and ProductAncillary plus a new child class of PriceBreakdown: PriceBreakdownAncillaryAir to define the ancillary inclusion and pricing. Example: true - `RequestedPricingModifiers.CustomResponseModifiersAir.includeFullPenaltyDisclosureInd` (boolean) If true, penalty information sourced from ATPCO Cat 31 and 33 will be disclosed. Penalties may be exposed at fare component level and include time windows. - `RequestedPricingModifiers.PricingModifiersAirChange` (object) Pricing Modifiers that can be used to influence the Price of an Exchanged Offer - `RequestedPricingModifiers.PricingModifiersAirChange.@type` (string) Example: "PricingModifiersAirChange" - `RequestedPricingModifiers.PricingModifiersAirChange.currencyCode` (string) ISO 4217 currency code Example: "USD" - `RequestedPricingModifiers.PricingModifiersAirChange.FareSelection` (object) Requests the return of fare types including private fares (negotiated), public fares (published), or net fares (consolidator fares, or any negotiated wholesale price that is further marked up for sale to customers). May be used to request fares with specific restrictions, change, or refund options. - `RequestedPricingModifiers.PricingModifiersAirChange.OrganizationInformation` (object) Use to send account codes for negotiated fares or to send optional India GST SSR Remarks in GSTRegistrationNumber. For NDC supports corporate loyalty program and GST Information. This information is returned in TermsAndConditions." - `RequestedPricingModifiers.PricingModifiersAirChange.WaiverCode` (object) A code assigned by an airline to support waiver of fees or ticket value as a result of disruption to the passenger. - `RequestedPricingModifiers.PricingModifiersAirChange.TaxExemption` (object) GDS only, not supported for NDC. Use to mark some or all taxes as exempt. Specify all taxes, only specific tax codes, or all taxes in specific countries. Must include either allTaxesExemptInd OR both countries and taxCodes. TaxExemption supports up to nine values for countries, taxCodes, or both combined. The response returns any exempt taxes with exemptInd=true and value=0. - `RequestedPricingModifiers.PricingModifiersAirChange.PromotionalCode` (object) NDC only. Not supported for GDS. Any NDC airline designated promotional code. - `RequestedPricingModifiers.PricingModifiersAirChange.SellCity` (string) Overrides the sell city of the requestor Example: "MEX" - `RequestedPricingModifiers.PricingModifiersAirChange.TicketCity` (string) Overrides the ticket city of the requestor Example: "MEX" - `RequestedPricingModifiers.PricingModifiersAirChange.PricingPCC` (string) Overrides the pricing PCC of the requestor Example: "0XS4" - `RequestedPricingModifiers.PricingModifiersAirChange.TicketingPCC` (string) Overrides the ticketing PCC of the requestor Example: "0XCD" - `RequestedPricingModifiers.PricingModifiersAirChange.CalculatedFareAdjustment` (object) Used in Exchange Search to modify the Price of the Fare. Discriminator classes CalculatedFareAdjustmentDiscount or CalculatedFareAdjustmentIncrease - `RequestedPricingModifiers.PricingModifiersAirChange.BrandPreference` (array) - `RequestedPricingModifiers.PricingModifiersAirChange.keepToBrandInd` (boolean) If true, the offerings returned will be of the same brand as the original Offer Example: true - `RequestedPricingModifiers.PricingModifiersAirChange.returnMostRestrictiveBrandInd` (boolean) if true, the most restrictive brand will be returned in the response when there are different brands present in the Offering Example: true - `RequestedPricingModifiers.PricingModifiersAirChange.doNotNetInd` (boolean) If true, this exchange will not net any residual/refundable amounts against due amounts. - `RequestedPricingModifiers.lowFareFinderInd` (boolean) Provides pricing flexibility around class of service. If not sent, the response returns fares only in the requested class of service. If true, returns the lowest fares available in any class of service available, which may not be the same as the requested class. Note that if lowFareFinderInd is sent with true and CabinPreference is sent, the only supported value for CabinPreference/type is Permitted. When lowFareFindInd=true and brand attributes are not disabled (inhibitBrandContentInd), AirPrice uses only the brand tier (and any other pricing modifiers) to find the lowest fare within a brand tier regardless of class of service. GDS only; not supported for NDC. Example: true - `RequestedPricingModifiers.keepToBrandInd` (boolean) If true, the original brand will be maintained during the exchange process. Example: true - `RequestedPricingModifiers.lowFareFindAndRebookInd` (boolean) If true, the original flights in the reservation will be rebooked or replaced with the new exchanged flights. - `PassengerCriteriaRefs` (array) NDC only; not supported for GDS. Returned for NDC if a traveler identifier was sent for this traveler in the previous workflow requests. Example: ["passengerCriteria_1"] - `FlightPassCredits` (integer) The number of flight pass credits consumed for this pricebreakdown. Example: 1 - PriceBreakdownAncillary: - `inclusiveOfTaxInd` (boolean) If true, this ancillary is sold inclusive of tax. Example: true - `quantity` (integer) The quantity of ancillary items included in this PriceBreakdown. Example: 1 - `Description` (object) A description of the ancillary with description codes. - `Description.value` (string) The text description of the ancillary. Example: "Vegetarian Meal" - `Description.code` (string) The ATPCO group code. Example: "BG" - `Description.subCode` (string) The ATPCO RFISC subcode. Example: "0D4" - `Description.subGroup` (string) The ATPCO sub group code. Example: "SP" - `Description.codeContext` (string) The code context value. Example: "ATPCO" - `Description.ssrCode` (string) The four character AIRIMP SSR code for this ancillary. Example: "VGML" - `Description.issuanceReasonCode` (string) The airline provided reason for issuance code. Example: "C" - `Description.geographicSpecification` (string) How the ancillary is applied across the itinerary. Enum: same as `Ancillary.Description.geographicSpecification` in "ProductAncillary" (3 values) - `ProductRef` (string) The product ref this PriceBreakdown applies to. If no productRef exists then the PriceBreakdown applies to all Products within the Offer. Example: "p_1" - `Discount` (object) NDC only; not supported for GDS. Returned for a fare discounted from the published price, such as a promotional discount. Not returned for privately negotiated discounts such as private fares. - `Discount.value` (number) The amount value of the discount Example: 20.22 - `Discount.description` (string) The text description for the discount. Example: "Spring discount on group bookings" - `Discount.currencyCode` (string, required) Currency code discount is returned in. Example: "USD" - `Discount.codeAuthority` (string, required) Not used. Currency code Authority. Example: "ISO" - `Discount.decimalPlace` (integer, required) Number of decimal places in the currency the discount is returned in. Example: 2 - `Discount.decimalAuthority` (string) Not used. Decimal Authority. Example: "ISO" - `TravelerIdentifierRef` (object) Identifier references as object both within a message payload or an object held in cache that may be used for subsequent workflows. Returned for NDC in the Price response if age was sent for this traveler in the previous workflow requests. - `TravelerIdentifierRef.name` (string) Traveler identifier - `TravelerIdentifierRef.passengerTypeCode` (string) Passenger Type code Example: "ADT" - `TravelerIdentifierRef.ages` (array) The ages of the travelers associated to a particular ptc. For NDC, this value will be returned in PriceBreakdownAir if sent as part of the PassengerCriteria in the Air Search request. Example: [15] - `TravelerIdentifierRef.passengerCriteriaRef` (string) Allows the user to associate passenger criteria information. Example: "passengerCriteria_1" - `TravelerIdentifierRef.value` (string) - `TravelerIdentifierRef.id` (string) A locally referenced ID - `TravelerIdentifierRef.description` (string) Descriptive text used to identify the contents of a target object - `TravelerIdentifierRef.uris` (array) Uniform Resource Identifier Example: ["google.com"] - `TravelerIdentifierRef.age` (integer) Replaced with ages array. The age of the traveler. Example: 11 - `AncillaryPriceApplicationCode` (object) Determines how an ancillary price has been built. - `AncillaryPriceApplicationCode.value` (string) Example: "3" - `AncillaryPriceApplicationCode.application` (string) Associated text. Example: "PerItem" - PriceBreakdownHospitality: - `roomPricingType` (string) A string provided by the hotel to describe how a service is priced, such as per night or per stay. Enum: same as `roomPricingType` in "PriceBreakdownHospitality" (5 values) - `Description` (string) Example: "Advance Purchase-Ro-Free WiFi" - `NightlyRate` (array) - `NightlyRate.@type` (string) - `NightlyRate.startDate` (string, required) Start date for the nightly rate in YYYY-MM-DD format. - `NightlyRate.nights` (integer) Number of nights the nightly rate is valid. - `NightlyRate.Amount` (object, required) Amount represents the cost applied - `AverageNightlyRate` (array) The average nightly rate for a given offer. - `AverageNightlyRate.value` (number) The amount of a given currency. Example: 124.56 - `AverageNightlyRate.code` (string) An ISO 4217 alpha character code (3 characters) that specifies a money unit. Example: "USD" - `AverageNightlyRate.minorUnit` (integer) Minor units are a mechanism for expressing the relationship between a major currency unit and its corresponding minor currency unit. It is the smallest unit of a given currency. For example; the smallest denomination in USD is the cent, which is 1/100 of a USD, and the minor unit value is 2. Not all currencies have a minor unit. Example: 2 - `AverageNightlyRate.currencySource` (string) The system requesting or returning the currency code specified in the attribute Enum: same as `MinimumAdcolAmount.currencySource` in "ChangePermitted" (3 values) - `AverageNightlyRate.approximateInd` (boolean) "If true, the currency amount has been converted from the original amount. For Air Exchange Eligibility, returned only if a currency is converted. If returned, the value is always true, indicating that the fee is approximate because of currency conversion. For Hotel Availability and Rules, true indicates this is a calculated value; false indicates this is the value returned by the property." Example: true - `AmenitySurcharges` (object) Amenity Surcharges information. - `AmenitySurcharges.@type` (string, required) Discriminator classes AmenitySurcharges or AmenitySurchargesDetail Example: "AmenitySurchargesDetail" - `AmenitySurcharges.TotalSurcharges` (number) A monetary amount, up to 4 decimal places. Decimal place needs to be included. Example: 211.11 - `AmenitySurcharges.approximateInd` (boolean) if true, the surcharge amounts are approximate - `AmenitySurcharges.Surcharge` (array, required) - `AmenitySurcharges.Surcharge.value` (number) Surcharge amount Example: 12 - `AmenitySurcharges.Surcharge.currencyCode` (string) ISO 4217 currency code for the surcharge. Example: "USD" - `AmenitySurcharges.Surcharge.surchargeCode` (string) Surcharge code Example: "ADDITIONAL COSTS" - `AmenitySurcharges.Surcharge.reportingAuthority` (string) Not used. Surcharge reporting authority Example: "Federal register" - `AmenitySurcharges.Surcharge.purpose` (string) Surcharge purpose. For Air workflows possible values include Weekend Surcharge, Stopover Charge, Multiple Stopover Charges, Other (default value that covers all other surcharges such as fuel surcharges). Example: "Weekend Surcharge" - `AmenitySurcharges.Surcharge.description` (string) Description of the surcharge. Example: "Rollaway Surcharge" - `AmenitySurcharges.Surcharge.surchargeApplication` (string) Application values (such as the application of a fee) like per person or per room. Enum: same as `Surcharge.surchargeApplication` (7 values) - `AmenitySurcharges.Surcharge.surchargeFrequency` (string) The frequency of a fee such as per night or per stay. Enum: same as `Surcharge.surchargeFrequency` (6 values) - `AmenitySurcharges.Surcharge.codeAuthority` (string) Not used. Currency code authority. Example: "ISO 4217" - `AmenitySurcharges.Surcharge.decimalPlace` (integer) Decimal place for the currency unit. Example: 4 - `AmenitySurcharges.Surcharge.decimalAuthority` (string) Not used. Currency code decimal authority. Example: "ISO 4217" - `priceChangesDuringStayInd` (boolean) "If true, indicates the price changes at least once during requested dates. If roomPricingType = Per night, multiple instances of priceChangesDuringStayInd are returned." - `shortRateDescription` (string) A normalized rate description for comparing rates across multiple aggregators. Example: "Flexible Rate" - PriceBreakdownVehiclePrice: - `VehiclePrice` (object, required) Rate summary for rental of the vehicle. - `VehiclePrice.@type` (string, required) Example: "VehiclePrice" - `VehiclePrice.id` (string) Internal ID - `VehiclePrice.rateSource` (string) Assigned Type: c-1100:StringTiny - `VehiclePrice.rateGuaranteedInd` (boolean) Assigned Type: c-1100:OptionalIndicator - `VehiclePrice.ratePeriod` (string) The time period for a rate such as daily, weekly, monthly Enum: same as `VehiclePrice.ratePeriod` in "PriceBreakdownVehiclePrice" (15 values) - `VehiclePrice.RateDistance` (object) Rate for the period defined by the attributes - `VehiclePrice.RateDistance.value` (number) - `VehiclePrice.RateDistance.unlimitedDistanceInd` (boolean) if true unlimited miles is included with the rental - `VehiclePrice.RateDistance.requestedCodeAppliedInd` (boolean) if true, the requested code has been applied - `VehiclePrice.RateDistance.allowance` (integer) The distance allowance permitted with this rate. Use in combination with distanceUnits and ratePeriod - `VehiclePrice.RateDistance.distanceUnits` (string) For Hotels: Optional object to request either miles or kilometers for the search radius from the specified location. If unitOfDistance is not specified, the search defaults to miles for properties in the United States, Myanmar, and Liberia. The search defaults to kilometers in all other countries. Enum: same as `Vehicle.VehicleDateLocation.RentalPickup.GeoLocation.altitudeUnitOfDistance` in "ProductVehicle" (2 values) - `VehiclePrice.RateDistance.ratePeriod` (string) The time period for a rate such as daily, weekly, monthly Enum: same as `VehiclePrice.ratePeriod` in "PriceBreakdownVehiclePrice" (15 values) - `VehiclePrice.RateDescription` (array) - `sequence` (integer) The order of the text block, if there are more than one block. Example: 2 - `description` (string) Text block detail description Example: "description" - `Image` (object) Each instance is one image and its accompanying details, including a link to the image. Key value pairs; not all may be returned. - `Image.value` (string) URL of the image - `Image.dimensionCategory` (string) Deprecated and replaced by imageSize - `Image.width` (integer) Image width Example: 42 - `Image.height` (integer) Image height Example: 43 - `Image.caption` (string) Image caption Example: "Ticket" - `Image.pictureCategory` (integer) deprecated and replaced by pictureOf Example: 5 - `Image.imageSize` (string) A size for the image to return, allowing you to set image quality. Hospitality APIs no longer support thumbnail. Enum: same as `Vehicle.Image.imageSize` in "ProductVehicle" (5 values) - `Image.pictureOf` (string) The image category Enum: same as `Vehicle.Image.pictureOf` in "ProductVehicle" (26 values) - `URL` (string) A URL for this block - `DateCreateModify` (object, required) Time stamp of the creation. - `DateCreateModify.value` (string) Example: "2026-03-04T11:22:00Z" - `DateCreateModify.creatorID` (string) ID of creator. Software system identifier or an employee id Example: "c1234563" - `DateCreateModify.lastModify` (string) Time stamp of last modification. Example: "2026-03-04T11:24:00Z" - `DateCreateModify.lastModifierID` (string) Identifies the last software system or person to modify a record Example: "m346789" - `DateCreateModify.purge` (string) Date an item will be purged from a system of record Example: "2026-03-03" - `VehiclePrice.RateDescription.@type` (string, required) Discriminator classes TextBlock or TextBlockDetail Example: "TextBlockDetail" - `VehiclePrice.RateDescription.title` (string) "The title of the rule or information. For TermsAndConditionsFullHospitality, may include any of the following Rule Types; Promotional Data, Rate Description, Room Rate Data, Rate Text, Guarantee, Cancellation, Deposit, Check in/out, Room detail, Extra charges, Packages, Property, Location, Miscellaneous, Rate Amount, Alternate Rate Amount, Rate Comment, FAX, Phone, Special Information, Information, Room Hold Expiration Time. Not every property returns all of these types. Some properties do not return any title. Only English is supported for these values." Example: "Baggage Details" - `VehiclePrice.RateDescription.id` (string) Internally referenced id Example: "2" - `VehiclePrice.RateDescription.TextFormatted` (array, required) - `VehiclePrice.RateAvailability` (string) Options are available to sell, need to call, or closed Enum: same as `VehiclePrice.RateAvailability` in "PriceBreakdownVehiclePrice" (3 values) - `VehiclePrice.SupplierRate` (object, required) Estimated total amount - Monetary amounts expressed in another currency. - `VehiclePrice.SupplierRate.@type` (string, required) Example: "SupplierRate" - `VehiclePrice.SupplierRate.BaseRate` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.SupplierRate.BaseRate.value` (number) The amount of a given currency. Example: 124.56 - `VehiclePrice.SupplierRate.BaseRate.code` (string) An ISO 4217 alpha character code (3 characters) that specifies a money unit. Example: "USD" - `VehiclePrice.SupplierRate.BaseRate.minorUnit` (integer) Minor units are a mechanism for expressing the relationship between a major currency unit and its corresponding minor currency unit. It is the smallest unit of a given currency. For example; the smallest denomination in USD is the cent, which is 1/100 of a USD, and the minor unit value is 2. Not all currencies have a minor unit. Example: 2 - `VehiclePrice.SupplierRate.BaseRate.currencySource` (string) The system requesting or returning the currency code specified in the attribute Enum: same as `MinimumAdcolAmount.currencySource` in "ChangePermitted" (3 values) - `VehiclePrice.SupplierRate.BaseRate.approximateInd` (boolean) "If true, the currency amount has been converted from the original amount. For Air Exchange Eligibility, returned only if a currency is converted. If returned, the value is always true, indicating that the fee is approximate because of currency conversion. For Hotel Availability and Rules, true indicates this is a calculated value; false indicates this is the value returned by the property." Example: true - `VehiclePrice.SupplierRate.RateForPeriod` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.SupplierRate.DropOffCharge` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.SupplierRate.ExtraMileageCharge` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.SupplierRate.EstimatedTotalAmount` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.ApproximateRate` (object) Estimated total amount - Monetary amounts expressed in another currency. - `VehiclePrice.ApproximateRate.@type` (string, required) Example: "ApproximateRate" - `VehiclePrice.ApproximateRate.BaseRate` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.ApproximateRate.RateForPeriod` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.ApproximateRate.DropOffCharge` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.ApproximateRate.ExtraMileageCharge` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.ApproximateRate.EstimatedTotalAmount` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.CustomerLoyalty` (object) Specifies the ID for the membership program. Object for sending customer loyalty information, such as for a frequent flyer program. For Hotel send the loyalty card number in the value field, followed by programID with the hotel chain code, and supplierType: Hotel. For Air send the loyalty card number in the value field, followed by airline code in "supplier". For cross accrual use the "shareWithSupplier" field to submit to partner airlines. - `VehiclePrice.CustomerLoyalty.value` (string, required) Number on loyalty card. Example: "132456" - `VehiclePrice.CustomerLoyalty.id` (string) Optional Customer Loyalty Id. Not saved Example: "Loyalty_1" - `VehiclePrice.CustomerLoyalty.priority` (integer) Optional Numeric Priority Code Example: 2 - `VehiclePrice.CustomerLoyalty.programId` (string) "Specifies an identifier to indicate the company owner of the loyalty program. Typically two characters. For frequent guest number, the hotel supplier or brand code. For frequent flyer number, the air supplier code of the loyalty program." Example: "HY" - `VehiclePrice.CustomerLoyalty.programName` (string) Supplier's loyalty program name. Example: "Frontier-EarlyReturns" - `VehiclePrice.CustomerLoyalty.supplierType` (string) The type of supplier of a loyalty program. Uses 'hotel' for frequent guest number or 'air' for frequent flyer number. Example: "Hotel" - `VehiclePrice.CustomerLoyalty.supplier` (string) Supplier of a loyalty program (typically 2 characters representing the hotel, brand, or airline). Example: "UA" - `VehiclePrice.CustomerLoyalty.tier` (string) Customer Loyalty tier Example: "Silver" - `VehiclePrice.CustomerLoyalty.shareWithSupplier` (array) The list of suppliers that the CustomerLoyalty number is shared. Used for cross accrual. Example: ["LH"] - `VehiclePrice.CustomerLoyalty.cardHolderName` (string) Customer loyalty member name; up to 128 characters are supported. In Air Search, for discounted offers to be returned, the name must be sent as LAST FIRST; e.g.,if SMITH is the last name and JORDAN the first name, send as SMITH JORDAN Example: "John Smith" - `VehiclePrice.CustomerLoyalty.validatedInd` (boolean) Customer loyalty number has been validated by the supplier Example: true - `VehiclePrice.CustomerLoyalty.prefix` (string) The cardholder name prefix title like Mr, Mrs, Dr Example: "Dr" - `VehiclePrice.CustomerLoyalty.given` (string) The First Name of the Cardholder Example: "John" - `VehiclePrice.CustomerLoyalty.middle` (string) Middle Name of the Cardholder Example: "Wilkinson" - `VehiclePrice.CustomerLoyalty.surname` (string) Last Name of the Cardholder Example: "Smith" - `VehiclePrice.RateQualifier` (string) A closed enumeration of possible rate qualifiers for vehicle rental Enum: same as `VehiclePrice.RateQualifier` in "PriceBreakdownVehiclePrice" (5 values) - `rateGuaranteedInd` (boolean) - PriceBreakdownVehicleDeposit: - `totalPayableNowInd` (boolean) If True the Amount is the total amount payable now - `totalPayableLaterInd` (boolean) If True the Amount is the total amount payable later - PriceBreakdownVehicleCharges: - `VehicleCharges` (object) - `VehicleCharges.@type` (string, required) Example: "VehicleCharges" - `VehicleCharges.description` (string) Assigned Type: c-1100:String - `VehicleCharges.VehicleChargePurposeCode` (object) Any code used to specify an item, for example a type of traveler, service code, room amenity, etc. - `VehicleCharges.VehicleChargePurposeCode.value` (string) Example: "INS" - `VehicleCharges.VehicleChargePurposeCode.codeContext` (string) Code Context Example: "ACRISS" - `VehicleCharges.ratePeriod` (string) The time period for a rate such as daily, weekly, monthly Enum: same as `VehiclePrice.ratePeriod` in "PriceBreakdownVehiclePrice" (15 values) - `VehicleCharges.rateChargeInfo` (string) Assigned Type: c-1100:String - `VehicleCharges.RateCategory` (string) For Hotel Search, request a rate category by sending up to 8 OTA rate categories to search for. If the supplier has rates available for the requested category, the response contains those rates and indicates them as such. Some properties do not return these rates unless explicitly requested. For a Hotel Rules request, this value can be found, if returned, in the Availability response's ProductRateCodeInfo/RateCodeInfo/rateCategory. Enum: same as `VehicleCharges.RateCategory` in "PriceBreakdownVehicleCharges" (32 values) - `VehicleCharges.VehicleCoverageTypeCode` (object) The OTA code defined for the Vehicle Coverage Type - `VehicleCharges.VehicleCoverageTypeCode.value` (string) Example: "INS" - `VehicleCharges.VehicleCoverageTypeCode.codeContext` (string) Code Context Example: "ACRISS" - `VehicleCharges.Calculation` (array) - `VehicleCharges.Calculation.@type` (string, required) Example: "Calculation" - `VehicleCharges.Calculation.UnitAmount` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehicleCharges.Calculation.UnitName` (string) The time period for a rate such as daily, weekly, monthly Enum: same as `VehiclePrice.ratePeriod` in "PriceBreakdownVehiclePrice" (15 values) - `VehicleCharges.Calculation.Quantity` (integer) The quantity used in the calculation of the vehicle charge e.g 2 x $500 per week - `VehicleCharges.Calculation.MaxQuantity` (integer) The maximum quantity allowed for a charge e.g Baby seat charged at $10 per day for a maximum of 10 days - `VehicleCharges.Calculation.TotalAmount` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehicleCharges.Calculation.Percent` (number) Used when the charge is based on a percentage of a TotalAmount - `VehicleCharges.Calculation.Applicability` (object) Textual information. - `VehicleCharges.taxInclusiveInd` (boolean) - `VehicleCharges.guaranteedInd` (boolean) - `VehicleCharges.payNowInd` (boolean) If true the vehicle charge must be paid now and is included in the totalPrice calculation - `VehicleCharges.includedInEstimatedTotalInd` (boolean) - `VehicleCharges.includedInBaseRateInd` (boolean) If true the Vehicle Charge has been included in the base rate of the Vehicle price - `ModifyPrice.PriceBreakdown.@type` (string, required) Discriminator - Air Search and Air Price APIs child classes are PriceBreakdownAir and PriceBreakdownAncillary. - Search Ancillaries and Seat Availabilities child classes are PriceBreakdown, PriceBreakdownAncillary, and PriceBreakdownAncillaryAir. - All Hotel API child classes are PriceBreakdownHospitality. - Vehicle API child classes are PriceBreakdownVehicleCharges, PriceBreakdownVehicleDeposit, PriceBreakdownVehiclePrice, and PriceBreakdownAncillaryVehicle. - Reservation and Reservation Workbench APIs are PriceBreakdownAir, PriceBreakdownAncillary, PriceBreakdownHospitality, PriceBreakdownVehicleCharges, PriceBreakdownVehicleDeposit, PriceBreakdownVehiclePrice, and PriceBreakdownAncillaryVehicle. Example: "PriceBreakdownAir" - `ModifyPrice.PriceBreakdown.Amount` (object) Amount represents the cost applied - `ModifyPrice.PriceBreakdown.Amount.@type` (string) - `ModifyPrice.PriceBreakdown.Amount.currencySource` (string) The system requesting or returning the currency code specified in the attribute Enum: same as `MinimumAdcolAmount.currencySource` in "ChangePermitted" (3 values) - `ModifyPrice.PriceBreakdown.Amount.CurrencyCode` (object) Currency codes are the three-letter alphabetic codes that represent the various currencies used throughout the world. Unless changed in the request, the currency is the default associated with your provisioned PCC from Travelport. For Hotel: SourceCurrency is based on the location of the hotel and used for all rates in the response. TargetCurrency is the currency code sent in the request in requestedCurrency. - `ModifyPrice.PriceBreakdown.Amount.Base` (number) The base price prior to all applicable taxes or fees of a product, such as the amount for a room or fare for a flight (one passenger). Example: 120.2 - `ModifyPrice.PriceBreakdown.Amount.Taxes` (object) Summary of all individual taxes. Child class TaxesDetail provides the breakdown of individual taxes. - `Tax` (array) - `TaxPercent` (object) Returned when the tax is expressed as a percentage of the amount. - `ModifyPrice.PriceBreakdown.Amount.Fees` (object) Includes TotalFees object to return the sum total of any fees. May include array of Fee objects to break down individual fees. Child class FeesDetail may also include a breakdown of the individual fees. - `Fee` (array) Array of individual fees. - `ModifyPrice.PriceBreakdown.Amount.Total` (number) "Specifies the total price including base + taxes + fees. In PriceBreakdownHospitality, this total is for a given group of nights. In PriceBreakdownAir this is the total of base cost and all fees and taxes for one passenger of this PTC type." Example: 230.13 - `ModifyPrice.PriceBreakdown.Amount.approximateInd` (boolean) if true this amount has been converted from the original amount Example: true - `ModifyPrice.PriceBreakdown.Commission` (object) — one of (discriminator: @type): GDS only; not supported for NDC. Commission information. Any commission filed by an airline in a CAT35 fare is returned in PriceBreakdownAir/Commission. The amount is either a percent of the fare component (@type CommissionPercent and the Percent object) or an amount (@type CommissionAmount and the Amount object)." - CommissionAmount: - `Amount` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `Amount.value` (number) The amount of a given currency. Example: 124.56 - `Amount.code` (string) An ISO 4217 alpha character code (3 characters) that specifies a money unit. Example: "USD" - `Amount.minorUnit` (integer) Minor units are a mechanism for expressing the relationship between a major currency unit and its corresponding minor currency unit. It is the smallest unit of a given currency. For example; the smallest denomination in USD is the cent, which is 1/100 of a USD, and the minor unit value is 2. Not all currencies have a minor unit. Example: 2 - `Amount.currencySource` (string) The system requesting or returning the currency code specified in the attribute Enum: same as `MinimumAdcolAmount.currencySource` in "ChangePermitted" (3 values) - `Amount.approximateInd` (boolean) "If true, the currency amount has been converted from the original amount. For Air Exchange Eligibility, returned only if a currency is converted. If returned, the value is always true, indicating that the fee is approximate because of currency conversion. For Hotel Availability and Rules, true indicates this is a calculated value; false indicates this is the value returned by the property." Example: true - CommissionPercent: - `Percent` (number) Percent amount of commission Example: 20 - `ModifyPrice.PriceBreakdown.Commission.@type` (string, required) Discriminator. Child classes CommissionAmount or CommissionPercent Example: "CommissionAmount" - `ModifyPrice.PriceBreakdown.Commission.application` (string) Type of commission Enum: same as `PriceBreakdown.Commission.application` (6 values) - `ModifyPrice.VendorCurrencyTotal` (object) No longer used. Previously used to expose the local vendor currency when it is different to the purchased currency - `retainedValueInd` (boolean) If true, the value will be retained on a document for future use Example: true - `productsUpdatedInd` (boolean) If present and true, the products in the host copy of the reservation have already been updated Example: true - `priceUpdatedInd` (boolean) If present and true, the price in the host copy of the reservation has already been updated Example: true - `documentVoidPeriodInd` (boolean) If true, when the Offer is cancelled the document will be voided. Example: true - `refundValueInd` (boolean) If true, when the Offer is cancelled the document value can be refunded. Example: true - `SupplierRetainedPrice` (object) Child class of Price. This includes all of the Price object plus the Pricebreakdown which gives detailed Price information per PTC or Hotel offering. For a Hotels Create Reservation (Full Payload) request, find the values to send in the Price objects from either Availability (returned in CatalogOffering/Price) or Rules (returned in Offer/Price). Although you can send the price returned in either API, the Rules pricing may be more accurate. If you sent a Rules request, send the value from that response. You must include CurrencyCode, Base, TotalTaxes, and TotalPrice. When returned from the previous steps, additionally send TermsAndConditionsFull, ProductRateCodeInfo, and RateCodeInfo. - `SupplierRetainedPrice.@type` (string, required) Discriminator classes Price or PriceDetail Example: "PriceDetail" - `SupplierRetainedPrice.id` (string) Internally referenced id Example: "2" - `SupplierRetainedPrice.CurrencyCode` (object) Currency codes are the three-letter alphabetic codes that represent the various currencies used throughout the world. Unless changed in the request, the currency is the default associated with your provisioned PCC from Travelport. For Hotel: SourceCurrency is based on the location of the hotel and used for all rates in the response. TargetCurrency is the currency code sent in the request in requestedCurrency. - `SupplierRetainedPrice.Base` (number) "Base price before taxes and fees. For Hotel, may not be returned by all suppliers." Example: 20.2 - `SupplierRetainedPrice.TotalTaxes` (number) "Total taxes applied to the base price. For Hotel, may not be returned by all suppliers." Example: 34.4 - `SupplierRetainedPrice.TotalFees` (number) Total fees included in Total Price. Example: 201 - `SupplierRetainedPrice.TotalPrice` (number) Total price of this offer including the base price and all taxes and fees. Example: 34 - `SupplierRetainedPrice.FlightPassCredits` (integer) The total number of flight pass credits consumed for this offer. Example: 2 - `SupplierRetainedPrice.PriceBreakdown` (array) — one of (discriminator: @type): - PriceBreakdownAir: - `quantity` (integer) Quantity of passengers in that PTC. Example: 2 - `requestedPassengerType` (string) The PTC to which the PriceBreakdown applies. Example: "CHD" - `FiledAmount` (object) Returned only in the Price APIs. GDS only; not supported for NDC. The base amount of a ticket price or net price that is filed in local currency. Returned when the origin currency is not the same as the PCC currency to show the currency in which the base fare has been filed. When used for NetBaseAmount: Net ticket data (NTD) is returned in the AirPrice, AirReservation, Exchange Search, and Reservation Retrieve responses for any GDS fare that has a private fare component (fareType=AgencyPrivateFare). When NTD is returned, TermsAndConditionsFuill includes FareGuaranteePolicy to return the fare calculation indicator for the fare. When NTD is returned, PriceBreakdown may include NetBaseAmount. - `FiledAmount.value` (number) Filed amount value Example: 43.3422 - `FiledAmount.currencyCode` (string) Code for the currency in which the base fare was filed. Example: "USD" - `FiledAmount.codeAuthority` (string) Filed amount currency code authority Example: "Australian Dollar" - `FiledAmount.decimalPlace` (integer, required) Number of decimal places in the currency in ISO 4217 standard format. Example: 3 - `FiledAmount.decimalAuthority` (string) ISO 4217 standard decimal authority Example: "ISO 4217" - `Discount` (object) NDC only; not supported for GDS. Returned for a fare discounted from the published price, such as a promotional discount. Not returned for privately negotiated discounts such as private fares. - `Discount.value` (number) The amount value of the discount Example: 20.22 - `Discount.description` (string) The text description for the discount. Example: "Spring discount on group bookings" - `Discount.currencyCode` (string, required) Currency code discount is returned in. Example: "USD" - `Discount.codeAuthority` (string, required) Not used. Currency code Authority. Example: "ISO" - `Discount.decimalPlace` (integer, required) Number of decimal places in the currency the discount is returned in. Example: 2 - `Discount.decimalAuthority` (string) Not used. Decimal Authority. Example: "ISO" - `NetFareInfo` (object) Detailed information on the net fare used. - `NetFareInfo.@type` (string, required) Example: "NetFareInfo" - `NetFareInfo.passengerTypeCode` (string) PassengerTypeCode Example: "ADT" - `NetFareInfo.NetFareBreakdownConstruction` (array) - `NetFareInfo.NetFareBreakdownConstruction.value` (string) - `NetFareInfo.NetFareBreakdownConstruction.fareType` (string) Assigned Type: c-1100:StringTiny - `NetFareInfo.NetFareBreakdownConstruction.rateOfExchange` (number) The rate of exchange applied to the fare breakdown - `NetFareInfo.TicketBaseAudit` (object) Returned only in the Price APIs. GDS only; not supported for NDC. The base amount of a ticket price or net price that is filed in local currency. Returned when the origin currency is not the same as the PCC currency to show the currency in which the base fare has been filed. When used for NetBaseAmount: Net ticket data (NTD) is returned in the AirPrice, AirReservation, Exchange Search, and Reservation Retrieve responses for any GDS fare that has a private fare component (fareType=AgencyPrivateFare). When NTD is returned, TermsAndConditionsFuill includes FareGuaranteePolicy to return the fare calculation indicator for the fare. When NTD is returned, PriceBreakdown may include NetBaseAmount. - `NetFareInfo.TicketBasePassenger` (object) The monetary value - `NetFareInfo.TicketBasePassenger.value` (number) - `NetFareInfo.TicketBasePassenger.currencyCode` (string) Assigned Type: c-1100:CurrencyCode - `NetFareInfo.TicketBasePassenger.codeAuthority` (string, required) Assigned Type: c-1100:CodeContext - `NetFareInfo.TicketBasePassenger.decimalPlace` (integer, required) Assigned Type: c-1100:CurrencyMinorUnit - `NetFareInfo.TicketBasePassenger.decimalAuthority` (string) Assigned Type: c-1100:CodeContext - `NetFareInfo.TicketBasePassenger.bTInd` (boolean) If true, this is a bulk ticket fare - `NetFareInfo.TicketBasePassenger.iTInd` (boolean) If true, this is an inclusive tour fare - `TravelerIdentifierRef` (object) Identifier references as object both within a message payload or an object held in cache that may be used for subsequent workflows. Returned for NDC in the Price response if age was sent for this traveler in the previous workflow requests. - `TravelerIdentifierRef.name` (string) Traveler identifier - `TravelerIdentifierRef.passengerTypeCode` (string) Passenger Type code Example: "ADT" - `TravelerIdentifierRef.ages` (array) The ages of the travelers associated to a particular ptc. For NDC, this value will be returned in PriceBreakdownAir if sent as part of the PassengerCriteria in the Air Search request. Example: [15] - `TravelerIdentifierRef.passengerCriteriaRef` (string) Allows the user to associate passenger criteria information. Example: "passengerCriteria_1" - `TravelerIdentifierRef.value` (string) - `TravelerIdentifierRef.id` (string) A locally referenced ID - `TravelerIdentifierRef.description` (string) Descriptive text used to identify the contents of a target object - `TravelerIdentifierRef.uris` (array) Uniform Resource Identifier Example: ["google.com"] - `TravelerIdentifierRef.age` (integer) Replaced with ages array. The age of the traveler. Example: 11 - `NetBaseAmount` (object) Returned only in the Price APIs. GDS only; not supported for NDC. The base amount of a ticket price or net price that is filed in local currency. Returned when the origin currency is not the same as the PCC currency to show the currency in which the base fare has been filed. When used for NetBaseAmount: Net ticket data (NTD) is returned in the AirPrice, AirReservation, Exchange Search, and Reservation Retrieve responses for any GDS fare that has a private fare component (fareType=AgencyPrivateFare). When NTD is returned, TermsAndConditionsFuill includes FareGuaranteePolicy to return the fare calculation indicator for the fare. When NTD is returned, PriceBreakdown may include NetBaseAmount. - `FareCalculation` (string) GDS only; not supported for NDC. For each PTC, when available, FareCalculation returns the fare calculation ladder for all public and private fare types filed by an agency or an airline. Example: "LON BA SYD R564.00YEE1Y BA LON R564.00YEE1Y NUC1128.00END ROE0.787855" - `Surcharges` (object) In AirSearch workflow this applies to GDS only. Not supported for NDC, which does not return surcharges. Returned if surcharges apply to this offer. For GDS only, for a multi-city offer with stopovers (see multi-city offers with stopovers for details), surcharges and commission amounts are for the entire journey. For all other offers, the surcharges and commission amounts are for each leg (origin and destination pair). A multi-city offer can be identified by the jc in its CombinabilityCode: jc1, jc2. Surcharges can be omitted from the Search response with excludeSurchargesInd. - `Surcharge` (array, required) - `Surcharge.value` (number) Surcharge amount Example: 12 - `Surcharge.currencyCode` (string) ISO 4217 currency code for the surcharge. Example: "USD" - `Surcharge.surchargeCode` (string) Surcharge code Example: "ADDITIONAL COSTS" - `Surcharge.reportingAuthority` (string) Not used. Surcharge reporting authority Example: "Federal register" - `Surcharge.purpose` (string) Surcharge purpose. For Air workflows possible values include Weekend Surcharge, Stopover Charge, Multiple Stopover Charges, Other (default value that covers all other surcharges such as fuel surcharges). Example: "Weekend Surcharge" - `Surcharge.description` (string) Description of the surcharge. Example: "Rollaway Surcharge" - `Surcharge.surchargeApplication` (string) Application values (such as the application of a fee) like per person or per room. Enum: same as `Surcharge.surchargeApplication` (7 values) - `Surcharge.surchargeFrequency` (string) The frequency of a fee such as per night or per stay. Enum: same as `Surcharge.surchargeFrequency` (6 values) - `Surcharge.codeAuthority` (string) Not used. Currency code authority. Example: "ISO 4217" - `Surcharge.decimalPlace` (integer) Decimal place for the currency unit. Example: 4 - `Surcharge.decimalAuthority` (string) Not used. Currency code decimal authority. Example: "ISO 4217" - `Surcharges.@type` (string, required) Discriminator class is SurchargesDetail Example: "SurchargesDetail" - `Surcharges.TotalSurcharges` (number) A monetary amount, up to 4 decimal places. Example: 211.11 - `Surcharges.approximateInd` (boolean) If true, the surcharge amounts are approximate. - `TravelerRefs` (array) Returned only in Reservation Retrieve to identify the traveler associated with this instance of PriceBreakdown in case of multiple offers on the booking. Example: ["[\"traveler_1\",\"traveler2\"]"] - `PaidTaxes` (object) Summary Taxes object - `Tax` (array) - `Tax.value` (number) Amount of the tax. Returned as 0 if a tax was marked as exempt with TaxExemption. Example: 12.2 - `Tax.currencyCode` (string) A ISO 4217 currency code associated to the value. Example: "USD" - `Tax.taxCode` (string) "Code for the tax. For Hotels this is the OTA code." Example: "XF2" - `Tax.reportingAuthority` (string) Identifies the reporting authority such as airport code for XF taxes Example: "JFK1" - `Tax.purpose` (string) Supplier returned description of tax. Example: "Fuel surcharge" - `Tax.description` (string) "Short summary of the tax. In Air workflows this is returned only for NDC. Note that descriptions are not returned for tax codes YQ and YR, which are fees charged by airlines and not government-imposed taxes. For Hotels this is the OTA tax description." Example: "Lodging tax" - `Tax.includedInBase` (string) Yes , No , Unknown Enum: same as `instantPurchase` in "AdvanceReservationRequired" (3 values) - `Tax.codeAuthority` (string) Not used. Currency Code Authority Example: "ISO" - `Tax.decimalPlace` (integer) Permitted number of decimals. Associated to the currency value. Example: 2 - `Tax.decimalAuthority` (string) Not used. Currency decimal authority Example: "ISO" - `Tax.exemptInd` (boolean) GDS only; not supported for NDC. Returned if a tax was marked exempt in a prior request with the TaxExemption pricing modifer. If true, this tax is exempt" Example: true - `Tax.nonRefundableInd` (boolean) If true, the tax is non refundable. This indicator is only supported for exchange search and exchange price quote transactions. Example: true - `Tax.excludedFromTotalPriceInd` (boolean) Returned in Hotel APIs when a tax is not included in the TotalPrice. Default behavior is for taxes to be included in TotalPrice. Example: true - `TaxPercent` (object) Returned when the tax is expressed as a percentage of the amount. - `TaxPercent.value` (number) The tax percentage amount. Example: 5.5 - `TaxPercent.taxCode` (string) Any code for the tax. Example: "971 - IRS Notice" - `TaxPercent.reportingAuthority` (string) Tax reporting authority Example: "Georgia Department of Revenue" - `TaxPercent.purpose` (string) Purpose of tax Example: "statutory tax" - `TaxPercent.description` (string) Description Example: "1.5% of SGST" - `TaxPercent.includedInBase` (string) Yes , No , Unknown Enum: same as `instantPurchase` in "AdvanceReservationRequired" (3 values) - `PaidTaxes.@type` (string, required) Discriminator classes PaidTaxes or PaidTaxesDetail Example: "PaidTaxesDetail" - `PaidTaxes.TotalTaxes` (number) A monetary amount, up to 4 decimal places. Decimal place needs to be included. Example: 220.12 - `RequestedPricingModifiers` (array) - `RequestedPricingModifiers.@type` (string, required) Discriminator. Example: "RequestedPricingModifiers" - `RequestedPricingModifiers.PassengerCriteria` (object) Defines the passenger criteria. Send one PassengerCriteria for each passenger type code (PTC). Search supports up to 9 total passengers. A maximum of 6 PTCs are supported for GDS. NDC does not have a PTC limitation. AirPrice supports up to nine total passengers across all PTCs. - `TravelerIdentifierRef` (object, required) Identifier references as object both within a message payload or an object held in cache that may be used for subsequent workflows. Returned for NDC in the Price response if age was sent for this traveler in the previous workflow requests. - `RequestedPricingModifiers.PassengerCriteria.@type` (string, required) Discriminator. No child classes. Example: "PassengerCriteria" - `RequestedPricingModifiers.PassengerCriteria.number` (integer, required) The amount of passengers associated with this passenger type code. Default is 1. Example: 1 - `RequestedPricingModifiers.PassengerCriteria.age` (integer) The age of the passenger. Notes on PTC and age: - Travelport recommends sending age only with PTCs that require age for pricing. - If the age is sent in the request, for NDC only, the age is returned in the pricing response. - For child passengers, Travelport recommends sending the age of the child in the age attribute plus the PTC CNN. Travelport recommends against sending CNN without age, or the CHD PTC. Not all fares cannot be quoted for CHD. - The age for CNN is generally between 2 and 11 inclusive, with ADT fares returned for ages 12 and up; however, this can vary by airline and country. - The age for INF must be either 0 or 1. - During booking, date of birth is required for all child and infant PTCs (Add Traveler payload in Traveler/birthDate). Example: 26 - `RequestedPricingModifiers.PassengerCriteria.passengerTypeCode` (string) The passenger type code (PTC) for the passengers on the itinerary. Required field for Air Search and Flight specific search. Common PTCs are: - ADT: adult - CHD: child of unknown age - For child passengers, Travelport recommends sending the age of the child in the age attribute plus the PTC CNN. Travelport recommends against sending CNN without age, or the CHD PTC. Many fares cannot be quoted for CHD. - CNN: child when age is known - The age for CNN is generally between 2 and 11 inclusive, with ADT fares returned for ages 12 and up; however, this can vary by airline and country. - INF: infant without a seat - INS: infant with a seat - UNN: unaccompanied child. See API guides to download a full list of PTCs. NDC carriers BA, SQ, AV, AA, and AF/KLM offer teen/young adult tax exemptions from the UK Air Passenger Duty (GB tax). Send PTC with the value YTH and send the passengers age per below. The PTC may be returned as ADT, or Cxx in which xx is the age, but the tax exemption is applied in the pricing on these NDC carriers. For marine fares, send the PTC value SEA. You must also send OSI remarks at Add Traveler with the vessel name and location. Marine fares are private fares for travelers going to or from a vessel. NDC only; not supported for GDS. When running a multiple passenger search for NDC on Qantas, Qantas supports only these PTCs: ADT, CHD, CNN, INF. Sending any other PTC may result in an error at ticketing. Any traveler sent without a PTC value is defaulted to ADT. PTC can be sent or omitted for ADT passenger. AirReservation defaults the PTC to ADT and returns it in the Reservation Retrieve. Example: "ADT" - `RequestedPricingModifiers.PassengerCriteria.birthDate` (string) The date of birth of the passenger. May be used in age validation for fares with age restrictions. Example: "2020-01-16" - `RequestedPricingModifiers.PassengerCriteria.id` (string) Unique id to support referencing of this specific passenger criteria. Example: "passengercriteria_001" - `RequestedPricingModifiers.PassengerCriteria.CustomerLoyalty` (array) NDC only; not supported for GDS. Optional object for sending customer loyalty information, such as for a frequent flyer program. If CustomerLoyalty is sent in the Search request, it must also be sent in the Air Price request and the Add Traveler request. As some carriers validate frequent traveler data through the workflow, failing to send the same CustomerLoyalty details, even if invalid, may cause a booking failure. If an invalid number is sent, the response returns a warning message that the FQTV is invalid, and the invalid number is cached to prevent a potential booking failure. - `RequestedPricingModifiers.PassengerCriteria.TravelerGeographicLocation` (object) For AirSearch: supported/validated only for NDC to support local citizen fares. For AirPrice and AirReservation: GDS only; not supported for NDC. Optional object for requesting local citizen/local resident fares for Spain and associated islands. You must also send a PTC relevant to the local resident fares; e.g., ADR for adult resident, CHR for child resident. Any discount applied through TravelerGeographicLocation applies to all travelers, not only to the traveler in this instance of PassengerCriteria. If the discount must apply only to an individual traveler, that traveler requires a separate search and book workflow. - `RequestedPricingModifiers.PassengerCriteria.specifiedPassengerTypeCodeOnlyInd` (boolean) GDS only; not supported for NDC. - If true: returns only offers for the specified PTC. If no fares are available for the specified PTC, returns an error message that there is no valid fare. - If false (default behavior): If no fares are available for the specified PTC, returns fares for the default ADT (adult) PTC instead. Example: true - `RequestedPricingModifiers.PricingModifiersAir` (object) A selection of Pricing Modifiers that can be used to influence the Price of an Offer. - For the AirPrice reference payload request, if any price modifiers were included in the preceding Search request and no price modifiers are sent in the AirPrice request, the cached price modifiers sent at Search are sent with the AirPrice request. If any price modifiers are sent in the AirPrice reference payload request, all cached Search modifiers are discarded and only the modifiers sent in that AirPrice request are used. - For the Add Offer request, you may optionally store fares with one or more pricing modifiers. If a pricing modifier is not added, the auto stored fare is added to the reservation. There is no change in the AirReservation response when pricing modifiers are requested. AirReservation applies modifiers from Add Offer and earlier steps as follows: - Modifiers sent in the Add Offer request (supported for both full and reference payload). - If no modifiers are sent in Add Offer, any pricing modifiers sent in AirPrice are applied. - If no modifiers were sent in AirPrice, or if AirPrice was not sent, any pricing modifiers sent in Search are applied. GDS only; pricing modifiers not supported for NDC. If the requested modifier does not have any fares associated with it, the workbench commit fails and returns the error message 'No Fare Found'. Pricing happens at commit, not at Add Offer. - `Brand` (object) Information on airline Brand offerings. If brand attributes were not excluded with inhibitBrandContentInd=true (GDS only), then brand attributes are returned and consolidated in ReferenceList/ReferenceListBrand. In this case Brand does not return the name or Identifier objects but instead returns only BrandRef, which matches to the brand identifier (e.g., b1) in ReferenceListBrand. - `RequestedPricingModifiers.PricingModifiersAir.@type` (string, required) Discriminator. Child classes PricingModifiersAir and PricingModifersAirDetail Example: "PricingModifiersAir" - `RequestedPricingModifiers.PricingModifiersAir.currencyCode` (string) In an API request, send the currency type to return if you want to override the default currency specified with your PCC. Example: "GBP" - `RequestedPricingModifiers.PricingModifiersAir.FareSelection` (object) Requests the return of fare types including private fares (negotiated), public fares (published), or net fares (consolidator fares, or any negotiated wholesale price that is further marked up for sale to customers). May be used to request fares with specific restrictions, change, or refund options. - `RequestedPricingModifiers.PricingModifiersAir.OrganizationInformation` (object) Use to send account codes for negotiated fares or to send optional India GST SSR Remarks in GSTRegistrationNumber. For NDC supports corporate loyalty program and GST Information. This information is returned in TermsAndConditions." - `RequestedPricingModifiers.PricingModifiersAir.TaxExemption` (object) GDS only, not supported for NDC. Use to mark some or all taxes as exempt. Specify all taxes, only specific tax codes, or all taxes in specific countries. Must include either allTaxesExemptInd OR both countries and taxCodes. TaxExemption supports up to nine values for countries, taxCodes, or both combined. The response returns any exempt taxes with exemptInd=true and value=0. - `RequestedPricingModifiers.PricingModifiersAir.PromotionalCode` (array) - `RequestedPricingModifiers.PricingModifiersAir.SellCity` (string) GDS only, not supported for NDC. The IATA location code for a city. Overrides the sell city of the requester to specify an alternate sale location and return fares based on that location. The response returns pricing in the local currency for the specified sell city instead of the PCC's default currency. Example: "NYC" - `RequestedPricingModifiers.PricingModifiersAir.TicketCity` (string) GDS only, not supported for NDC. The IATA location code for a city. Overrides the ticketing city of the requester to specify an alternate ticket location and return fares based on that location; the response returns pricing in the local currency for the specified ticket city instead of the PCC's default currency. Example: "NYC" - `RequestedPricingModifiers.PricingModifiersAir.PricingPCC` (string) GDS only, not supported for NDC. Use to send a faring PCC for which a selective access or code group agreement exists between that PCC and the PCC associated with your account. The following combinations of PricingPCC and FareSelection/fareType=PrivateFaresOnly return results as follows: - PricingPCC sent and PrivateFaresOnly not requested: If a selective access or group agreement exists, both public and any available private fares are returned for the requesting and providing PCC. - If no selective access or group agreement exists, only public fares are returned. - PricingPCC sent and PrivateFaresOnly is requested: If a selective access or group agreement exists that allows private fare access, only available private fares are returned for the requesting and providing PCC. - If no agreement exists, or if an agreement exists but does not allow private fares access, an error is returned. Example: "0Bx3" - `RequestedPricingModifiers.PricingModifiersAir.FareBasisCodeOverride` (array) - `RequestedPricingModifiers.PricingModifiersAir.MultiPricingAgency` (array) The customer can send up to 3 Pseudo City Codes (PCCs) in PricingModifiersAir, MultiPricingAgency. If a customer sends more than 3 PCCs in MultiPricingAgency, only the first 3 are validated. If a customer sends both PricingPCC and MultiPricingAgency with PCCs, the PCC in PricingPCC is ignored. Example: ["[\"0XS4\",\"0YBZ\",\"J80K\"]"] - `RequestedPricingModifiers.PricingModifiersAir.TicketingPCC` (string) GDS only, not supported for NDC. In an API request, overrides the ticketing PCC associated with your account to specify an alternate PCC and return fares based on that PCC. Example: "0XS4" - `RequestedPricingModifiers.PricingModifiersAir.CalculatedFareAdjustment` (object) Used in Exchange Search to modify the Price of the Fare. Discriminator classes CalculatedFareAdjustmentDiscount or CalculatedFareAdjustmentIncrease - `RequestedPricingModifiers.PricingModifiersAir.ManualFareAdjustment` (array) Send to manually adjust the base fare amount on all fares for a specific PTC. - `RequestedPricingModifiers.PricingModifiersAir.BrandPreference` (array) - `RequestedPricingModifiers.PricingModifiersAir.includeSplitPaymentInd` (boolean) Requests request split ticketing, which returns outbound and inbound one-way fares in addition to round trip options in the Search API response. This may result in lower fares than the same or similar round-trip itinerary. If true, requests split ticketing. If false or omitted split ticketing options are not returned. Default is false. GDS only, not supported for NDC. When split ticketing is requested, the Search response returns offers in the following order: Outbound one-way offers, Inbound one-way offers, Round trip offers. The response identifies all one-way outbound and inbound offers with CombinabilityCode j0. CombinabilityCode values for round trip offers start at j1 and increment by one for each offer. Only the following are in scope for split ticketing: Search (not supported for Next Leg Search or Flight Specific Search), Round-trip journey-based offerings ( isJourney header not sent or sent as true, or CustomResponseModifiersAir/SearchRepresentation not sent or sent with value Journey ) Upsells. Split ticketing is not supported for round-trip leg-based searches, virtual interlining, or NDC. Split ticketing is available only for customers specifically provisioned for split ticketing. Split ticketing returns one-way outbound and one-way inbound fares in addition to round-trip offers. Split ticket offers are identified with CombinabilityCode j0. If your account is not configured for split ticketing, sending includeSplitPaymentInd returns a response without split ticket offers and a warning message. GDS only, not supported for NDC. In Air Price, For split ticketing, the request must send offers that are identified in the Search response with CombinabilityCode j0, which identifies those offers as one-way outbound and one-way inbound split ticketing offers. A combination of j0 and any non-j0 value offer returns an error message that split pricing is not supported - `RequestedPricingModifiers.PricingModifiersAir.returnMostRestrictiveBrandInd` (boolean) In Search API, when there are different brands on a connecting flight, return information for either the most restrictive brand or the brand on the most significant segment on the itinerary. If true, return the offer brand of the most restrictive brand. If false or omitted, return the offer brand of the most significant segment of the itinerary. GDS only, not supported for NDC. - `RequestedPricingModifiers.PricingModifiersAir.splitPaymentOfferings` (number) Number between 0 and 99. Send with includeSplitPaymentInd to configure the percentage of round trip offers to return in a split ticketing response. By default, Search divides the split ticketing response into 34% round-trip offerings and the remainder as split ticketing offers, which are combined outbound and inbound one-way fares. To change this percentage, send SplitPaymentOfferings with the percentage value of round trip offers to return. Example: 25 - `RequestedPricingModifiers.CabinPreference` (object) Requests a fare based on the cabin class. Only one cabin preferenceType (Permitted, Preferred, PreferredWithUpgrade) is allowed per request, but there is no limit to the number of cabins that can be sent. Any CabinPreference in the initial Search request is applied to any subsequent Next Leg Search and reference Flight Specific Search requests. In AirPrice and AirReservation only one cabin preference type is allowed per request, but there is no limit to the number of cabins that can be sent. If CabinPreference was sent in the Search request, it is cached and sent with the AirPrice reference payload request. If you send CabinPreference in the AirPrice request, all cached modifiers are discarded and only the modifiers sent in the AirPrice request are used. Can be combined with lowFareFinderInd=true to return lowest fare in the requested cabin or cabins. When using CabinPreference and lowFareFinderInd, if both CabinPreference and a class of service are sent, class of service is ignored. If CabinPreference is sent without a class of service, the response returns the lowest fare in the cabin requested. If that cabin is not available, the response may upgrade or downgrade to a different cabin. If a different cabin than requested is returned, the response returns the message that the cabin class may differ from the class requested. If lowFareFinderInd=false and CabinPreference are sent in the request, AirPrice ignores the preferred cabin and returns a message that the preferred cabin was ignored. If CabinPreference is set to All, no cabin preference is applied." - `RequestedPricingModifiers.CabinPreference.@type` (string, required) Discriminator. No child classes exist Example: "CabinPreference" - `RequestedPricingModifiers.CabinPreference.preferenceType` (string) Type of cabin preference. Sending a mix of preferenceType values is not supported. For example, you cannot send an instance of CabinPreference with a preferenceType of Permitted and another instance with preferenceType of Prohibited. In this case the results default to the Preferred preference. Note that if lowFareFinderInd is sent with true and CabinPreference is sent, the only supported value for CabinPreference/type is Permitted. Enum: same as `RequestedPricingModifiers.CabinPreference.preferenceType` in "PriceBreakdownAir" (4 values) - `RequestedPricingModifiers.CabinPreference.cabins` (array) A space-delimited list of cabins. Enum: same as `PassengerFlight.FlightProduct.cabin` in "ProductAir" (5 values) - `RequestedPricingModifiers.CabinPreference.legSequence` (array) Limits preference to the specified leg referenced in SearchCriteriaFlight. You can apply the preference to only some legs of the itinerary, or different preferences to different legs. To apply preference to the entire itinerary, do not send legSequence. GDS only, not supported for NDC. Not supported at Price or Book. Example: [1,2] - `RequestedPricingModifiers.FlightType` (object) The type of flight connection - `RequestedPricingModifiers.FlightType.@type` (string, required) Discriminator. No child classes. Example: "FlightType" - `RequestedPricingModifiers.FlightType.connectionType` (string) Limits the connection type returned. Each value returns the specified type and all higher types. For example, StopDirect could return both flights that stop without a change of planes (StopDirect) and non-stop direct flights (NonStopDirect). SingleConnection or DoubleConnection will not exclude StopDirect flights from the journey. For example, SingleConnection could return an itinerary with two flight numbers, and either of these flights could have intermediate stops. Enum: same as `RequestedPricingModifiers.FlightType.connectionType` in "PriceBreakdownAir" (5 values) - `RequestedPricingModifiers.FlightType.excludeInterlineConnectionsInd` (boolean) Excludes interline connectionsClosed from results. If true, does not return offers with interline connections. If false or omitted, may return interline connections in results. Default is false. GDS only, not supported for NDC. When a product contains multiple interline air segments, brand details return only the brand of the significant carrier, not the validating/plating carrier brand information. The IATA rules for determining the significant carrier on an itinerary are based on the areas in which the transportation takes place. Example: true - `RequestedPricingModifiers.CustomResponseModifiersAir` (object) Contains additional modifiers to customize the result set. Includes optional indicators for returning or excluding specified response content. Values sent at Search can carry forward into the Next Leg Search request and are not re-sent. - `RequestedPricingModifiers.CustomResponseModifiersAir.@type` (string, required) discriminator Example: "CustomResponseModifiersAir" - `RequestedPricingModifiers.CustomResponseModifiersAir.BrandAttributeInclusion` (array) Supported in AirSearch and AirPrice. Returns only information about the brand attributes specified and does not return any other brand attributes. - `RequestedPricingModifiers.CustomResponseModifiersAir.SearchRepresentation` (string) Specifies either a journey or leg-based response. Journey returns offers for all legs of the itinerary. Journey is the default. Leg returns offers for only the first leg of the itinerary. Must be followed with a Next Leg Search to select an offer for the first leg and return offers on the subsequent leg to combine with it.Customize search result set as leg or journey based. Next Leg Search requests, and Flight Specific Search requests for less than the full itinerary, are supported only after a leg-based Search, not a journey-based Search. If these requests follow a journey-based Search request, an error message is returned. Enum: same as `RequestedPricingModifiers.CustomResponseModifiersAir.SearchRepresentation` in "PriceBreakdownAir" (3 values) - `RequestedPricingModifiers.CustomResponseModifiersAir.excludePenaltiesInd` (boolean) GDS only; not supported for NDC. Indicator to omit change and cancel penalties. - If true: omits all penalty information from the response. - If false (default behavior): returns any change and penalty details provided by carrier for each offer in TermsAndConditionsFullAir/Penalties. If sent in Search but not in AirPrice, the value sent in Search is cached and applied to the AirPrice results. However, you can override the value sent in Search by sending excludePenaltiesInd in the AirPrice request with the opposite value. For example, if the Search request sends excludePenaltiesInd=true and the AirPrice request sends excludePenaltiesInd=false, the Search response does not return penalties and the AirPrice response does return penalties. Example: true - `RequestedPricingModifiers.CustomResponseModifiersAir.excludeBaggageFeesInd` (boolean) GDS only; not supported for NDC. Indicator to exclude baggage details. - If true: excludes baggage fees, carry on fees, and embargo information from the response. Baggage quantity or weight is returned instead. - If false (default behavior): baggage details returned in response. Default is false. Example: true - `RequestedPricingModifiers.CustomResponseModifiersAir.includeFareCalculationInd` (boolean) GDS only; not supported for NDC or in the Flight Specific Search full payload request. Indicator to request the return of the fare calculation ladder. - If true: returns the fare calculation ladder in BestCombinablePrice.PriceBreakdownAir.FareCalculation. - If false (default behavior): fare calculation ladder is not returned. Example: true - `RequestedPricingModifiers.CustomResponseModifiersAir.excludeSurchargesInd` (boolean) GDS only; not supported for NDC. Indicator to exclude a surcharge breakdown. - If true: excludes a surcharge breakdown from the response. Baggage quantity or kilos is returned instead. - If false (default behavior): surcharge breakdown returned in response. Example: true - `RequestedPricingModifiers.CustomResponseModifiersAir.excludeUnbundledFaresInd` (boolean) GDS only, not supported for NDC. Sets whether to return unbundled fares. Supported in AirSearch and AirPrice. - If true: does not return unbundled fares. - If false (default behavior): returns unbundled and bundled fares as available. Example: true - `RequestedPricingModifiers.CustomResponseModifiersAir.includeCO2EmissionsDataInd` (boolean) Indicator to return CO2 emission data in the Search and Next Leg Search responses. - If true: returns CO2 emission data. - If false (default behavior): CO2 emission data not returned. Example: true - `RequestedPricingModifiers.CustomResponseModifiersAir.includeFlightAmenitiesInd` (boolean) Indicator to return flight amenities from ATPCO RouteHappy data. - If true: includes amenities in the response if available. - If false: Does not return ATPCO RouteHappy amenities. Example: true - `RequestedPricingModifiers.CustomResponseModifiersAir.includeUniversalProductAttributesInd` (boolean) Indicator to return universal product attributes (UPAs), which include images, icons, and URLs as provided by ATPCO. Must also send includeFlightAmenitiesInd=true. - If true: returns universal product attributes if available. - If false (default behavior): Universal product attributes not returned. UPAs are not returned for direct flights with intermediate stops, non-flight segments such as trains, or for Premium Business class. Example: true - `RequestedPricingModifiers.CustomResponseModifiersAir.includeBundledAncillariesInd` (boolean) NDC only. If true: the search and price response will include bundled air and ancillary offerings/offers. Search and Price response will contain both ProductAir and ProductAncillary plus a new child class of PriceBreakdown: PriceBreakdownAncillaryAir to define the ancillary inclusion and pricing. Example: true - `RequestedPricingModifiers.CustomResponseModifiersAir.includeFullPenaltyDisclosureInd` (boolean) If true, penalty information sourced from ATPCO Cat 31 and 33 will be disclosed. Penalties may be exposed at fare component level and include time windows. - `RequestedPricingModifiers.PricingModifiersAirChange` (object) Pricing Modifiers that can be used to influence the Price of an Exchanged Offer - `RequestedPricingModifiers.PricingModifiersAirChange.@type` (string) Example: "PricingModifiersAirChange" - `RequestedPricingModifiers.PricingModifiersAirChange.currencyCode` (string) ISO 4217 currency code Example: "USD" - `RequestedPricingModifiers.PricingModifiersAirChange.FareSelection` (object) Requests the return of fare types including private fares (negotiated), public fares (published), or net fares (consolidator fares, or any negotiated wholesale price that is further marked up for sale to customers). May be used to request fares with specific restrictions, change, or refund options. - `RequestedPricingModifiers.PricingModifiersAirChange.OrganizationInformation` (object) Use to send account codes for negotiated fares or to send optional India GST SSR Remarks in GSTRegistrationNumber. For NDC supports corporate loyalty program and GST Information. This information is returned in TermsAndConditions." - `RequestedPricingModifiers.PricingModifiersAirChange.WaiverCode` (object) A code assigned by an airline to support waiver of fees or ticket value as a result of disruption to the passenger. - `RequestedPricingModifiers.PricingModifiersAirChange.TaxExemption` (object) GDS only, not supported for NDC. Use to mark some or all taxes as exempt. Specify all taxes, only specific tax codes, or all taxes in specific countries. Must include either allTaxesExemptInd OR both countries and taxCodes. TaxExemption supports up to nine values for countries, taxCodes, or both combined. The response returns any exempt taxes with exemptInd=true and value=0. - `RequestedPricingModifiers.PricingModifiersAirChange.PromotionalCode` (object) NDC only. Not supported for GDS. Any NDC airline designated promotional code. - `RequestedPricingModifiers.PricingModifiersAirChange.SellCity` (string) Overrides the sell city of the requestor Example: "MEX" - `RequestedPricingModifiers.PricingModifiersAirChange.TicketCity` (string) Overrides the ticket city of the requestor Example: "MEX" - `RequestedPricingModifiers.PricingModifiersAirChange.PricingPCC` (string) Overrides the pricing PCC of the requestor Example: "0XS4" - `RequestedPricingModifiers.PricingModifiersAirChange.TicketingPCC` (string) Overrides the ticketing PCC of the requestor Example: "0XCD" - `RequestedPricingModifiers.PricingModifiersAirChange.CalculatedFareAdjustment` (object) Used in Exchange Search to modify the Price of the Fare. Discriminator classes CalculatedFareAdjustmentDiscount or CalculatedFareAdjustmentIncrease - `RequestedPricingModifiers.PricingModifiersAirChange.BrandPreference` (array) - `RequestedPricingModifiers.PricingModifiersAirChange.keepToBrandInd` (boolean) If true, the offerings returned will be of the same brand as the original Offer Example: true - `RequestedPricingModifiers.PricingModifiersAirChange.returnMostRestrictiveBrandInd` (boolean) if true, the most restrictive brand will be returned in the response when there are different brands present in the Offering Example: true - `RequestedPricingModifiers.PricingModifiersAirChange.doNotNetInd` (boolean) If true, this exchange will not net any residual/refundable amounts against due amounts. - `RequestedPricingModifiers.lowFareFinderInd` (boolean) Provides pricing flexibility around class of service. If not sent, the response returns fares only in the requested class of service. If true, returns the lowest fares available in any class of service available, which may not be the same as the requested class. Note that if lowFareFinderInd is sent with true and CabinPreference is sent, the only supported value for CabinPreference/type is Permitted. When lowFareFindInd=true and brand attributes are not disabled (inhibitBrandContentInd), AirPrice uses only the brand tier (and any other pricing modifiers) to find the lowest fare within a brand tier regardless of class of service. GDS only; not supported for NDC. Example: true - `RequestedPricingModifiers.keepToBrandInd` (boolean) If true, the original brand will be maintained during the exchange process. Example: true - `RequestedPricingModifiers.lowFareFindAndRebookInd` (boolean) If true, the original flights in the reservation will be rebooked or replaced with the new exchanged flights. - `PassengerCriteriaRefs` (array) NDC only; not supported for GDS. Returned for NDC if a traveler identifier was sent for this traveler in the previous workflow requests. Example: ["passengerCriteria_1"] - `FlightPassCredits` (integer) The number of flight pass credits consumed for this pricebreakdown. Example: 1 - PriceBreakdownAncillary: - `inclusiveOfTaxInd` (boolean) If true, this ancillary is sold inclusive of tax. Example: true - `quantity` (integer) The quantity of ancillary items included in this PriceBreakdown. Example: 1 - `Description` (object) A description of the ancillary with description codes. - `Description.value` (string) The text description of the ancillary. Example: "Vegetarian Meal" - `Description.code` (string) The ATPCO group code. Example: "BG" - `Description.subCode` (string) The ATPCO RFISC subcode. Example: "0D4" - `Description.subGroup` (string) The ATPCO sub group code. Example: "SP" - `Description.codeContext` (string) The code context value. Example: "ATPCO" - `Description.ssrCode` (string) The four character AIRIMP SSR code for this ancillary. Example: "VGML" - `Description.issuanceReasonCode` (string) The airline provided reason for issuance code. Example: "C" - `Description.geographicSpecification` (string) How the ancillary is applied across the itinerary. Enum: same as `Ancillary.Description.geographicSpecification` in "ProductAncillary" (3 values) - `ProductRef` (string) The product ref this PriceBreakdown applies to. If no productRef exists then the PriceBreakdown applies to all Products within the Offer. Example: "p_1" - `Discount` (object) NDC only; not supported for GDS. Returned for a fare discounted from the published price, such as a promotional discount. Not returned for privately negotiated discounts such as private fares. - `Discount.value` (number) The amount value of the discount Example: 20.22 - `Discount.description` (string) The text description for the discount. Example: "Spring discount on group bookings" - `Discount.currencyCode` (string, required) Currency code discount is returned in. Example: "USD" - `Discount.codeAuthority` (string, required) Not used. Currency code Authority. Example: "ISO" - `Discount.decimalPlace` (integer, required) Number of decimal places in the currency the discount is returned in. Example: 2 - `Discount.decimalAuthority` (string) Not used. Decimal Authority. Example: "ISO" - `TravelerIdentifierRef` (object) Identifier references as object both within a message payload or an object held in cache that may be used for subsequent workflows. Returned for NDC in the Price response if age was sent for this traveler in the previous workflow requests. - `TravelerIdentifierRef.name` (string) Traveler identifier - `TravelerIdentifierRef.passengerTypeCode` (string) Passenger Type code Example: "ADT" - `TravelerIdentifierRef.ages` (array) The ages of the travelers associated to a particular ptc. For NDC, this value will be returned in PriceBreakdownAir if sent as part of the PassengerCriteria in the Air Search request. Example: [15] - `TravelerIdentifierRef.passengerCriteriaRef` (string) Allows the user to associate passenger criteria information. Example: "passengerCriteria_1" - `TravelerIdentifierRef.value` (string) - `TravelerIdentifierRef.id` (string) A locally referenced ID - `TravelerIdentifierRef.description` (string) Descriptive text used to identify the contents of a target object - `TravelerIdentifierRef.uris` (array) Uniform Resource Identifier Example: ["google.com"] - `TravelerIdentifierRef.age` (integer) Replaced with ages array. The age of the traveler. Example: 11 - `AncillaryPriceApplicationCode` (object) Determines how an ancillary price has been built. - `AncillaryPriceApplicationCode.value` (string) Example: "3" - `AncillaryPriceApplicationCode.application` (string) Associated text. Example: "PerItem" - PriceBreakdownHospitality: - `roomPricingType` (string) A string provided by the hotel to describe how a service is priced, such as per night or per stay. Enum: same as `roomPricingType` in "PriceBreakdownHospitality" (5 values) - `Description` (string) Example: "Advance Purchase-Ro-Free WiFi" - `NightlyRate` (array) - `NightlyRate.@type` (string) - `NightlyRate.startDate` (string, required) Start date for the nightly rate in YYYY-MM-DD format. - `NightlyRate.nights` (integer) Number of nights the nightly rate is valid. - `NightlyRate.Amount` (object, required) Amount represents the cost applied - `AverageNightlyRate` (array) The average nightly rate for a given offer. - `AverageNightlyRate.value` (number) The amount of a given currency. Example: 124.56 - `AverageNightlyRate.code` (string) An ISO 4217 alpha character code (3 characters) that specifies a money unit. Example: "USD" - `AverageNightlyRate.minorUnit` (integer) Minor units are a mechanism for expressing the relationship between a major currency unit and its corresponding minor currency unit. It is the smallest unit of a given currency. For example; the smallest denomination in USD is the cent, which is 1/100 of a USD, and the minor unit value is 2. Not all currencies have a minor unit. Example: 2 - `AverageNightlyRate.currencySource` (string) The system requesting or returning the currency code specified in the attribute Enum: same as `MinimumAdcolAmount.currencySource` in "ChangePermitted" (3 values) - `AverageNightlyRate.approximateInd` (boolean) "If true, the currency amount has been converted from the original amount. For Air Exchange Eligibility, returned only if a currency is converted. If returned, the value is always true, indicating that the fee is approximate because of currency conversion. For Hotel Availability and Rules, true indicates this is a calculated value; false indicates this is the value returned by the property." Example: true - `AmenitySurcharges` (object) Amenity Surcharges information. - `AmenitySurcharges.@type` (string, required) Discriminator classes AmenitySurcharges or AmenitySurchargesDetail Example: "AmenitySurchargesDetail" - `AmenitySurcharges.TotalSurcharges` (number) A monetary amount, up to 4 decimal places. Decimal place needs to be included. Example: 211.11 - `AmenitySurcharges.approximateInd` (boolean) if true, the surcharge amounts are approximate - `AmenitySurcharges.Surcharge` (array, required) - `AmenitySurcharges.Surcharge.value` (number) Surcharge amount Example: 12 - `AmenitySurcharges.Surcharge.currencyCode` (string) ISO 4217 currency code for the surcharge. Example: "USD" - `AmenitySurcharges.Surcharge.surchargeCode` (string) Surcharge code Example: "ADDITIONAL COSTS" - `AmenitySurcharges.Surcharge.reportingAuthority` (string) Not used. Surcharge reporting authority Example: "Federal register" - `AmenitySurcharges.Surcharge.purpose` (string) Surcharge purpose. For Air workflows possible values include Weekend Surcharge, Stopover Charge, Multiple Stopover Charges, Other (default value that covers all other surcharges such as fuel surcharges). Example: "Weekend Surcharge" - `AmenitySurcharges.Surcharge.description` (string) Description of the surcharge. Example: "Rollaway Surcharge" - `AmenitySurcharges.Surcharge.surchargeApplication` (string) Application values (such as the application of a fee) like per person or per room. Enum: same as `Surcharge.surchargeApplication` (7 values) - `AmenitySurcharges.Surcharge.surchargeFrequency` (string) The frequency of a fee such as per night or per stay. Enum: same as `Surcharge.surchargeFrequency` (6 values) - `AmenitySurcharges.Surcharge.codeAuthority` (string) Not used. Currency code authority. Example: "ISO 4217" - `AmenitySurcharges.Surcharge.decimalPlace` (integer) Decimal place for the currency unit. Example: 4 - `AmenitySurcharges.Surcharge.decimalAuthority` (string) Not used. Currency code decimal authority. Example: "ISO 4217" - `priceChangesDuringStayInd` (boolean) "If true, indicates the price changes at least once during requested dates. If roomPricingType = Per night, multiple instances of priceChangesDuringStayInd are returned." - `shortRateDescription` (string) A normalized rate description for comparing rates across multiple aggregators. Example: "Flexible Rate" - PriceBreakdownVehiclePrice: - `VehiclePrice` (object, required) Rate summary for rental of the vehicle. - `VehiclePrice.@type` (string, required) Example: "VehiclePrice" - `VehiclePrice.id` (string) Internal ID - `VehiclePrice.rateSource` (string) Assigned Type: c-1100:StringTiny - `VehiclePrice.rateGuaranteedInd` (boolean) Assigned Type: c-1100:OptionalIndicator - `VehiclePrice.ratePeriod` (string) The time period for a rate such as daily, weekly, monthly Enum: same as `VehiclePrice.ratePeriod` in "PriceBreakdownVehiclePrice" (15 values) - `VehiclePrice.RateDistance` (object) Rate for the period defined by the attributes - `VehiclePrice.RateDistance.value` (number) - `VehiclePrice.RateDistance.unlimitedDistanceInd` (boolean) if true unlimited miles is included with the rental - `VehiclePrice.RateDistance.requestedCodeAppliedInd` (boolean) if true, the requested code has been applied - `VehiclePrice.RateDistance.allowance` (integer) The distance allowance permitted with this rate. Use in combination with distanceUnits and ratePeriod - `VehiclePrice.RateDistance.distanceUnits` (string) For Hotels: Optional object to request either miles or kilometers for the search radius from the specified location. If unitOfDistance is not specified, the search defaults to miles for properties in the United States, Myanmar, and Liberia. The search defaults to kilometers in all other countries. Enum: same as `Vehicle.VehicleDateLocation.RentalPickup.GeoLocation.altitudeUnitOfDistance` in "ProductVehicle" (2 values) - `VehiclePrice.RateDistance.ratePeriod` (string) The time period for a rate such as daily, weekly, monthly Enum: same as `VehiclePrice.ratePeriod` in "PriceBreakdownVehiclePrice" (15 values) - `VehiclePrice.RateDescription` (array) - `sequence` (integer) The order of the text block, if there are more than one block. Example: 2 - `description` (string) Text block detail description Example: "description" - `Image` (object) Each instance is one image and its accompanying details, including a link to the image. Key value pairs; not all may be returned. - `Image.value` (string) URL of the image - `Image.dimensionCategory` (string) Deprecated and replaced by imageSize - `Image.width` (integer) Image width Example: 42 - `Image.height` (integer) Image height Example: 43 - `Image.caption` (string) Image caption Example: "Ticket" - `Image.pictureCategory` (integer) deprecated and replaced by pictureOf Example: 5 - `Image.imageSize` (string) A size for the image to return, allowing you to set image quality. Hospitality APIs no longer support thumbnail. Enum: same as `Vehicle.Image.imageSize` in "ProductVehicle" (5 values) - `Image.pictureOf` (string) The image category Enum: same as `Vehicle.Image.pictureOf` in "ProductVehicle" (26 values) - `URL` (string) A URL for this block - `DateCreateModify` (object, required) Time stamp of the creation. - `DateCreateModify.value` (string) Example: "2026-03-04T11:22:00Z" - `DateCreateModify.creatorID` (string) ID of creator. Software system identifier or an employee id Example: "c1234563" - `DateCreateModify.lastModify` (string) Time stamp of last modification. Example: "2026-03-04T11:24:00Z" - `DateCreateModify.lastModifierID` (string) Identifies the last software system or person to modify a record Example: "m346789" - `DateCreateModify.purge` (string) Date an item will be purged from a system of record Example: "2026-03-03" - `VehiclePrice.RateDescription.@type` (string, required) Discriminator classes TextBlock or TextBlockDetail Example: "TextBlockDetail" - `VehiclePrice.RateDescription.title` (string) "The title of the rule or information. For TermsAndConditionsFullHospitality, may include any of the following Rule Types; Promotional Data, Rate Description, Room Rate Data, Rate Text, Guarantee, Cancellation, Deposit, Check in/out, Room detail, Extra charges, Packages, Property, Location, Miscellaneous, Rate Amount, Alternate Rate Amount, Rate Comment, FAX, Phone, Special Information, Information, Room Hold Expiration Time. Not every property returns all of these types. Some properties do not return any title. Only English is supported for these values." Example: "Baggage Details" - `VehiclePrice.RateDescription.id` (string) Internally referenced id Example: "2" - `VehiclePrice.RateDescription.TextFormatted` (array, required) - `VehiclePrice.RateAvailability` (string) Options are available to sell, need to call, or closed Enum: same as `VehiclePrice.RateAvailability` in "PriceBreakdownVehiclePrice" (3 values) - `VehiclePrice.SupplierRate` (object, required) Estimated total amount - Monetary amounts expressed in another currency. - `VehiclePrice.SupplierRate.@type` (string, required) Example: "SupplierRate" - `VehiclePrice.SupplierRate.BaseRate` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.SupplierRate.BaseRate.value` (number) The amount of a given currency. Example: 124.56 - `VehiclePrice.SupplierRate.BaseRate.code` (string) An ISO 4217 alpha character code (3 characters) that specifies a money unit. Example: "USD" - `VehiclePrice.SupplierRate.BaseRate.minorUnit` (integer) Minor units are a mechanism for expressing the relationship between a major currency unit and its corresponding minor currency unit. It is the smallest unit of a given currency. For example; the smallest denomination in USD is the cent, which is 1/100 of a USD, and the minor unit value is 2. Not all currencies have a minor unit. Example: 2 - `VehiclePrice.SupplierRate.BaseRate.currencySource` (string) The system requesting or returning the currency code specified in the attribute Enum: same as `MinimumAdcolAmount.currencySource` in "ChangePermitted" (3 values) - `VehiclePrice.SupplierRate.BaseRate.approximateInd` (boolean) "If true, the currency amount has been converted from the original amount. For Air Exchange Eligibility, returned only if a currency is converted. If returned, the value is always true, indicating that the fee is approximate because of currency conversion. For Hotel Availability and Rules, true indicates this is a calculated value; false indicates this is the value returned by the property." Example: true - `VehiclePrice.SupplierRate.RateForPeriod` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.SupplierRate.DropOffCharge` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.SupplierRate.ExtraMileageCharge` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.SupplierRate.EstimatedTotalAmount` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.ApproximateRate` (object) Estimated total amount - Monetary amounts expressed in another currency. - `VehiclePrice.ApproximateRate.@type` (string, required) Example: "ApproximateRate" - `VehiclePrice.ApproximateRate.BaseRate` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.ApproximateRate.RateForPeriod` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.ApproximateRate.DropOffCharge` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.ApproximateRate.ExtraMileageCharge` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.ApproximateRate.EstimatedTotalAmount` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.CustomerLoyalty` (object) Specifies the ID for the membership program. Object for sending customer loyalty information, such as for a frequent flyer program. For Hotel send the loyalty card number in the value field, followed by programID with the hotel chain code, and supplierType: Hotel. For Air send the loyalty card number in the value field, followed by airline code in "supplier". For cross accrual use the "shareWithSupplier" field to submit to partner airlines. - `VehiclePrice.CustomerLoyalty.value` (string, required) Number on loyalty card. Example: "132456" - `VehiclePrice.CustomerLoyalty.id` (string) Optional Customer Loyalty Id. Not saved Example: "Loyalty_1" - `VehiclePrice.CustomerLoyalty.priority` (integer) Optional Numeric Priority Code Example: 2 - `VehiclePrice.CustomerLoyalty.programId` (string) "Specifies an identifier to indicate the company owner of the loyalty program. Typically two characters. For frequent guest number, the hotel supplier or brand code. For frequent flyer number, the air supplier code of the loyalty program." Example: "HY" - `VehiclePrice.CustomerLoyalty.programName` (string) Supplier's loyalty program name. Example: "Frontier-EarlyReturns" - `VehiclePrice.CustomerLoyalty.supplierType` (string) The type of supplier of a loyalty program. Uses 'hotel' for frequent guest number or 'air' for frequent flyer number. Example: "Hotel" - `VehiclePrice.CustomerLoyalty.supplier` (string) Supplier of a loyalty program (typically 2 characters representing the hotel, brand, or airline). Example: "UA" - `VehiclePrice.CustomerLoyalty.tier` (string) Customer Loyalty tier Example: "Silver" - `VehiclePrice.CustomerLoyalty.shareWithSupplier` (array) The list of suppliers that the CustomerLoyalty number is shared. Used for cross accrual. Example: ["LH"] - `VehiclePrice.CustomerLoyalty.cardHolderName` (string) Customer loyalty member name; up to 128 characters are supported. In Air Search, for discounted offers to be returned, the name must be sent as LAST FIRST; e.g.,if SMITH is the last name and JORDAN the first name, send as SMITH JORDAN Example: "John Smith" - `VehiclePrice.CustomerLoyalty.validatedInd` (boolean) Customer loyalty number has been validated by the supplier Example: true - `VehiclePrice.CustomerLoyalty.prefix` (string) The cardholder name prefix title like Mr, Mrs, Dr Example: "Dr" - `VehiclePrice.CustomerLoyalty.given` (string) The First Name of the Cardholder Example: "John" - `VehiclePrice.CustomerLoyalty.middle` (string) Middle Name of the Cardholder Example: "Wilkinson" - `VehiclePrice.CustomerLoyalty.surname` (string) Last Name of the Cardholder Example: "Smith" - `VehiclePrice.RateQualifier` (string) A closed enumeration of possible rate qualifiers for vehicle rental Enum: same as `VehiclePrice.RateQualifier` in "PriceBreakdownVehiclePrice" (5 values) - `rateGuaranteedInd` (boolean) - PriceBreakdownVehicleDeposit: - `totalPayableNowInd` (boolean) If True the Amount is the total amount payable now - `totalPayableLaterInd` (boolean) If True the Amount is the total amount payable later - PriceBreakdownVehicleCharges: - `VehicleCharges` (object) - `VehicleCharges.@type` (string, required) Example: "VehicleCharges" - `VehicleCharges.description` (string) Assigned Type: c-1100:String - `VehicleCharges.VehicleChargePurposeCode` (object) Any code used to specify an item, for example a type of traveler, service code, room amenity, etc. - `VehicleCharges.VehicleChargePurposeCode.value` (string) Example: "INS" - `VehicleCharges.VehicleChargePurposeCode.codeContext` (string) Code Context Example: "ACRISS" - `VehicleCharges.ratePeriod` (string) The time period for a rate such as daily, weekly, monthly Enum: same as `VehiclePrice.ratePeriod` in "PriceBreakdownVehiclePrice" (15 values) - `VehicleCharges.rateChargeInfo` (string) Assigned Type: c-1100:String - `VehicleCharges.RateCategory` (string) For Hotel Search, request a rate category by sending up to 8 OTA rate categories to search for. If the supplier has rates available for the requested category, the response contains those rates and indicates them as such. Some properties do not return these rates unless explicitly requested. For a Hotel Rules request, this value can be found, if returned, in the Availability response's ProductRateCodeInfo/RateCodeInfo/rateCategory. Enum: same as `VehicleCharges.RateCategory` in "PriceBreakdownVehicleCharges" (32 values) - `VehicleCharges.VehicleCoverageTypeCode` (object) The OTA code defined for the Vehicle Coverage Type - `VehicleCharges.VehicleCoverageTypeCode.value` (string) Example: "INS" - `VehicleCharges.VehicleCoverageTypeCode.codeContext` (string) Code Context Example: "ACRISS" - `VehicleCharges.Calculation` (array) - `VehicleCharges.Calculation.@type` (string, required) Example: "Calculation" - `VehicleCharges.Calculation.UnitAmount` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehicleCharges.Calculation.UnitName` (string) The time period for a rate such as daily, weekly, monthly Enum: same as `VehiclePrice.ratePeriod` in "PriceBreakdownVehiclePrice" (15 values) - `VehicleCharges.Calculation.Quantity` (integer) The quantity used in the calculation of the vehicle charge e.g 2 x $500 per week - `VehicleCharges.Calculation.MaxQuantity` (integer) The maximum quantity allowed for a charge e.g Baby seat charged at $10 per day for a maximum of 10 days - `VehicleCharges.Calculation.TotalAmount` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehicleCharges.Calculation.Percent` (number) Used when the charge is based on a percentage of a TotalAmount - `VehicleCharges.Calculation.Applicability` (object) Textual information. - `VehicleCharges.taxInclusiveInd` (boolean) - `VehicleCharges.guaranteedInd` (boolean) - `VehicleCharges.payNowInd` (boolean) If true the vehicle charge must be paid now and is included in the totalPrice calculation - `VehicleCharges.includedInEstimatedTotalInd` (boolean) - `VehicleCharges.includedInBaseRateInd` (boolean) If true the Vehicle Charge has been included in the base rate of the Vehicle price - `SupplierRetainedPrice.VendorCurrencyTotal` (object) No longer used. Previously used to expose the local vendor currency when it is different to the purchased currency - `ConsumedPrice` (object) Child class of Price. This includes all of the Price object plus the Pricebreakdown which gives detailed Price information per PTC or Hotel offering. For a Hotels Create Reservation (Full Payload) request, find the values to send in the Price objects from either Availability (returned in CatalogOffering/Price) or Rules (returned in Offer/Price). Although you can send the price returned in either API, the Rules pricing may be more accurate. If you sent a Rules request, send the value from that response. You must include CurrencyCode, Base, TotalTaxes, and TotalPrice. When returned from the previous steps, additionally send TermsAndConditionsFull, ProductRateCodeInfo, and RateCodeInfo. - `ResidualPrice` (object) The Residual amount that will be refunded separately for this transaction. - `ResidualPrice.@type` (string, required) Example: "ResidualPriceDetail" - `ResidualPrice.id` (string) Internally referenced id - `ResidualPrice.CurrencyCode` (object) Currency codes are the three-letter alphabetic codes that represent the various currencies used throughout the world. Unless changed in the request, the currency is the default associated with your provisioned PCC from Travelport. For Hotel: SourceCurrency is based on the location of the hotel and used for all rates in the response. TargetCurrency is the currency code sent in the request in requestedCurrency. - `ResidualPrice.Base` (number) The total amount not including taxes and/or fees Example: 12.2 - `ResidualPrice.TotalTaxes` (number) The total of the taxes included in the total price Example: 24 - `ResidualPrice.TotalFees` (number) The total of the fees included in the total price Example: 10.5 - `ResidualPrice.TotalPrice` (number) The total price of the product in the currency indicated Example: 34.7 - `ResidualPrice.PriceBreakdown` (array) — one of (discriminator: @type): - PriceBreakdownAir: - `quantity` (integer) Quantity of passengers in that PTC. Example: 2 - `requestedPassengerType` (string) The PTC to which the PriceBreakdown applies. Example: "CHD" - `FiledAmount` (object) Returned only in the Price APIs. GDS only; not supported for NDC. The base amount of a ticket price or net price that is filed in local currency. Returned when the origin currency is not the same as the PCC currency to show the currency in which the base fare has been filed. When used for NetBaseAmount: Net ticket data (NTD) is returned in the AirPrice, AirReservation, Exchange Search, and Reservation Retrieve responses for any GDS fare that has a private fare component (fareType=AgencyPrivateFare). When NTD is returned, TermsAndConditionsFuill includes FareGuaranteePolicy to return the fare calculation indicator for the fare. When NTD is returned, PriceBreakdown may include NetBaseAmount. - `FiledAmount.value` (number) Filed amount value Example: 43.3422 - `FiledAmount.currencyCode` (string) Code for the currency in which the base fare was filed. Example: "USD" - `FiledAmount.codeAuthority` (string) Filed amount currency code authority Example: "Australian Dollar" - `FiledAmount.decimalPlace` (integer, required) Number of decimal places in the currency in ISO 4217 standard format. Example: 3 - `FiledAmount.decimalAuthority` (string) ISO 4217 standard decimal authority Example: "ISO 4217" - `Discount` (object) NDC only; not supported for GDS. Returned for a fare discounted from the published price, such as a promotional discount. Not returned for privately negotiated discounts such as private fares. - `Discount.value` (number) The amount value of the discount Example: 20.22 - `Discount.description` (string) The text description for the discount. Example: "Spring discount on group bookings" - `Discount.currencyCode` (string, required) Currency code discount is returned in. Example: "USD" - `Discount.codeAuthority` (string, required) Not used. Currency code Authority. Example: "ISO" - `Discount.decimalPlace` (integer, required) Number of decimal places in the currency the discount is returned in. Example: 2 - `Discount.decimalAuthority` (string) Not used. Decimal Authority. Example: "ISO" - `NetFareInfo` (object) Detailed information on the net fare used. - `NetFareInfo.@type` (string, required) Example: "NetFareInfo" - `NetFareInfo.passengerTypeCode` (string) PassengerTypeCode Example: "ADT" - `NetFareInfo.NetFareBreakdownConstruction` (array) - `NetFareInfo.NetFareBreakdownConstruction.value` (string) - `NetFareInfo.NetFareBreakdownConstruction.fareType` (string) Assigned Type: c-1100:StringTiny - `NetFareInfo.NetFareBreakdownConstruction.rateOfExchange` (number) The rate of exchange applied to the fare breakdown - `NetFareInfo.TicketBaseAudit` (object) Returned only in the Price APIs. GDS only; not supported for NDC. The base amount of a ticket price or net price that is filed in local currency. Returned when the origin currency is not the same as the PCC currency to show the currency in which the base fare has been filed. When used for NetBaseAmount: Net ticket data (NTD) is returned in the AirPrice, AirReservation, Exchange Search, and Reservation Retrieve responses for any GDS fare that has a private fare component (fareType=AgencyPrivateFare). When NTD is returned, TermsAndConditionsFuill includes FareGuaranteePolicy to return the fare calculation indicator for the fare. When NTD is returned, PriceBreakdown may include NetBaseAmount. - `NetFareInfo.TicketBasePassenger` (object) The monetary value - `NetFareInfo.TicketBasePassenger.value` (number) - `NetFareInfo.TicketBasePassenger.currencyCode` (string) Assigned Type: c-1100:CurrencyCode - `NetFareInfo.TicketBasePassenger.codeAuthority` (string, required) Assigned Type: c-1100:CodeContext - `NetFareInfo.TicketBasePassenger.decimalPlace` (integer, required) Assigned Type: c-1100:CurrencyMinorUnit - `NetFareInfo.TicketBasePassenger.decimalAuthority` (string) Assigned Type: c-1100:CodeContext - `NetFareInfo.TicketBasePassenger.bTInd` (boolean) If true, this is a bulk ticket fare - `NetFareInfo.TicketBasePassenger.iTInd` (boolean) If true, this is an inclusive tour fare - `TravelerIdentifierRef` (object) Identifier references as object both within a message payload or an object held in cache that may be used for subsequent workflows. Returned for NDC in the Price response if age was sent for this traveler in the previous workflow requests. - `TravelerIdentifierRef.name` (string) Traveler identifier - `TravelerIdentifierRef.passengerTypeCode` (string) Passenger Type code Example: "ADT" - `TravelerIdentifierRef.ages` (array) The ages of the travelers associated to a particular ptc. For NDC, this value will be returned in PriceBreakdownAir if sent as part of the PassengerCriteria in the Air Search request. Example: [15] - `TravelerIdentifierRef.passengerCriteriaRef` (string) Allows the user to associate passenger criteria information. Example: "passengerCriteria_1" - `TravelerIdentifierRef.value` (string) - `TravelerIdentifierRef.id` (string) A locally referenced ID - `TravelerIdentifierRef.description` (string) Descriptive text used to identify the contents of a target object - `TravelerIdentifierRef.uris` (array) Uniform Resource Identifier Example: ["google.com"] - `TravelerIdentifierRef.age` (integer) Replaced with ages array. The age of the traveler. Example: 11 - `NetBaseAmount` (object) Returned only in the Price APIs. GDS only; not supported for NDC. The base amount of a ticket price or net price that is filed in local currency. Returned when the origin currency is not the same as the PCC currency to show the currency in which the base fare has been filed. When used for NetBaseAmount: Net ticket data (NTD) is returned in the AirPrice, AirReservation, Exchange Search, and Reservation Retrieve responses for any GDS fare that has a private fare component (fareType=AgencyPrivateFare). When NTD is returned, TermsAndConditionsFuill includes FareGuaranteePolicy to return the fare calculation indicator for the fare. When NTD is returned, PriceBreakdown may include NetBaseAmount. - `FareCalculation` (string) GDS only; not supported for NDC. For each PTC, when available, FareCalculation returns the fare calculation ladder for all public and private fare types filed by an agency or an airline. Example: "LON BA SYD R564.00YEE1Y BA LON R564.00YEE1Y NUC1128.00END ROE0.787855" - `Surcharges` (object) In AirSearch workflow this applies to GDS only. Not supported for NDC, which does not return surcharges. Returned if surcharges apply to this offer. For GDS only, for a multi-city offer with stopovers (see multi-city offers with stopovers for details), surcharges and commission amounts are for the entire journey. For all other offers, the surcharges and commission amounts are for each leg (origin and destination pair). A multi-city offer can be identified by the jc in its CombinabilityCode: jc1, jc2. Surcharges can be omitted from the Search response with excludeSurchargesInd. - `Surcharge` (array, required) - `Surcharge.value` (number) Surcharge amount Example: 12 - `Surcharge.currencyCode` (string) ISO 4217 currency code for the surcharge. Example: "USD" - `Surcharge.surchargeCode` (string) Surcharge code Example: "ADDITIONAL COSTS" - `Surcharge.reportingAuthority` (string) Not used. Surcharge reporting authority Example: "Federal register" - `Surcharge.purpose` (string) Surcharge purpose. For Air workflows possible values include Weekend Surcharge, Stopover Charge, Multiple Stopover Charges, Other (default value that covers all other surcharges such as fuel surcharges). Example: "Weekend Surcharge" - `Surcharge.description` (string) Description of the surcharge. Example: "Rollaway Surcharge" - `Surcharge.surchargeApplication` (string) Application values (such as the application of a fee) like per person or per room. Enum: same as `Surcharge.surchargeApplication` (7 values) - `Surcharge.surchargeFrequency` (string) The frequency of a fee such as per night or per stay. Enum: same as `Surcharge.surchargeFrequency` (6 values) - `Surcharge.codeAuthority` (string) Not used. Currency code authority. Example: "ISO 4217" - `Surcharge.decimalPlace` (integer) Decimal place for the currency unit. Example: 4 - `Surcharge.decimalAuthority` (string) Not used. Currency code decimal authority. Example: "ISO 4217" - `Surcharges.@type` (string, required) Discriminator class is SurchargesDetail Example: "SurchargesDetail" - `Surcharges.TotalSurcharges` (number) A monetary amount, up to 4 decimal places. Example: 211.11 - `Surcharges.approximateInd` (boolean) If true, the surcharge amounts are approximate. - `TravelerRefs` (array) Returned only in Reservation Retrieve to identify the traveler associated with this instance of PriceBreakdown in case of multiple offers on the booking. Example: ["[\"traveler_1\",\"traveler2\"]"] - `PaidTaxes` (object) Summary Taxes object - `Tax` (array) - `Tax.value` (number) Amount of the tax. Returned as 0 if a tax was marked as exempt with TaxExemption. Example: 12.2 - `Tax.currencyCode` (string) A ISO 4217 currency code associated to the value. Example: "USD" - `Tax.taxCode` (string) "Code for the tax. For Hotels this is the OTA code." Example: "XF2" - `Tax.reportingAuthority` (string) Identifies the reporting authority such as airport code for XF taxes Example: "JFK1" - `Tax.purpose` (string) Supplier returned description of tax. Example: "Fuel surcharge" - `Tax.description` (string) "Short summary of the tax. In Air workflows this is returned only for NDC. Note that descriptions are not returned for tax codes YQ and YR, which are fees charged by airlines and not government-imposed taxes. For Hotels this is the OTA tax description." Example: "Lodging tax" - `Tax.includedInBase` (string) Yes , No , Unknown Enum: same as `instantPurchase` in "AdvanceReservationRequired" (3 values) - `Tax.codeAuthority` (string) Not used. Currency Code Authority Example: "ISO" - `Tax.decimalPlace` (integer) Permitted number of decimals. Associated to the currency value. Example: 2 - `Tax.decimalAuthority` (string) Not used. Currency decimal authority Example: "ISO" - `Tax.exemptInd` (boolean) GDS only; not supported for NDC. Returned if a tax was marked exempt in a prior request with the TaxExemption pricing modifer. If true, this tax is exempt" Example: true - `Tax.nonRefundableInd` (boolean) If true, the tax is non refundable. This indicator is only supported for exchange search and exchange price quote transactions. Example: true - `Tax.excludedFromTotalPriceInd` (boolean) Returned in Hotel APIs when a tax is not included in the TotalPrice. Default behavior is for taxes to be included in TotalPrice. Example: true - `TaxPercent` (object) Returned when the tax is expressed as a percentage of the amount. - `TaxPercent.value` (number) The tax percentage amount. Example: 5.5 - `TaxPercent.taxCode` (string) Any code for the tax. Example: "971 - IRS Notice" - `TaxPercent.reportingAuthority` (string) Tax reporting authority Example: "Georgia Department of Revenue" - `TaxPercent.purpose` (string) Purpose of tax Example: "statutory tax" - `TaxPercent.description` (string) Description Example: "1.5% of SGST" - `TaxPercent.includedInBase` (string) Yes , No , Unknown Enum: same as `instantPurchase` in "AdvanceReservationRequired" (3 values) - `PaidTaxes.@type` (string, required) Discriminator classes PaidTaxes or PaidTaxesDetail Example: "PaidTaxesDetail" - `PaidTaxes.TotalTaxes` (number) A monetary amount, up to 4 decimal places. Decimal place needs to be included. Example: 220.12 - `RequestedPricingModifiers` (array) - `RequestedPricingModifiers.@type` (string, required) Discriminator. Example: "RequestedPricingModifiers" - `RequestedPricingModifiers.PassengerCriteria` (object) Defines the passenger criteria. Send one PassengerCriteria for each passenger type code (PTC). Search supports up to 9 total passengers. A maximum of 6 PTCs are supported for GDS. NDC does not have a PTC limitation. AirPrice supports up to nine total passengers across all PTCs. - `TravelerIdentifierRef` (object, required) Identifier references as object both within a message payload or an object held in cache that may be used for subsequent workflows. Returned for NDC in the Price response if age was sent for this traveler in the previous workflow requests. - `RequestedPricingModifiers.PassengerCriteria.@type` (string, required) Discriminator. No child classes. Example: "PassengerCriteria" - `RequestedPricingModifiers.PassengerCriteria.number` (integer, required) The amount of passengers associated with this passenger type code. Default is 1. Example: 1 - `RequestedPricingModifiers.PassengerCriteria.age` (integer) The age of the passenger. Notes on PTC and age: - Travelport recommends sending age only with PTCs that require age for pricing. - If the age is sent in the request, for NDC only, the age is returned in the pricing response. - For child passengers, Travelport recommends sending the age of the child in the age attribute plus the PTC CNN. Travelport recommends against sending CNN without age, or the CHD PTC. Not all fares cannot be quoted for CHD. - The age for CNN is generally between 2 and 11 inclusive, with ADT fares returned for ages 12 and up; however, this can vary by airline and country. - The age for INF must be either 0 or 1. - During booking, date of birth is required for all child and infant PTCs (Add Traveler payload in Traveler/birthDate). Example: 26 - `RequestedPricingModifiers.PassengerCriteria.passengerTypeCode` (string) The passenger type code (PTC) for the passengers on the itinerary. Required field for Air Search and Flight specific search. Common PTCs are: - ADT: adult - CHD: child of unknown age - For child passengers, Travelport recommends sending the age of the child in the age attribute plus the PTC CNN. Travelport recommends against sending CNN without age, or the CHD PTC. Many fares cannot be quoted for CHD. - CNN: child when age is known - The age for CNN is generally between 2 and 11 inclusive, with ADT fares returned for ages 12 and up; however, this can vary by airline and country. - INF: infant without a seat - INS: infant with a seat - UNN: unaccompanied child. See API guides to download a full list of PTCs. NDC carriers BA, SQ, AV, AA, and AF/KLM offer teen/young adult tax exemptions from the UK Air Passenger Duty (GB tax). Send PTC with the value YTH and send the passengers age per below. The PTC may be returned as ADT, or Cxx in which xx is the age, but the tax exemption is applied in the pricing on these NDC carriers. For marine fares, send the PTC value SEA. You must also send OSI remarks at Add Traveler with the vessel name and location. Marine fares are private fares for travelers going to or from a vessel. NDC only; not supported for GDS. When running a multiple passenger search for NDC on Qantas, Qantas supports only these PTCs: ADT, CHD, CNN, INF. Sending any other PTC may result in an error at ticketing. Any traveler sent without a PTC value is defaulted to ADT. PTC can be sent or omitted for ADT passenger. AirReservation defaults the PTC to ADT and returns it in the Reservation Retrieve. Example: "ADT" - `RequestedPricingModifiers.PassengerCriteria.birthDate` (string) The date of birth of the passenger. May be used in age validation for fares with age restrictions. Example: "2020-01-16" - `RequestedPricingModifiers.PassengerCriteria.id` (string) Unique id to support referencing of this specific passenger criteria. Example: "passengercriteria_001" - `RequestedPricingModifiers.PassengerCriteria.CustomerLoyalty` (array) NDC only; not supported for GDS. Optional object for sending customer loyalty information, such as for a frequent flyer program. If CustomerLoyalty is sent in the Search request, it must also be sent in the Air Price request and the Add Traveler request. As some carriers validate frequent traveler data through the workflow, failing to send the same CustomerLoyalty details, even if invalid, may cause a booking failure. If an invalid number is sent, the response returns a warning message that the FQTV is invalid, and the invalid number is cached to prevent a potential booking failure. - `RequestedPricingModifiers.PassengerCriteria.TravelerGeographicLocation` (object) For AirSearch: supported/validated only for NDC to support local citizen fares. For AirPrice and AirReservation: GDS only; not supported for NDC. Optional object for requesting local citizen/local resident fares for Spain and associated islands. You must also send a PTC relevant to the local resident fares; e.g., ADR for adult resident, CHR for child resident. Any discount applied through TravelerGeographicLocation applies to all travelers, not only to the traveler in this instance of PassengerCriteria. If the discount must apply only to an individual traveler, that traveler requires a separate search and book workflow. - `RequestedPricingModifiers.PassengerCriteria.specifiedPassengerTypeCodeOnlyInd` (boolean) GDS only; not supported for NDC. - If true: returns only offers for the specified PTC. If no fares are available for the specified PTC, returns an error message that there is no valid fare. - If false (default behavior): If no fares are available for the specified PTC, returns fares for the default ADT (adult) PTC instead. Example: true - `RequestedPricingModifiers.PricingModifiersAir` (object) A selection of Pricing Modifiers that can be used to influence the Price of an Offer. - For the AirPrice reference payload request, if any price modifiers were included in the preceding Search request and no price modifiers are sent in the AirPrice request, the cached price modifiers sent at Search are sent with the AirPrice request. If any price modifiers are sent in the AirPrice reference payload request, all cached Search modifiers are discarded and only the modifiers sent in that AirPrice request are used. - For the Add Offer request, you may optionally store fares with one or more pricing modifiers. If a pricing modifier is not added, the auto stored fare is added to the reservation. There is no change in the AirReservation response when pricing modifiers are requested. AirReservation applies modifiers from Add Offer and earlier steps as follows: - Modifiers sent in the Add Offer request (supported for both full and reference payload). - If no modifiers are sent in Add Offer, any pricing modifiers sent in AirPrice are applied. - If no modifiers were sent in AirPrice, or if AirPrice was not sent, any pricing modifiers sent in Search are applied. GDS only; pricing modifiers not supported for NDC. If the requested modifier does not have any fares associated with it, the workbench commit fails and returns the error message 'No Fare Found'. Pricing happens at commit, not at Add Offer. - `Brand` (object) Information on airline Brand offerings. If brand attributes were not excluded with inhibitBrandContentInd=true (GDS only), then brand attributes are returned and consolidated in ReferenceList/ReferenceListBrand. In this case Brand does not return the name or Identifier objects but instead returns only BrandRef, which matches to the brand identifier (e.g., b1) in ReferenceListBrand. - `RequestedPricingModifiers.PricingModifiersAir.@type` (string, required) Discriminator. Child classes PricingModifiersAir and PricingModifersAirDetail Example: "PricingModifiersAir" - `RequestedPricingModifiers.PricingModifiersAir.currencyCode` (string) In an API request, send the currency type to return if you want to override the default currency specified with your PCC. Example: "GBP" - `RequestedPricingModifiers.PricingModifiersAir.FareSelection` (object) Requests the return of fare types including private fares (negotiated), public fares (published), or net fares (consolidator fares, or any negotiated wholesale price that is further marked up for sale to customers). May be used to request fares with specific restrictions, change, or refund options. - `RequestedPricingModifiers.PricingModifiersAir.OrganizationInformation` (object) Use to send account codes for negotiated fares or to send optional India GST SSR Remarks in GSTRegistrationNumber. For NDC supports corporate loyalty program and GST Information. This information is returned in TermsAndConditions." - `RequestedPricingModifiers.PricingModifiersAir.TaxExemption` (object) GDS only, not supported for NDC. Use to mark some or all taxes as exempt. Specify all taxes, only specific tax codes, or all taxes in specific countries. Must include either allTaxesExemptInd OR both countries and taxCodes. TaxExemption supports up to nine values for countries, taxCodes, or both combined. The response returns any exempt taxes with exemptInd=true and value=0. - `RequestedPricingModifiers.PricingModifiersAir.PromotionalCode` (array) - `RequestedPricingModifiers.PricingModifiersAir.SellCity` (string) GDS only, not supported for NDC. The IATA location code for a city. Overrides the sell city of the requester to specify an alternate sale location and return fares based on that location. The response returns pricing in the local currency for the specified sell city instead of the PCC's default currency. Example: "NYC" - `RequestedPricingModifiers.PricingModifiersAir.TicketCity` (string) GDS only, not supported for NDC. The IATA location code for a city. Overrides the ticketing city of the requester to specify an alternate ticket location and return fares based on that location; the response returns pricing in the local currency for the specified ticket city instead of the PCC's default currency. Example: "NYC" - `RequestedPricingModifiers.PricingModifiersAir.PricingPCC` (string) GDS only, not supported for NDC. Use to send a faring PCC for which a selective access or code group agreement exists between that PCC and the PCC associated with your account. The following combinations of PricingPCC and FareSelection/fareType=PrivateFaresOnly return results as follows: - PricingPCC sent and PrivateFaresOnly not requested: If a selective access or group agreement exists, both public and any available private fares are returned for the requesting and providing PCC. - If no selective access or group agreement exists, only public fares are returned. - PricingPCC sent and PrivateFaresOnly is requested: If a selective access or group agreement exists that allows private fare access, only available private fares are returned for the requesting and providing PCC. - If no agreement exists, or if an agreement exists but does not allow private fares access, an error is returned. Example: "0Bx3" - `RequestedPricingModifiers.PricingModifiersAir.FareBasisCodeOverride` (array) - `RequestedPricingModifiers.PricingModifiersAir.MultiPricingAgency` (array) The customer can send up to 3 Pseudo City Codes (PCCs) in PricingModifiersAir, MultiPricingAgency. If a customer sends more than 3 PCCs in MultiPricingAgency, only the first 3 are validated. If a customer sends both PricingPCC and MultiPricingAgency with PCCs, the PCC in PricingPCC is ignored. Example: ["[\"0XS4\",\"0YBZ\",\"J80K\"]"] - `RequestedPricingModifiers.PricingModifiersAir.TicketingPCC` (string) GDS only, not supported for NDC. In an API request, overrides the ticketing PCC associated with your account to specify an alternate PCC and return fares based on that PCC. Example: "0XS4" - `RequestedPricingModifiers.PricingModifiersAir.CalculatedFareAdjustment` (object) Used in Exchange Search to modify the Price of the Fare. Discriminator classes CalculatedFareAdjustmentDiscount or CalculatedFareAdjustmentIncrease - `RequestedPricingModifiers.PricingModifiersAir.ManualFareAdjustment` (array) Send to manually adjust the base fare amount on all fares for a specific PTC. - `RequestedPricingModifiers.PricingModifiersAir.BrandPreference` (array) - `RequestedPricingModifiers.PricingModifiersAir.includeSplitPaymentInd` (boolean) Requests request split ticketing, which returns outbound and inbound one-way fares in addition to round trip options in the Search API response. This may result in lower fares than the same or similar round-trip itinerary. If true, requests split ticketing. If false or omitted split ticketing options are not returned. Default is false. GDS only, not supported for NDC. When split ticketing is requested, the Search response returns offers in the following order: Outbound one-way offers, Inbound one-way offers, Round trip offers. The response identifies all one-way outbound and inbound offers with CombinabilityCode j0. CombinabilityCode values for round trip offers start at j1 and increment by one for each offer. Only the following are in scope for split ticketing: Search (not supported for Next Leg Search or Flight Specific Search), Round-trip journey-based offerings ( isJourney header not sent or sent as true, or CustomResponseModifiersAir/SearchRepresentation not sent or sent with value Journey ) Upsells. Split ticketing is not supported for round-trip leg-based searches, virtual interlining, or NDC. Split ticketing is available only for customers specifically provisioned for split ticketing. Split ticketing returns one-way outbound and one-way inbound fares in addition to round-trip offers. Split ticket offers are identified with CombinabilityCode j0. If your account is not configured for split ticketing, sending includeSplitPaymentInd returns a response without split ticket offers and a warning message. GDS only, not supported for NDC. In Air Price, For split ticketing, the request must send offers that are identified in the Search response with CombinabilityCode j0, which identifies those offers as one-way outbound and one-way inbound split ticketing offers. A combination of j0 and any non-j0 value offer returns an error message that split pricing is not supported - `RequestedPricingModifiers.PricingModifiersAir.returnMostRestrictiveBrandInd` (boolean) In Search API, when there are different brands on a connecting flight, return information for either the most restrictive brand or the brand on the most significant segment on the itinerary. If true, return the offer brand of the most restrictive brand. If false or omitted, return the offer brand of the most significant segment of the itinerary. GDS only, not supported for NDC. - `RequestedPricingModifiers.PricingModifiersAir.splitPaymentOfferings` (number) Number between 0 and 99. Send with includeSplitPaymentInd to configure the percentage of round trip offers to return in a split ticketing response. By default, Search divides the split ticketing response into 34% round-trip offerings and the remainder as split ticketing offers, which are combined outbound and inbound one-way fares. To change this percentage, send SplitPaymentOfferings with the percentage value of round trip offers to return. Example: 25 - `RequestedPricingModifiers.CabinPreference` (object) Requests a fare based on the cabin class. Only one cabin preferenceType (Permitted, Preferred, PreferredWithUpgrade) is allowed per request, but there is no limit to the number of cabins that can be sent. Any CabinPreference in the initial Search request is applied to any subsequent Next Leg Search and reference Flight Specific Search requests. In AirPrice and AirReservation only one cabin preference type is allowed per request, but there is no limit to the number of cabins that can be sent. If CabinPreference was sent in the Search request, it is cached and sent with the AirPrice reference payload request. If you send CabinPreference in the AirPrice request, all cached modifiers are discarded and only the modifiers sent in the AirPrice request are used. Can be combined with lowFareFinderInd=true to return lowest fare in the requested cabin or cabins. When using CabinPreference and lowFareFinderInd, if both CabinPreference and a class of service are sent, class of service is ignored. If CabinPreference is sent without a class of service, the response returns the lowest fare in the cabin requested. If that cabin is not available, the response may upgrade or downgrade to a different cabin. If a different cabin than requested is returned, the response returns the message that the cabin class may differ from the class requested. If lowFareFinderInd=false and CabinPreference are sent in the request, AirPrice ignores the preferred cabin and returns a message that the preferred cabin was ignored. If CabinPreference is set to All, no cabin preference is applied." - `RequestedPricingModifiers.CabinPreference.@type` (string, required) Discriminator. No child classes exist Example: "CabinPreference" - `RequestedPricingModifiers.CabinPreference.preferenceType` (string) Type of cabin preference. Sending a mix of preferenceType values is not supported. For example, you cannot send an instance of CabinPreference with a preferenceType of Permitted and another instance with preferenceType of Prohibited. In this case the results default to the Preferred preference. Note that if lowFareFinderInd is sent with true and CabinPreference is sent, the only supported value for CabinPreference/type is Permitted. Enum: same as `RequestedPricingModifiers.CabinPreference.preferenceType` in "PriceBreakdownAir" (4 values) - `RequestedPricingModifiers.CabinPreference.cabins` (array) A space-delimited list of cabins. Enum: same as `PassengerFlight.FlightProduct.cabin` in "ProductAir" (5 values) - `RequestedPricingModifiers.CabinPreference.legSequence` (array) Limits preference to the specified leg referenced in SearchCriteriaFlight. You can apply the preference to only some legs of the itinerary, or different preferences to different legs. To apply preference to the entire itinerary, do not send legSequence. GDS only, not supported for NDC. Not supported at Price or Book. Example: [1,2] - `RequestedPricingModifiers.FlightType` (object) The type of flight connection - `RequestedPricingModifiers.FlightType.@type` (string, required) Discriminator. No child classes. Example: "FlightType" - `RequestedPricingModifiers.FlightType.connectionType` (string) Limits the connection type returned. Each value returns the specified type and all higher types. For example, StopDirect could return both flights that stop without a change of planes (StopDirect) and non-stop direct flights (NonStopDirect). SingleConnection or DoubleConnection will not exclude StopDirect flights from the journey. For example, SingleConnection could return an itinerary with two flight numbers, and either of these flights could have intermediate stops. Enum: same as `RequestedPricingModifiers.FlightType.connectionType` in "PriceBreakdownAir" (5 values) - `RequestedPricingModifiers.FlightType.excludeInterlineConnectionsInd` (boolean) Excludes interline connectionsClosed from results. If true, does not return offers with interline connections. If false or omitted, may return interline connections in results. Default is false. GDS only, not supported for NDC. When a product contains multiple interline air segments, brand details return only the brand of the significant carrier, not the validating/plating carrier brand information. The IATA rules for determining the significant carrier on an itinerary are based on the areas in which the transportation takes place. Example: true - `RequestedPricingModifiers.CustomResponseModifiersAir` (object) Contains additional modifiers to customize the result set. Includes optional indicators for returning or excluding specified response content. Values sent at Search can carry forward into the Next Leg Search request and are not re-sent. - `RequestedPricingModifiers.CustomResponseModifiersAir.@type` (string, required) discriminator Example: "CustomResponseModifiersAir" - `RequestedPricingModifiers.CustomResponseModifiersAir.BrandAttributeInclusion` (array) Supported in AirSearch and AirPrice. Returns only information about the brand attributes specified and does not return any other brand attributes. - `RequestedPricingModifiers.CustomResponseModifiersAir.SearchRepresentation` (string) Specifies either a journey or leg-based response. Journey returns offers for all legs of the itinerary. Journey is the default. Leg returns offers for only the first leg of the itinerary. Must be followed with a Next Leg Search to select an offer for the first leg and return offers on the subsequent leg to combine with it.Customize search result set as leg or journey based. Next Leg Search requests, and Flight Specific Search requests for less than the full itinerary, are supported only after a leg-based Search, not a journey-based Search. If these requests follow a journey-based Search request, an error message is returned. Enum: same as `RequestedPricingModifiers.CustomResponseModifiersAir.SearchRepresentation` in "PriceBreakdownAir" (3 values) - `RequestedPricingModifiers.CustomResponseModifiersAir.excludePenaltiesInd` (boolean) GDS only; not supported for NDC. Indicator to omit change and cancel penalties. - If true: omits all penalty information from the response. - If false (default behavior): returns any change and penalty details provided by carrier for each offer in TermsAndConditionsFullAir/Penalties. If sent in Search but not in AirPrice, the value sent in Search is cached and applied to the AirPrice results. However, you can override the value sent in Search by sending excludePenaltiesInd in the AirPrice request with the opposite value. For example, if the Search request sends excludePenaltiesInd=true and the AirPrice request sends excludePenaltiesInd=false, the Search response does not return penalties and the AirPrice response does return penalties. Example: true - `RequestedPricingModifiers.CustomResponseModifiersAir.excludeBaggageFeesInd` (boolean) GDS only; not supported for NDC. Indicator to exclude baggage details. - If true: excludes baggage fees, carry on fees, and embargo information from the response. Baggage quantity or weight is returned instead. - If false (default behavior): baggage details returned in response. Default is false. Example: true - `RequestedPricingModifiers.CustomResponseModifiersAir.includeFareCalculationInd` (boolean) GDS only; not supported for NDC or in the Flight Specific Search full payload request. Indicator to request the return of the fare calculation ladder. - If true: returns the fare calculation ladder in BestCombinablePrice.PriceBreakdownAir.FareCalculation. - If false (default behavior): fare calculation ladder is not returned. Example: true - `RequestedPricingModifiers.CustomResponseModifiersAir.excludeSurchargesInd` (boolean) GDS only; not supported for NDC. Indicator to exclude a surcharge breakdown. - If true: excludes a surcharge breakdown from the response. Baggage quantity or kilos is returned instead. - If false (default behavior): surcharge breakdown returned in response. Example: true - `RequestedPricingModifiers.CustomResponseModifiersAir.excludeUnbundledFaresInd` (boolean) GDS only, not supported for NDC. Sets whether to return unbundled fares. Supported in AirSearch and AirPrice. - If true: does not return unbundled fares. - If false (default behavior): returns unbundled and bundled fares as available. Example: true - `RequestedPricingModifiers.CustomResponseModifiersAir.includeCO2EmissionsDataInd` (boolean) Indicator to return CO2 emission data in the Search and Next Leg Search responses. - If true: returns CO2 emission data. - If false (default behavior): CO2 emission data not returned. Example: true - `RequestedPricingModifiers.CustomResponseModifiersAir.includeFlightAmenitiesInd` (boolean) Indicator to return flight amenities from ATPCO RouteHappy data. - If true: includes amenities in the response if available. - If false: Does not return ATPCO RouteHappy amenities. Example: true - `RequestedPricingModifiers.CustomResponseModifiersAir.includeUniversalProductAttributesInd` (boolean) Indicator to return universal product attributes (UPAs), which include images, icons, and URLs as provided by ATPCO. Must also send includeFlightAmenitiesInd=true. - If true: returns universal product attributes if available. - If false (default behavior): Universal product attributes not returned. UPAs are not returned for direct flights with intermediate stops, non-flight segments such as trains, or for Premium Business class. Example: true - `RequestedPricingModifiers.CustomResponseModifiersAir.includeBundledAncillariesInd` (boolean) NDC only. If true: the search and price response will include bundled air and ancillary offerings/offers. Search and Price response will contain both ProductAir and ProductAncillary plus a new child class of PriceBreakdown: PriceBreakdownAncillaryAir to define the ancillary inclusion and pricing. Example: true - `RequestedPricingModifiers.CustomResponseModifiersAir.includeFullPenaltyDisclosureInd` (boolean) If true, penalty information sourced from ATPCO Cat 31 and 33 will be disclosed. Penalties may be exposed at fare component level and include time windows. - `RequestedPricingModifiers.PricingModifiersAirChange` (object) Pricing Modifiers that can be used to influence the Price of an Exchanged Offer - `RequestedPricingModifiers.PricingModifiersAirChange.@type` (string) Example: "PricingModifiersAirChange" - `RequestedPricingModifiers.PricingModifiersAirChange.currencyCode` (string) ISO 4217 currency code Example: "USD" - `RequestedPricingModifiers.PricingModifiersAirChange.FareSelection` (object) Requests the return of fare types including private fares (negotiated), public fares (published), or net fares (consolidator fares, or any negotiated wholesale price that is further marked up for sale to customers). May be used to request fares with specific restrictions, change, or refund options. - `RequestedPricingModifiers.PricingModifiersAirChange.OrganizationInformation` (object) Use to send account codes for negotiated fares or to send optional India GST SSR Remarks in GSTRegistrationNumber. For NDC supports corporate loyalty program and GST Information. This information is returned in TermsAndConditions." - `RequestedPricingModifiers.PricingModifiersAirChange.WaiverCode` (object) A code assigned by an airline to support waiver of fees or ticket value as a result of disruption to the passenger. - `RequestedPricingModifiers.PricingModifiersAirChange.TaxExemption` (object) GDS only, not supported for NDC. Use to mark some or all taxes as exempt. Specify all taxes, only specific tax codes, or all taxes in specific countries. Must include either allTaxesExemptInd OR both countries and taxCodes. TaxExemption supports up to nine values for countries, taxCodes, or both combined. The response returns any exempt taxes with exemptInd=true and value=0. - `RequestedPricingModifiers.PricingModifiersAirChange.PromotionalCode` (object) NDC only. Not supported for GDS. Any NDC airline designated promotional code. - `RequestedPricingModifiers.PricingModifiersAirChange.SellCity` (string) Overrides the sell city of the requestor Example: "MEX" - `RequestedPricingModifiers.PricingModifiersAirChange.TicketCity` (string) Overrides the ticket city of the requestor Example: "MEX" - `RequestedPricingModifiers.PricingModifiersAirChange.PricingPCC` (string) Overrides the pricing PCC of the requestor Example: "0XS4" - `RequestedPricingModifiers.PricingModifiersAirChange.TicketingPCC` (string) Overrides the ticketing PCC of the requestor Example: "0XCD" - `RequestedPricingModifiers.PricingModifiersAirChange.CalculatedFareAdjustment` (object) Used in Exchange Search to modify the Price of the Fare. Discriminator classes CalculatedFareAdjustmentDiscount or CalculatedFareAdjustmentIncrease - `RequestedPricingModifiers.PricingModifiersAirChange.BrandPreference` (array) - `RequestedPricingModifiers.PricingModifiersAirChange.keepToBrandInd` (boolean) If true, the offerings returned will be of the same brand as the original Offer Example: true - `RequestedPricingModifiers.PricingModifiersAirChange.returnMostRestrictiveBrandInd` (boolean) if true, the most restrictive brand will be returned in the response when there are different brands present in the Offering Example: true - `RequestedPricingModifiers.PricingModifiersAirChange.doNotNetInd` (boolean) If true, this exchange will not net any residual/refundable amounts against due amounts. - `RequestedPricingModifiers.lowFareFinderInd` (boolean) Provides pricing flexibility around class of service. If not sent, the response returns fares only in the requested class of service. If true, returns the lowest fares available in any class of service available, which may not be the same as the requested class. Note that if lowFareFinderInd is sent with true and CabinPreference is sent, the only supported value for CabinPreference/type is Permitted. When lowFareFindInd=true and brand attributes are not disabled (inhibitBrandContentInd), AirPrice uses only the brand tier (and any other pricing modifiers) to find the lowest fare within a brand tier regardless of class of service. GDS only; not supported for NDC. Example: true - `RequestedPricingModifiers.keepToBrandInd` (boolean) If true, the original brand will be maintained during the exchange process. Example: true - `RequestedPricingModifiers.lowFareFindAndRebookInd` (boolean) If true, the original flights in the reservation will be rebooked or replaced with the new exchanged flights. - `PassengerCriteriaRefs` (array) NDC only; not supported for GDS. Returned for NDC if a traveler identifier was sent for this traveler in the previous workflow requests. Example: ["passengerCriteria_1"] - `FlightPassCredits` (integer) The number of flight pass credits consumed for this pricebreakdown. Example: 1 - PriceBreakdownAncillary: - `inclusiveOfTaxInd` (boolean) If true, this ancillary is sold inclusive of tax. Example: true - `quantity` (integer) The quantity of ancillary items included in this PriceBreakdown. Example: 1 - `Description` (object) A description of the ancillary with description codes. - `Description.value` (string) The text description of the ancillary. Example: "Vegetarian Meal" - `Description.code` (string) The ATPCO group code. Example: "BG" - `Description.subCode` (string) The ATPCO RFISC subcode. Example: "0D4" - `Description.subGroup` (string) The ATPCO sub group code. Example: "SP" - `Description.codeContext` (string) The code context value. Example: "ATPCO" - `Description.ssrCode` (string) The four character AIRIMP SSR code for this ancillary. Example: "VGML" - `Description.issuanceReasonCode` (string) The airline provided reason for issuance code. Example: "C" - `Description.geographicSpecification` (string) How the ancillary is applied across the itinerary. Enum: same as `Ancillary.Description.geographicSpecification` in "ProductAncillary" (3 values) - `ProductRef` (string) The product ref this PriceBreakdown applies to. If no productRef exists then the PriceBreakdown applies to all Products within the Offer. Example: "p_1" - `Discount` (object) NDC only; not supported for GDS. Returned for a fare discounted from the published price, such as a promotional discount. Not returned for privately negotiated discounts such as private fares. - `Discount.value` (number) The amount value of the discount Example: 20.22 - `Discount.description` (string) The text description for the discount. Example: "Spring discount on group bookings" - `Discount.currencyCode` (string, required) Currency code discount is returned in. Example: "USD" - `Discount.codeAuthority` (string, required) Not used. Currency code Authority. Example: "ISO" - `Discount.decimalPlace` (integer, required) Number of decimal places in the currency the discount is returned in. Example: 2 - `Discount.decimalAuthority` (string) Not used. Decimal Authority. Example: "ISO" - `TravelerIdentifierRef` (object) Identifier references as object both within a message payload or an object held in cache that may be used for subsequent workflows. Returned for NDC in the Price response if age was sent for this traveler in the previous workflow requests. - `TravelerIdentifierRef.name` (string) Traveler identifier - `TravelerIdentifierRef.passengerTypeCode` (string) Passenger Type code Example: "ADT" - `TravelerIdentifierRef.ages` (array) The ages of the travelers associated to a particular ptc. For NDC, this value will be returned in PriceBreakdownAir if sent as part of the PassengerCriteria in the Air Search request. Example: [15] - `TravelerIdentifierRef.passengerCriteriaRef` (string) Allows the user to associate passenger criteria information. Example: "passengerCriteria_1" - `TravelerIdentifierRef.value` (string) - `TravelerIdentifierRef.id` (string) A locally referenced ID - `TravelerIdentifierRef.description` (string) Descriptive text used to identify the contents of a target object - `TravelerIdentifierRef.uris` (array) Uniform Resource Identifier Example: ["google.com"] - `TravelerIdentifierRef.age` (integer) Replaced with ages array. The age of the traveler. Example: 11 - `AncillaryPriceApplicationCode` (object) Determines how an ancillary price has been built. - `AncillaryPriceApplicationCode.value` (string) Example: "3" - `AncillaryPriceApplicationCode.application` (string) Associated text. Example: "PerItem" - PriceBreakdownHospitality: - `roomPricingType` (string) A string provided by the hotel to describe how a service is priced, such as per night or per stay. Enum: same as `roomPricingType` in "PriceBreakdownHospitality" (5 values) - `Description` (string) Example: "Advance Purchase-Ro-Free WiFi" - `NightlyRate` (array) - `NightlyRate.@type` (string) - `NightlyRate.startDate` (string, required) Start date for the nightly rate in YYYY-MM-DD format. - `NightlyRate.nights` (integer) Number of nights the nightly rate is valid. - `NightlyRate.Amount` (object, required) Amount represents the cost applied - `AverageNightlyRate` (array) The average nightly rate for a given offer. - `AverageNightlyRate.value` (number) The amount of a given currency. Example: 124.56 - `AverageNightlyRate.code` (string) An ISO 4217 alpha character code (3 characters) that specifies a money unit. Example: "USD" - `AverageNightlyRate.minorUnit` (integer) Minor units are a mechanism for expressing the relationship between a major currency unit and its corresponding minor currency unit. It is the smallest unit of a given currency. For example; the smallest denomination in USD is the cent, which is 1/100 of a USD, and the minor unit value is 2. Not all currencies have a minor unit. Example: 2 - `AverageNightlyRate.currencySource` (string) The system requesting or returning the currency code specified in the attribute Enum: same as `MinimumAdcolAmount.currencySource` in "ChangePermitted" (3 values) - `AverageNightlyRate.approximateInd` (boolean) "If true, the currency amount has been converted from the original amount. For Air Exchange Eligibility, returned only if a currency is converted. If returned, the value is always true, indicating that the fee is approximate because of currency conversion. For Hotel Availability and Rules, true indicates this is a calculated value; false indicates this is the value returned by the property." Example: true - `AmenitySurcharges` (object) Amenity Surcharges information. - `AmenitySurcharges.@type` (string, required) Discriminator classes AmenitySurcharges or AmenitySurchargesDetail Example: "AmenitySurchargesDetail" - `AmenitySurcharges.TotalSurcharges` (number) A monetary amount, up to 4 decimal places. Decimal place needs to be included. Example: 211.11 - `AmenitySurcharges.approximateInd` (boolean) if true, the surcharge amounts are approximate - `AmenitySurcharges.Surcharge` (array, required) - `AmenitySurcharges.Surcharge.value` (number) Surcharge amount Example: 12 - `AmenitySurcharges.Surcharge.currencyCode` (string) ISO 4217 currency code for the surcharge. Example: "USD" - `AmenitySurcharges.Surcharge.surchargeCode` (string) Surcharge code Example: "ADDITIONAL COSTS" - `AmenitySurcharges.Surcharge.reportingAuthority` (string) Not used. Surcharge reporting authority Example: "Federal register" - `AmenitySurcharges.Surcharge.purpose` (string) Surcharge purpose. For Air workflows possible values include Weekend Surcharge, Stopover Charge, Multiple Stopover Charges, Other (default value that covers all other surcharges such as fuel surcharges). Example: "Weekend Surcharge" - `AmenitySurcharges.Surcharge.description` (string) Description of the surcharge. Example: "Rollaway Surcharge" - `AmenitySurcharges.Surcharge.surchargeApplication` (string) Application values (such as the application of a fee) like per person or per room. Enum: same as `Surcharge.surchargeApplication` (7 values) - `AmenitySurcharges.Surcharge.surchargeFrequency` (string) The frequency of a fee such as per night or per stay. Enum: same as `Surcharge.surchargeFrequency` (6 values) - `AmenitySurcharges.Surcharge.codeAuthority` (string) Not used. Currency code authority. Example: "ISO 4217" - `AmenitySurcharges.Surcharge.decimalPlace` (integer) Decimal place for the currency unit. Example: 4 - `AmenitySurcharges.Surcharge.decimalAuthority` (string) Not used. Currency code decimal authority. Example: "ISO 4217" - `priceChangesDuringStayInd` (boolean) "If true, indicates the price changes at least once during requested dates. If roomPricingType = Per night, multiple instances of priceChangesDuringStayInd are returned." - `shortRateDescription` (string) A normalized rate description for comparing rates across multiple aggregators. Example: "Flexible Rate" - PriceBreakdownVehiclePrice: - `VehiclePrice` (object, required) Rate summary for rental of the vehicle. - `VehiclePrice.@type` (string, required) Example: "VehiclePrice" - `VehiclePrice.id` (string) Internal ID - `VehiclePrice.rateSource` (string) Assigned Type: c-1100:StringTiny - `VehiclePrice.rateGuaranteedInd` (boolean) Assigned Type: c-1100:OptionalIndicator - `VehiclePrice.ratePeriod` (string) The time period for a rate such as daily, weekly, monthly Enum: same as `VehiclePrice.ratePeriod` in "PriceBreakdownVehiclePrice" (15 values) - `VehiclePrice.RateDistance` (object) Rate for the period defined by the attributes - `VehiclePrice.RateDistance.value` (number) - `VehiclePrice.RateDistance.unlimitedDistanceInd` (boolean) if true unlimited miles is included with the rental - `VehiclePrice.RateDistance.requestedCodeAppliedInd` (boolean) if true, the requested code has been applied - `VehiclePrice.RateDistance.allowance` (integer) The distance allowance permitted with this rate. Use in combination with distanceUnits and ratePeriod - `VehiclePrice.RateDistance.distanceUnits` (string) For Hotels: Optional object to request either miles or kilometers for the search radius from the specified location. If unitOfDistance is not specified, the search defaults to miles for properties in the United States, Myanmar, and Liberia. The search defaults to kilometers in all other countries. Enum: same as `Vehicle.VehicleDateLocation.RentalPickup.GeoLocation.altitudeUnitOfDistance` in "ProductVehicle" (2 values) - `VehiclePrice.RateDistance.ratePeriod` (string) The time period for a rate such as daily, weekly, monthly Enum: same as `VehiclePrice.ratePeriod` in "PriceBreakdownVehiclePrice" (15 values) - `VehiclePrice.RateDescription` (array) - `sequence` (integer) The order of the text block, if there are more than one block. Example: 2 - `description` (string) Text block detail description Example: "description" - `Image` (object) Each instance is one image and its accompanying details, including a link to the image. Key value pairs; not all may be returned. - `Image.value` (string) URL of the image - `Image.dimensionCategory` (string) Deprecated and replaced by imageSize - `Image.width` (integer) Image width Example: 42 - `Image.height` (integer) Image height Example: 43 - `Image.caption` (string) Image caption Example: "Ticket" - `Image.pictureCategory` (integer) deprecated and replaced by pictureOf Example: 5 - `Image.imageSize` (string) A size for the image to return, allowing you to set image quality. Hospitality APIs no longer support thumbnail. Enum: same as `Vehicle.Image.imageSize` in "ProductVehicle" (5 values) - `Image.pictureOf` (string) The image category Enum: same as `Vehicle.Image.pictureOf` in "ProductVehicle" (26 values) - `URL` (string) A URL for this block - `DateCreateModify` (object, required) Time stamp of the creation. - `DateCreateModify.value` (string) Example: "2026-03-04T11:22:00Z" - `DateCreateModify.creatorID` (string) ID of creator. Software system identifier or an employee id Example: "c1234563" - `DateCreateModify.lastModify` (string) Time stamp of last modification. Example: "2026-03-04T11:24:00Z" - `DateCreateModify.lastModifierID` (string) Identifies the last software system or person to modify a record Example: "m346789" - `DateCreateModify.purge` (string) Date an item will be purged from a system of record Example: "2026-03-03" - `VehiclePrice.RateDescription.@type` (string, required) Discriminator classes TextBlock or TextBlockDetail Example: "TextBlockDetail" - `VehiclePrice.RateDescription.title` (string) "The title of the rule or information. For TermsAndConditionsFullHospitality, may include any of the following Rule Types; Promotional Data, Rate Description, Room Rate Data, Rate Text, Guarantee, Cancellation, Deposit, Check in/out, Room detail, Extra charges, Packages, Property, Location, Miscellaneous, Rate Amount, Alternate Rate Amount, Rate Comment, FAX, Phone, Special Information, Information, Room Hold Expiration Time. Not every property returns all of these types. Some properties do not return any title. Only English is supported for these values." Example: "Baggage Details" - `VehiclePrice.RateDescription.id` (string) Internally referenced id Example: "2" - `VehiclePrice.RateDescription.TextFormatted` (array, required) - `VehiclePrice.RateAvailability` (string) Options are available to sell, need to call, or closed Enum: same as `VehiclePrice.RateAvailability` in "PriceBreakdownVehiclePrice" (3 values) - `VehiclePrice.SupplierRate` (object, required) Estimated total amount - Monetary amounts expressed in another currency. - `VehiclePrice.SupplierRate.@type` (string, required) Example: "SupplierRate" - `VehiclePrice.SupplierRate.BaseRate` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.SupplierRate.BaseRate.value` (number) The amount of a given currency. Example: 124.56 - `VehiclePrice.SupplierRate.BaseRate.code` (string) An ISO 4217 alpha character code (3 characters) that specifies a money unit. Example: "USD" - `VehiclePrice.SupplierRate.BaseRate.minorUnit` (integer) Minor units are a mechanism for expressing the relationship between a major currency unit and its corresponding minor currency unit. It is the smallest unit of a given currency. For example; the smallest denomination in USD is the cent, which is 1/100 of a USD, and the minor unit value is 2. Not all currencies have a minor unit. Example: 2 - `VehiclePrice.SupplierRate.BaseRate.currencySource` (string) The system requesting or returning the currency code specified in the attribute Enum: same as `MinimumAdcolAmount.currencySource` in "ChangePermitted" (3 values) - `VehiclePrice.SupplierRate.BaseRate.approximateInd` (boolean) "If true, the currency amount has been converted from the original amount. For Air Exchange Eligibility, returned only if a currency is converted. If returned, the value is always true, indicating that the fee is approximate because of currency conversion. For Hotel Availability and Rules, true indicates this is a calculated value; false indicates this is the value returned by the property." Example: true - `VehiclePrice.SupplierRate.RateForPeriod` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.SupplierRate.DropOffCharge` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.SupplierRate.ExtraMileageCharge` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.SupplierRate.EstimatedTotalAmount` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.ApproximateRate` (object) Estimated total amount - Monetary amounts expressed in another currency. - `VehiclePrice.ApproximateRate.@type` (string, required) Example: "ApproximateRate" - `VehiclePrice.ApproximateRate.BaseRate` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.ApproximateRate.RateForPeriod` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.ApproximateRate.DropOffCharge` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.ApproximateRate.ExtraMileageCharge` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.ApproximateRate.EstimatedTotalAmount` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.CustomerLoyalty` (object) Specifies the ID for the membership program. Object for sending customer loyalty information, such as for a frequent flyer program. For Hotel send the loyalty card number in the value field, followed by programID with the hotel chain code, and supplierType: Hotel. For Air send the loyalty card number in the value field, followed by airline code in "supplier". For cross accrual use the "shareWithSupplier" field to submit to partner airlines. - `VehiclePrice.CustomerLoyalty.value` (string, required) Number on loyalty card. Example: "132456" - `VehiclePrice.CustomerLoyalty.id` (string) Optional Customer Loyalty Id. Not saved Example: "Loyalty_1" - `VehiclePrice.CustomerLoyalty.priority` (integer) Optional Numeric Priority Code Example: 2 - `VehiclePrice.CustomerLoyalty.programId` (string) "Specifies an identifier to indicate the company owner of the loyalty program. Typically two characters. For frequent guest number, the hotel supplier or brand code. For frequent flyer number, the air supplier code of the loyalty program." Example: "HY" - `VehiclePrice.CustomerLoyalty.programName` (string) Supplier's loyalty program name. Example: "Frontier-EarlyReturns" - `VehiclePrice.CustomerLoyalty.supplierType` (string) The type of supplier of a loyalty program. Uses 'hotel' for frequent guest number or 'air' for frequent flyer number. Example: "Hotel" - `VehiclePrice.CustomerLoyalty.supplier` (string) Supplier of a loyalty program (typically 2 characters representing the hotel, brand, or airline). Example: "UA" - `VehiclePrice.CustomerLoyalty.tier` (string) Customer Loyalty tier Example: "Silver" - `VehiclePrice.CustomerLoyalty.shareWithSupplier` (array) The list of suppliers that the CustomerLoyalty number is shared. Used for cross accrual. Example: ["LH"] - `VehiclePrice.CustomerLoyalty.cardHolderName` (string) Customer loyalty member name; up to 128 characters are supported. In Air Search, for discounted offers to be returned, the name must be sent as LAST FIRST; e.g.,if SMITH is the last name and JORDAN the first name, send as SMITH JORDAN Example: "John Smith" - `VehiclePrice.CustomerLoyalty.validatedInd` (boolean) Customer loyalty number has been validated by the supplier Example: true - `VehiclePrice.CustomerLoyalty.prefix` (string) The cardholder name prefix title like Mr, Mrs, Dr Example: "Dr" - `VehiclePrice.CustomerLoyalty.given` (string) The First Name of the Cardholder Example: "John" - `VehiclePrice.CustomerLoyalty.middle` (string) Middle Name of the Cardholder Example: "Wilkinson" - `VehiclePrice.CustomerLoyalty.surname` (string) Last Name of the Cardholder Example: "Smith" - `VehiclePrice.RateQualifier` (string) A closed enumeration of possible rate qualifiers for vehicle rental Enum: same as `VehiclePrice.RateQualifier` in "PriceBreakdownVehiclePrice" (5 values) - `rateGuaranteedInd` (boolean) - PriceBreakdownVehicleDeposit: - `totalPayableNowInd` (boolean) If True the Amount is the total amount payable now - `totalPayableLaterInd` (boolean) If True the Amount is the total amount payable later - PriceBreakdownVehicleCharges: - `VehicleCharges` (object) - `VehicleCharges.@type` (string, required) Example: "VehicleCharges" - `VehicleCharges.description` (string) Assigned Type: c-1100:String - `VehicleCharges.VehicleChargePurposeCode` (object) Any code used to specify an item, for example a type of traveler, service code, room amenity, etc. - `VehicleCharges.VehicleChargePurposeCode.value` (string) Example: "INS" - `VehicleCharges.VehicleChargePurposeCode.codeContext` (string) Code Context Example: "ACRISS" - `VehicleCharges.ratePeriod` (string) The time period for a rate such as daily, weekly, monthly Enum: same as `VehiclePrice.ratePeriod` in "PriceBreakdownVehiclePrice" (15 values) - `VehicleCharges.rateChargeInfo` (string) Assigned Type: c-1100:String - `VehicleCharges.RateCategory` (string) For Hotel Search, request a rate category by sending up to 8 OTA rate categories to search for. If the supplier has rates available for the requested category, the response contains those rates and indicates them as such. Some properties do not return these rates unless explicitly requested. For a Hotel Rules request, this value can be found, if returned, in the Availability response's ProductRateCodeInfo/RateCodeInfo/rateCategory. Enum: same as `VehicleCharges.RateCategory` in "PriceBreakdownVehicleCharges" (32 values) - `VehicleCharges.VehicleCoverageTypeCode` (object) The OTA code defined for the Vehicle Coverage Type - `VehicleCharges.VehicleCoverageTypeCode.value` (string) Example: "INS" - `VehicleCharges.VehicleCoverageTypeCode.codeContext` (string) Code Context Example: "ACRISS" - `VehicleCharges.Calculation` (array) - `VehicleCharges.Calculation.@type` (string, required) Example: "Calculation" - `VehicleCharges.Calculation.UnitAmount` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehicleCharges.Calculation.UnitName` (string) The time period for a rate such as daily, weekly, monthly Enum: same as `VehiclePrice.ratePeriod` in "PriceBreakdownVehiclePrice" (15 values) - `VehicleCharges.Calculation.Quantity` (integer) The quantity used in the calculation of the vehicle charge e.g 2 x $500 per week - `VehicleCharges.Calculation.MaxQuantity` (integer) The maximum quantity allowed for a charge e.g Baby seat charged at $10 per day for a maximum of 10 days - `VehicleCharges.Calculation.TotalAmount` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehicleCharges.Calculation.Percent` (number) Used when the charge is based on a percentage of a TotalAmount - `VehicleCharges.Calculation.Applicability` (object) Textual information. - `VehicleCharges.taxInclusiveInd` (boolean) - `VehicleCharges.guaranteedInd` (boolean) - `VehicleCharges.payNowInd` (boolean) If true the vehicle charge must be paid now and is included in the totalPrice calculation - `VehicleCharges.includedInEstimatedTotalInd` (boolean) - `VehicleCharges.includedInBaseRateInd` (boolean) If true the Vehicle Charge has been included in the base rate of the Vehicle price - `ResidualPrice.VendorCurrencyTotal` (object) No longer used. Previously used to expose the local vendor currency when it is different to the purchased currency - `AdditionalCollectionPrice` (object) The Additional Collection amount for this transaction. - `PriceBreakdown` (array) — one of (discriminator: @type): - PriceBreakdownAir: - `quantity` (integer) Quantity of passengers in that PTC. Example: 2 - `requestedPassengerType` (string) The PTC to which the PriceBreakdown applies. Example: "CHD" - `FiledAmount` (object) Returned only in the Price APIs. GDS only; not supported for NDC. The base amount of a ticket price or net price that is filed in local currency. Returned when the origin currency is not the same as the PCC currency to show the currency in which the base fare has been filed. When used for NetBaseAmount: Net ticket data (NTD) is returned in the AirPrice, AirReservation, Exchange Search, and Reservation Retrieve responses for any GDS fare that has a private fare component (fareType=AgencyPrivateFare). When NTD is returned, TermsAndConditionsFuill includes FareGuaranteePolicy to return the fare calculation indicator for the fare. When NTD is returned, PriceBreakdown may include NetBaseAmount. - `FiledAmount.value` (number) Filed amount value Example: 43.3422 - `FiledAmount.currencyCode` (string) Code for the currency in which the base fare was filed. Example: "USD" - `FiledAmount.codeAuthority` (string) Filed amount currency code authority Example: "Australian Dollar" - `FiledAmount.decimalPlace` (integer, required) Number of decimal places in the currency in ISO 4217 standard format. Example: 3 - `FiledAmount.decimalAuthority` (string) ISO 4217 standard decimal authority Example: "ISO 4217" - `Discount` (object) NDC only; not supported for GDS. Returned for a fare discounted from the published price, such as a promotional discount. Not returned for privately negotiated discounts such as private fares. - `Discount.value` (number) The amount value of the discount Example: 20.22 - `Discount.description` (string) The text description for the discount. Example: "Spring discount on group bookings" - `Discount.currencyCode` (string, required) Currency code discount is returned in. Example: "USD" - `Discount.codeAuthority` (string, required) Not used. Currency code Authority. Example: "ISO" - `Discount.decimalPlace` (integer, required) Number of decimal places in the currency the discount is returned in. Example: 2 - `Discount.decimalAuthority` (string) Not used. Decimal Authority. Example: "ISO" - `NetFareInfo` (object) Detailed information on the net fare used. - `NetFareInfo.@type` (string, required) Example: "NetFareInfo" - `NetFareInfo.passengerTypeCode` (string) PassengerTypeCode Example: "ADT" - `NetFareInfo.NetFareBreakdownConstruction` (array) - `NetFareInfo.NetFareBreakdownConstruction.value` (string) - `NetFareInfo.NetFareBreakdownConstruction.fareType` (string) Assigned Type: c-1100:StringTiny - `NetFareInfo.NetFareBreakdownConstruction.rateOfExchange` (number) The rate of exchange applied to the fare breakdown - `NetFareInfo.TicketBaseAudit` (object) Returned only in the Price APIs. GDS only; not supported for NDC. The base amount of a ticket price or net price that is filed in local currency. Returned when the origin currency is not the same as the PCC currency to show the currency in which the base fare has been filed. When used for NetBaseAmount: Net ticket data (NTD) is returned in the AirPrice, AirReservation, Exchange Search, and Reservation Retrieve responses for any GDS fare that has a private fare component (fareType=AgencyPrivateFare). When NTD is returned, TermsAndConditionsFuill includes FareGuaranteePolicy to return the fare calculation indicator for the fare. When NTD is returned, PriceBreakdown may include NetBaseAmount. - `NetFareInfo.TicketBasePassenger` (object) The monetary value - `NetFareInfo.TicketBasePassenger.value` (number) - `NetFareInfo.TicketBasePassenger.currencyCode` (string) Assigned Type: c-1100:CurrencyCode - `NetFareInfo.TicketBasePassenger.codeAuthority` (string, required) Assigned Type: c-1100:CodeContext - `NetFareInfo.TicketBasePassenger.decimalPlace` (integer, required) Assigned Type: c-1100:CurrencyMinorUnit - `NetFareInfo.TicketBasePassenger.decimalAuthority` (string) Assigned Type: c-1100:CodeContext - `NetFareInfo.TicketBasePassenger.bTInd` (boolean) If true, this is a bulk ticket fare - `NetFareInfo.TicketBasePassenger.iTInd` (boolean) If true, this is an inclusive tour fare - `TravelerIdentifierRef` (object) Identifier references as object both within a message payload or an object held in cache that may be used for subsequent workflows. Returned for NDC in the Price response if age was sent for this traveler in the previous workflow requests. - `TravelerIdentifierRef.name` (string) Traveler identifier - `TravelerIdentifierRef.passengerTypeCode` (string) Passenger Type code Example: "ADT" - `TravelerIdentifierRef.ages` (array) The ages of the travelers associated to a particular ptc. For NDC, this value will be returned in PriceBreakdownAir if sent as part of the PassengerCriteria in the Air Search request. Example: [15] - `TravelerIdentifierRef.passengerCriteriaRef` (string) Allows the user to associate passenger criteria information. Example: "passengerCriteria_1" - `TravelerIdentifierRef.value` (string) - `TravelerIdentifierRef.id` (string) A locally referenced ID - `TravelerIdentifierRef.description` (string) Descriptive text used to identify the contents of a target object - `TravelerIdentifierRef.uris` (array) Uniform Resource Identifier Example: ["google.com"] - `TravelerIdentifierRef.age` (integer) Replaced with ages array. The age of the traveler. Example: 11 - `NetBaseAmount` (object) Returned only in the Price APIs. GDS only; not supported for NDC. The base amount of a ticket price or net price that is filed in local currency. Returned when the origin currency is not the same as the PCC currency to show the currency in which the base fare has been filed. When used for NetBaseAmount: Net ticket data (NTD) is returned in the AirPrice, AirReservation, Exchange Search, and Reservation Retrieve responses for any GDS fare that has a private fare component (fareType=AgencyPrivateFare). When NTD is returned, TermsAndConditionsFuill includes FareGuaranteePolicy to return the fare calculation indicator for the fare. When NTD is returned, PriceBreakdown may include NetBaseAmount. - `FareCalculation` (string) GDS only; not supported for NDC. For each PTC, when available, FareCalculation returns the fare calculation ladder for all public and private fare types filed by an agency or an airline. Example: "LON BA SYD R564.00YEE1Y BA LON R564.00YEE1Y NUC1128.00END ROE0.787855" - `Surcharges` (object) In AirSearch workflow this applies to GDS only. Not supported for NDC, which does not return surcharges. Returned if surcharges apply to this offer. For GDS only, for a multi-city offer with stopovers (see multi-city offers with stopovers for details), surcharges and commission amounts are for the entire journey. For all other offers, the surcharges and commission amounts are for each leg (origin and destination pair). A multi-city offer can be identified by the jc in its CombinabilityCode: jc1, jc2. Surcharges can be omitted from the Search response with excludeSurchargesInd. - `Surcharge` (array, required) - `Surcharge.value` (number) Surcharge amount Example: 12 - `Surcharge.currencyCode` (string) ISO 4217 currency code for the surcharge. Example: "USD" - `Surcharge.surchargeCode` (string) Surcharge code Example: "ADDITIONAL COSTS" - `Surcharge.reportingAuthority` (string) Not used. Surcharge reporting authority Example: "Federal register" - `Surcharge.purpose` (string) Surcharge purpose. For Air workflows possible values include Weekend Surcharge, Stopover Charge, Multiple Stopover Charges, Other (default value that covers all other surcharges such as fuel surcharges). Example: "Weekend Surcharge" - `Surcharge.description` (string) Description of the surcharge. Example: "Rollaway Surcharge" - `Surcharge.surchargeApplication` (string) Application values (such as the application of a fee) like per person or per room. Enum: same as `Surcharge.surchargeApplication` (7 values) - `Surcharge.surchargeFrequency` (string) The frequency of a fee such as per night or per stay. Enum: same as `Surcharge.surchargeFrequency` (6 values) - `Surcharge.codeAuthority` (string) Not used. Currency code authority. Example: "ISO 4217" - `Surcharge.decimalPlace` (integer) Decimal place for the currency unit. Example: 4 - `Surcharge.decimalAuthority` (string) Not used. Currency code decimal authority. Example: "ISO 4217" - `Surcharges.@type` (string, required) Discriminator class is SurchargesDetail Example: "SurchargesDetail" - `Surcharges.TotalSurcharges` (number) A monetary amount, up to 4 decimal places. Example: 211.11 - `Surcharges.approximateInd` (boolean) If true, the surcharge amounts are approximate. - `TravelerRefs` (array) Returned only in Reservation Retrieve to identify the traveler associated with this instance of PriceBreakdown in case of multiple offers on the booking. Example: ["[\"traveler_1\",\"traveler2\"]"] - `PaidTaxes` (object) Summary Taxes object - `Tax` (array) - `Tax.value` (number) Amount of the tax. Returned as 0 if a tax was marked as exempt with TaxExemption. Example: 12.2 - `Tax.currencyCode` (string) A ISO 4217 currency code associated to the value. Example: "USD" - `Tax.taxCode` (string) "Code for the tax. For Hotels this is the OTA code." Example: "XF2" - `Tax.reportingAuthority` (string) Identifies the reporting authority such as airport code for XF taxes Example: "JFK1" - `Tax.purpose` (string) Supplier returned description of tax. Example: "Fuel surcharge" - `Tax.description` (string) "Short summary of the tax. In Air workflows this is returned only for NDC. Note that descriptions are not returned for tax codes YQ and YR, which are fees charged by airlines and not government-imposed taxes. For Hotels this is the OTA tax description." Example: "Lodging tax" - `Tax.includedInBase` (string) Yes , No , Unknown Enum: same as `instantPurchase` in "AdvanceReservationRequired" (3 values) - `Tax.codeAuthority` (string) Not used. Currency Code Authority Example: "ISO" - `Tax.decimalPlace` (integer) Permitted number of decimals. Associated to the currency value. Example: 2 - `Tax.decimalAuthority` (string) Not used. Currency decimal authority Example: "ISO" - `Tax.exemptInd` (boolean) GDS only; not supported for NDC. Returned if a tax was marked exempt in a prior request with the TaxExemption pricing modifer. If true, this tax is exempt" Example: true - `Tax.nonRefundableInd` (boolean) If true, the tax is non refundable. This indicator is only supported for exchange search and exchange price quote transactions. Example: true - `Tax.excludedFromTotalPriceInd` (boolean) Returned in Hotel APIs when a tax is not included in the TotalPrice. Default behavior is for taxes to be included in TotalPrice. Example: true - `TaxPercent` (object) Returned when the tax is expressed as a percentage of the amount. - `TaxPercent.value` (number) The tax percentage amount. Example: 5.5 - `TaxPercent.taxCode` (string) Any code for the tax. Example: "971 - IRS Notice" - `TaxPercent.reportingAuthority` (string) Tax reporting authority Example: "Georgia Department of Revenue" - `TaxPercent.purpose` (string) Purpose of tax Example: "statutory tax" - `TaxPercent.description` (string) Description Example: "1.5% of SGST" - `TaxPercent.includedInBase` (string) Yes , No , Unknown Enum: same as `instantPurchase` in "AdvanceReservationRequired" (3 values) - `PaidTaxes.@type` (string, required) Discriminator classes PaidTaxes or PaidTaxesDetail Example: "PaidTaxesDetail" - `PaidTaxes.TotalTaxes` (number) A monetary amount, up to 4 decimal places. Decimal place needs to be included. Example: 220.12 - `RequestedPricingModifiers` (array) - `RequestedPricingModifiers.@type` (string, required) Discriminator. Example: "RequestedPricingModifiers" - `RequestedPricingModifiers.PassengerCriteria` (object) Defines the passenger criteria. Send one PassengerCriteria for each passenger type code (PTC). Search supports up to 9 total passengers. A maximum of 6 PTCs are supported for GDS. NDC does not have a PTC limitation. AirPrice supports up to nine total passengers across all PTCs. - `TravelerIdentifierRef` (object, required) Identifier references as object both within a message payload or an object held in cache that may be used for subsequent workflows. Returned for NDC in the Price response if age was sent for this traveler in the previous workflow requests. - `RequestedPricingModifiers.PassengerCriteria.@type` (string, required) Discriminator. No child classes. Example: "PassengerCriteria" - `RequestedPricingModifiers.PassengerCriteria.number` (integer, required) The amount of passengers associated with this passenger type code. Default is 1. Example: 1 - `RequestedPricingModifiers.PassengerCriteria.age` (integer) The age of the passenger. Notes on PTC and age: - Travelport recommends sending age only with PTCs that require age for pricing. - If the age is sent in the request, for NDC only, the age is returned in the pricing response. - For child passengers, Travelport recommends sending the age of the child in the age attribute plus the PTC CNN. Travelport recommends against sending CNN without age, or the CHD PTC. Not all fares cannot be quoted for CHD. - The age for CNN is generally between 2 and 11 inclusive, with ADT fares returned for ages 12 and up; however, this can vary by airline and country. - The age for INF must be either 0 or 1. - During booking, date of birth is required for all child and infant PTCs (Add Traveler payload in Traveler/birthDate). Example: 26 - `RequestedPricingModifiers.PassengerCriteria.passengerTypeCode` (string) The passenger type code (PTC) for the passengers on the itinerary. Required field for Air Search and Flight specific search. Common PTCs are: - ADT: adult - CHD: child of unknown age - For child passengers, Travelport recommends sending the age of the child in the age attribute plus the PTC CNN. Travelport recommends against sending CNN without age, or the CHD PTC. Many fares cannot be quoted for CHD. - CNN: child when age is known - The age for CNN is generally between 2 and 11 inclusive, with ADT fares returned for ages 12 and up; however, this can vary by airline and country. - INF: infant without a seat - INS: infant with a seat - UNN: unaccompanied child. See API guides to download a full list of PTCs. NDC carriers BA, SQ, AV, AA, and AF/KLM offer teen/young adult tax exemptions from the UK Air Passenger Duty (GB tax). Send PTC with the value YTH and send the passengers age per below. The PTC may be returned as ADT, or Cxx in which xx is the age, but the tax exemption is applied in the pricing on these NDC carriers. For marine fares, send the PTC value SEA. You must also send OSI remarks at Add Traveler with the vessel name and location. Marine fares are private fares for travelers going to or from a vessel. NDC only; not supported for GDS. When running a multiple passenger search for NDC on Qantas, Qantas supports only these PTCs: ADT, CHD, CNN, INF. Sending any other PTC may result in an error at ticketing. Any traveler sent without a PTC value is defaulted to ADT. PTC can be sent or omitted for ADT passenger. AirReservation defaults the PTC to ADT and returns it in the Reservation Retrieve. Example: "ADT" - `RequestedPricingModifiers.PassengerCriteria.birthDate` (string) The date of birth of the passenger. May be used in age validation for fares with age restrictions. Example: "2020-01-16" - `RequestedPricingModifiers.PassengerCriteria.id` (string) Unique id to support referencing of this specific passenger criteria. Example: "passengercriteria_001" - `RequestedPricingModifiers.PassengerCriteria.CustomerLoyalty` (array) NDC only; not supported for GDS. Optional object for sending customer loyalty information, such as for a frequent flyer program. If CustomerLoyalty is sent in the Search request, it must also be sent in the Air Price request and the Add Traveler request. As some carriers validate frequent traveler data through the workflow, failing to send the same CustomerLoyalty details, even if invalid, may cause a booking failure. If an invalid number is sent, the response returns a warning message that the FQTV is invalid, and the invalid number is cached to prevent a potential booking failure. - `RequestedPricingModifiers.PassengerCriteria.TravelerGeographicLocation` (object) For AirSearch: supported/validated only for NDC to support local citizen fares. For AirPrice and AirReservation: GDS only; not supported for NDC. Optional object for requesting local citizen/local resident fares for Spain and associated islands. You must also send a PTC relevant to the local resident fares; e.g., ADR for adult resident, CHR for child resident. Any discount applied through TravelerGeographicLocation applies to all travelers, not only to the traveler in this instance of PassengerCriteria. If the discount must apply only to an individual traveler, that traveler requires a separate search and book workflow. - `RequestedPricingModifiers.PassengerCriteria.specifiedPassengerTypeCodeOnlyInd` (boolean) GDS only; not supported for NDC. - If true: returns only offers for the specified PTC. If no fares are available for the specified PTC, returns an error message that there is no valid fare. - If false (default behavior): If no fares are available for the specified PTC, returns fares for the default ADT (adult) PTC instead. Example: true - `RequestedPricingModifiers.PricingModifiersAir` (object) A selection of Pricing Modifiers that can be used to influence the Price of an Offer. - For the AirPrice reference payload request, if any price modifiers were included in the preceding Search request and no price modifiers are sent in the AirPrice request, the cached price modifiers sent at Search are sent with the AirPrice request. If any price modifiers are sent in the AirPrice reference payload request, all cached Search modifiers are discarded and only the modifiers sent in that AirPrice request are used. - For the Add Offer request, you may optionally store fares with one or more pricing modifiers. If a pricing modifier is not added, the auto stored fare is added to the reservation. There is no change in the AirReservation response when pricing modifiers are requested. AirReservation applies modifiers from Add Offer and earlier steps as follows: - Modifiers sent in the Add Offer request (supported for both full and reference payload). - If no modifiers are sent in Add Offer, any pricing modifiers sent in AirPrice are applied. - If no modifiers were sent in AirPrice, or if AirPrice was not sent, any pricing modifiers sent in Search are applied. GDS only; pricing modifiers not supported for NDC. If the requested modifier does not have any fares associated with it, the workbench commit fails and returns the error message 'No Fare Found'. Pricing happens at commit, not at Add Offer. - `Brand` (object) Information on airline Brand offerings. If brand attributes were not excluded with inhibitBrandContentInd=true (GDS only), then brand attributes are returned and consolidated in ReferenceList/ReferenceListBrand. In this case Brand does not return the name or Identifier objects but instead returns only BrandRef, which matches to the brand identifier (e.g., b1) in ReferenceListBrand. - `RequestedPricingModifiers.PricingModifiersAir.@type` (string, required) Discriminator. Child classes PricingModifiersAir and PricingModifersAirDetail Example: "PricingModifiersAir" - `RequestedPricingModifiers.PricingModifiersAir.currencyCode` (string) In an API request, send the currency type to return if you want to override the default currency specified with your PCC. Example: "GBP" - `RequestedPricingModifiers.PricingModifiersAir.FareSelection` (object) Requests the return of fare types including private fares (negotiated), public fares (published), or net fares (consolidator fares, or any negotiated wholesale price that is further marked up for sale to customers). May be used to request fares with specific restrictions, change, or refund options. - `RequestedPricingModifiers.PricingModifiersAir.OrganizationInformation` (object) Use to send account codes for negotiated fares or to send optional India GST SSR Remarks in GSTRegistrationNumber. For NDC supports corporate loyalty program and GST Information. This information is returned in TermsAndConditions." - `RequestedPricingModifiers.PricingModifiersAir.TaxExemption` (object) GDS only, not supported for NDC. Use to mark some or all taxes as exempt. Specify all taxes, only specific tax codes, or all taxes in specific countries. Must include either allTaxesExemptInd OR both countries and taxCodes. TaxExemption supports up to nine values for countries, taxCodes, or both combined. The response returns any exempt taxes with exemptInd=true and value=0. - `RequestedPricingModifiers.PricingModifiersAir.PromotionalCode` (array) - `RequestedPricingModifiers.PricingModifiersAir.SellCity` (string) GDS only, not supported for NDC. The IATA location code for a city. Overrides the sell city of the requester to specify an alternate sale location and return fares based on that location. The response returns pricing in the local currency for the specified sell city instead of the PCC's default currency. Example: "NYC" - `RequestedPricingModifiers.PricingModifiersAir.TicketCity` (string) GDS only, not supported for NDC. The IATA location code for a city. Overrides the ticketing city of the requester to specify an alternate ticket location and return fares based on that location; the response returns pricing in the local currency for the specified ticket city instead of the PCC's default currency. Example: "NYC" - `RequestedPricingModifiers.PricingModifiersAir.PricingPCC` (string) GDS only, not supported for NDC. Use to send a faring PCC for which a selective access or code group agreement exists between that PCC and the PCC associated with your account. The following combinations of PricingPCC and FareSelection/fareType=PrivateFaresOnly return results as follows: - PricingPCC sent and PrivateFaresOnly not requested: If a selective access or group agreement exists, both public and any available private fares are returned for the requesting and providing PCC. - If no selective access or group agreement exists, only public fares are returned. - PricingPCC sent and PrivateFaresOnly is requested: If a selective access or group agreement exists that allows private fare access, only available private fares are returned for the requesting and providing PCC. - If no agreement exists, or if an agreement exists but does not allow private fares access, an error is returned. Example: "0Bx3" - `RequestedPricingModifiers.PricingModifiersAir.FareBasisCodeOverride` (array) - `RequestedPricingModifiers.PricingModifiersAir.MultiPricingAgency` (array) The customer can send up to 3 Pseudo City Codes (PCCs) in PricingModifiersAir, MultiPricingAgency. If a customer sends more than 3 PCCs in MultiPricingAgency, only the first 3 are validated. If a customer sends both PricingPCC and MultiPricingAgency with PCCs, the PCC in PricingPCC is ignored. Example: ["[\"0XS4\",\"0YBZ\",\"J80K\"]"] - `RequestedPricingModifiers.PricingModifiersAir.TicketingPCC` (string) GDS only, not supported for NDC. In an API request, overrides the ticketing PCC associated with your account to specify an alternate PCC and return fares based on that PCC. Example: "0XS4" - `RequestedPricingModifiers.PricingModifiersAir.CalculatedFareAdjustment` (object) Used in Exchange Search to modify the Price of the Fare. Discriminator classes CalculatedFareAdjustmentDiscount or CalculatedFareAdjustmentIncrease - `RequestedPricingModifiers.PricingModifiersAir.ManualFareAdjustment` (array) Send to manually adjust the base fare amount on all fares for a specific PTC. - `RequestedPricingModifiers.PricingModifiersAir.BrandPreference` (array) - `RequestedPricingModifiers.PricingModifiersAir.includeSplitPaymentInd` (boolean) Requests request split ticketing, which returns outbound and inbound one-way fares in addition to round trip options in the Search API response. This may result in lower fares than the same or similar round-trip itinerary. If true, requests split ticketing. If false or omitted split ticketing options are not returned. Default is false. GDS only, not supported for NDC. When split ticketing is requested, the Search response returns offers in the following order: Outbound one-way offers, Inbound one-way offers, Round trip offers. The response identifies all one-way outbound and inbound offers with CombinabilityCode j0. CombinabilityCode values for round trip offers start at j1 and increment by one for each offer. Only the following are in scope for split ticketing: Search (not supported for Next Leg Search or Flight Specific Search), Round-trip journey-based offerings ( isJourney header not sent or sent as true, or CustomResponseModifiersAir/SearchRepresentation not sent or sent with value Journey ) Upsells. Split ticketing is not supported for round-trip leg-based searches, virtual interlining, or NDC. Split ticketing is available only for customers specifically provisioned for split ticketing. Split ticketing returns one-way outbound and one-way inbound fares in addition to round-trip offers. Split ticket offers are identified with CombinabilityCode j0. If your account is not configured for split ticketing, sending includeSplitPaymentInd returns a response without split ticket offers and a warning message. GDS only, not supported for NDC. In Air Price, For split ticketing, the request must send offers that are identified in the Search response with CombinabilityCode j0, which identifies those offers as one-way outbound and one-way inbound split ticketing offers. A combination of j0 and any non-j0 value offer returns an error message that split pricing is not supported - `RequestedPricingModifiers.PricingModifiersAir.returnMostRestrictiveBrandInd` (boolean) In Search API, when there are different brands on a connecting flight, return information for either the most restrictive brand or the brand on the most significant segment on the itinerary. If true, return the offer brand of the most restrictive brand. If false or omitted, return the offer brand of the most significant segment of the itinerary. GDS only, not supported for NDC. - `RequestedPricingModifiers.PricingModifiersAir.splitPaymentOfferings` (number) Number between 0 and 99. Send with includeSplitPaymentInd to configure the percentage of round trip offers to return in a split ticketing response. By default, Search divides the split ticketing response into 34% round-trip offerings and the remainder as split ticketing offers, which are combined outbound and inbound one-way fares. To change this percentage, send SplitPaymentOfferings with the percentage value of round trip offers to return. Example: 25 - `RequestedPricingModifiers.CabinPreference` (object) Requests a fare based on the cabin class. Only one cabin preferenceType (Permitted, Preferred, PreferredWithUpgrade) is allowed per request, but there is no limit to the number of cabins that can be sent. Any CabinPreference in the initial Search request is applied to any subsequent Next Leg Search and reference Flight Specific Search requests. In AirPrice and AirReservation only one cabin preference type is allowed per request, but there is no limit to the number of cabins that can be sent. If CabinPreference was sent in the Search request, it is cached and sent with the AirPrice reference payload request. If you send CabinPreference in the AirPrice request, all cached modifiers are discarded and only the modifiers sent in the AirPrice request are used. Can be combined with lowFareFinderInd=true to return lowest fare in the requested cabin or cabins. When using CabinPreference and lowFareFinderInd, if both CabinPreference and a class of service are sent, class of service is ignored. If CabinPreference is sent without a class of service, the response returns the lowest fare in the cabin requested. If that cabin is not available, the response may upgrade or downgrade to a different cabin. If a different cabin than requested is returned, the response returns the message that the cabin class may differ from the class requested. If lowFareFinderInd=false and CabinPreference are sent in the request, AirPrice ignores the preferred cabin and returns a message that the preferred cabin was ignored. If CabinPreference is set to All, no cabin preference is applied." - `RequestedPricingModifiers.CabinPreference.@type` (string, required) Discriminator. No child classes exist Example: "CabinPreference" - `RequestedPricingModifiers.CabinPreference.preferenceType` (string) Type of cabin preference. Sending a mix of preferenceType values is not supported. For example, you cannot send an instance of CabinPreference with a preferenceType of Permitted and another instance with preferenceType of Prohibited. In this case the results default to the Preferred preference. Note that if lowFareFinderInd is sent with true and CabinPreference is sent, the only supported value for CabinPreference/type is Permitted. Enum: same as `RequestedPricingModifiers.CabinPreference.preferenceType` in "PriceBreakdownAir" (4 values) - `RequestedPricingModifiers.CabinPreference.cabins` (array) A space-delimited list of cabins. Enum: same as `PassengerFlight.FlightProduct.cabin` in "ProductAir" (5 values) - `RequestedPricingModifiers.CabinPreference.legSequence` (array) Limits preference to the specified leg referenced in SearchCriteriaFlight. You can apply the preference to only some legs of the itinerary, or different preferences to different legs. To apply preference to the entire itinerary, do not send legSequence. GDS only, not supported for NDC. Not supported at Price or Book. Example: [1,2] - `RequestedPricingModifiers.FlightType` (object) The type of flight connection - `RequestedPricingModifiers.FlightType.@type` (string, required) Discriminator. No child classes. Example: "FlightType" - `RequestedPricingModifiers.FlightType.connectionType` (string) Limits the connection type returned. Each value returns the specified type and all higher types. For example, StopDirect could return both flights that stop without a change of planes (StopDirect) and non-stop direct flights (NonStopDirect). SingleConnection or DoubleConnection will not exclude StopDirect flights from the journey. For example, SingleConnection could return an itinerary with two flight numbers, and either of these flights could have intermediate stops. Enum: same as `RequestedPricingModifiers.FlightType.connectionType` in "PriceBreakdownAir" (5 values) - `RequestedPricingModifiers.FlightType.excludeInterlineConnectionsInd` (boolean) Excludes interline connectionsClosed from results. If true, does not return offers with interline connections. If false or omitted, may return interline connections in results. Default is false. GDS only, not supported for NDC. When a product contains multiple interline air segments, brand details return only the brand of the significant carrier, not the validating/plating carrier brand information. The IATA rules for determining the significant carrier on an itinerary are based on the areas in which the transportation takes place. Example: true - `RequestedPricingModifiers.CustomResponseModifiersAir` (object) Contains additional modifiers to customize the result set. Includes optional indicators for returning or excluding specified response content. Values sent at Search can carry forward into the Next Leg Search request and are not re-sent. - `RequestedPricingModifiers.CustomResponseModifiersAir.@type` (string, required) discriminator Example: "CustomResponseModifiersAir" - `RequestedPricingModifiers.CustomResponseModifiersAir.BrandAttributeInclusion` (array) Supported in AirSearch and AirPrice. Returns only information about the brand attributes specified and does not return any other brand attributes. - `RequestedPricingModifiers.CustomResponseModifiersAir.SearchRepresentation` (string) Specifies either a journey or leg-based response. Journey returns offers for all legs of the itinerary. Journey is the default. Leg returns offers for only the first leg of the itinerary. Must be followed with a Next Leg Search to select an offer for the first leg and return offers on the subsequent leg to combine with it.Customize search result set as leg or journey based. Next Leg Search requests, and Flight Specific Search requests for less than the full itinerary, are supported only after a leg-based Search, not a journey-based Search. If these requests follow a journey-based Search request, an error message is returned. Enum: same as `RequestedPricingModifiers.CustomResponseModifiersAir.SearchRepresentation` in "PriceBreakdownAir" (3 values) - `RequestedPricingModifiers.CustomResponseModifiersAir.excludePenaltiesInd` (boolean) GDS only; not supported for NDC. Indicator to omit change and cancel penalties. - If true: omits all penalty information from the response. - If false (default behavior): returns any change and penalty details provided by carrier for each offer in TermsAndConditionsFullAir/Penalties. If sent in Search but not in AirPrice, the value sent in Search is cached and applied to the AirPrice results. However, you can override the value sent in Search by sending excludePenaltiesInd in the AirPrice request with the opposite value. For example, if the Search request sends excludePenaltiesInd=true and the AirPrice request sends excludePenaltiesInd=false, the Search response does not return penalties and the AirPrice response does return penalties. Example: true - `RequestedPricingModifiers.CustomResponseModifiersAir.excludeBaggageFeesInd` (boolean) GDS only; not supported for NDC. Indicator to exclude baggage details. - If true: excludes baggage fees, carry on fees, and embargo information from the response. Baggage quantity or weight is returned instead. - If false (default behavior): baggage details returned in response. Default is false. Example: true - `RequestedPricingModifiers.CustomResponseModifiersAir.includeFareCalculationInd` (boolean) GDS only; not supported for NDC or in the Flight Specific Search full payload request. Indicator to request the return of the fare calculation ladder. - If true: returns the fare calculation ladder in BestCombinablePrice.PriceBreakdownAir.FareCalculation. - If false (default behavior): fare calculation ladder is not returned. Example: true - `RequestedPricingModifiers.CustomResponseModifiersAir.excludeSurchargesInd` (boolean) GDS only; not supported for NDC. Indicator to exclude a surcharge breakdown. - If true: excludes a surcharge breakdown from the response. Baggage quantity or kilos is returned instead. - If false (default behavior): surcharge breakdown returned in response. Example: true - `RequestedPricingModifiers.CustomResponseModifiersAir.excludeUnbundledFaresInd` (boolean) GDS only, not supported for NDC. Sets whether to return unbundled fares. Supported in AirSearch and AirPrice. - If true: does not return unbundled fares. - If false (default behavior): returns unbundled and bundled fares as available. Example: true - `RequestedPricingModifiers.CustomResponseModifiersAir.includeCO2EmissionsDataInd` (boolean) Indicator to return CO2 emission data in the Search and Next Leg Search responses. - If true: returns CO2 emission data. - If false (default behavior): CO2 emission data not returned. Example: true - `RequestedPricingModifiers.CustomResponseModifiersAir.includeFlightAmenitiesInd` (boolean) Indicator to return flight amenities from ATPCO RouteHappy data. - If true: includes amenities in the response if available. - If false: Does not return ATPCO RouteHappy amenities. Example: true - `RequestedPricingModifiers.CustomResponseModifiersAir.includeUniversalProductAttributesInd` (boolean) Indicator to return universal product attributes (UPAs), which include images, icons, and URLs as provided by ATPCO. Must also send includeFlightAmenitiesInd=true. - If true: returns universal product attributes if available. - If false (default behavior): Universal product attributes not returned. UPAs are not returned for direct flights with intermediate stops, non-flight segments such as trains, or for Premium Business class. Example: true - `RequestedPricingModifiers.CustomResponseModifiersAir.includeBundledAncillariesInd` (boolean) NDC only. If true: the search and price response will include bundled air and ancillary offerings/offers. Search and Price response will contain both ProductAir and ProductAncillary plus a new child class of PriceBreakdown: PriceBreakdownAncillaryAir to define the ancillary inclusion and pricing. Example: true - `RequestedPricingModifiers.CustomResponseModifiersAir.includeFullPenaltyDisclosureInd` (boolean) If true, penalty information sourced from ATPCO Cat 31 and 33 will be disclosed. Penalties may be exposed at fare component level and include time windows. - `RequestedPricingModifiers.PricingModifiersAirChange` (object) Pricing Modifiers that can be used to influence the Price of an Exchanged Offer - `RequestedPricingModifiers.PricingModifiersAirChange.@type` (string) Example: "PricingModifiersAirChange" - `RequestedPricingModifiers.PricingModifiersAirChange.currencyCode` (string) ISO 4217 currency code Example: "USD" - `RequestedPricingModifiers.PricingModifiersAirChange.FareSelection` (object) Requests the return of fare types including private fares (negotiated), public fares (published), or net fares (consolidator fares, or any negotiated wholesale price that is further marked up for sale to customers). May be used to request fares with specific restrictions, change, or refund options. - `RequestedPricingModifiers.PricingModifiersAirChange.OrganizationInformation` (object) Use to send account codes for negotiated fares or to send optional India GST SSR Remarks in GSTRegistrationNumber. For NDC supports corporate loyalty program and GST Information. This information is returned in TermsAndConditions." - `RequestedPricingModifiers.PricingModifiersAirChange.WaiverCode` (object) A code assigned by an airline to support waiver of fees or ticket value as a result of disruption to the passenger. - `RequestedPricingModifiers.PricingModifiersAirChange.TaxExemption` (object) GDS only, not supported for NDC. Use to mark some or all taxes as exempt. Specify all taxes, only specific tax codes, or all taxes in specific countries. Must include either allTaxesExemptInd OR both countries and taxCodes. TaxExemption supports up to nine values for countries, taxCodes, or both combined. The response returns any exempt taxes with exemptInd=true and value=0. - `RequestedPricingModifiers.PricingModifiersAirChange.PromotionalCode` (object) NDC only. Not supported for GDS. Any NDC airline designated promotional code. - `RequestedPricingModifiers.PricingModifiersAirChange.SellCity` (string) Overrides the sell city of the requestor Example: "MEX" - `RequestedPricingModifiers.PricingModifiersAirChange.TicketCity` (string) Overrides the ticket city of the requestor Example: "MEX" - `RequestedPricingModifiers.PricingModifiersAirChange.PricingPCC` (string) Overrides the pricing PCC of the requestor Example: "0XS4" - `RequestedPricingModifiers.PricingModifiersAirChange.TicketingPCC` (string) Overrides the ticketing PCC of the requestor Example: "0XCD" - `RequestedPricingModifiers.PricingModifiersAirChange.CalculatedFareAdjustment` (object) Used in Exchange Search to modify the Price of the Fare. Discriminator classes CalculatedFareAdjustmentDiscount or CalculatedFareAdjustmentIncrease - `RequestedPricingModifiers.PricingModifiersAirChange.BrandPreference` (array) - `RequestedPricingModifiers.PricingModifiersAirChange.keepToBrandInd` (boolean) If true, the offerings returned will be of the same brand as the original Offer Example: true - `RequestedPricingModifiers.PricingModifiersAirChange.returnMostRestrictiveBrandInd` (boolean) if true, the most restrictive brand will be returned in the response when there are different brands present in the Offering Example: true - `RequestedPricingModifiers.PricingModifiersAirChange.doNotNetInd` (boolean) If true, this exchange will not net any residual/refundable amounts against due amounts. - `RequestedPricingModifiers.lowFareFinderInd` (boolean) Provides pricing flexibility around class of service. If not sent, the response returns fares only in the requested class of service. If true, returns the lowest fares available in any class of service available, which may not be the same as the requested class. Note that if lowFareFinderInd is sent with true and CabinPreference is sent, the only supported value for CabinPreference/type is Permitted. When lowFareFindInd=true and brand attributes are not disabled (inhibitBrandContentInd), AirPrice uses only the brand tier (and any other pricing modifiers) to find the lowest fare within a brand tier regardless of class of service. GDS only; not supported for NDC. Example: true - `RequestedPricingModifiers.keepToBrandInd` (boolean) If true, the original brand will be maintained during the exchange process. Example: true - `RequestedPricingModifiers.lowFareFindAndRebookInd` (boolean) If true, the original flights in the reservation will be rebooked or replaced with the new exchanged flights. - `PassengerCriteriaRefs` (array) NDC only; not supported for GDS. Returned for NDC if a traveler identifier was sent for this traveler in the previous workflow requests. Example: ["passengerCriteria_1"] - `FlightPassCredits` (integer) The number of flight pass credits consumed for this pricebreakdown. Example: 1 - PriceBreakdownAncillary: - `inclusiveOfTaxInd` (boolean) If true, this ancillary is sold inclusive of tax. Example: true - `quantity` (integer) The quantity of ancillary items included in this PriceBreakdown. Example: 1 - `Description` (object) A description of the ancillary with description codes. - `Description.value` (string) The text description of the ancillary. Example: "Vegetarian Meal" - `Description.code` (string) The ATPCO group code. Example: "BG" - `Description.subCode` (string) The ATPCO RFISC subcode. Example: "0D4" - `Description.subGroup` (string) The ATPCO sub group code. Example: "SP" - `Description.codeContext` (string) The code context value. Example: "ATPCO" - `Description.ssrCode` (string) The four character AIRIMP SSR code for this ancillary. Example: "VGML" - `Description.issuanceReasonCode` (string) The airline provided reason for issuance code. Example: "C" - `Description.geographicSpecification` (string) How the ancillary is applied across the itinerary. Enum: same as `Ancillary.Description.geographicSpecification` in "ProductAncillary" (3 values) - `ProductRef` (string) The product ref this PriceBreakdown applies to. If no productRef exists then the PriceBreakdown applies to all Products within the Offer. Example: "p_1" - `Discount` (object) NDC only; not supported for GDS. Returned for a fare discounted from the published price, such as a promotional discount. Not returned for privately negotiated discounts such as private fares. - `Discount.value` (number) The amount value of the discount Example: 20.22 - `Discount.description` (string) The text description for the discount. Example: "Spring discount on group bookings" - `Discount.currencyCode` (string, required) Currency code discount is returned in. Example: "USD" - `Discount.codeAuthority` (string, required) Not used. Currency code Authority. Example: "ISO" - `Discount.decimalPlace` (integer, required) Number of decimal places in the currency the discount is returned in. Example: 2 - `Discount.decimalAuthority` (string) Not used. Decimal Authority. Example: "ISO" - `TravelerIdentifierRef` (object) Identifier references as object both within a message payload or an object held in cache that may be used for subsequent workflows. Returned for NDC in the Price response if age was sent for this traveler in the previous workflow requests. - `TravelerIdentifierRef.name` (string) Traveler identifier - `TravelerIdentifierRef.passengerTypeCode` (string) Passenger Type code Example: "ADT" - `TravelerIdentifierRef.ages` (array) The ages of the travelers associated to a particular ptc. For NDC, this value will be returned in PriceBreakdownAir if sent as part of the PassengerCriteria in the Air Search request. Example: [15] - `TravelerIdentifierRef.passengerCriteriaRef` (string) Allows the user to associate passenger criteria information. Example: "passengerCriteria_1" - `TravelerIdentifierRef.value` (string) - `TravelerIdentifierRef.id` (string) A locally referenced ID - `TravelerIdentifierRef.description` (string) Descriptive text used to identify the contents of a target object - `TravelerIdentifierRef.uris` (array) Uniform Resource Identifier Example: ["google.com"] - `TravelerIdentifierRef.age` (integer) Replaced with ages array. The age of the traveler. Example: 11 - `AncillaryPriceApplicationCode` (object) Determines how an ancillary price has been built. - `AncillaryPriceApplicationCode.value` (string) Example: "3" - `AncillaryPriceApplicationCode.application` (string) Associated text. Example: "PerItem" - PriceBreakdownHospitality: - `roomPricingType` (string) A string provided by the hotel to describe how a service is priced, such as per night or per stay. Enum: same as `roomPricingType` in "PriceBreakdownHospitality" (5 values) - `Description` (string) Example: "Advance Purchase-Ro-Free WiFi" - `NightlyRate` (array) - `NightlyRate.@type` (string) - `NightlyRate.startDate` (string, required) Start date for the nightly rate in YYYY-MM-DD format. - `NightlyRate.nights` (integer) Number of nights the nightly rate is valid. - `NightlyRate.Amount` (object, required) Amount represents the cost applied - `AverageNightlyRate` (array) The average nightly rate for a given offer. - `AverageNightlyRate.value` (number) The amount of a given currency. Example: 124.56 - `AverageNightlyRate.code` (string) An ISO 4217 alpha character code (3 characters) that specifies a money unit. Example: "USD" - `AverageNightlyRate.minorUnit` (integer) Minor units are a mechanism for expressing the relationship between a major currency unit and its corresponding minor currency unit. It is the smallest unit of a given currency. For example; the smallest denomination in USD is the cent, which is 1/100 of a USD, and the minor unit value is 2. Not all currencies have a minor unit. Example: 2 - `AverageNightlyRate.currencySource` (string) The system requesting or returning the currency code specified in the attribute Enum: same as `MinimumAdcolAmount.currencySource` in "ChangePermitted" (3 values) - `AverageNightlyRate.approximateInd` (boolean) "If true, the currency amount has been converted from the original amount. For Air Exchange Eligibility, returned only if a currency is converted. If returned, the value is always true, indicating that the fee is approximate because of currency conversion. For Hotel Availability and Rules, true indicates this is a calculated value; false indicates this is the value returned by the property." Example: true - `AmenitySurcharges` (object) Amenity Surcharges information. - `AmenitySurcharges.@type` (string, required) Discriminator classes AmenitySurcharges or AmenitySurchargesDetail Example: "AmenitySurchargesDetail" - `AmenitySurcharges.TotalSurcharges` (number) A monetary amount, up to 4 decimal places. Decimal place needs to be included. Example: 211.11 - `AmenitySurcharges.approximateInd` (boolean) if true, the surcharge amounts are approximate - `AmenitySurcharges.Surcharge` (array, required) - `AmenitySurcharges.Surcharge.value` (number) Surcharge amount Example: 12 - `AmenitySurcharges.Surcharge.currencyCode` (string) ISO 4217 currency code for the surcharge. Example: "USD" - `AmenitySurcharges.Surcharge.surchargeCode` (string) Surcharge code Example: "ADDITIONAL COSTS" - `AmenitySurcharges.Surcharge.reportingAuthority` (string) Not used. Surcharge reporting authority Example: "Federal register" - `AmenitySurcharges.Surcharge.purpose` (string) Surcharge purpose. For Air workflows possible values include Weekend Surcharge, Stopover Charge, Multiple Stopover Charges, Other (default value that covers all other surcharges such as fuel surcharges). Example: "Weekend Surcharge" - `AmenitySurcharges.Surcharge.description` (string) Description of the surcharge. Example: "Rollaway Surcharge" - `AmenitySurcharges.Surcharge.surchargeApplication` (string) Application values (such as the application of a fee) like per person or per room. Enum: same as `Surcharge.surchargeApplication` (7 values) - `AmenitySurcharges.Surcharge.surchargeFrequency` (string) The frequency of a fee such as per night or per stay. Enum: same as `Surcharge.surchargeFrequency` (6 values) - `AmenitySurcharges.Surcharge.codeAuthority` (string) Not used. Currency code authority. Example: "ISO 4217" - `AmenitySurcharges.Surcharge.decimalPlace` (integer) Decimal place for the currency unit. Example: 4 - `AmenitySurcharges.Surcharge.decimalAuthority` (string) Not used. Currency code decimal authority. Example: "ISO 4217" - `priceChangesDuringStayInd` (boolean) "If true, indicates the price changes at least once during requested dates. If roomPricingType = Per night, multiple instances of priceChangesDuringStayInd are returned." - `shortRateDescription` (string) A normalized rate description for comparing rates across multiple aggregators. Example: "Flexible Rate" - PriceBreakdownVehiclePrice: - `VehiclePrice` (object, required) Rate summary for rental of the vehicle. - `VehiclePrice.@type` (string, required) Example: "VehiclePrice" - `VehiclePrice.id` (string) Internal ID - `VehiclePrice.rateSource` (string) Assigned Type: c-1100:StringTiny - `VehiclePrice.rateGuaranteedInd` (boolean) Assigned Type: c-1100:OptionalIndicator - `VehiclePrice.ratePeriod` (string) The time period for a rate such as daily, weekly, monthly Enum: same as `VehiclePrice.ratePeriod` in "PriceBreakdownVehiclePrice" (15 values) - `VehiclePrice.RateDistance` (object) Rate for the period defined by the attributes - `VehiclePrice.RateDistance.value` (number) - `VehiclePrice.RateDistance.unlimitedDistanceInd` (boolean) if true unlimited miles is included with the rental - `VehiclePrice.RateDistance.requestedCodeAppliedInd` (boolean) if true, the requested code has been applied - `VehiclePrice.RateDistance.allowance` (integer) The distance allowance permitted with this rate. Use in combination with distanceUnits and ratePeriod - `VehiclePrice.RateDistance.distanceUnits` (string) For Hotels: Optional object to request either miles or kilometers for the search radius from the specified location. If unitOfDistance is not specified, the search defaults to miles for properties in the United States, Myanmar, and Liberia. The search defaults to kilometers in all other countries. Enum: same as `Vehicle.VehicleDateLocation.RentalPickup.GeoLocation.altitudeUnitOfDistance` in "ProductVehicle" (2 values) - `VehiclePrice.RateDistance.ratePeriod` (string) The time period for a rate such as daily, weekly, monthly Enum: same as `VehiclePrice.ratePeriod` in "PriceBreakdownVehiclePrice" (15 values) - `VehiclePrice.RateDescription` (array) - `sequence` (integer) The order of the text block, if there are more than one block. Example: 2 - `description` (string) Text block detail description Example: "description" - `Image` (object) Each instance is one image and its accompanying details, including a link to the image. Key value pairs; not all may be returned. - `Image.value` (string) URL of the image - `Image.dimensionCategory` (string) Deprecated and replaced by imageSize - `Image.width` (integer) Image width Example: 42 - `Image.height` (integer) Image height Example: 43 - `Image.caption` (string) Image caption Example: "Ticket" - `Image.pictureCategory` (integer) deprecated and replaced by pictureOf Example: 5 - `Image.imageSize` (string) A size for the image to return, allowing you to set image quality. Hospitality APIs no longer support thumbnail. Enum: same as `Vehicle.Image.imageSize` in "ProductVehicle" (5 values) - `Image.pictureOf` (string) The image category Enum: same as `Vehicle.Image.pictureOf` in "ProductVehicle" (26 values) - `URL` (string) A URL for this block - `DateCreateModify` (object, required) Time stamp of the creation. - `DateCreateModify.value` (string) Example: "2026-03-04T11:22:00Z" - `DateCreateModify.creatorID` (string) ID of creator. Software system identifier or an employee id Example: "c1234563" - `DateCreateModify.lastModify` (string) Time stamp of last modification. Example: "2026-03-04T11:24:00Z" - `DateCreateModify.lastModifierID` (string) Identifies the last software system or person to modify a record Example: "m346789" - `DateCreateModify.purge` (string) Date an item will be purged from a system of record Example: "2026-03-03" - `VehiclePrice.RateDescription.@type` (string, required) Discriminator classes TextBlock or TextBlockDetail Example: "TextBlockDetail" - `VehiclePrice.RateDescription.title` (string) "The title of the rule or information. For TermsAndConditionsFullHospitality, may include any of the following Rule Types; Promotional Data, Rate Description, Room Rate Data, Rate Text, Guarantee, Cancellation, Deposit, Check in/out, Room detail, Extra charges, Packages, Property, Location, Miscellaneous, Rate Amount, Alternate Rate Amount, Rate Comment, FAX, Phone, Special Information, Information, Room Hold Expiration Time. Not every property returns all of these types. Some properties do not return any title. Only English is supported for these values." Example: "Baggage Details" - `VehiclePrice.RateDescription.id` (string) Internally referenced id Example: "2" - `VehiclePrice.RateDescription.TextFormatted` (array, required) - `VehiclePrice.RateAvailability` (string) Options are available to sell, need to call, or closed Enum: same as `VehiclePrice.RateAvailability` in "PriceBreakdownVehiclePrice" (3 values) - `VehiclePrice.SupplierRate` (object, required) Estimated total amount - Monetary amounts expressed in another currency. - `VehiclePrice.SupplierRate.@type` (string, required) Example: "SupplierRate" - `VehiclePrice.SupplierRate.BaseRate` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.SupplierRate.BaseRate.value` (number) The amount of a given currency. Example: 124.56 - `VehiclePrice.SupplierRate.BaseRate.code` (string) An ISO 4217 alpha character code (3 characters) that specifies a money unit. Example: "USD" - `VehiclePrice.SupplierRate.BaseRate.minorUnit` (integer) Minor units are a mechanism for expressing the relationship between a major currency unit and its corresponding minor currency unit. It is the smallest unit of a given currency. For example; the smallest denomination in USD is the cent, which is 1/100 of a USD, and the minor unit value is 2. Not all currencies have a minor unit. Example: 2 - `VehiclePrice.SupplierRate.BaseRate.currencySource` (string) The system requesting or returning the currency code specified in the attribute Enum: same as `MinimumAdcolAmount.currencySource` in "ChangePermitted" (3 values) - `VehiclePrice.SupplierRate.BaseRate.approximateInd` (boolean) "If true, the currency amount has been converted from the original amount. For Air Exchange Eligibility, returned only if a currency is converted. If returned, the value is always true, indicating that the fee is approximate because of currency conversion. For Hotel Availability and Rules, true indicates this is a calculated value; false indicates this is the value returned by the property." Example: true - `VehiclePrice.SupplierRate.RateForPeriod` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.SupplierRate.DropOffCharge` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.SupplierRate.ExtraMileageCharge` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.SupplierRate.EstimatedTotalAmount` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.ApproximateRate` (object) Estimated total amount - Monetary amounts expressed in another currency. - `VehiclePrice.ApproximateRate.@type` (string, required) Example: "ApproximateRate" - `VehiclePrice.ApproximateRate.BaseRate` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.ApproximateRate.RateForPeriod` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.ApproximateRate.DropOffCharge` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.ApproximateRate.ExtraMileageCharge` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.ApproximateRate.EstimatedTotalAmount` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.CustomerLoyalty` (object) Specifies the ID for the membership program. Object for sending customer loyalty information, such as for a frequent flyer program. For Hotel send the loyalty card number in the value field, followed by programID with the hotel chain code, and supplierType: Hotel. For Air send the loyalty card number in the value field, followed by airline code in "supplier". For cross accrual use the "shareWithSupplier" field to submit to partner airlines. - `VehiclePrice.CustomerLoyalty.value` (string, required) Number on loyalty card. Example: "132456" - `VehiclePrice.CustomerLoyalty.id` (string) Optional Customer Loyalty Id. Not saved Example: "Loyalty_1" - `VehiclePrice.CustomerLoyalty.priority` (integer) Optional Numeric Priority Code Example: 2 - `VehiclePrice.CustomerLoyalty.programId` (string) "Specifies an identifier to indicate the company owner of the loyalty program. Typically two characters. For frequent guest number, the hotel supplier or brand code. For frequent flyer number, the air supplier code of the loyalty program." Example: "HY" - `VehiclePrice.CustomerLoyalty.programName` (string) Supplier's loyalty program name. Example: "Frontier-EarlyReturns" - `VehiclePrice.CustomerLoyalty.supplierType` (string) The type of supplier of a loyalty program. Uses 'hotel' for frequent guest number or 'air' for frequent flyer number. Example: "Hotel" - `VehiclePrice.CustomerLoyalty.supplier` (string) Supplier of a loyalty program (typically 2 characters representing the hotel, brand, or airline). Example: "UA" - `VehiclePrice.CustomerLoyalty.tier` (string) Customer Loyalty tier Example: "Silver" - `VehiclePrice.CustomerLoyalty.shareWithSupplier` (array) The list of suppliers that the CustomerLoyalty number is shared. Used for cross accrual. Example: ["LH"] - `VehiclePrice.CustomerLoyalty.cardHolderName` (string) Customer loyalty member name; up to 128 characters are supported. In Air Search, for discounted offers to be returned, the name must be sent as LAST FIRST; e.g.,if SMITH is the last name and JORDAN the first name, send as SMITH JORDAN Example: "John Smith" - `VehiclePrice.CustomerLoyalty.validatedInd` (boolean) Customer loyalty number has been validated by the supplier Example: true - `VehiclePrice.CustomerLoyalty.prefix` (string) The cardholder name prefix title like Mr, Mrs, Dr Example: "Dr" - `VehiclePrice.CustomerLoyalty.given` (string) The First Name of the Cardholder Example: "John" - `VehiclePrice.CustomerLoyalty.middle` (string) Middle Name of the Cardholder Example: "Wilkinson" - `VehiclePrice.CustomerLoyalty.surname` (string) Last Name of the Cardholder Example: "Smith" - `VehiclePrice.RateQualifier` (string) A closed enumeration of possible rate qualifiers for vehicle rental Enum: same as `VehiclePrice.RateQualifier` in "PriceBreakdownVehiclePrice" (5 values) - `rateGuaranteedInd` (boolean) - PriceBreakdownVehicleDeposit: - `totalPayableNowInd` (boolean) If True the Amount is the total amount payable now - `totalPayableLaterInd` (boolean) If True the Amount is the total amount payable later - PriceBreakdownVehicleCharges: - `VehicleCharges` (object) - `VehicleCharges.@type` (string, required) Example: "VehicleCharges" - `VehicleCharges.description` (string) Assigned Type: c-1100:String - `VehicleCharges.VehicleChargePurposeCode` (object) Any code used to specify an item, for example a type of traveler, service code, room amenity, etc. - `VehicleCharges.VehicleChargePurposeCode.value` (string) Example: "INS" - `VehicleCharges.VehicleChargePurposeCode.codeContext` (string) Code Context Example: "ACRISS" - `VehicleCharges.ratePeriod` (string) The time period for a rate such as daily, weekly, monthly Enum: same as `VehiclePrice.ratePeriod` in "PriceBreakdownVehiclePrice" (15 values) - `VehicleCharges.rateChargeInfo` (string) Assigned Type: c-1100:String - `VehicleCharges.RateCategory` (string) For Hotel Search, request a rate category by sending up to 8 OTA rate categories to search for. If the supplier has rates available for the requested category, the response contains those rates and indicates them as such. Some properties do not return these rates unless explicitly requested. For a Hotel Rules request, this value can be found, if returned, in the Availability response's ProductRateCodeInfo/RateCodeInfo/rateCategory. Enum: same as `VehicleCharges.RateCategory` in "PriceBreakdownVehicleCharges" (32 values) - `VehicleCharges.VehicleCoverageTypeCode` (object) The OTA code defined for the Vehicle Coverage Type - `VehicleCharges.VehicleCoverageTypeCode.value` (string) Example: "INS" - `VehicleCharges.VehicleCoverageTypeCode.codeContext` (string) Code Context Example: "ACRISS" - `VehicleCharges.Calculation` (array) - `VehicleCharges.Calculation.@type` (string, required) Example: "Calculation" - `VehicleCharges.Calculation.UnitAmount` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehicleCharges.Calculation.UnitName` (string) The time period for a rate such as daily, weekly, monthly Enum: same as `VehiclePrice.ratePeriod` in "PriceBreakdownVehiclePrice" (15 values) - `VehicleCharges.Calculation.Quantity` (integer) The quantity used in the calculation of the vehicle charge e.g 2 x $500 per week - `VehicleCharges.Calculation.MaxQuantity` (integer) The maximum quantity allowed for a charge e.g Baby seat charged at $10 per day for a maximum of 10 days - `VehicleCharges.Calculation.TotalAmount` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehicleCharges.Calculation.Percent` (number) Used when the charge is based on a percentage of a TotalAmount - `VehicleCharges.Calculation.Applicability` (object) Textual information. - `VehicleCharges.taxInclusiveInd` (boolean) - `VehicleCharges.guaranteedInd` (boolean) - `VehicleCharges.payNowInd` (boolean) If true the vehicle charge must be paid now and is included in the totalPrice calculation - `VehicleCharges.includedInEstimatedTotalInd` (boolean) - `VehicleCharges.includedInBaseRateInd` (boolean) If true the Vehicle Charge has been included in the base rate of the Vehicle price - `AdditionalCollectionPrice.@type` (string, required) Example: "AdditionalCollectionPrice" - `AdditionalCollectionPrice.id` (string) Internally referenced id Example: "adcolPrice_1" - `AdditionalCollectionPrice.CurrencyCode` (object) Currency codes are the three-letter alphabetic codes that represent the various currencies used throughout the world. Unless changed in the request, the currency is the default associated with your provisioned PCC from Travelport. For Hotel: SourceCurrency is based on the location of the hotel and used for all rates in the response. TargetCurrency is the currency code sent in the request in requestedCurrency. - `AdditionalCollectionPrice.Base` (number) The total amount not including taxes and/or fees - `AdditionalCollectionPrice.TotalTaxes` (number) The total of the taxes included in the total price - `AdditionalCollectionPrice.TotalFees` (number) The total of the fees included in the total price - `AdditionalCollectionPrice.TotalPrice` (number) The total price of the product in the currency indicated - `AdditionalCollectionPrice.VendorCurrencyTotal` (object) No longer used. Previously used to expose the local vendor currency when it is different to the purchased currency - OfferUpsell: - `OfferUpsellInd` (string) If true, the OfferUpsell contains ancillary offerings offered in connection with the ParentOffer Example: "true" - `Offer.@type` (string, required) Discriminator - Air Price child classes OfferID, Offer, and OfferUpsell. - Reservation and ReservationWorkbench child classes OfferID, Offer, OfferModify, and OfferUpsell. - Hotel Rules child classes OfferID and Offer. Example: "Offer" - `Offer.id` (string) Offer identifier sent in the reference payload request to book that offer. Not returned in the full payload response; this is the only difference in the two responses. Example: "offer_1" - `Offer.offerRef` (string) Used to reference another instance of this object in the same message Example: "offer_1" - `Offer.Identifier` (object) A globally unique identifier key often used to reference a given option (such as Pricing, Booking, Rules, or additional workflows) or to retrieve information (such as Hotel pagination). - `Offer.ContentSource` (string) Indicates the owner the offer or document. Enum: "GDS", "NDC", "LCC", "API" - `Offer.parentOfferRef` (string) A reference to the Offer this offer is sold in conjunction with Example: "offer_1" - `Offer.offerModifyRef` (string) Reference to the new Offer created as a result of this Offer being subject to a schedule change. - `Offer.Product` (array, required) Lists the flight or flights for one leg of the itinerary. Repeats for additional leg or legs. - `Quantity` (integer) "The quantity of the product. For Hotel Create Reservation (Full Payload) request, the number of rooms requested; 1-9 inclusive supported. If not provided, default is 1. For Hotel responses, the number of rooms currently available matching this rate. In Air Search quantity represents the number of seats available for that Product. If the Product has connecting flights, Quantity returns the lowest number available. For example, if the first flight has 9 seats in Y class and the connecting flight has 4 seats in Y class, Quantity returns a value of 4." Example: 2 - `Offer.Product.@type` (string, required) Discriminator. - Air Search child classes are ProductAir and ProductAncillary. - Exchange Search child class is ProductAir. - Ancillary Search child class is ProductAncillary. - Seat Map child class is ProductSeatAvailability. - Air Price child classes are ProductAir and ProductAncillary. - Hotel Availability child classes are ProductHospitality and ProductHospitalityOffer. - Hotel Rules and HotelReservation child classes are ProductHospitality. - All Vehicle APIs child classes are ProductVehicle and ProductAncillaryVehicle. - Reservation and Reservation Workbench child classes are ProductAir, ProductAncillary, ProductHospitality, ProductVehicle, and ProductAncillaryVehicle. Example: "ProductAir" - `Offer.Product.id` (string) Local id within a given message to support referencing this object. Example: "product_1" - `Offer.Product.productRef` (string) Reference id that corresponds to the product 'id' in ReferenceListProduct.Product. To find flight details for a product, use the ProductRef id to identify the product in ReferenceListProduct.Product, and use the Flight id's (e.g., s3, s4) to match to flight information in ReferenceListFlight.Flight. Example: "product_1" - `Offer.Product.Identifier` (object) A globally unique identifier key often used to reference a given option (such as Pricing, Booking, Rules, or additional workflows) or to retrieve information (such as Hotel pagination). - `Offer.Price` (object, required) Price includes a summary of the Base, Taxes, and Fees applicable to the offer in the currency indicated. The amounts in Base, TotalTaxes, TotalFees, and TotalPrice are inclusive of all travelers across all PTCs. The amounts in PriceBreakdown apply to one traveler with the PTC returned in that instance. - `FlightPassCredits` (integer) The total number of flight pass credits consumed for this offer. Example: 2 - `PriceBreakdown` (array) — one of (discriminator: @type): - PriceBreakdownAir: - `quantity` (integer) Quantity of passengers in that PTC. Example: 2 - `requestedPassengerType` (string) The PTC to which the PriceBreakdown applies. Example: "CHD" - `FiledAmount` (object) Returned only in the Price APIs. GDS only; not supported for NDC. The base amount of a ticket price or net price that is filed in local currency. Returned when the origin currency is not the same as the PCC currency to show the currency in which the base fare has been filed. When used for NetBaseAmount: Net ticket data (NTD) is returned in the AirPrice, AirReservation, Exchange Search, and Reservation Retrieve responses for any GDS fare that has a private fare component (fareType=AgencyPrivateFare). When NTD is returned, TermsAndConditionsFuill includes FareGuaranteePolicy to return the fare calculation indicator for the fare. When NTD is returned, PriceBreakdown may include NetBaseAmount. - `FiledAmount.value` (number) Filed amount value Example: 43.3422 - `FiledAmount.currencyCode` (string) Code for the currency in which the base fare was filed. Example: "USD" - `FiledAmount.codeAuthority` (string) Filed amount currency code authority Example: "Australian Dollar" - `FiledAmount.decimalPlace` (integer, required) Number of decimal places in the currency in ISO 4217 standard format. Example: 3 - `FiledAmount.decimalAuthority` (string) ISO 4217 standard decimal authority Example: "ISO 4217" - `Discount` (object) NDC only; not supported for GDS. Returned for a fare discounted from the published price, such as a promotional discount. Not returned for privately negotiated discounts such as private fares. - `Discount.value` (number) The amount value of the discount Example: 20.22 - `Discount.description` (string) The text description for the discount. Example: "Spring discount on group bookings" - `Discount.currencyCode` (string, required) Currency code discount is returned in. Example: "USD" - `Discount.codeAuthority` (string, required) Not used. Currency code Authority. Example: "ISO" - `Discount.decimalPlace` (integer, required) Number of decimal places in the currency the discount is returned in. Example: 2 - `Discount.decimalAuthority` (string) Not used. Decimal Authority. Example: "ISO" - `NetFareInfo` (object) Detailed information on the net fare used. - `NetFareInfo.@type` (string, required) Example: "NetFareInfo" - `NetFareInfo.passengerTypeCode` (string) PassengerTypeCode Example: "ADT" - `NetFareInfo.NetFareBreakdownConstruction` (array) - `NetFareInfo.TicketBaseAudit` (object) Returned only in the Price APIs. GDS only; not supported for NDC. The base amount of a ticket price or net price that is filed in local currency. Returned when the origin currency is not the same as the PCC currency to show the currency in which the base fare has been filed. When used for NetBaseAmount: Net ticket data (NTD) is returned in the AirPrice, AirReservation, Exchange Search, and Reservation Retrieve responses for any GDS fare that has a private fare component (fareType=AgencyPrivateFare). When NTD is returned, TermsAndConditionsFuill includes FareGuaranteePolicy to return the fare calculation indicator for the fare. When NTD is returned, PriceBreakdown may include NetBaseAmount. - `NetFareInfo.TicketBasePassenger` (object) The monetary value - `NetFareInfo.TicketBasePassenger.value` (number) - `NetFareInfo.TicketBasePassenger.currencyCode` (string) Assigned Type: c-1100:CurrencyCode - `NetFareInfo.TicketBasePassenger.codeAuthority` (string, required) Assigned Type: c-1100:CodeContext - `NetFareInfo.TicketBasePassenger.decimalPlace` (integer, required) Assigned Type: c-1100:CurrencyMinorUnit - `NetFareInfo.TicketBasePassenger.decimalAuthority` (string) Assigned Type: c-1100:CodeContext - `NetFareInfo.TicketBasePassenger.bTInd` (boolean) If true, this is a bulk ticket fare - `NetFareInfo.TicketBasePassenger.iTInd` (boolean) If true, this is an inclusive tour fare - `TravelerIdentifierRef` (object) Identifier references as object both within a message payload or an object held in cache that may be used for subsequent workflows. Returned for NDC in the Price response if age was sent for this traveler in the previous workflow requests. - `TravelerIdentifierRef.name` (string) Traveler identifier - `TravelerIdentifierRef.passengerTypeCode` (string) Passenger Type code Example: "ADT" - `TravelerIdentifierRef.ages` (array) The ages of the travelers associated to a particular ptc. For NDC, this value will be returned in PriceBreakdownAir if sent as part of the PassengerCriteria in the Air Search request. Example: [15] - `TravelerIdentifierRef.passengerCriteriaRef` (string) Allows the user to associate passenger criteria information. Example: "passengerCriteria_1" - `TravelerIdentifierRef.value` (string) - `TravelerIdentifierRef.id` (string) A locally referenced ID - `TravelerIdentifierRef.description` (string) Descriptive text used to identify the contents of a target object - `TravelerIdentifierRef.uris` (array) Uniform Resource Identifier Example: ["google.com"] - `TravelerIdentifierRef.age` (integer) Replaced with ages array. The age of the traveler. Example: 11 - `NetBaseAmount` (object) Returned only in the Price APIs. GDS only; not supported for NDC. The base amount of a ticket price or net price that is filed in local currency. Returned when the origin currency is not the same as the PCC currency to show the currency in which the base fare has been filed. When used for NetBaseAmount: Net ticket data (NTD) is returned in the AirPrice, AirReservation, Exchange Search, and Reservation Retrieve responses for any GDS fare that has a private fare component (fareType=AgencyPrivateFare). When NTD is returned, TermsAndConditionsFuill includes FareGuaranteePolicy to return the fare calculation indicator for the fare. When NTD is returned, PriceBreakdown may include NetBaseAmount. - `FareCalculation` (string) GDS only; not supported for NDC. For each PTC, when available, FareCalculation returns the fare calculation ladder for all public and private fare types filed by an agency or an airline. Example: "LON BA SYD R564.00YEE1Y BA LON R564.00YEE1Y NUC1128.00END ROE0.787855" - `Surcharges` (object) In AirSearch workflow this applies to GDS only. Not supported for NDC, which does not return surcharges. Returned if surcharges apply to this offer. For GDS only, for a multi-city offer with stopovers (see multi-city offers with stopovers for details), surcharges and commission amounts are for the entire journey. For all other offers, the surcharges and commission amounts are for each leg (origin and destination pair). A multi-city offer can be identified by the jc in its CombinabilityCode: jc1, jc2. Surcharges can be omitted from the Search response with excludeSurchargesInd. - `Surcharge` (array, required) - `Surcharges.@type` (string, required) Discriminator class is SurchargesDetail Example: "SurchargesDetail" - `Surcharges.TotalSurcharges` (number) A monetary amount, up to 4 decimal places. Example: 211.11 - `Surcharges.approximateInd` (boolean) If true, the surcharge amounts are approximate. - `TravelerRefs` (array) Returned only in Reservation Retrieve to identify the traveler associated with this instance of PriceBreakdown in case of multiple offers on the booking. Example: ["[\"traveler_1\",\"traveler2\"]"] - `PaidTaxes` (object) Summary Taxes object - `Tax` (array) - `TaxPercent` (object) Returned when the tax is expressed as a percentage of the amount. - `TaxPercent.value` (number) The tax percentage amount. Example: 5.5 - `TaxPercent.taxCode` (string) Any code for the tax. Example: "971 - IRS Notice" - `TaxPercent.reportingAuthority` (string) Tax reporting authority Example: "Georgia Department of Revenue" - `TaxPercent.purpose` (string) Purpose of tax Example: "statutory tax" - `TaxPercent.description` (string) Description Example: "1.5% of SGST" - `TaxPercent.includedInBase` (string) Yes , No , Unknown Enum: same as `instantPurchase` in "AdvanceReservationRequired" (3 values) - `PaidTaxes.@type` (string, required) Discriminator classes PaidTaxes or PaidTaxesDetail Example: "PaidTaxesDetail" - `PaidTaxes.TotalTaxes` (number) A monetary amount, up to 4 decimal places. Decimal place needs to be included. Example: 220.12 - `RequestedPricingModifiers` (array) - `RequestedPricingModifiers.@type` (string, required) Discriminator. Example: "RequestedPricingModifiers" - `RequestedPricingModifiers.PassengerCriteria` (object) Defines the passenger criteria. Send one PassengerCriteria for each passenger type code (PTC). Search supports up to 9 total passengers. A maximum of 6 PTCs are supported for GDS. NDC does not have a PTC limitation. AirPrice supports up to nine total passengers across all PTCs. - `RequestedPricingModifiers.PricingModifiersAir` (object) A selection of Pricing Modifiers that can be used to influence the Price of an Offer. - For the AirPrice reference payload request, if any price modifiers were included in the preceding Search request and no price modifiers are sent in the AirPrice request, the cached price modifiers sent at Search are sent with the AirPrice request. If any price modifiers are sent in the AirPrice reference payload request, all cached Search modifiers are discarded and only the modifiers sent in that AirPrice request are used. - For the Add Offer request, you may optionally store fares with one or more pricing modifiers. If a pricing modifier is not added, the auto stored fare is added to the reservation. There is no change in the AirReservation response when pricing modifiers are requested. AirReservation applies modifiers from Add Offer and earlier steps as follows: - Modifiers sent in the Add Offer request (supported for both full and reference payload). - If no modifiers are sent in Add Offer, any pricing modifiers sent in AirPrice are applied. - If no modifiers were sent in AirPrice, or if AirPrice was not sent, any pricing modifiers sent in Search are applied. GDS only; pricing modifiers not supported for NDC. If the requested modifier does not have any fares associated with it, the workbench commit fails and returns the error message 'No Fare Found'. Pricing happens at commit, not at Add Offer. - `RequestedPricingModifiers.CabinPreference` (object) Requests a fare based on the cabin class. Only one cabin preferenceType (Permitted, Preferred, PreferredWithUpgrade) is allowed per request, but there is no limit to the number of cabins that can be sent. Any CabinPreference in the initial Search request is applied to any subsequent Next Leg Search and reference Flight Specific Search requests. In AirPrice and AirReservation only one cabin preference type is allowed per request, but there is no limit to the number of cabins that can be sent. If CabinPreference was sent in the Search request, it is cached and sent with the AirPrice reference payload request. If you send CabinPreference in the AirPrice request, all cached modifiers are discarded and only the modifiers sent in the AirPrice request are used. Can be combined with lowFareFinderInd=true to return lowest fare in the requested cabin or cabins. When using CabinPreference and lowFareFinderInd, if both CabinPreference and a class of service are sent, class of service is ignored. If CabinPreference is sent without a class of service, the response returns the lowest fare in the cabin requested. If that cabin is not available, the response may upgrade or downgrade to a different cabin. If a different cabin than requested is returned, the response returns the message that the cabin class may differ from the class requested. If lowFareFinderInd=false and CabinPreference are sent in the request, AirPrice ignores the preferred cabin and returns a message that the preferred cabin was ignored. If CabinPreference is set to All, no cabin preference is applied." - `RequestedPricingModifiers.FlightType` (object) The type of flight connection - `RequestedPricingModifiers.CustomResponseModifiersAir` (object) Contains additional modifiers to customize the result set. Includes optional indicators for returning or excluding specified response content. Values sent at Search can carry forward into the Next Leg Search request and are not re-sent. - `RequestedPricingModifiers.PricingModifiersAirChange` (object) Pricing Modifiers that can be used to influence the Price of an Exchanged Offer - `RequestedPricingModifiers.lowFareFinderInd` (boolean) Provides pricing flexibility around class of service. If not sent, the response returns fares only in the requested class of service. If true, returns the lowest fares available in any class of service available, which may not be the same as the requested class. Note that if lowFareFinderInd is sent with true and CabinPreference is sent, the only supported value for CabinPreference/type is Permitted. When lowFareFindInd=true and brand attributes are not disabled (inhibitBrandContentInd), AirPrice uses only the brand tier (and any other pricing modifiers) to find the lowest fare within a brand tier regardless of class of service. GDS only; not supported for NDC. Example: true - `RequestedPricingModifiers.keepToBrandInd` (boolean) If true, the original brand will be maintained during the exchange process. Example: true - `RequestedPricingModifiers.lowFareFindAndRebookInd` (boolean) If true, the original flights in the reservation will be rebooked or replaced with the new exchanged flights. - `PassengerCriteriaRefs` (array) NDC only; not supported for GDS. Returned for NDC if a traveler identifier was sent for this traveler in the previous workflow requests. Example: ["passengerCriteria_1"] - `FlightPassCredits` (integer) The number of flight pass credits consumed for this pricebreakdown. Example: 1 - PriceBreakdownAncillary: - `inclusiveOfTaxInd` (boolean) If true, this ancillary is sold inclusive of tax. Example: true - `quantity` (integer) The quantity of ancillary items included in this PriceBreakdown. Example: 1 - `Description` (object) A description of the ancillary with description codes. - `Description.value` (string) The text description of the ancillary. Example: "Vegetarian Meal" - `Description.code` (string) The ATPCO group code. Example: "BG" - `Description.subCode` (string) The ATPCO RFISC subcode. Example: "0D4" - `Description.subGroup` (string) The ATPCO sub group code. Example: "SP" - `Description.codeContext` (string) The code context value. Example: "ATPCO" - `Description.ssrCode` (string) The four character AIRIMP SSR code for this ancillary. Example: "VGML" - `Description.issuanceReasonCode` (string) The airline provided reason for issuance code. Example: "C" - `Description.geographicSpecification` (string) How the ancillary is applied across the itinerary. Enum: same as `Ancillary.Description.geographicSpecification` in "ProductAncillary" (3 values) - `ProductRef` (string) The product ref this PriceBreakdown applies to. If no productRef exists then the PriceBreakdown applies to all Products within the Offer. Example: "p_1" - `Discount` (object) NDC only; not supported for GDS. Returned for a fare discounted from the published price, such as a promotional discount. Not returned for privately negotiated discounts such as private fares. - `Discount.value` (number) The amount value of the discount Example: 20.22 - `Discount.description` (string) The text description for the discount. Example: "Spring discount on group bookings" - `Discount.currencyCode` (string, required) Currency code discount is returned in. Example: "USD" - `Discount.codeAuthority` (string, required) Not used. Currency code Authority. Example: "ISO" - `Discount.decimalPlace` (integer, required) Number of decimal places in the currency the discount is returned in. Example: 2 - `Discount.decimalAuthority` (string) Not used. Decimal Authority. Example: "ISO" - `TravelerIdentifierRef` (object) Identifier references as object both within a message payload or an object held in cache that may be used for subsequent workflows. Returned for NDC in the Price response if age was sent for this traveler in the previous workflow requests. - `TravelerIdentifierRef.name` (string) Traveler identifier - `TravelerIdentifierRef.passengerTypeCode` (string) Passenger Type code Example: "ADT" - `TravelerIdentifierRef.ages` (array) The ages of the travelers associated to a particular ptc. For NDC, this value will be returned in PriceBreakdownAir if sent as part of the PassengerCriteria in the Air Search request. Example: [15] - `TravelerIdentifierRef.passengerCriteriaRef` (string) Allows the user to associate passenger criteria information. Example: "passengerCriteria_1" - `TravelerIdentifierRef.value` (string) - `TravelerIdentifierRef.id` (string) A locally referenced ID - `TravelerIdentifierRef.description` (string) Descriptive text used to identify the contents of a target object - `TravelerIdentifierRef.uris` (array) Uniform Resource Identifier Example: ["google.com"] - `TravelerIdentifierRef.age` (integer) Replaced with ages array. The age of the traveler. Example: 11 - `AncillaryPriceApplicationCode` (object) Determines how an ancillary price has been built. - `AncillaryPriceApplicationCode.value` (string) Example: "3" - `AncillaryPriceApplicationCode.application` (string) Associated text. Example: "PerItem" - PriceBreakdownHospitality: - `roomPricingType` (string) A string provided by the hotel to describe how a service is priced, such as per night or per stay. Enum: same as `roomPricingType` in "PriceBreakdownHospitality" (5 values) - `Description` (string) Example: "Advance Purchase-Ro-Free WiFi" - `NightlyRate` (array) - `NightlyRate.@type` (string) - `NightlyRate.startDate` (string, required) Start date for the nightly rate in YYYY-MM-DD format. - `NightlyRate.nights` (integer) Number of nights the nightly rate is valid. - `NightlyRate.Amount` (object, required) Amount represents the cost applied - `AverageNightlyRate` (array) The average nightly rate for a given offer. - `AverageNightlyRate.value` (number) The amount of a given currency. Example: 124.56 - `AverageNightlyRate.code` (string) An ISO 4217 alpha character code (3 characters) that specifies a money unit. Example: "USD" - `AverageNightlyRate.minorUnit` (integer) Minor units are a mechanism for expressing the relationship between a major currency unit and its corresponding minor currency unit. It is the smallest unit of a given currency. For example; the smallest denomination in USD is the cent, which is 1/100 of a USD, and the minor unit value is 2. Not all currencies have a minor unit. Example: 2 - `AverageNightlyRate.currencySource` (string) The system requesting or returning the currency code specified in the attribute Enum: same as `MinimumAdcolAmount.currencySource` in "ChangePermitted" (3 values) - `AverageNightlyRate.approximateInd` (boolean) "If true, the currency amount has been converted from the original amount. For Air Exchange Eligibility, returned only if a currency is converted. If returned, the value is always true, indicating that the fee is approximate because of currency conversion. For Hotel Availability and Rules, true indicates this is a calculated value; false indicates this is the value returned by the property." Example: true - `AmenitySurcharges` (object) Amenity Surcharges information. - `AmenitySurcharges.@type` (string, required) Discriminator classes AmenitySurcharges or AmenitySurchargesDetail Example: "AmenitySurchargesDetail" - `AmenitySurcharges.TotalSurcharges` (number) A monetary amount, up to 4 decimal places. Decimal place needs to be included. Example: 211.11 - `AmenitySurcharges.approximateInd` (boolean) if true, the surcharge amounts are approximate - `AmenitySurcharges.Surcharge` (array, required) - `priceChangesDuringStayInd` (boolean) "If true, indicates the price changes at least once during requested dates. If roomPricingType = Per night, multiple instances of priceChangesDuringStayInd are returned." - `shortRateDescription` (string) A normalized rate description for comparing rates across multiple aggregators. Example: "Flexible Rate" - PriceBreakdownVehiclePrice: - `VehiclePrice` (object, required) Rate summary for rental of the vehicle. - `VehiclePrice.@type` (string, required) Example: "VehiclePrice" - `VehiclePrice.id` (string) Internal ID - `VehiclePrice.rateSource` (string) Assigned Type: c-1100:StringTiny - `VehiclePrice.rateGuaranteedInd` (boolean) Assigned Type: c-1100:OptionalIndicator - `VehiclePrice.ratePeriod` (string) The time period for a rate such as daily, weekly, monthly Enum: same as `VehiclePrice.ratePeriod` in "PriceBreakdownVehiclePrice" (15 values) - `VehiclePrice.RateDistance` (object) Rate for the period defined by the attributes - `VehiclePrice.RateDistance.value` (number) - `VehiclePrice.RateDistance.unlimitedDistanceInd` (boolean) if true unlimited miles is included with the rental - `VehiclePrice.RateDistance.requestedCodeAppliedInd` (boolean) if true, the requested code has been applied - `VehiclePrice.RateDistance.allowance` (integer) The distance allowance permitted with this rate. Use in combination with distanceUnits and ratePeriod - `VehiclePrice.RateDistance.distanceUnits` (string) For Hotels: Optional object to request either miles or kilometers for the search radius from the specified location. If unitOfDistance is not specified, the search defaults to miles for properties in the United States, Myanmar, and Liberia. The search defaults to kilometers in all other countries. Enum: same as `Vehicle.VehicleDateLocation.RentalPickup.GeoLocation.altitudeUnitOfDistance` in "ProductVehicle" (2 values) - `VehiclePrice.RateDistance.ratePeriod` (string) The time period for a rate such as daily, weekly, monthly Enum: same as `VehiclePrice.ratePeriod` in "PriceBreakdownVehiclePrice" (15 values) - `VehiclePrice.RateDescription` (array) - `sequence` (integer) The order of the text block, if there are more than one block. Example: 2 - `description` (string) Text block detail description Example: "description" - `Image` (object) Each instance is one image and its accompanying details, including a link to the image. Key value pairs; not all may be returned. - `URL` (string) A URL for this block - `DateCreateModify` (object, required) Time stamp of the creation. - `VehiclePrice.RateAvailability` (string) Options are available to sell, need to call, or closed Enum: same as `VehiclePrice.RateAvailability` in "PriceBreakdownVehiclePrice" (3 values) - `VehiclePrice.SupplierRate` (object, required) Estimated total amount - Monetary amounts expressed in another currency. - `VehiclePrice.SupplierRate.@type` (string, required) Example: "SupplierRate" - `VehiclePrice.SupplierRate.BaseRate` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.SupplierRate.RateForPeriod` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.SupplierRate.DropOffCharge` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.SupplierRate.ExtraMileageCharge` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.SupplierRate.EstimatedTotalAmount` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.ApproximateRate` (object) Estimated total amount - Monetary amounts expressed in another currency. - `VehiclePrice.ApproximateRate.@type` (string, required) Example: "ApproximateRate" - `VehiclePrice.ApproximateRate.BaseRate` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.ApproximateRate.RateForPeriod` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.ApproximateRate.DropOffCharge` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.ApproximateRate.ExtraMileageCharge` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.ApproximateRate.EstimatedTotalAmount` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.CustomerLoyalty` (object) Specifies the ID for the membership program. Object for sending customer loyalty information, such as for a frequent flyer program. For Hotel send the loyalty card number in the value field, followed by programID with the hotel chain code, and supplierType: Hotel. For Air send the loyalty card number in the value field, followed by airline code in "supplier". For cross accrual use the "shareWithSupplier" field to submit to partner airlines. - `VehiclePrice.CustomerLoyalty.value` (string, required) Number on loyalty card. Example: "132456" - `VehiclePrice.CustomerLoyalty.id` (string) Optional Customer Loyalty Id. Not saved Example: "Loyalty_1" - `VehiclePrice.CustomerLoyalty.priority` (integer) Optional Numeric Priority Code Example: 2 - `VehiclePrice.CustomerLoyalty.programId` (string) "Specifies an identifier to indicate the company owner of the loyalty program. Typically two characters. For frequent guest number, the hotel supplier or brand code. For frequent flyer number, the air supplier code of the loyalty program." Example: "HY" - `VehiclePrice.CustomerLoyalty.programName` (string) Supplier's loyalty program name. Example: "Frontier-EarlyReturns" - `VehiclePrice.CustomerLoyalty.supplierType` (string) The type of supplier of a loyalty program. Uses 'hotel' for frequent guest number or 'air' for frequent flyer number. Example: "Hotel" - `VehiclePrice.CustomerLoyalty.supplier` (string) Supplier of a loyalty program (typically 2 characters representing the hotel, brand, or airline). Example: "UA" - `VehiclePrice.CustomerLoyalty.tier` (string) Customer Loyalty tier Example: "Silver" - `VehiclePrice.CustomerLoyalty.shareWithSupplier` (array) The list of suppliers that the CustomerLoyalty number is shared. Used for cross accrual. Example: ["LH"] - `VehiclePrice.CustomerLoyalty.cardHolderName` (string) Customer loyalty member name; up to 128 characters are supported. In Air Search, for discounted offers to be returned, the name must be sent as LAST FIRST; e.g.,if SMITH is the last name and JORDAN the first name, send as SMITH JORDAN Example: "John Smith" - `VehiclePrice.CustomerLoyalty.validatedInd` (boolean) Customer loyalty number has been validated by the supplier Example: true - `VehiclePrice.CustomerLoyalty.prefix` (string) The cardholder name prefix title like Mr, Mrs, Dr Example: "Dr" - `VehiclePrice.CustomerLoyalty.given` (string) The First Name of the Cardholder Example: "John" - `VehiclePrice.CustomerLoyalty.middle` (string) Middle Name of the Cardholder Example: "Wilkinson" - `VehiclePrice.CustomerLoyalty.surname` (string) Last Name of the Cardholder Example: "Smith" - `VehiclePrice.RateQualifier` (string) A closed enumeration of possible rate qualifiers for vehicle rental Enum: same as `VehiclePrice.RateQualifier` in "PriceBreakdownVehiclePrice" (5 values) - `rateGuaranteedInd` (boolean) - PriceBreakdownVehicleDeposit: - `totalPayableNowInd` (boolean) If True the Amount is the total amount payable now - `totalPayableLaterInd` (boolean) If True the Amount is the total amount payable later - PriceBreakdownVehicleCharges: - `VehicleCharges` (object) - `VehicleCharges.@type` (string, required) Example: "VehicleCharges" - `VehicleCharges.description` (string) Assigned Type: c-1100:String - `VehicleCharges.VehicleChargePurposeCode` (object) Any code used to specify an item, for example a type of traveler, service code, room amenity, etc. - `VehicleCharges.VehicleChargePurposeCode.value` (string) Example: "INS" - `VehicleCharges.VehicleChargePurposeCode.codeContext` (string) Code Context Example: "ACRISS" - `VehicleCharges.ratePeriod` (string) The time period for a rate such as daily, weekly, monthly Enum: same as `VehiclePrice.ratePeriod` in "PriceBreakdownVehiclePrice" (15 values) - `VehicleCharges.rateChargeInfo` (string) Assigned Type: c-1100:String - `VehicleCharges.RateCategory` (string) For Hotel Search, request a rate category by sending up to 8 OTA rate categories to search for. If the supplier has rates available for the requested category, the response contains those rates and indicates them as such. Some properties do not return these rates unless explicitly requested. For a Hotel Rules request, this value can be found, if returned, in the Availability response's ProductRateCodeInfo/RateCodeInfo/rateCategory. Enum: same as `VehicleCharges.RateCategory` in "PriceBreakdownVehicleCharges" (32 values) - `VehicleCharges.VehicleCoverageTypeCode` (object) The OTA code defined for the Vehicle Coverage Type - `VehicleCharges.VehicleCoverageTypeCode.value` (string) Example: "INS" - `VehicleCharges.VehicleCoverageTypeCode.codeContext` (string) Code Context Example: "ACRISS" - `VehicleCharges.Calculation` (array) - `VehicleCharges.taxInclusiveInd` (boolean) - `VehicleCharges.guaranteedInd` (boolean) - `VehicleCharges.payNowInd` (boolean) If true the vehicle charge must be paid now and is included in the totalPrice calculation - `VehicleCharges.includedInEstimatedTotalInd` (boolean) - `VehicleCharges.includedInBaseRateInd` (boolean) If true the Vehicle Charge has been included in the base rate of the Vehicle price - `PriceBreakdown.@type` (string, required) Discriminator - Air Search and Air Price APIs child classes are PriceBreakdownAir and PriceBreakdownAncillary. - Search Ancillaries and Seat Availabilities child classes are PriceBreakdown, PriceBreakdownAncillary, and PriceBreakdownAncillaryAir. - All Hotel API child classes are PriceBreakdownHospitality. - Vehicle API child classes are PriceBreakdownVehicleCharges, PriceBreakdownVehicleDeposit, PriceBreakdownVehiclePrice, and PriceBreakdownAncillaryVehicle. - Reservation and Reservation Workbench APIs are PriceBreakdownAir, PriceBreakdownAncillary, PriceBreakdownHospitality, PriceBreakdownVehicleCharges, PriceBreakdownVehicleDeposit, PriceBreakdownVehiclePrice, and PriceBreakdownAncillaryVehicle. Example: "PriceBreakdownAir" - `PriceBreakdown.Amount` (object) Amount represents the cost applied - `PriceBreakdown.Amount.@type` (string) - `PriceBreakdown.Amount.currencySource` (string) The system requesting or returning the currency code specified in the attribute Enum: same as `MinimumAdcolAmount.currencySource` in "ChangePermitted" (3 values) - `PriceBreakdown.Amount.CurrencyCode` (object) Currency codes are the three-letter alphabetic codes that represent the various currencies used throughout the world. Unless changed in the request, the currency is the default associated with your provisioned PCC from Travelport. For Hotel: SourceCurrency is based on the location of the hotel and used for all rates in the response. TargetCurrency is the currency code sent in the request in requestedCurrency. - `PriceBreakdown.Amount.Base` (number) The base price prior to all applicable taxes or fees of a product, such as the amount for a room or fare for a flight (one passenger). Example: 120.2 - `PriceBreakdown.Amount.Taxes` (object) Summary of all individual taxes. Child class TaxesDetail provides the breakdown of individual taxes. - `PriceBreakdown.Amount.Fees` (object) Includes TotalFees object to return the sum total of any fees. May include array of Fee objects to break down individual fees. Child class FeesDetail may also include a breakdown of the individual fees. - `PriceBreakdown.Amount.Total` (number) "Specifies the total price including base + taxes + fees. In PriceBreakdownHospitality, this total is for a given group of nights. In PriceBreakdownAir this is the total of base cost and all fees and taxes for one passenger of this PTC type." Example: 230.13 - `PriceBreakdown.Amount.approximateInd` (boolean) if true this amount has been converted from the original amount Example: true - `PriceBreakdown.Commission` (object) — one of (discriminator: @type): GDS only; not supported for NDC. Commission information. Any commission filed by an airline in a CAT35 fare is returned in PriceBreakdownAir/Commission. The amount is either a percent of the fare component (@type CommissionPercent and the Percent object) or an amount (@type CommissionAmount and the Amount object)." - CommissionAmount: - `Amount` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - CommissionPercent: - `Percent` (number) Percent amount of commission Example: 20 - `PriceBreakdown.Commission.@type` (string, required) Discriminator. Child classes CommissionAmount or CommissionPercent Example: "CommissionAmount" - `PriceBreakdown.Commission.application` (string) Type of commission Enum: same as `PriceBreakdown.Commission.application` (6 values) - `Offer.Price.@type` (string, required) Discriminator classes Price or PriceDetail Example: "PriceDetail" - `Offer.Price.id` (string) Internally referenced id Example: "2" - `Offer.Price.CurrencyCode` (object) Currency codes are the three-letter alphabetic codes that represent the various currencies used throughout the world. Unless changed in the request, the currency is the default associated with your provisioned PCC from Travelport. For Hotel: SourceCurrency is based on the location of the hotel and used for all rates in the response. TargetCurrency is the currency code sent in the request in requestedCurrency. - `Offer.Price.CurrencyCode.value` (string) An ISO 4217 currency code. Example: "USD" - `Offer.Price.CurrencyCode.codeAuthority` (string) Currency code authority Example: "ISO 4217" - `Offer.Price.CurrencyCode.decimalPlace` (integer) Number of decimal places for the currency. Example: 4 - `Offer.Price.CurrencyCode.decimalAuthority` (string) Currency code decimal authority Example: "ISO 4217" - `Offer.Price.Base` (number) "Base price before taxes and fees. For Hotel, may not be returned by all suppliers." Example: 20.2 - `Offer.Price.TotalTaxes` (number) "Total taxes applied to the base price. For Hotel, may not be returned by all suppliers." Example: 34.4 - `Offer.Price.TotalFees` (number) Total fees included in Total Price. Example: 201 - `Offer.Price.TotalPrice` (number) Total price of this offer including the base price and all taxes and fees. Example: 34 - `Offer.Price.VendorCurrencyTotal` (object) No longer used. Previously used to expose the local vendor currency when it is different to the purchased currency - `Offer.Price.VendorCurrencyTotal.@type` (string) - `Offer.Price.VendorCurrencyTotal.currencySource` (string) The system requesting or returning the currency code specified in the attribute Enum: same as `MinimumAdcolAmount.currencySource` in "ChangePermitted" (3 values) - `Offer.Price.VendorCurrencyTotal.CurrencyCode` (object) Currency codes are the three-letter alphabetic codes that represent the various currencies used throughout the world. Unless changed in the request, the currency is the default associated with your provisioned PCC from Travelport. For Hotel: SourceCurrency is based on the location of the hotel and used for all rates in the response. TargetCurrency is the currency code sent in the request in requestedCurrency. - `Offer.Price.VendorCurrencyTotal.Base` (number) The price prior to all applicable taxes of a product such as the rate for a room or fare for a flight. Example: 120.2 - `Offer.Price.VendorCurrencyTotal.Taxes` (object) Summary of all individual taxes. Child class TaxesDetail provides the breakdown of individual taxes. - `Tax` (array) - `TaxPercent` (object) Returned when the tax is expressed as a percentage of the amount. - `TaxPercent.value` (number) The tax percentage amount. Example: 5.5 - `TaxPercent.taxCode` (string) Any code for the tax. Example: "971 - IRS Notice" - `TaxPercent.reportingAuthority` (string) Tax reporting authority Example: "Georgia Department of Revenue" - `TaxPercent.purpose` (string) Purpose of tax Example: "statutory tax" - `TaxPercent.description` (string) Description Example: "1.5% of SGST" - `TaxPercent.includedInBase` (string) Yes , No , Unknown Enum: same as `instantPurchase` in "AdvanceReservationRequired" (3 values) - `Offer.Price.VendorCurrencyTotal.Taxes.@type` (string, required) Discriminator class is TaxesDetail Example: "TaxesDetail" - `Offer.Price.VendorCurrencyTotal.Taxes.TotalTaxes` (number) A monetary amount, representing the total of all taxes included in this offer. Supports up to 4 decimal places; decimal place must be included. Example: 330.1 - `Offer.Price.VendorCurrencyTotal.Taxes.TaxInfo` (array) Returned for TripChange APIS only. - `Offer.Price.VendorCurrencyTotal.Fees` (object) Includes TotalFees object to return the sum total of any fees. May include array of Fee objects to break down individual fees. Child class FeesDetail may also include a breakdown of the individual fees. - `Fee` (array) Array of individual fees. - `Offer.Price.VendorCurrencyTotal.Fees.@type` (string, required) Discriminator. Child class FeesDetail Example: "FeesDetail" - `Offer.Price.VendorCurrencyTotal.Fees.TotalFees` (number) Total fees included in the TotalPrice. Supports up to 4 decimal places; decimal place needs to be included. Example: 111.11 - `Offer.Price.VendorCurrencyTotal.Fees.TotalAdditionalFeesPayableLocally` (number) Fees due separately at the property. Expected to be paid in local currency. These fees are not included in the Offer TotalPrice. Example: 2.1 - `Offer.Price.VendorCurrencyTotal.Total` (number) Specifies the total price including base + taxes + fees Example: 30.13 - `Offer.Price.VendorCurrencyTotal.approximateInd` (boolean) True if this amount has been converted from the original amount Example: true - `Offer.TermsAndConditionsFull` (array) — one of (discriminator: @type): - TermsAndConditionsFull: - `ExpiryDate` (string) The date and time in UTC the offer will no longer be valid. Example: "2022-08-07T12:12:00Z" - `CustomerLoyalty` (array) - `CustomerLoyalty.value` (string, required) Number on loyalty card. Example: "132456" - `CustomerLoyalty.id` (string) Optional Customer Loyalty Id. Not saved Example: "Loyalty_1" - `CustomerLoyalty.priority` (integer) Optional Numeric Priority Code Example: 2 - `CustomerLoyalty.programId` (string) "Specifies an identifier to indicate the company owner of the loyalty program. Typically two characters. For frequent guest number, the hotel supplier or brand code. For frequent flyer number, the air supplier code of the loyalty program." Example: "HY" - `CustomerLoyalty.programName` (string) Supplier's loyalty program name. Example: "Frontier-EarlyReturns" - `CustomerLoyalty.supplierType` (string) The type of supplier of a loyalty program. Uses 'hotel' for frequent guest number or 'air' for frequent flyer number. Example: "Hotel" - `CustomerLoyalty.supplier` (string) Supplier of a loyalty program (typically 2 characters representing the hotel, brand, or airline). Example: "UA" - `CustomerLoyalty.tier` (string) Customer Loyalty tier Example: "Silver" - `CustomerLoyalty.shareWithSupplier` (array) The list of suppliers that the CustomerLoyalty number is shared. Used for cross accrual. Example: ["LH"] - `CustomerLoyalty.cardHolderName` (string) Customer loyalty member name; up to 128 characters are supported. In Air Search, for discounted offers to be returned, the name must be sent as LAST FIRST; e.g.,if SMITH is the last name and JORDAN the first name, send as SMITH JORDAN Example: "John Smith" - `CustomerLoyalty.validatedInd` (boolean) Customer loyalty number has been validated by the supplier Example: true - `CustomerLoyalty.prefix` (string) The cardholder name prefix title like Mr, Mrs, Dr Example: "Dr" - `CustomerLoyalty.given` (string) The First Name of the Cardholder Example: "John" - `CustomerLoyalty.middle` (string) Middle Name of the Cardholder Example: "Wilkinson" - `CustomerLoyalty.surname` (string) Last Name of the Cardholder Example: "Smith" - `TextBlock` (array) A list of free text terms and conditions. - `sequence` (integer) The order of the text block, if there are more than one block. Example: 2 - `description` (string) Text block detail description Example: "description" - `Image` (object) Each instance is one image and its accompanying details, including a link to the image. Key value pairs; not all may be returned. - `Image.value` (string) URL of the image - `Image.dimensionCategory` (string) Deprecated and replaced by imageSize - `Image.width` (integer) Image width Example: 42 - `Image.height` (integer) Image height Example: 43 - `Image.caption` (string) Image caption Example: "Ticket" - `Image.pictureCategory` (integer) deprecated and replaced by pictureOf Example: 5 - `Image.imageSize` (string) A size for the image to return, allowing you to set image quality. Hospitality APIs no longer support thumbnail. Enum: same as `Vehicle.Image.imageSize` in "ProductVehicle" (5 values) - `Image.pictureOf` (string) The image category Enum: same as `Vehicle.Image.pictureOf` in "ProductVehicle" (26 values) - `URL` (string) A URL for this block - `DateCreateModify` (object, required) Time stamp of the creation. - `DateCreateModify.value` (string) Example: "2026-03-04T11:22:00Z" - `DateCreateModify.creatorID` (string) ID of creator. Software system identifier or an employee id Example: "c1234563" - `DateCreateModify.lastModify` (string) Time stamp of last modification. Example: "2026-03-04T11:24:00Z" - `DateCreateModify.lastModifierID` (string) Identifies the last software system or person to modify a record Example: "m346789" - `DateCreateModify.purge` (string) Date an item will be purged from a system of record Example: "2026-03-03" - `TextBlock.@type` (string, required) Discriminator classes TextBlock or TextBlockDetail Example: "TextBlockDetail" - `TextBlock.title` (string) "The title of the rule or information. For TermsAndConditionsFullHospitality, may include any of the following Rule Types; Promotional Data, Rate Description, Room Rate Data, Rate Text, Guarantee, Cancellation, Deposit, Check in/out, Room detail, Extra charges, Packages, Property, Location, Miscellaneous, Rate Amount, Alternate Rate Amount, Rate Comment, FAX, Phone, Special Information, Information, Room Hold Expiration Time. Not every property returns all of these types. Some properties do not return any title. Only English is supported for these values." Example: "Baggage Details" - `TextBlock.id` (string) Internally referenced id Example: "2" - `TextBlock.TextFormatted` (array, required) - TermsAndConditionsFullSummary: - `ExpiryDate` (string) The data and time the offer will expire Example: "2022-08-07T12:12:00Z" - `CustomerLoyalty` (array) - `CustomerLoyalty.value` (string, required) Number on loyalty card. Example: "132456" - `CustomerLoyalty.id` (string) Optional Customer Loyalty Id. Not saved Example: "Loyalty_1" - `CustomerLoyalty.priority` (integer) Optional Numeric Priority Code Example: 2 - `CustomerLoyalty.programId` (string) "Specifies an identifier to indicate the company owner of the loyalty program. Typically two characters. For frequent guest number, the hotel supplier or brand code. For frequent flyer number, the air supplier code of the loyalty program." Example: "HY" - `CustomerLoyalty.programName` (string) Supplier's loyalty program name. Example: "Frontier-EarlyReturns" - `CustomerLoyalty.supplierType` (string) The type of supplier of a loyalty program. Uses 'hotel' for frequent guest number or 'air' for frequent flyer number. Example: "Hotel" - `CustomerLoyalty.supplier` (string) Supplier of a loyalty program (typically 2 characters representing the hotel, brand, or airline). Example: "UA" - `CustomerLoyalty.tier` (string) Customer Loyalty tier Example: "Silver" - `CustomerLoyalty.shareWithSupplier` (array) The list of suppliers that the CustomerLoyalty number is shared. Used for cross accrual. Example: ["LH"] - `CustomerLoyalty.cardHolderName` (string) Customer loyalty member name; up to 128 characters are supported. In Air Search, for discounted offers to be returned, the name must be sent as LAST FIRST; e.g.,if SMITH is the last name and JORDAN the first name, send as SMITH JORDAN Example: "John Smith" - `CustomerLoyalty.validatedInd` (boolean) Customer loyalty number has been validated by the supplier Example: true - `CustomerLoyalty.prefix` (string) The cardholder name prefix title like Mr, Mrs, Dr Example: "Dr" - `CustomerLoyalty.given` (string) The First Name of the Cardholder Example: "John" - `CustomerLoyalty.middle` (string) Middle Name of the Cardholder Example: "Wilkinson" - `CustomerLoyalty.surname` (string) Last Name of the Cardholder Example: "Smith" - `TextBlock` (array) - `sequence` (integer) The order of the text block, if there are more than one block. Example: 2 - `description` (string) Text block detail description Example: "description" - `Image` (object) Each instance is one image and its accompanying details, including a link to the image. Key value pairs; not all may be returned. - `Image.value` (string) URL of the image - `Image.dimensionCategory` (string) Deprecated and replaced by imageSize - `Image.width` (integer) Image width Example: 42 - `Image.height` (integer) Image height Example: 43 - `Image.caption` (string) Image caption Example: "Ticket" - `Image.pictureCategory` (integer) deprecated and replaced by pictureOf Example: 5 - `Image.imageSize` (string) A size for the image to return, allowing you to set image quality. Hospitality APIs no longer support thumbnail. Enum: same as `Vehicle.Image.imageSize` in "ProductVehicle" (5 values) - `Image.pictureOf` (string) The image category Enum: same as `Vehicle.Image.pictureOf` in "ProductVehicle" (26 values) - `URL` (string) A URL for this block - `DateCreateModify` (object, required) Time stamp of the creation. - `DateCreateModify.value` (string) Example: "2026-03-04T11:22:00Z" - `DateCreateModify.creatorID` (string) ID of creator. Software system identifier or an employee id Example: "c1234563" - `DateCreateModify.lastModify` (string) Time stamp of last modification. Example: "2026-03-04T11:24:00Z" - `DateCreateModify.lastModifierID` (string) Identifies the last software system or person to modify a record Example: "m346789" - `DateCreateModify.purge` (string) Date an item will be purged from a system of record Example: "2026-03-03" - `TextBlock.@type` (string, required) Discriminator classes TextBlock or TextBlockDetail Example: "TextBlockDetail" - `TextBlock.title` (string) "The title of the rule or information. For TermsAndConditionsFullHospitality, may include any of the following Rule Types; Promotional Data, Rate Description, Room Rate Data, Rate Text, Guarantee, Cancellation, Deposit, Check in/out, Room detail, Extra charges, Packages, Property, Location, Miscellaneous, Rate Amount, Alternate Rate Amount, Rate Comment, FAX, Phone, Special Information, Information, Room Hold Expiration Time. Not every property returns all of these types. Some properties do not return any title. Only English is supported for these values." Example: "Baggage Details" - `TextBlock.id` (string) Internally referenced id Example: "2" - `TextBlock.TextFormatted` (array, required) - `Offer.TermsAndConditionsFull.@type` (string, required) Discriminator - Air Price child classes are TermsAndConditionsFullAir and TermsAndConditionsFullAncillary. - Hotel Rules and Reservation class is TermsAndConditionsFullHospitality. - Vehicle Rules and Reservation class is TermsAndConditionsFullVehicle. - Reservation and Reservation Workbench APIs child classes are TermsAndConditionsFullAir, TermsAndConditionsFullAncillary, TermsAndConditionsFullHospitality, TermsAndConditionsFullVehicle, TermsAndConditionsFullVehicle, and TermsAndConditionsFullScheduleChange. Example: "TermsAndConditionsFullAir" - `Offer.TermsAndConditionsFull.id` (string) Local identifier within a given message for this object. Example: "TC_1" - `Offer.TermsAndConditionsFull.termsAndConditionsRef` (string) Used to reference another instance of this object in the same message. Example: "TC_1" - `Offer.TermsAndConditionsFull.Identifier` (object) A globally unique identifier key often used to reference a given option (such as Pricing, Booking, Rules, or additional workflows) or to retrieve information (such as Hotel pagination). - `Offer.passiveOfferInd` (boolean) Indicates aggregator segment built into PNR. Always send with true when using in a request. If returned true in a response, the Offer is passive for booking purposes. Example: true - `Offer.scheduleChangeInd` (boolean) If true, this Offer is subject to a schedule change. - ReferenceListBrand: - `Brand` (array) Each instance provides details for one BrandRef id. - `Brand.@type` (string, required) Discriminator. Child classes BrandID and Brand. BrandCompleteInfo is no longer in use. Example: "BrandID" - `Brand.id` (string) Local id within a given message to support referencing this object. Example: "brand_001" - `Brand.BrandRef` (string) Reference id that corresponds to the brand 'id' in ReferenceListBrand.Brand. Example: "brandRef_001" - `Brand.Identifier` (object) A globally unique identifier key often used to reference a given option (such as Pricing, Booking, Rules, or additional workflows) or to retrieve information (such as Hotel pagination). - `Brand.name` (string, required) Brand name from the supplier. Example: "Main Cabin Extra" - `Brand.tier` (integer) The brand tier. Not returned for NDC. Example: 2 - `Brand.shelfNumbers` (array) ATPCO shelf number. If the carrier has provided it for this brand, the shelf number is the number for a grouping of comparable brands that share similar ticket and flight attributes. Example: [1,4,5] - `Brand.code` (string) The ATPCO Brand Code. Example: "REFMAIN" - `Brand.BrandAttribute` (array) A list of enumerated features that are included, chargeable, or not offered for this brand. Contains one or more instances of the two paired key value pairs classification and inclusion. The return of brand attributes can be disabled in the AirPrice Reference Payload request. - `Brand.BrandAttribute.@type` (string, required) Discriminator. No child classes. Example: "BrandAttribute" - `Brand.BrandAttribute.classification` (string, required) The Travelport classification used for a category of ancillaries. Additional items can be sent in AdditionalClassification Enum: same as `BrandAttribute.classification` (11 values) - `Brand.BrandAttribute.inclusion` (string, required) The indicator as to how the brand and the product are associated. Enum: same as `BrandAttribute.inclusion` (3 values) - `Brand.BrandAttribute.ImageURL` (array) URL for an image for the brand, when available. Example: ["http:/imageurl.com"] - `Brand.BrandAttribute.matchedAttributeInd` (boolean) Returned only if true for any attribute requested in ProductInclusionPreference.Classification. Example: true - `Brand.BrandAttribute.groupCode` (string) Carrier group code. Returned if filed by the carrier. Example: "BG" - `Brand.BrandAttribute.subGroupCode` (string) Carrier sub group code. Returned if filed by the carrier. Example: "CY" - `Brand.BrandAttribute.subCode` (string) Carrier sub code. Returned if filed by the carrier. Example: "08A" - `Brand.AdditionalBrandAttribute` (array) Array of non-enumerated features that are included, chargeable, or not offered for this brand. Contains one or more instances of the two paired key value pairs classification and inclusion. - `Brand.AdditionalBrandAttribute.@type` (string, required) Discriminator. No child classes. Example: "AdditionalBrandAttribute" - `Brand.AdditionalBrandAttribute.Classification` (string, required) The Travelport classification used for categories of ancillaries. Supported attributes currently include ChauffeurTransfer, ExtraLegroom, InFlightEntertainment, LoungeAccess, PriorityBaggage, PriorityBoarding, PriorityCheckIn, PrioritySecurity, PriorityServices,MileageAccrual, Upgrades, USB. Example: "ChauffeurTransfer" - `Brand.AdditionalBrandAttribute.Inclusion` (string, required) The indicator as to how the brand and the product are associated. Enum: same as `BrandAttribute.inclusion` (3 values) - `Brand.AdditionalBrandAttribute.ImageURL` (array) URL for an image for the brand, when available. Example: ["https:/travelport/image/profile/firstviewimage"] - `Brand.AdditionalBrandAttribute.matchedAttributeInd` (boolean) Returned only if true for any attribute requested in ProductInclusionPreference.Classification. Example: true - `Brand.AdditionalBrandAttribute.groupCode` (string) Carrier group code. Returned if filed by the carrier. Example: "BG" - `Brand.AdditionalBrandAttribute.subGroupCode` (string) Carrier sub group code. Returned if filed by the carrier. Example: "CY" - `Brand.AdditionalBrandAttribute.subCode` (string) Carrier sub code. Returned if filed by the carrier. Example: "08A" - `Brand.ImageURL` (array) Example: ["http:/imageurl.com"] - ReferenceListTermsAndConditions: - `TermsAndConditions` (array) — one of (discriminator: @type): - TermsAndConditionsAir: - `BaggageAllowance` (array) - `url` (string) Link to additional baggage policy information. Example: "https://airline/baggage" - `BaggageAllowance.@type` (string, required) Discriminator. Child class BaggageAllowanceDetail Example: "BaggageAllowanceDetail" - `BaggageAllowance.passengerTypeCodes` (array) All PTCs to which this allowance applies. Example: ["ADT"] - `BaggageAllowance.baggageType` (string) Identifies the type of baggage. Enum: "CarryOn", "FirstCheckedBag", "SecondCheckedBag", "AdditionalBags", "BaggageEmbargo" - `BaggageAllowance.validatingAirlineCode` (string) The validating baggage airline code Example: "BA" - `BaggageAllowance.ProductRef` (array) The Product id/s to which this baggage allowance applies. Example: ["p1","p2"] - `BaggageAllowance.BaggageItem` (array) - `BaggageAllowance.BaggageItem.@type` (string) Example: "BaggageItem" - `BaggageAllowance.BaggageItem.quantity` (integer) The number of baggage items allowed. May be free or at a charge. Not returned for baggage allowances by weight. Example: 2 - `BaggageAllowance.BaggageItem.includedInOfferPrice` (string) Yes , No , Unknown Enum: same as `instantPurchase` in "AdvanceReservationRequired" (3 values) - `BaggageAllowance.BaggageItem.Measurement` (array) Measurement details for BaggageItem as available and applicable. Baggage measurements are not always returned. - measurementType: Type of measurement specified, such as weight, height, width, etc. - unit: Unit in which measurement is specified, such as Kilograms, Inches, Centimeters, etc. - value: The number of units allowed for this measurement type. NDC returns quantity and Measurement info for FirstCheckedBag, SecondCheckedBag, AdditionalBags, and CarryOn when returned by the NDC carrier. NDC returns measurements in structured format in the Search response when the NDC carrier returns them this way. Otherwise, the measurements are returned in Text. For GDS, baggage measurements are returned in Text. - `BaggageAllowance.BaggageItem.BaggageFee` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `BaggageAllowance.BaggageItem.BaggageFee.value` (number) The amount of a given currency. Example: 124.56 - `BaggageAllowance.BaggageItem.BaggageFee.code` (string) An ISO 4217 alpha character code (3 characters) that specifies a money unit. Example: "USD" - `BaggageAllowance.BaggageItem.BaggageFee.minorUnit` (integer) Minor units are a mechanism for expressing the relationship between a major currency unit and its corresponding minor currency unit. It is the smallest unit of a given currency. For example; the smallest denomination in USD is the cent, which is 1/100 of a USD, and the minor unit value is 2. Not all currencies have a minor unit. Example: 2 - `BaggageAllowance.BaggageItem.BaggageFee.currencySource` (string) The system requesting or returning the currency code specified in the attribute Enum: same as `MinimumAdcolAmount.currencySource` in "ChangePermitted" (3 values) - `BaggageAllowance.BaggageItem.BaggageFee.approximateInd` (boolean) "If true, the currency amount has been converted from the original amount. For Air Exchange Eligibility, returned only if a currency is converted. If returned, the value is always true, indicating that the fee is approximate because of currency conversion. For Hotel Availability and Rules, true indicates this is a calculated value; false indicates this is the value returned by the property." Example: true - `BaggageAllowance.BaggageItem.Text` (string) Any free text provided by carrier for baggage terms. May provide measurements for the allowed baggage dimension. When the baggage allowance is based on pieces, Text returns 0P, 1P, 2P, or 3P, defined as follows, for FirstCheckedBag, SecondCheckedBag, AdditionalBags, and/or CarryOn. - 0P: No free bags. - 1P: The FirstCheckedBag is free; the SecondCheckedBag has a fee. - 2P: Both the FirstCheckedBag and SecondCheckedBag are free. - 3P: Both the FirstCheckedBag and SecondCheckedBag are free, plus an additional checked bag (AdditionalBags) is free." Example: "UPTO15LB/7KG AND UPTO45LI/115LCM" - `BaggageAllowance.BaggageItem.soldByPieceInd` (boolean) Returned only if true. Indicates baggage allowance is by piece, such as one, two, or three pieces. Weight restrictions may also apply. - `BaggageAllowance.BaggageItem.soldByWeightInd` (boolean) Returned only if true. Indicates the baggage is allowed by weight, either kilograms or pounds, such as 50 pounds or 35 kilograms. Number of item restrictions may also apply. - `BaggageAllowance.SegmentSequenceList` (array) Segment/s on which this baggage allowance applies. Segment sequence is only to be used when the baggage allowance differs between segments within a product. If so, then the ProducRef must be specified. Example: [12,45,3,2] - `BaggageAllowance.Text` (array) Example: ["Blue baggage allowed","Purple baggage allowed"] - `FareRuleIdentifierRef` (object) Identifier references as object both within a message payload or an object held in cache that may be used for subsequent workflows. FareRuleIdentifierRef is deprecated and not in use. Use Fare Rule end points directly for detailed fare rules. - `FareRuleIdentifierRef.value` (string) - `FareRuleIdentifierRef.id` (string) A locally referenced ID - `FareRuleIdentifierRef.description` (string) Descriptive text used to identify the contents of a target object - `FareRuleIdentifierRef.uris` (array) Uniform Resource Identifier Example: ["google.com"] - `OrganizationInformation` (object) Use to send account codes for negotiated fares or to send optional India GST SSR Remarks in GSTRegistrationNumber. For NDC supports corporate loyalty program and GST Information. This information is returned in TermsAndConditions." - `OrganizationInformation.@type` (string, required) Discriminator. No child classes Example: "OrganizationInformation" - `OrganizationInformation.OrganizationIdentifier` (array) Array of account codes to return negotiated fares. The response returns an instance of TermsAndConditions/OrganizationInformation/OrganizationIdentifier for each account code sent. When FareSelection/fareType=PrivateFaresOnly and an account code is sent in OrganizationIdentifier, AirPrice ignores the account code. Instead, AirPrice returns any private fares available for that market and a booking code for your PCC. This prevents the return of an error message when no specific fare has been filed for that account code. - `OrganizationInformation.OrganizationIdentifier.value` (string) The value of the code to apply. Example: "JBD123456" - `OrganizationInformation.OrganizationIdentifier.supplier` (string) The IATA code for the airline on which the code is applicable. Example: "AA" - `OrganizationInformation.OrganizationIdentifier.organizationCodeType` (string) Sends a description for the OrganizationIdentifer value. For AirPrice, always send with a value of Account. Enum: "Account", "OrganizationLoyaltyProgram", "Tour", "TicketDesignator" - `OrganizationInformation.OrganizationIdentifier.segmentSequenceList` (array) Returned in response when the code is applicable to a specified segment sequence Example: [1,2,3] - `OrganizationInformation.OrganizationIdentifier.productRef` (array) Returned in response when the code is applicable to a specified product Example: ["product_1"] - `OrganizationInformation.OrganizationIdentifier.accountCodeFaresOnlyInd` (boolean) GDS only; not supported for NDC. Not supported in Standalone Price. Indicator to limit the fares returned to only fares filed for the specified account code. - If true: Limits the fares returned to only fares filed for that account code; must send with one or more account codes in OrganizationIdentifier/value. If sending multiple account codes, send each instance with accountCodeFaresOnlyInd set to true. - If false (default behavior): does not limit fares returned to any account code sent. If an account code is sent without accountCodeFaresOnlyInd=true, the response includes any fares filed for that account code plus fares that are not specific to the account code. If accountCodeFaresOnlyInd=true and no account code is sent, the indicator is ignored and the response returns all fares and a warning message that the request must include an account code. Note the following when also requesting private fares only: - FareSelection/fareType=PrivateFaresOnly and account code: Private fares are returned. - FareSelection/fareType=PrivateFaresOnly, accountCodeFaresOnlyInd=true, and account code: Any private fares specific to that account code are returned if available. If no private fares exist for that account code, an error message is returned. Note the following when also requesting net fares: - FareSelection/fareType=NetFaresOnly and account code: Net fares are returned. - FareSelection/fareType=NetFaresOnly, accountCodeFaresOnlyInd=true, and account code: Any net fares specific to that account code are returned if available. If no net fares exist for that account code, an error message is returned. Example: true - `OrganizationInformation.GSTRegistrationNumber` (array) Send to add India GST (Goods and Services Tax) Special Service Requests. In this case country should be IND. Supported during book 'Add Offer' workflow. See the [India GST SSRs](https://developer.travelport.com/docs/flights/guides/booking-and-reservations/remarks-and-service-requests#india-gst-ssr) in the Remarks & Service Requests Guide for important details. - `OrganizationInformation.GSTRegistrationNumber.value` (string, required) The GST registered number for the business. Example: "07AAGFF2194N1Z1" - `OrganizationInformation.GSTRegistrationNumber.telephone` (string, required) Business telephone number Example: "222-222-222" - `OrganizationInformation.GSTRegistrationNumber.address` (string, required) Business address Example: "1122 sample trail, CO, USA, 21232" - `OrganizationInformation.GSTRegistrationNumber.country` (string, required) IATA country code of the business. Example: "IND" - `OrganizationInformation.GSTRegistrationNumber.companyName` (string, required) Business name Example: "Adecco" - `OrganizationInformation.GSTRegistrationNumber.email` (string, required) Business E-Mail address Example: "sample@adecco.com" - `ValidatingAirline` (array) Each instance lists the carrier on which the ticket is issued. - `ValidatingAirline.@type` (string) Example: "ValidatingAirline" - `ValidatingAirline.SegmentSequenceList` (array) The segmentSequenceList the validatingCarrier applies to Example: [2,4,6,8,10] - `ValidatingAirline.ValidatingAirline` (string, required) Represents the airline responsible for ticketing\/fulfillment of this Offer Example: "QA" - `ValidatingAirline.ProductRef` (array) The productRef the validatingCarrier applies to Example: ["product1","product2","product3"] - `TicketingAgency` (array) If TicketingPCC was sent in the request to override the default ticketing agency, TicketingAgency returns the PCC of the overriding agency. If no override request was made, TicketingAgency returns the default PCC. GDS only; not supported for NDC. - `TicketingAgency.@type` (string) Example: "TicketingAgency" - `TicketingAgency.Code` (string, required) PCC of the overriding or default ticket agency. Example: "A561510" - `TicketingAgency.ProductRef` (array) Product references to which this ticketing agency PCC applies. If empty applies to all products within the offer. Example: ["p1","p2","p3"] - `TicketingAgency.SegmentSequenceList` (array) SegmentSequenceList the TicketingAgency applies to. If empty applies to all segments within the product. Example: [31,28,43,42,51,26] - `PaymentTimeLimit` (string) The local (per the point of sale) date and time by which the offer must be ticketed. Returned for GDS offers and some NDC airlines. Example: "2022-08-07T12:12:00Z" - `PromotionalCode` (object) NDC only. Not supported for GDS. Any NDC airline designated promotional code. - `PromotionalCode.value` (string) The promotional code to apply Example: "CDFRT" - `PromotionalCode.supplierCode` (string, required) The IATA code for the airline on which the promotional code is applicable. Example: "AA" - `Penalties` (array) Air Search returns change and cancel penalties for this set of terms and conditions. For GDS, Penalties are currently returned as the most restrictive CAT16 penalty details; NDC penalty rules are not necessarily filed in a specific category (CAT). Returned by default. Not returned if the optional indicator excludePenaltiesInd=true (GDS only), which omits penalty information from the response. Includes the PassengerTypeCodes object and either or both the Change and Cancel objects. Not all NDC carriers return penalty details. Some NDC carriers may not return Penalty/amount when a change is permitted, which means there is no charge for the change. - `Penalties.@type` (string, required) Discriminator. No child classes. Example: "Penalties" - `Penalties.Change` (array) — one of (discriminator: @type): Details about maximum or minimum change fees charged for changes to this itinerary. Returned in Penalties object with type ChangePermitted if a change is permitted after booking. - ChangeIndeterminate: - `IndeterminateInd` (string) Structured fare rules could not be determined for this category. Example: "true" - ChangePermitted: - `penaltyTypes` (array, required) Enum: same as `penaltyTypes` in "ChangePermitted" (8 values) - `PenaltyAppliesTo` (string) Returned in Change and Cancel objects to specify what the change or cancel penalty applies to. Enum: same as `PenaltyAppliesTo` in "ChangePermitted" (5 values) - `Penalty` (array) — one of (discriminator: @type): - PenaltyAmount: - `Amount` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - PenaltyPercent: - `Percent` (number) Percent of the fare charges for the penalty Example: 20 - `Penalty.@type` (string, required) Discriminator. Child classes PenaltyAmount or PenaltyPercent Example: "PenaltyAmount" - `Penalty.application` (string) Type of commission Enum: same as `PriceBreakdown.Commission.application` (6 values) - `higherPenatltyAppliesInd` (boolean) If true, when an amount and a percent are specified in the Penalty then the higher of these apply Example: true - `MinimumAdcolAmount` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `ChangeMethod` (string) Ticket must be reissued, revalidated or both Enum: same as `ChangeMethod` in "ChangePermitted" (3 values) - `ResidualValuePenalty` (string) List of Residual Value Penalty types. Enum: same as `ResidualValuePenalty` in "ChangePermitted" (4 values) - `PeriodBeforeDeparture` (object) The first occurrence (if day of week) or the unit of time - `PeriodBeforeDeparture.value` (integer) Example: 1 - `PeriodBeforeDeparture.period` (string) Defines the Units that can be applied to Stay restrictions. Enum: same as `PeriodBeforeDeparture.period` in "ChangePermitted" (11 values) - `PenaltyException` (object) The first occurrence (if day of week) or the unit of time - `PenaltyException.value` (integer) Example: 1 - `PenaltyException.period` (string) Defines the Units that can be applied to Stay restrictions. Enum: same as `PeriodBeforeDeparture.period` in "ChangePermitted" (11 values) - `PenaltyException.appliesAfterReservationInd` (boolean) If true, exception applies after reservation has been made - `PenaltyException.appliesAfterTicketingInd` (boolean) If true, exception applies after ticketing - ChangeNotPermitted: - `NotPermittedInd` (string) Changes are not permitted Example: "true" - `penaltyTypes` (array) Enum: same as `penaltyTypes` in "ChangePermitted" (8 values) - `PeriodBeforeDeparture` (object) The first occurrence (if day of week) or the unit of time - `PeriodBeforeDeparture.value` (integer) Example: 1 - `PeriodBeforeDeparture.period` (string) Defines the Units that can be applied to Stay restrictions. Enum: same as `PeriodBeforeDeparture.period` in "ChangePermitted" (11 values) - `taxesNonRefundableInd` (boolean) if true, for non-refundable fares taxes are also non-refundable. Example: true - `Penalties.Change.@type` (string, required) Discriminator. Child classes ChangePermitted, ChangeNotPermitted, and ChangeIndeterminate. Example: "ChangePermitted" - `Penalties.Change.ProductRefs` (array) List of product reference ids to which these penalties apply, if applicable only to specific products. Example: ["p1","p2"] - `Penalties.Change.SegmentSequence` (array) List of segment sequence numbers to which these penalties apply, if applicable only to specific segments. Example: [1] - `Penalties.Cancel` (array) — one of (discriminator: @type): Returned in Penalties object with type CancelPermitted if a cancellation is permitted after booking. - CancelIndeterminate: - `IndeterminateInd` (string) structured fare rules could not be determined for this category Example: "true" - CancelPermitted: - `penaltyTypes` (array, required) Enum: same as `penaltyTypes` in "ChangePermitted" (8 values) - `PenaltyAppliesTo` (string) Returned in Change and Cancel objects to specify what the change or cancel penalty applies to. Enum: same as `PenaltyAppliesTo` in "ChangePermitted" (5 values) - `Penalty` (array) — one of (discriminator: @type): - PenaltyAmount: - `Amount` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - PenaltyPercent: - `Percent` (number) Percent of the fare charges for the penalty Example: 20 - `Penalty.@type` (string, required) Discriminator. Child classes PenaltyAmount or PenaltyPercent Example: "PenaltyAmount" - `Penalty.application` (string) Type of commission Enum: same as `PriceBreakdown.Commission.application` (6 values) - `higherPenatltyAppliesInd` (boolean) If true, when an amount and a percent are specified in the Penalty then the higher of these apply Example: true - `MinimumAdcolAmount` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `ChangeMethod` (string) Ticket must be reissued, revalidated or both Enum: same as `ChangeMethod` in "ChangePermitted" (3 values) - `ResidualValuePenalty` (string) List of Residual Value Penalty types. Enum: same as `ResidualValuePenalty` in "ChangePermitted" (4 values) - `PeriodBeforeDeparture` (object) The first occurrence (if day of week) or the unit of time - `PeriodBeforeDeparture.value` (integer) Example: 1 - `PeriodBeforeDeparture.period` (string) Defines the Units that can be applied to Stay restrictions. Enum: same as `PeriodBeforeDeparture.period` in "ChangePermitted" (11 values) - `PenaltyException` (object) The first occurrence (if day of week) or the unit of time - `PenaltyException.value` (integer) Example: 1 - `PenaltyException.period` (string) Defines the Units that can be applied to Stay restrictions. Enum: same as `PeriodBeforeDeparture.period` in "ChangePermitted" (11 values) - `PenaltyException.appliesAfterReservationInd` (boolean) If true, exception applies after reservation has been made - `PenaltyException.appliesAfterTicketingInd` (boolean) If true, exception applies after ticketing - CancelNotPermitted: - `NotPermittedInd` (string) Cancel is not permitted Example: "true" - `penaltyTypes` (array) Enum: same as `penaltyTypes` in "ChangePermitted" (8 values) - `PeriodBeforeDeparture` (object) The first occurrence (if day of week) or the unit of time - `PeriodBeforeDeparture.value` (integer) Example: 1 - `PeriodBeforeDeparture.period` (string) Defines the Units that can be applied to Stay restrictions. Enum: same as `PeriodBeforeDeparture.period` in "ChangePermitted" (11 values) - `taxesNonRefundableInd` (boolean) if true, for non-refundable fares taxes are also non-refundable Example: true - `Penalties.Cancel.@type` (string, required) discriminator Example: "CancelPermitted" - `Penalties.Cancel.ProductRefs` (array) The product ids this cancel information applies to. Example: ["p1","p2"] - `Penalties.Cancel.SegmentSequence` (array) The list of any segment sequence numbers this cancelation information applies to. Example: [1] - `Penalties.Waiver` (array) Enum: same as `StructuredFareRules.Penalties.Waiver` in "FareRuleStructured" (6 values) - `Penalties.PenaltySourceCode` (object) The source of the penalty applied. - `Penalties.PenaltySourceCode.value` (string) Example: "Properties of the penalty" - `Penalties.PenaltySourceCode.codeContext` (string) Penalty source code context Example: "Context of the penalty source" - `Penalties.PassengerTypeCodes` (array) The passenger type codes that the penalties apply to. Example: ["ADT","CHD"] - `Penalties.involuntaryInd` (boolean) Penalties apply for involuntary changes initiated by the airline. Example: true - `Penalties.applyLeastRestrictiveInd` (boolean) If true, the least restrictive of the rule hierarchy is applied. Example: true - `Penalties.ruleNumber` (string) The rule number associated to this fare rule info. Example: "D38" - `Penalties.tariffNumber` (string) The tariff number associated to this fare rule info. Example: "01634" - `FareGuaranteePolicy` (array) - `FareGuaranteePolicy.@type` (string, required) discriminator Example: "FareGuaranteePolicy" - `FareGuaranteePolicy.passengerTypeCodes` (array) The list of passenger type codes Example: ["ADT","CHD"] - `FareGuaranteePolicy.EligibleforADMReview` (string, required) Yes , No , Unknown Enum: same as `instantPurchase` in "AdvanceReservationRequired" (3 values) - `FareGuaranteePolicy.Code` (object) Any code used to specify an item, for example a type of traveler, service code, room amenity, etc. - `FareGuaranteePolicy.Code.value` (string) Example: "INS" - `FareGuaranteePolicy.Code.codeContext` (string) Code Context Example: "ACRISS" - `PricingAgency` (array) - `PricingAgency.@type` (string) Discriminator. No child classes. Example: "PricingAgency" - `PricingAgency.ProductRef` (array) Product references to which this pricing agency PCC applies. If empty applies to all products within the offer. Example: ["p1"] - `PricingAgency.Code` (string, required) PCC of the overriding or default pricing agency. Example: "0XS4" - `PricingAgency.SegmentSequenceList` (array) SegmentSequence references to which this pricing agency PCC applies. If empty applies to all segments within the products. Example: [2,4,6,8,10] - `FlightPass` (array) - `FlightPass.@type` (string, required) Discriminator. No child classes Example: "FlightPass" - `FlightPass.accountNumber` (string, required) The flight pass account number Example: "0140851633093" - `FlightPass.supplier` (string, required) The flight pass supplier code Example: "AC" - `FlightPass.Description` (array) Example: ["FlightPass"] - `FlightPass.TravelerIdentifierRef` (array) In Search, use the passengerCriteriaRef to reference the owner of the flightpass. This is a mandatory field for Search API. - `FlightPass.TravelerIdentifierRef.name` (string) Traveler identifier - `FlightPass.TravelerIdentifierRef.passengerTypeCode` (string) Passenger Type code Example: "ADT" - `FlightPass.TravelerIdentifierRef.ages` (array) The ages of the travelers associated to a particular ptc. For NDC, this value will be returned in PriceBreakdownAir if sent as part of the PassengerCriteria in the Air Search request. Example: [15] - `FlightPass.TravelerIdentifierRef.passengerCriteriaRef` (string) Allows the user to associate passenger criteria information. Example: "passengerCriteria_1" - `FlightPass.TravelerIdentifierRef.value` (string) - `FlightPass.TravelerIdentifierRef.id` (string) A locally referenced ID - `FlightPass.TravelerIdentifierRef.description` (string) Descriptive text used to identify the contents of a target object - `FlightPass.TravelerIdentifierRef.uris` (array) Uniform Resource Identifier Example: ["google.com"] - `FlightPass.TravelerIdentifierRef.age` (integer) Replaced with ages array. The age of the traveler. Example: 11 - `instantPurchaseInd` (boolean) If true the Offer/Offering must be paid for at the same time as creating the Reservation. Example: true - `secureFlightPassengerDataRequiredInd` (boolean) Returned only when true to indicate the airline requires additional passenger data for one or more travelers to complete the reservation per Secure Flight Passenger Data requirements. Example: true - `TourCodes` (array) GDS only; not supported for NDC. Any tour code applicable to this fare, per PTC. Includes TravelerIdentifierRef and TourCode objects.A tour code is a carrier specified and agreed code for a negotiated fare. It is used by the BSP or ARC data processing center to perform a series of calculations that may be based on the itinerary, agency code, dates, and other transaction attributes. The tour code can help identify airline-specific incentive payments such as commissions for fares that offer the most revenue. - `TourCodes.@type` (string) Discriminator. No child classes. Example: "TourCodes" - `TourCodes.TravelerIdentifierRef` (array) Reference the traveler if the tour code is traveler specific. Leave blank to apply to all travelers. - `TourCodes.TourCode` (object, required) Tour code - `TourCodes.TourCode.value` (string) The actual value of the tour code. - `TourCodes.TourCode.tourCodeType` (string) List of tour code types. Enum: "Bulk Tour", "Inclusive Tour" - `DocumentValidDateRange` (object) The valid date range to be applied to the document. - `DocumentValidDateRange.@type` (string) Example: "DocumentValidDateRange" - `DocumentValidDateRange.ProductRef` (string) The product this document date range applies to. If blank, applies to all products. Example: "product_1" - `DocumentValidDateRange.SegmentSequenceList` (array) The segmentSequence within the product the action is being requested for. Used when multiple flights exist within a product. Only one product may be selected with this option. - `DocumentValidDateRange.ValidDateRange` (object) Specifies the begin and end date of an event, such as check-in and check-out dates. - `DocumentValidDateRange.ValidDateRange.start` (string, required) Specifies the start date for an event, such as a booking or check-in date in YYYY-MM-DD format. Example: "2026-03-03" - `DocumentValidDateRange.ValidDateRange.end` (string, required) Specifies the end date an event, such as a booking or check-out date in YYYY-MM-DD format. Example: "2026-03-03" - `flightPassInd` (boolean) If true, this offer is made in conjunction with a flight pass account. - `Restriction` (array) Not supported in Search response. - `Restriction.value` (string) Example: "No late arrivals" - `Restriction.segmentSequenceList` (array) Segment sequence list Example: [2,4,6,8,10] - `Restriction.productRef` (array) The productRef which the restriction applies to Example: ["p1","p2","p3","p4"] - `BaggageRecheck` (array) Not implemented. - `BaggageRecheck.@type` (string) Example: "BaggageRecheck" - `BaggageRecheck.At` (string, required) The city where the baggage recheck is required Example: "MEX" - `BaggageRecheck.ArrivalFlight` (object, required) Flight common schema. Used across Air workflow. One instance for each flight in the FlightSegment. A direct flight option has one Flight object while connecting flights have a Flight object for each flight on the leg. - `distance` (integer) Distance covered by the flight. Example: 6574 - `stops` (integer) Number of stops Example: 2 - `duration` (string) Elapsed flight time. Represented in hours (H) and minutes (M) OR the format PT{x}H{x}M, in which P is the duration designator, T is the time designator, {x}H is the number of hours for the connection, and {x}H is the number of minutes for the connection. Example: "PT1H40M" - `carrier` (string, required) The airline code. Example: "BA" - `number` (string, required) The marketing carrier flight number. Example: "98" - `operatingCarrier` (string) The operating airline code. Shown in codeshare situations when the operating carrier is different to the marketing carrier. Example: "BA" - `operatingCarrierName` (string) The operating carrier name Example: "Liberty Aerospace" - `operatingCarrierNumber` (string) Operating airline flight number. If there is no operating carrier number, then CO2 emission estimates for operating carriers is not supported. GDS only; not returned for NDC. Returned only in Search response. Example: "091" - `equipment` (string) Equipment model. Note that TRN, TRS, and BUS equipment codes indicate ground transportation. Example: "777" - `Departure` (object, required) Departure details for a given leg. - `terminal` (string) Departure terminal, returned when available. Example: "Terminal 1" - `country` (string) Country of to departure or arrival Example: "US" - `Departure.@type` (string, required) Discriminator classes Departure or DepartureDetail Example: "DepartureDetail" - `Departure.location` (string, required) IATA code for departure airport or city for this leg of the itinerary. Example: "AMS" - `Departure.date` (string, required) Departure date in YYYY-MM-DD format. Example: "0011-10-17" - `Departure.time` (string, required) Departure date in HH:mm:ss (24-hour format). Example: "04:45:00" - `Arrival` (object, required) - `terminal` (string) Arrival terminal, returned when available. Example: "Terminal 1" - `country` (string) Country of to departure or arrival Example: "US" - `Arrival.@type` (string, required) Discriminator classes Arrival or ArrivalDetail Example: "ArrivalDetail" - `Arrival.location` (string, required) IATA code for arrival airport or city for this leg of the itinerary. Example: "MAD" - `Arrival.date` (string, required) Arrival date in YYYY-MM-DD format. Example: "0011-10-17" - `Arrival.time` (string) Arrival date in HH:mm:ss (24-hour format). Example: "04:45:00" - `IntermediateStop` (array) - `IntermediateStop.value` (string) The IATA airport code for the airport where the intermediate stop occurs. - `IntermediateStop.arrivalFlightDuration` (string) Duration in hours and minutes of the flight arriving at the intermediate stop. ISO 8601 format Example: "PT2H35M" - `IntermediateStop.departureFlightDuration` (string) Duration in hours and minutes of the flight departing the intermediate stop. ISO 8601 format Example: "PT1H35M" - `IntermediateStop.duration` (string) Duration in hours and minutes between the arrival and departure at the intermediate stop. ISO 8601 format Example: "PT1H35M" - `IntermediateStop.equipment` (string) Equipment model, if there is a change of equipment during the stop. Example: "777" - `IntermediateStop.arrivalDate` (string) The local date the aircraft arrives at the intermediate stop Example: "2026-04-30" - `IntermediateStop.departureDate` (string) The local date the aircraft departs from the intermediate stop Example: "2026-04-30" - `IntermediateStop.arrivalTime` (string) The local time the aircraft arrives at the intermediate stop Example: "68400" - `IntermediateStop.departurelTime` (string) The local time the aircraft departs from the intermediate stop Example: "72000" - `IntermediateStop.arrivalTerminal` (string) Arrival terminal of the intermediate stop airport Example: "Terminal2" - `IntermediateStop.departureTerminal` (string) Departure terminal of the intermediate stop airport Example: "Terminal4" - `subjectToGovernmentApprovalInd` (boolean) If true, the airline has filed in its schedule that availability for a specific flight is subject to government approval. GDS only, not supported for NDC. Returned only in the Air Search API response. Example: true - `BaggageRecheck.DepartureFlight` (object, required) Flight common schema. Used across Air workflow. One instance for each flight in the FlightSegment. A direct flight option has one Flight object while connecting flights have a Flight object for each flight on the leg. - `distance` (integer) Distance covered by the flight. Example: 6574 - `stops` (integer) Number of stops Example: 2 - `duration` (string) Elapsed flight time. Represented in hours (H) and minutes (M) OR the format PT{x}H{x}M, in which P is the duration designator, T is the time designator, {x}H is the number of hours for the connection, and {x}H is the number of minutes for the connection. Example: "PT1H40M" - `carrier` (string, required) The airline code. Example: "BA" - `number` (string, required) The marketing carrier flight number. Example: "98" - `operatingCarrier` (string) The operating airline code. Shown in codeshare situations when the operating carrier is different to the marketing carrier. Example: "BA" - `operatingCarrierName` (string) The operating carrier name Example: "Liberty Aerospace" - `operatingCarrierNumber` (string) Operating airline flight number. If there is no operating carrier number, then CO2 emission estimates for operating carriers is not supported. GDS only; not returned for NDC. Returned only in Search response. Example: "091" - `equipment` (string) Equipment model. Note that TRN, TRS, and BUS equipment codes indicate ground transportation. Example: "777" - `Departure` (object, required) Departure details for a given leg. - `terminal` (string) Departure terminal, returned when available. Example: "Terminal 1" - `country` (string) Country of to departure or arrival Example: "US" - `Departure.@type` (string, required) Discriminator classes Departure or DepartureDetail Example: "DepartureDetail" - `Departure.location` (string, required) IATA code for departure airport or city for this leg of the itinerary. Example: "AMS" - `Departure.date` (string, required) Departure date in YYYY-MM-DD format. Example: "0011-10-17" - `Departure.time` (string, required) Departure date in HH:mm:ss (24-hour format). Example: "04:45:00" - `Arrival` (object, required) - `terminal` (string) Arrival terminal, returned when available. Example: "Terminal 1" - `country` (string) Country of to departure or arrival Example: "US" - `Arrival.@type` (string, required) Discriminator classes Arrival or ArrivalDetail Example: "ArrivalDetail" - `Arrival.location` (string, required) IATA code for arrival airport or city for this leg of the itinerary. Example: "MAD" - `Arrival.date` (string, required) Arrival date in YYYY-MM-DD format. Example: "0011-10-17" - `Arrival.time` (string) Arrival date in HH:mm:ss (24-hour format). Example: "04:45:00" - `IntermediateStop` (array) - `IntermediateStop.value` (string) The IATA airport code for the airport where the intermediate stop occurs. - `IntermediateStop.arrivalFlightDuration` (string) Duration in hours and minutes of the flight arriving at the intermediate stop. ISO 8601 format Example: "PT2H35M" - `IntermediateStop.departureFlightDuration` (string) Duration in hours and minutes of the flight departing the intermediate stop. ISO 8601 format Example: "PT1H35M" - `IntermediateStop.duration` (string) Duration in hours and minutes between the arrival and departure at the intermediate stop. ISO 8601 format Example: "PT1H35M" - `IntermediateStop.equipment` (string) Equipment model, if there is a change of equipment during the stop. Example: "777" - `IntermediateStop.arrivalDate` (string) The local date the aircraft arrives at the intermediate stop Example: "2026-04-30" - `IntermediateStop.departureDate` (string) The local date the aircraft departs from the intermediate stop Example: "2026-04-30" - `IntermediateStop.arrivalTime` (string) The local time the aircraft arrives at the intermediate stop Example: "68400" - `IntermediateStop.departurelTime` (string) The local time the aircraft departs from the intermediate stop Example: "72000" - `IntermediateStop.arrivalTerminal` (string) Arrival terminal of the intermediate stop airport Example: "Terminal2" - `IntermediateStop.departureTerminal` (string) Departure terminal of the intermediate stop airport Example: "Terminal4" - `subjectToGovernmentApprovalInd` (boolean) If true, the airline has filed in its schedule that availability for a specific flight is subject to government approval. GDS only, not supported for NDC. Returned only in the Air Search API response. Example: true - TermsAndConditionsAncillary: - `ApplicationLimit` (object) Exposes any limitation on the amount of ancillaries available for purchase. Example, start 1 end 3 ApplicableLevel Passenger would mean a minumum of 1 and maximum of 3 ancillary items may be purchased. - `ApplicationLimit.value` (string) The application of the ancillary Enum: "PassengerSegment", "Segment", "Itinerary", "Passengers", "PassengerOD", "Other" - `ApplicationLimit.start` (string) The start value Example: "45" - `ApplicationLimit.end` (string) The end value Example: "67" - `Refundability` (object) Describes the refundability of an Offer - `Refundability.value` (string) Describes the refundability of an Offer Enum: "Refundable", "NonRefundable", "Reusable" - `validatingAirline` (string) Represents the airline responsible for ticketing/fulfillment of this Offer. Example: "AA" - `fulfillmentType` (string) The EMD fulfillment types Enum: "EMD-S Standalone", "EMD-A Associated", "EMD-S Referenced", "Other" - `associatedItem` (string) The EMD Association types Enum: "Flight", "BaggageCharges" - `unsellableInd` (boolean) If true, this ancillary product can not be sold through Travelport systems. - `instantPurchaseInd` (boolean) If true, the Offer/Offering must be paid for at the same time as creating the Reservation. - TermsAndConditionsScheduleChange: - `ScheduleChangeOptions` (array) - `ScheduleChangeOptions.@type` (string, required) Example: "ScheduleChangeOptions" - `ScheduleChangeOptions.options` (array) List of available options. Enum: "Accept", "Reshop", "Refund" - `ScheduleChangeOptions.waiverCodeRequiredInd` (boolean) If true, a waiver code is required in subsequent reshop or refund transactions. Example: true - `ScheduleChangeOptions.reissueRequiredInd` (boolean) If true, the schedule change requires the original document to be reissued. Example: true - `ScheduleChangeOptions.documentsRevalidatedInd` (boolean) If true, the original documents associated to the Offer have already been revalidated with the new flight details. Example: true - `TermsAndConditions.@type` (string, required) Discriminator. - Air Search child classes are TermsAndConditionsAir and TermsAndConditionsAncillary. - Exchange Search child class is TermsAndConditionsAirChange. - Search Ancillaries and Seat Availabilities child classes are TermsAndConditions, TermsAndConditionsAncillary, and TermsAndConditionsAncillaryAir. - Hotel Availability child class is TermsAndConditionsHospitality. Example: "TermsAndConditionsAir" - `TermsAndConditions.id` (string) Local id within a given message to support referencing this object. For Air Search APIs, matches to the reference value in ProductBrandOffering/TermsAndConditions/termsAndConditionsRef in instances of ProductBrandOptions. Example: "TC_1" - `TermsAndConditions.termsAndConditionsRef` (string) Reference id that corresponds to the TermsAndConditions 'id' in ReferenceListTermsAndConditions.TermsAndConditions. Example: "TC_1" - `TermsAndConditions.Identifier` (object) A globally unique identifier key often used to reference a given option (such as Pricing, Booking, Rules, or additional workflows) or to retrieve information (such as Hotel pagination). - `TermsAndConditions.ExpiryDate` (string) The date and time in UTC the offer will expire. Not returned in GDS Search. NDC generally allows 20 to 30 minutes to create a booking (the offer time limit). That time limit varies by airline and is returned here in the Search response. Example: "2022-08-07T12:12:00Z" - `TermsAndConditions.CustomerLoyalty` (array) - `TermsAndConditions.CustomerLoyalty.value` (string, required) Number on loyalty card. Example: "132456" - `TermsAndConditions.CustomerLoyalty.id` (string) Optional Customer Loyalty Id. Not saved Example: "Loyalty_1" - `TermsAndConditions.CustomerLoyalty.priority` (integer) Optional Numeric Priority Code Example: 2 - `TermsAndConditions.CustomerLoyalty.programId` (string) "Specifies an identifier to indicate the company owner of the loyalty program. Typically two characters. For frequent guest number, the hotel supplier or brand code. For frequent flyer number, the air supplier code of the loyalty program." Example: "HY" - `TermsAndConditions.CustomerLoyalty.programName` (string) Supplier's loyalty program name. Example: "Frontier-EarlyReturns" - `TermsAndConditions.CustomerLoyalty.supplierType` (string) The type of supplier of a loyalty program. Uses 'hotel' for frequent guest number or 'air' for frequent flyer number. Example: "Hotel" - `TermsAndConditions.CustomerLoyalty.supplier` (string) Supplier of a loyalty program (typically 2 characters representing the hotel, brand, or airline). Example: "UA" - `TermsAndConditions.CustomerLoyalty.tier` (string) Customer Loyalty tier Example: "Silver" - `TermsAndConditions.CustomerLoyalty.shareWithSupplier` (array) The list of suppliers that the CustomerLoyalty number is shared. Used for cross accrual. Example: ["LH"] - `TermsAndConditions.CustomerLoyalty.cardHolderName` (string) Customer loyalty member name; up to 128 characters are supported. In Air Search, for discounted offers to be returned, the name must be sent as LAST FIRST; e.g.,if SMITH is the last name and JORDAN the first name, send as SMITH JORDAN Example: "John Smith" - `TermsAndConditions.CustomerLoyalty.validatedInd` (boolean) Customer loyalty number has been validated by the supplier Example: true - `TermsAndConditions.CustomerLoyalty.prefix` (string) The cardholder name prefix title like Mr, Mrs, Dr Example: "Dr" - `TermsAndConditions.CustomerLoyalty.given` (string) The First Name of the Cardholder Example: "John" - `TermsAndConditions.CustomerLoyalty.middle` (string) Middle Name of the Cardholder Example: "Wilkinson" - `TermsAndConditions.CustomerLoyalty.surname` (string) Last Name of the Cardholder Example: "Smith" - ReferenceListExchangedPrice: - `Price` (array, required) - `FlightPassCredits` (integer) The total number of flight pass credits consumed for this offer. Example: 2 - `PriceBreakdown` (array) — one of (discriminator: @type): - PriceBreakdownAir: - `quantity` (integer) Quantity of passengers in that PTC. Example: 2 - `requestedPassengerType` (string) The PTC to which the PriceBreakdown applies. Example: "CHD" - `FiledAmount` (object) Returned only in the Price APIs. GDS only; not supported for NDC. The base amount of a ticket price or net price that is filed in local currency. Returned when the origin currency is not the same as the PCC currency to show the currency in which the base fare has been filed. When used for NetBaseAmount: Net ticket data (NTD) is returned in the AirPrice, AirReservation, Exchange Search, and Reservation Retrieve responses for any GDS fare that has a private fare component (fareType=AgencyPrivateFare). When NTD is returned, TermsAndConditionsFuill includes FareGuaranteePolicy to return the fare calculation indicator for the fare. When NTD is returned, PriceBreakdown may include NetBaseAmount. - `FiledAmount.value` (number) Filed amount value Example: 43.3422 - `FiledAmount.currencyCode` (string) Code for the currency in which the base fare was filed. Example: "USD" - `FiledAmount.codeAuthority` (string) Filed amount currency code authority Example: "Australian Dollar" - `FiledAmount.decimalPlace` (integer, required) Number of decimal places in the currency in ISO 4217 standard format. Example: 3 - `FiledAmount.decimalAuthority` (string) ISO 4217 standard decimal authority Example: "ISO 4217" - `Discount` (object) NDC only; not supported for GDS. Returned for a fare discounted from the published price, such as a promotional discount. Not returned for privately negotiated discounts such as private fares. - `Discount.value` (number) The amount value of the discount Example: 20.22 - `Discount.description` (string) The text description for the discount. Example: "Spring discount on group bookings" - `Discount.currencyCode` (string, required) Currency code discount is returned in. Example: "USD" - `Discount.codeAuthority` (string, required) Not used. Currency code Authority. Example: "ISO" - `Discount.decimalPlace` (integer, required) Number of decimal places in the currency the discount is returned in. Example: 2 - `Discount.decimalAuthority` (string) Not used. Decimal Authority. Example: "ISO" - `NetFareInfo` (object) Detailed information on the net fare used. - `NetFareInfo.@type` (string, required) Example: "NetFareInfo" - `NetFareInfo.passengerTypeCode` (string) PassengerTypeCode Example: "ADT" - `NetFareInfo.NetFareBreakdownConstruction` (array) - `NetFareInfo.NetFareBreakdownConstruction.value` (string) - `NetFareInfo.NetFareBreakdownConstruction.fareType` (string) Assigned Type: c-1100:StringTiny - `NetFareInfo.NetFareBreakdownConstruction.rateOfExchange` (number) The rate of exchange applied to the fare breakdown - `NetFareInfo.TicketBaseAudit` (object) Returned only in the Price APIs. GDS only; not supported for NDC. The base amount of a ticket price or net price that is filed in local currency. Returned when the origin currency is not the same as the PCC currency to show the currency in which the base fare has been filed. When used for NetBaseAmount: Net ticket data (NTD) is returned in the AirPrice, AirReservation, Exchange Search, and Reservation Retrieve responses for any GDS fare that has a private fare component (fareType=AgencyPrivateFare). When NTD is returned, TermsAndConditionsFuill includes FareGuaranteePolicy to return the fare calculation indicator for the fare. When NTD is returned, PriceBreakdown may include NetBaseAmount. - `NetFareInfo.TicketBasePassenger` (object) The monetary value - `NetFareInfo.TicketBasePassenger.value` (number) - `NetFareInfo.TicketBasePassenger.currencyCode` (string) Assigned Type: c-1100:CurrencyCode - `NetFareInfo.TicketBasePassenger.codeAuthority` (string, required) Assigned Type: c-1100:CodeContext - `NetFareInfo.TicketBasePassenger.decimalPlace` (integer, required) Assigned Type: c-1100:CurrencyMinorUnit - `NetFareInfo.TicketBasePassenger.decimalAuthority` (string) Assigned Type: c-1100:CodeContext - `NetFareInfo.TicketBasePassenger.bTInd` (boolean) If true, this is a bulk ticket fare - `NetFareInfo.TicketBasePassenger.iTInd` (boolean) If true, this is an inclusive tour fare - `TravelerIdentifierRef` (object) Identifier references as object both within a message payload or an object held in cache that may be used for subsequent workflows. Returned for NDC in the Price response if age was sent for this traveler in the previous workflow requests. - `TravelerIdentifierRef.name` (string) Traveler identifier - `TravelerIdentifierRef.passengerTypeCode` (string) Passenger Type code Example: "ADT" - `TravelerIdentifierRef.ages` (array) The ages of the travelers associated to a particular ptc. For NDC, this value will be returned in PriceBreakdownAir if sent as part of the PassengerCriteria in the Air Search request. Example: [15] - `TravelerIdentifierRef.passengerCriteriaRef` (string) Allows the user to associate passenger criteria information. Example: "passengerCriteria_1" - `TravelerIdentifierRef.value` (string) - `TravelerIdentifierRef.id` (string) A locally referenced ID - `TravelerIdentifierRef.description` (string) Descriptive text used to identify the contents of a target object - `TravelerIdentifierRef.uris` (array) Uniform Resource Identifier Example: ["google.com"] - `TravelerIdentifierRef.age` (integer) Replaced with ages array. The age of the traveler. Example: 11 - `NetBaseAmount` (object) Returned only in the Price APIs. GDS only; not supported for NDC. The base amount of a ticket price or net price that is filed in local currency. Returned when the origin currency is not the same as the PCC currency to show the currency in which the base fare has been filed. When used for NetBaseAmount: Net ticket data (NTD) is returned in the AirPrice, AirReservation, Exchange Search, and Reservation Retrieve responses for any GDS fare that has a private fare component (fareType=AgencyPrivateFare). When NTD is returned, TermsAndConditionsFuill includes FareGuaranteePolicy to return the fare calculation indicator for the fare. When NTD is returned, PriceBreakdown may include NetBaseAmount. - `FareCalculation` (string) GDS only; not supported for NDC. For each PTC, when available, FareCalculation returns the fare calculation ladder for all public and private fare types filed by an agency or an airline. Example: "LON BA SYD R564.00YEE1Y BA LON R564.00YEE1Y NUC1128.00END ROE0.787855" - `Surcharges` (object) In AirSearch workflow this applies to GDS only. Not supported for NDC, which does not return surcharges. Returned if surcharges apply to this offer. For GDS only, for a multi-city offer with stopovers (see multi-city offers with stopovers for details), surcharges and commission amounts are for the entire journey. For all other offers, the surcharges and commission amounts are for each leg (origin and destination pair). A multi-city offer can be identified by the jc in its CombinabilityCode: jc1, jc2. Surcharges can be omitted from the Search response with excludeSurchargesInd. - `Surcharge` (array, required) - `Surcharge.value` (number) Surcharge amount Example: 12 - `Surcharge.currencyCode` (string) ISO 4217 currency code for the surcharge. Example: "USD" - `Surcharge.surchargeCode` (string) Surcharge code Example: "ADDITIONAL COSTS" - `Surcharge.reportingAuthority` (string) Not used. Surcharge reporting authority Example: "Federal register" - `Surcharge.purpose` (string) Surcharge purpose. For Air workflows possible values include Weekend Surcharge, Stopover Charge, Multiple Stopover Charges, Other (default value that covers all other surcharges such as fuel surcharges). Example: "Weekend Surcharge" - `Surcharge.description` (string) Description of the surcharge. Example: "Rollaway Surcharge" - `Surcharge.surchargeApplication` (string) Application values (such as the application of a fee) like per person or per room. Enum: same as `Surcharge.surchargeApplication` (7 values) - `Surcharge.surchargeFrequency` (string) The frequency of a fee such as per night or per stay. Enum: same as `Surcharge.surchargeFrequency` (6 values) - `Surcharge.codeAuthority` (string) Not used. Currency code authority. Example: "ISO 4217" - `Surcharge.decimalPlace` (integer) Decimal place for the currency unit. Example: 4 - `Surcharge.decimalAuthority` (string) Not used. Currency code decimal authority. Example: "ISO 4217" - `Surcharges.@type` (string, required) Discriminator class is SurchargesDetail Example: "SurchargesDetail" - `Surcharges.TotalSurcharges` (number) A monetary amount, up to 4 decimal places. Example: 211.11 - `Surcharges.approximateInd` (boolean) If true, the surcharge amounts are approximate. - `TravelerRefs` (array) Returned only in Reservation Retrieve to identify the traveler associated with this instance of PriceBreakdown in case of multiple offers on the booking. Example: ["[\"traveler_1\",\"traveler2\"]"] - `PaidTaxes` (object) Summary Taxes object - `Tax` (array) - `Tax.value` (number) Amount of the tax. Returned as 0 if a tax was marked as exempt with TaxExemption. Example: 12.2 - `Tax.currencyCode` (string) A ISO 4217 currency code associated to the value. Example: "USD" - `Tax.taxCode` (string) "Code for the tax. For Hotels this is the OTA code." Example: "XF2" - `Tax.reportingAuthority` (string) Identifies the reporting authority such as airport code for XF taxes Example: "JFK1" - `Tax.purpose` (string) Supplier returned description of tax. Example: "Fuel surcharge" - `Tax.description` (string) "Short summary of the tax. In Air workflows this is returned only for NDC. Note that descriptions are not returned for tax codes YQ and YR, which are fees charged by airlines and not government-imposed taxes. For Hotels this is the OTA tax description." Example: "Lodging tax" - `Tax.includedInBase` (string) Yes , No , Unknown Enum: same as `instantPurchase` in "AdvanceReservationRequired" (3 values) - `Tax.codeAuthority` (string) Not used. Currency Code Authority Example: "ISO" - `Tax.decimalPlace` (integer) Permitted number of decimals. Associated to the currency value. Example: 2 - `Tax.decimalAuthority` (string) Not used. Currency decimal authority Example: "ISO" - `Tax.exemptInd` (boolean) GDS only; not supported for NDC. Returned if a tax was marked exempt in a prior request with the TaxExemption pricing modifer. If true, this tax is exempt" Example: true - `Tax.nonRefundableInd` (boolean) If true, the tax is non refundable. This indicator is only supported for exchange search and exchange price quote transactions. Example: true - `Tax.excludedFromTotalPriceInd` (boolean) Returned in Hotel APIs when a tax is not included in the TotalPrice. Default behavior is for taxes to be included in TotalPrice. Example: true - `TaxPercent` (object) Returned when the tax is expressed as a percentage of the amount. - `TaxPercent.value` (number) The tax percentage amount. Example: 5.5 - `TaxPercent.taxCode` (string) Any code for the tax. Example: "971 - IRS Notice" - `TaxPercent.reportingAuthority` (string) Tax reporting authority Example: "Georgia Department of Revenue" - `TaxPercent.purpose` (string) Purpose of tax Example: "statutory tax" - `TaxPercent.description` (string) Description Example: "1.5% of SGST" - `TaxPercent.includedInBase` (string) Yes , No , Unknown Enum: same as `instantPurchase` in "AdvanceReservationRequired" (3 values) - `PaidTaxes.@type` (string, required) Discriminator classes PaidTaxes or PaidTaxesDetail Example: "PaidTaxesDetail" - `PaidTaxes.TotalTaxes` (number) A monetary amount, up to 4 decimal places. Decimal place needs to be included. Example: 220.12 - `RequestedPricingModifiers` (array) - `RequestedPricingModifiers.@type` (string, required) Discriminator. Example: "RequestedPricingModifiers" - `RequestedPricingModifiers.PassengerCriteria` (object) Defines the passenger criteria. Send one PassengerCriteria for each passenger type code (PTC). Search supports up to 9 total passengers. A maximum of 6 PTCs are supported for GDS. NDC does not have a PTC limitation. AirPrice supports up to nine total passengers across all PTCs. - `TravelerIdentifierRef` (object, required) Identifier references as object both within a message payload or an object held in cache that may be used for subsequent workflows. Returned for NDC in the Price response if age was sent for this traveler in the previous workflow requests. - `RequestedPricingModifiers.PassengerCriteria.@type` (string, required) Discriminator. No child classes. Example: "PassengerCriteria" - `RequestedPricingModifiers.PassengerCriteria.number` (integer, required) The amount of passengers associated with this passenger type code. Default is 1. Example: 1 - `RequestedPricingModifiers.PassengerCriteria.age` (integer) The age of the passenger. Notes on PTC and age: - Travelport recommends sending age only with PTCs that require age for pricing. - If the age is sent in the request, for NDC only, the age is returned in the pricing response. - For child passengers, Travelport recommends sending the age of the child in the age attribute plus the PTC CNN. Travelport recommends against sending CNN without age, or the CHD PTC. Not all fares cannot be quoted for CHD. - The age for CNN is generally between 2 and 11 inclusive, with ADT fares returned for ages 12 and up; however, this can vary by airline and country. - The age for INF must be either 0 or 1. - During booking, date of birth is required for all child and infant PTCs (Add Traveler payload in Traveler/birthDate). Example: 26 - `RequestedPricingModifiers.PassengerCriteria.passengerTypeCode` (string) The passenger type code (PTC) for the passengers on the itinerary. Required field for Air Search and Flight specific search. Common PTCs are: - ADT: adult - CHD: child of unknown age - For child passengers, Travelport recommends sending the age of the child in the age attribute plus the PTC CNN. Travelport recommends against sending CNN without age, or the CHD PTC. Many fares cannot be quoted for CHD. - CNN: child when age is known - The age for CNN is generally between 2 and 11 inclusive, with ADT fares returned for ages 12 and up; however, this can vary by airline and country. - INF: infant without a seat - INS: infant with a seat - UNN: unaccompanied child. See API guides to download a full list of PTCs. NDC carriers BA, SQ, AV, AA, and AF/KLM offer teen/young adult tax exemptions from the UK Air Passenger Duty (GB tax). Send PTC with the value YTH and send the passengers age per below. The PTC may be returned as ADT, or Cxx in which xx is the age, but the tax exemption is applied in the pricing on these NDC carriers. For marine fares, send the PTC value SEA. You must also send OSI remarks at Add Traveler with the vessel name and location. Marine fares are private fares for travelers going to or from a vessel. NDC only; not supported for GDS. When running a multiple passenger search for NDC on Qantas, Qantas supports only these PTCs: ADT, CHD, CNN, INF. Sending any other PTC may result in an error at ticketing. Any traveler sent without a PTC value is defaulted to ADT. PTC can be sent or omitted for ADT passenger. AirReservation defaults the PTC to ADT and returns it in the Reservation Retrieve. Example: "ADT" - `RequestedPricingModifiers.PassengerCriteria.birthDate` (string) The date of birth of the passenger. May be used in age validation for fares with age restrictions. Example: "2020-01-16" - `RequestedPricingModifiers.PassengerCriteria.id` (string) Unique id to support referencing of this specific passenger criteria. Example: "passengercriteria_001" - `RequestedPricingModifiers.PassengerCriteria.CustomerLoyalty` (array) NDC only; not supported for GDS. Optional object for sending customer loyalty information, such as for a frequent flyer program. If CustomerLoyalty is sent in the Search request, it must also be sent in the Air Price request and the Add Traveler request. As some carriers validate frequent traveler data through the workflow, failing to send the same CustomerLoyalty details, even if invalid, may cause a booking failure. If an invalid number is sent, the response returns a warning message that the FQTV is invalid, and the invalid number is cached to prevent a potential booking failure. - `RequestedPricingModifiers.PassengerCriteria.TravelerGeographicLocation` (object) For AirSearch: supported/validated only for NDC to support local citizen fares. For AirPrice and AirReservation: GDS only; not supported for NDC. Optional object for requesting local citizen/local resident fares for Spain and associated islands. You must also send a PTC relevant to the local resident fares; e.g., ADR for adult resident, CHR for child resident. Any discount applied through TravelerGeographicLocation applies to all travelers, not only to the traveler in this instance of PassengerCriteria. If the discount must apply only to an individual traveler, that traveler requires a separate search and book workflow. - `RequestedPricingModifiers.PassengerCriteria.TravelerGeographicLocation.value` (string) IATA code for the city, country, or state/province relevant to the local citizen//local resident fare. Example: "PMI" - `RequestedPricingModifiers.PassengerCriteria.TravelerGeographicLocation.travelerGeographicLocationType` (string) The type of location where the fare is valid. Enum: "Country", "StateProvince", "City" - `RequestedPricingModifiers.PassengerCriteria.TravelerGeographicLocation.residentGeographicCode` (string) Resident code for Spanish residency fares for NDC. Any discount will apply to all travelers, not only to the traveler in this instance of PassengerCriteria. Supported/validated only for NDC to support local citizen fares. - `RequestedPricingModifiers.PassengerCriteria.TravelerGeographicLocation.generalLargeFamilyResidentDiscountInd` (boolean) Send only if true and request qualifies for general large family resident discount, defined as general large families (up to three children) from Spain, from the EU/EEA, or of any other nationality whose residency in Spain is recognized and who are in possession of a large-family certificate issued by the autonomous community in which they live. Supported/validated only for NDC to support local citizen fares. Example: true - `RequestedPricingModifiers.PassengerCriteria.TravelerGeographicLocation.specialLargeFamilyResidentDiscountInd` (boolean) Send only if true and request qualifies for special large family resident discount, defined as special large families (four or more children) from Spain, from the EU/EEA, or of any other nationality whose residency in Spain is recognized and who are in possession of a large-family certificate issued by the autonomous community in which they live. Supported/validated only for NDC to support local citizen fares. Example: true - `RequestedPricingModifiers.PassengerCriteria.specifiedPassengerTypeCodeOnlyInd` (boolean) GDS only; not supported for NDC. - If true: returns only offers for the specified PTC. If no fares are available for the specified PTC, returns an error message that there is no valid fare. - If false (default behavior): If no fares are available for the specified PTC, returns fares for the default ADT (adult) PTC instead. Example: true - `RequestedPricingModifiers.PricingModifiersAir` (object) A selection of Pricing Modifiers that can be used to influence the Price of an Offer. - For the AirPrice reference payload request, if any price modifiers were included in the preceding Search request and no price modifiers are sent in the AirPrice request, the cached price modifiers sent at Search are sent with the AirPrice request. If any price modifiers are sent in the AirPrice reference payload request, all cached Search modifiers are discarded and only the modifiers sent in that AirPrice request are used. - For the Add Offer request, you may optionally store fares with one or more pricing modifiers. If a pricing modifier is not added, the auto stored fare is added to the reservation. There is no change in the AirReservation response when pricing modifiers are requested. AirReservation applies modifiers from Add Offer and earlier steps as follows: - Modifiers sent in the Add Offer request (supported for both full and reference payload). - If no modifiers are sent in Add Offer, any pricing modifiers sent in AirPrice are applied. - If no modifiers were sent in AirPrice, or if AirPrice was not sent, any pricing modifiers sent in Search are applied. GDS only; pricing modifiers not supported for NDC. If the requested modifier does not have any fares associated with it, the workbench commit fails and returns the error message 'No Fare Found'. Pricing happens at commit, not at Add Offer. - `Brand` (object) Information on airline Brand offerings. If brand attributes were not excluded with inhibitBrandContentInd=true (GDS only), then brand attributes are returned and consolidated in ReferenceList/ReferenceListBrand. In this case Brand does not return the name or Identifier objects but instead returns only BrandRef, which matches to the brand identifier (e.g., b1) in ReferenceListBrand. - `Brand.@type` (string, required) Discriminator. Child classes BrandID and Brand. BrandCompleteInfo is no longer in use. Example: "BrandID" - `Brand.id` (string) Local id within a given message to support referencing this object. Example: "brand_001" - `Brand.BrandRef` (string) Reference id that corresponds to the brand 'id' in ReferenceListBrand.Brand. Example: "brandRef_001" - `Brand.Identifier` (object) A globally unique identifier key often used to reference a given option (such as Pricing, Booking, Rules, or additional workflows) or to retrieve information (such as Hotel pagination). - `Brand.name` (string, required) Brand name from the supplier. Example: "Main Cabin Extra" - `Brand.tier` (integer) The brand tier. Not returned for NDC. Example: 2 - `Brand.shelfNumbers` (array) ATPCO shelf number. If the carrier has provided it for this brand, the shelf number is the number for a grouping of comparable brands that share similar ticket and flight attributes. Example: [1,4,5] - `Brand.code` (string) The ATPCO Brand Code. Example: "REFMAIN" - `Brand.BrandAttribute` (array) A list of enumerated features that are included, chargeable, or not offered for this brand. Contains one or more instances of the two paired key value pairs classification and inclusion. The return of brand attributes can be disabled in the AirPrice Reference Payload request. - `Brand.AdditionalBrandAttribute` (array) Array of non-enumerated features that are included, chargeable, or not offered for this brand. Contains one or more instances of the two paired key value pairs classification and inclusion. - `Brand.ImageURL` (array) Example: ["http:/imageurl.com"] - `RequestedPricingModifiers.PricingModifiersAir.@type` (string, required) Discriminator. Child classes PricingModifiersAir and PricingModifersAirDetail Example: "PricingModifiersAir" - `RequestedPricingModifiers.PricingModifiersAir.currencyCode` (string) In an API request, send the currency type to return if you want to override the default currency specified with your PCC. Example: "GBP" - `RequestedPricingModifiers.PricingModifiersAir.FareSelection` (object) Requests the return of fare types including private fares (negotiated), public fares (published), or net fares (consolidator fares, or any negotiated wholesale price that is further marked up for sale to customers). May be used to request fares with specific restrictions, change, or refund options. - `validatingCarrier` (string) IATA code for a carrier to override any default validating carrier (the airline designator that the ticket is issued against). If the validating carrier code is not supported for an itinerary, the response returns the error Ticketing Agreement does not exist. If an invalid validating carrier code is sent in the request, the response returns the error Unknown Carrier. Example: "KA" - `prohibitMinStayFaresInd` (boolean) If true, returns only fares that do not require a minimum stay. False allows minimum stay fares. Default is false. Example: true - `prohibitMaxStayFaresInd` (boolean) If true, returns only fares that do not require a maximum stay. False allows maximum stay fares. Default is false. Example: true - `refundableOnlyInd` (boolean) If true, returns only fares that are fully refundable. Default is false. Example: true - `prohibitAdvancePurchaseFaresInd` (boolean) If true, returns only fares that do not require advance purchase. False allows fares with advance purchase restrictions. Default is false. Example: true - `prohibitUnbundledFaresInd` (boolean) Example: true - `prohibitRefundableFaresInd` (boolean) This field is deprecated. Use RefundOptions for refundability options Example: true - `RequestedPricingModifiers.PricingModifiersAir.FareSelection.@type` (string, required) Discriminator. Child class FareSelectionDetail. Example: "FareSelection" - `RequestedPricingModifiers.PricingModifiersAir.FareSelection.fareType` (string) Defines the type of fares to return (only public fares, only private fares, only agency private fares, etc.). These can be combined. The response identifies the type of fare returned for each Product in PassengerFlight/FlightProduct @fareType. Possible values in the response are AirlinePrivateFare, AgencyPrivateFare, NetFare, or PublicFare. Enum: "PublicFaresOnly", "PrivateFaresOnly", "AgencyPrivateFaresOnly", "AirlinePrivateFaresOnly", "PublicAndPrivateFares", "NetFaresOnly", "AllFares" - `RequestedPricingModifiers.PricingModifiersAir.FareSelection.RefundOptions` (object) Supports requesting only fares that meet certain refund criteria. GDS only; not supported for NDC. Search supports sending up to 12 refundability options. The following combinations are mutually exclusive; if sent, Search ignores them and returns a warning message: NonRefundable cannot also be sent with PartialRefund. Refundable cannot also be sent with ChangeOptions/changeTypes=PenaltyToChange - `RequestedPricingModifiers.PricingModifiersAir.FareSelection.ChangeOptions` (object) Supports requesting only fares that meet certain change criteria. GDS only; not supported for NDC. Search supports sending up to 12 changeability options. ChangeOptions.changeTypes=PenaltyToChange cannot be sent with RefundOptions.Refundable. If sent, Search ignores them and returns a warning message - `RequestedPricingModifiers.PricingModifiersAir.FareSelection.FareQualiferString` (array) Request specific private leisure fares. Supported values vary by NDC carrier. For detailed NDC support by carrier, see the Knowledge Base article NDC capabilities by airline through JSON API in the guide section. This value is returned in FlightProduct.FareQualifierString if supplied by the airline. (Note the misspelling in request parameter) Example: ["Tour"] - `RequestedPricingModifiers.PricingModifiersAir.FareSelection.FareQualifier` (array) - `RequestedPricingModifiers.PricingModifiersAir.OrganizationInformation` (object) Use to send account codes for negotiated fares or to send optional India GST SSR Remarks in GSTRegistrationNumber. For NDC supports corporate loyalty program and GST Information. This information is returned in TermsAndConditions." - `RequestedPricingModifiers.PricingModifiersAir.OrganizationInformation.@type` (string, required) Discriminator. No child classes Example: "OrganizationInformation" - `RequestedPricingModifiers.PricingModifiersAir.OrganizationInformation.OrganizationIdentifier` (array) Array of account codes to return negotiated fares. The response returns an instance of TermsAndConditions/OrganizationInformation/OrganizationIdentifier for each account code sent. When FareSelection/fareType=PrivateFaresOnly and an account code is sent in OrganizationIdentifier, AirPrice ignores the account code. Instead, AirPrice returns any private fares available for that market and a booking code for your PCC. This prevents the return of an error message when no specific fare has been filed for that account code. - `RequestedPricingModifiers.PricingModifiersAir.OrganizationInformation.GSTRegistrationNumber` (array) Send to add India GST (Goods and Services Tax) Special Service Requests. In this case country should be IND. Supported during book 'Add Offer' workflow. See the [India GST SSRs](https://developer.travelport.com/docs/flights/guides/booking-and-reservations/remarks-and-service-requests#india-gst-ssr) in the Remarks & Service Requests Guide for important details. - `RequestedPricingModifiers.PricingModifiersAir.TaxExemption` (object) GDS only, not supported for NDC. Use to mark some or all taxes as exempt. Specify all taxes, only specific tax codes, or all taxes in specific countries. Must include either allTaxesExemptInd OR both countries and taxCodes. TaxExemption supports up to nine values for countries, taxCodes, or both combined. The response returns any exempt taxes with exemptInd=true and value=0. - `RequestedPricingModifiers.PricingModifiersAir.TaxExemption.@type` (string) Discriminator. No child classes. Example: "TaxExemption" - `RequestedPricingModifiers.PricingModifiersAir.TaxExemption.countries` (array) One or more ISO codes for the countries in which the paired taxCodes sent are tax exempt. Must also send taxCodes object. Example: ["GB","MX"] - `RequestedPricingModifiers.PricingModifiersAir.TaxExemption.taxCodes` (array) One or more two-letter alphanumeric tax codes to mark as exempt in the paired country. Must also send countries object. Example: ["US"] - `RequestedPricingModifiers.PricingModifiersAir.TaxExemption.allTaxesExemptInd` (boolean) Use to set all taxes as exempt. - If true: marks all taxes on the itinerary as tax exempt. - Do not send if false. Instead, use countries and taxCodes to specify which taxes to exempt. Example: true - `RequestedPricingModifiers.PricingModifiersAir.PromotionalCode` (array) - `RequestedPricingModifiers.PricingModifiersAir.SellCity` (string) GDS only, not supported for NDC. The IATA location code for a city. Overrides the sell city of the requester to specify an alternate sale location and return fares based on that location. The response returns pricing in the local currency for the specified sell city instead of the PCC's default currency. Example: "NYC" - `RequestedPricingModifiers.PricingModifiersAir.TicketCity` (string) GDS only, not supported for NDC. The IATA location code for a city. Overrides the ticketing city of the requester to specify an alternate ticket location and return fares based on that location; the response returns pricing in the local currency for the specified ticket city instead of the PCC's default currency. Example: "NYC" - `RequestedPricingModifiers.PricingModifiersAir.PricingPCC` (string) GDS only, not supported for NDC. Use to send a faring PCC for which a selective access or code group agreement exists between that PCC and the PCC associated with your account. The following combinations of PricingPCC and FareSelection/fareType=PrivateFaresOnly return results as follows: - PricingPCC sent and PrivateFaresOnly not requested: If a selective access or group agreement exists, both public and any available private fares are returned for the requesting and providing PCC. - If no selective access or group agreement exists, only public fares are returned. - PricingPCC sent and PrivateFaresOnly is requested: If a selective access or group agreement exists that allows private fare access, only available private fares are returned for the requesting and providing PCC. - If no agreement exists, or if an agreement exists but does not allow private fares access, an error is returned. Example: "0Bx3" - `RequestedPricingModifiers.PricingModifiersAir.FareBasisCodeOverride` (array) - `RequestedPricingModifiers.PricingModifiersAir.MultiPricingAgency` (array) The customer can send up to 3 Pseudo City Codes (PCCs) in PricingModifiersAir, MultiPricingAgency. If a customer sends more than 3 PCCs in MultiPricingAgency, only the first 3 are validated. If a customer sends both PricingPCC and MultiPricingAgency with PCCs, the PCC in PricingPCC is ignored. Example: ["[\"0XS4\",\"0YBZ\",\"J80K\"]"] - `RequestedPricingModifiers.PricingModifiersAir.TicketingPCC` (string) GDS only, not supported for NDC. In an API request, overrides the ticketing PCC associated with your account to specify an alternate PCC and return fares based on that PCC. Example: "0XS4" - `RequestedPricingModifiers.PricingModifiersAir.CalculatedFareAdjustment` (object) — one of (discriminator: @type): Used in Exchange Search to modify the Price of the Fare. Discriminator classes CalculatedFareAdjustmentDiscount or CalculatedFareAdjustmentIncrease - CalculatedFareAdjustmentDiscount: - `AmountPercent` (object) Parent object when amount is applied as an Amount or a Percent. - CalculatedFareAdjustmentIncrease: - `AmountPercent` (object, required) Parent object when amount is applied as an Amount or a Percent. - `RequestedPricingModifiers.PricingModifiersAir.CalculatedFareAdjustment.@type` (string, required) Example: "CalculatedFareAdjustmentDiscount" - `RequestedPricingModifiers.PricingModifiersAir.ManualFareAdjustment` (array) — one of (discriminator: @type): Send to manually adjust the base fare amount on all fares for a specific PTC. - ManualFareAdjustmentIncrease: - `AmountPercent` (object, required) Parent object when amount is applied as an Amount or a Percent. - ManualFareAdjustmentDiscount: - `AmountPercent` (object, required) Parent object when amount is applied as an Amount or a Percent. - `RequestedPricingModifiers.PricingModifiersAir.BrandPreference` (array) - `RequestedPricingModifiers.PricingModifiersAir.includeSplitPaymentInd` (boolean) Requests request split ticketing, which returns outbound and inbound one-way fares in addition to round trip options in the Search API response. This may result in lower fares than the same or similar round-trip itinerary. If true, requests split ticketing. If false or omitted split ticketing options are not returned. Default is false. GDS only, not supported for NDC. When split ticketing is requested, the Search response returns offers in the following order: Outbound one-way offers, Inbound one-way offers, Round trip offers. The response identifies all one-way outbound and inbound offers with CombinabilityCode j0. CombinabilityCode values for round trip offers start at j1 and increment by one for each offer. Only the following are in scope for split ticketing: Search (not supported for Next Leg Search or Flight Specific Search), Round-trip journey-based offerings ( isJourney header not sent or sent as true, or CustomResponseModifiersAir/SearchRepresentation not sent or sent with value Journey ) Upsells. Split ticketing is not supported for round-trip leg-based searches, virtual interlining, or NDC. Split ticketing is available only for customers specifically provisioned for split ticketing. Split ticketing returns one-way outbound and one-way inbound fares in addition to round-trip offers. Split ticket offers are identified with CombinabilityCode j0. If your account is not configured for split ticketing, sending includeSplitPaymentInd returns a response without split ticket offers and a warning message. GDS only, not supported for NDC. In Air Price, For split ticketing, the request must send offers that are identified in the Search response with CombinabilityCode j0, which identifies those offers as one-way outbound and one-way inbound split ticketing offers. A combination of j0 and any non-j0 value offer returns an error message that split pricing is not supported - `RequestedPricingModifiers.PricingModifiersAir.returnMostRestrictiveBrandInd` (boolean) In Search API, when there are different brands on a connecting flight, return information for either the most restrictive brand or the brand on the most significant segment on the itinerary. If true, return the offer brand of the most restrictive brand. If false or omitted, return the offer brand of the most significant segment of the itinerary. GDS only, not supported for NDC. - `RequestedPricingModifiers.PricingModifiersAir.splitPaymentOfferings` (number) Number between 0 and 99. Send with includeSplitPaymentInd to configure the percentage of round trip offers to return in a split ticketing response. By default, Search divides the split ticketing response into 34% round-trip offerings and the remainder as split ticketing offers, which are combined outbound and inbound one-way fares. To change this percentage, send SplitPaymentOfferings with the percentage value of round trip offers to return. Example: 25 - `RequestedPricingModifiers.CabinPreference` (object) Requests a fare based on the cabin class. Only one cabin preferenceType (Permitted, Preferred, PreferredWithUpgrade) is allowed per request, but there is no limit to the number of cabins that can be sent. Any CabinPreference in the initial Search request is applied to any subsequent Next Leg Search and reference Flight Specific Search requests. In AirPrice and AirReservation only one cabin preference type is allowed per request, but there is no limit to the number of cabins that can be sent. If CabinPreference was sent in the Search request, it is cached and sent with the AirPrice reference payload request. If you send CabinPreference in the AirPrice request, all cached modifiers are discarded and only the modifiers sent in the AirPrice request are used. Can be combined with lowFareFinderInd=true to return lowest fare in the requested cabin or cabins. When using CabinPreference and lowFareFinderInd, if both CabinPreference and a class of service are sent, class of service is ignored. If CabinPreference is sent without a class of service, the response returns the lowest fare in the cabin requested. If that cabin is not available, the response may upgrade or downgrade to a different cabin. If a different cabin than requested is returned, the response returns the message that the cabin class may differ from the class requested. If lowFareFinderInd=false and CabinPreference are sent in the request, AirPrice ignores the preferred cabin and returns a message that the preferred cabin was ignored. If CabinPreference is set to All, no cabin preference is applied." - `RequestedPricingModifiers.CabinPreference.@type` (string, required) Discriminator. No child classes exist Example: "CabinPreference" - `RequestedPricingModifiers.CabinPreference.preferenceType` (string) Type of cabin preference. Sending a mix of preferenceType values is not supported. For example, you cannot send an instance of CabinPreference with a preferenceType of Permitted and another instance with preferenceType of Prohibited. In this case the results default to the Preferred preference. Note that if lowFareFinderInd is sent with true and CabinPreference is sent, the only supported value for CabinPreference/type is Permitted. Enum: same as `RequestedPricingModifiers.CabinPreference.preferenceType` in "PriceBreakdownAir" (4 values) - `RequestedPricingModifiers.CabinPreference.cabins` (array) A space-delimited list of cabins. Enum: same as `PassengerFlight.FlightProduct.cabin` in "ProductAir" (5 values) - `RequestedPricingModifiers.CabinPreference.legSequence` (array) Limits preference to the specified leg referenced in SearchCriteriaFlight. You can apply the preference to only some legs of the itinerary, or different preferences to different legs. To apply preference to the entire itinerary, do not send legSequence. GDS only, not supported for NDC. Not supported at Price or Book. Example: [1,2] - `RequestedPricingModifiers.FlightType` (object) The type of flight connection - `RequestedPricingModifiers.FlightType.@type` (string, required) Discriminator. No child classes. Example: "FlightType" - `RequestedPricingModifiers.FlightType.connectionType` (string) Limits the connection type returned. Each value returns the specified type and all higher types. For example, StopDirect could return both flights that stop without a change of planes (StopDirect) and non-stop direct flights (NonStopDirect). SingleConnection or DoubleConnection will not exclude StopDirect flights from the journey. For example, SingleConnection could return an itinerary with two flight numbers, and either of these flights could have intermediate stops. Enum: same as `RequestedPricingModifiers.FlightType.connectionType` in "PriceBreakdownAir" (5 values) - `RequestedPricingModifiers.FlightType.excludeInterlineConnectionsInd` (boolean) Excludes interline connectionsClosed from results. If true, does not return offers with interline connections. If false or omitted, may return interline connections in results. Default is false. GDS only, not supported for NDC. When a product contains multiple interline air segments, brand details return only the brand of the significant carrier, not the validating/plating carrier brand information. The IATA rules for determining the significant carrier on an itinerary are based on the areas in which the transportation takes place. Example: true - `RequestedPricingModifiers.CustomResponseModifiersAir` (object) Contains additional modifiers to customize the result set. Includes optional indicators for returning or excluding specified response content. Values sent at Search can carry forward into the Next Leg Search request and are not re-sent. - `RequestedPricingModifiers.CustomResponseModifiersAir.@type` (string, required) discriminator Example: "CustomResponseModifiersAir" - `RequestedPricingModifiers.CustomResponseModifiersAir.BrandAttributeInclusion` (array) Supported in AirSearch and AirPrice. Returns only information about the brand attributes specified and does not return any other brand attributes. - `RequestedPricingModifiers.CustomResponseModifiersAir.SearchRepresentation` (string) Specifies either a journey or leg-based response. Journey returns offers for all legs of the itinerary. Journey is the default. Leg returns offers for only the first leg of the itinerary. Must be followed with a Next Leg Search to select an offer for the first leg and return offers on the subsequent leg to combine with it.Customize search result set as leg or journey based. Next Leg Search requests, and Flight Specific Search requests for less than the full itinerary, are supported only after a leg-based Search, not a journey-based Search. If these requests follow a journey-based Search request, an error message is returned. Enum: same as `RequestedPricingModifiers.CustomResponseModifiersAir.SearchRepresentation` in "PriceBreakdownAir" (3 values) - `RequestedPricingModifiers.CustomResponseModifiersAir.excludePenaltiesInd` (boolean) GDS only; not supported for NDC. Indicator to omit change and cancel penalties. - If true: omits all penalty information from the response. - If false (default behavior): returns any change and penalty details provided by carrier for each offer in TermsAndConditionsFullAir/Penalties. If sent in Search but not in AirPrice, the value sent in Search is cached and applied to the AirPrice results. However, you can override the value sent in Search by sending excludePenaltiesInd in the AirPrice request with the opposite value. For example, if the Search request sends excludePenaltiesInd=true and the AirPrice request sends excludePenaltiesInd=false, the Search response does not return penalties and the AirPrice response does return penalties. Example: true - `RequestedPricingModifiers.CustomResponseModifiersAir.excludeBaggageFeesInd` (boolean) GDS only; not supported for NDC. Indicator to exclude baggage details. - If true: excludes baggage fees, carry on fees, and embargo information from the response. Baggage quantity or weight is returned instead. - If false (default behavior): baggage details returned in response. Default is false. Example: true - `RequestedPricingModifiers.CustomResponseModifiersAir.includeFareCalculationInd` (boolean) GDS only; not supported for NDC or in the Flight Specific Search full payload request. Indicator to request the return of the fare calculation ladder. - If true: returns the fare calculation ladder in BestCombinablePrice.PriceBreakdownAir.FareCalculation. - If false (default behavior): fare calculation ladder is not returned. Example: true - `RequestedPricingModifiers.CustomResponseModifiersAir.excludeSurchargesInd` (boolean) GDS only; not supported for NDC. Indicator to exclude a surcharge breakdown. - If true: excludes a surcharge breakdown from the response. Baggage quantity or kilos is returned instead. - If false (default behavior): surcharge breakdown returned in response. Example: true - `RequestedPricingModifiers.CustomResponseModifiersAir.excludeUnbundledFaresInd` (boolean) GDS only, not supported for NDC. Sets whether to return unbundled fares. Supported in AirSearch and AirPrice. - If true: does not return unbundled fares. - If false (default behavior): returns unbundled and bundled fares as available. Example: true - `RequestedPricingModifiers.CustomResponseModifiersAir.includeCO2EmissionsDataInd` (boolean) Indicator to return CO2 emission data in the Search and Next Leg Search responses. - If true: returns CO2 emission data. - If false (default behavior): CO2 emission data not returned. Example: true - `RequestedPricingModifiers.CustomResponseModifiersAir.includeFlightAmenitiesInd` (boolean) Indicator to return flight amenities from ATPCO RouteHappy data. - If true: includes amenities in the response if available. - If false: Does not return ATPCO RouteHappy amenities. Example: true - `RequestedPricingModifiers.CustomResponseModifiersAir.includeUniversalProductAttributesInd` (boolean) Indicator to return universal product attributes (UPAs), which include images, icons, and URLs as provided by ATPCO. Must also send includeFlightAmenitiesInd=true. - If true: returns universal product attributes if available. - If false (default behavior): Universal product attributes not returned. UPAs are not returned for direct flights with intermediate stops, non-flight segments such as trains, or for Premium Business class. Example: true - `RequestedPricingModifiers.CustomResponseModifiersAir.includeBundledAncillariesInd` (boolean) NDC only. If true: the search and price response will include bundled air and ancillary offerings/offers. Search and Price response will contain both ProductAir and ProductAncillary plus a new child class of PriceBreakdown: PriceBreakdownAncillaryAir to define the ancillary inclusion and pricing. Example: true - `RequestedPricingModifiers.CustomResponseModifiersAir.includeFullPenaltyDisclosureInd` (boolean) If true, penalty information sourced from ATPCO Cat 31 and 33 will be disclosed. Penalties may be exposed at fare component level and include time windows. - `RequestedPricingModifiers.PricingModifiersAirChange` (object) Pricing Modifiers that can be used to influence the Price of an Exchanged Offer - `RequestedPricingModifiers.PricingModifiersAirChange.@type` (string) Example: "PricingModifiersAirChange" - `RequestedPricingModifiers.PricingModifiersAirChange.currencyCode` (string) ISO 4217 currency code Example: "USD" - `RequestedPricingModifiers.PricingModifiersAirChange.FareSelection` (object) Requests the return of fare types including private fares (negotiated), public fares (published), or net fares (consolidator fares, or any negotiated wholesale price that is further marked up for sale to customers). May be used to request fares with specific restrictions, change, or refund options. - `validatingCarrier` (string) IATA code for a carrier to override any default validating carrier (the airline designator that the ticket is issued against). If the validating carrier code is not supported for an itinerary, the response returns the error Ticketing Agreement does not exist. If an invalid validating carrier code is sent in the request, the response returns the error Unknown Carrier. Example: "KA" - `prohibitMinStayFaresInd` (boolean) If true, returns only fares that do not require a minimum stay. False allows minimum stay fares. Default is false. Example: true - `prohibitMaxStayFaresInd` (boolean) If true, returns only fares that do not require a maximum stay. False allows maximum stay fares. Default is false. Example: true - `refundableOnlyInd` (boolean) If true, returns only fares that are fully refundable. Default is false. Example: true - `prohibitAdvancePurchaseFaresInd` (boolean) If true, returns only fares that do not require advance purchase. False allows fares with advance purchase restrictions. Default is false. Example: true - `prohibitUnbundledFaresInd` (boolean) Example: true - `prohibitRefundableFaresInd` (boolean) This field is deprecated. Use RefundOptions for refundability options Example: true - `RequestedPricingModifiers.PricingModifiersAirChange.OrganizationInformation` (object) Use to send account codes for negotiated fares or to send optional India GST SSR Remarks in GSTRegistrationNumber. For NDC supports corporate loyalty program and GST Information. This information is returned in TermsAndConditions." - `RequestedPricingModifiers.PricingModifiersAirChange.WaiverCode` (object) A code assigned by an airline to support waiver of fees or ticket value as a result of disruption to the passenger. - `RequestedPricingModifiers.PricingModifiersAirChange.WaiverCode.value` (string) - `RequestedPricingModifiers.PricingModifiersAirChange.WaiverCode.reasonCode` (integer) A code assigned to identify the reason for disruption Example: 2 - `RequestedPricingModifiers.PricingModifiersAirChange.WaiverCode.waiverType` (string) List of waiver types. Enum: "ChangePenalty", "PriceDifference", "ChangePenaltyAndPriceDifference", "RefundPenalty", "NameChangePenalty" - `RequestedPricingModifiers.PricingModifiersAirChange.TaxExemption` (object) GDS only, not supported for NDC. Use to mark some or all taxes as exempt. Specify all taxes, only specific tax codes, or all taxes in specific countries. Must include either allTaxesExemptInd OR both countries and taxCodes. TaxExemption supports up to nine values for countries, taxCodes, or both combined. The response returns any exempt taxes with exemptInd=true and value=0. - `RequestedPricingModifiers.PricingModifiersAirChange.PromotionalCode` (object) NDC only. Not supported for GDS. Any NDC airline designated promotional code. - `RequestedPricingModifiers.PricingModifiersAirChange.PromotionalCode.value` (string) The promotional code to apply Example: "CDFRT" - `RequestedPricingModifiers.PricingModifiersAirChange.PromotionalCode.supplierCode` (string, required) The IATA code for the airline on which the promotional code is applicable. Example: "AA" - `RequestedPricingModifiers.PricingModifiersAirChange.SellCity` (string) Overrides the sell city of the requestor Example: "MEX" - `RequestedPricingModifiers.PricingModifiersAirChange.TicketCity` (string) Overrides the ticket city of the requestor Example: "MEX" - `RequestedPricingModifiers.PricingModifiersAirChange.PricingPCC` (string) Overrides the pricing PCC of the requestor Example: "0XS4" - `RequestedPricingModifiers.PricingModifiersAirChange.TicketingPCC` (string) Overrides the ticketing PCC of the requestor Example: "0XCD" - `RequestedPricingModifiers.PricingModifiersAirChange.CalculatedFareAdjustment` (object) — one of (discriminator: @type): Used in Exchange Search to modify the Price of the Fare. Discriminator classes CalculatedFareAdjustmentDiscount or CalculatedFareAdjustmentIncrease - CalculatedFareAdjustmentDiscount: - `AmountPercent` (object) Parent object when amount is applied as an Amount or a Percent. - CalculatedFareAdjustmentIncrease: - `AmountPercent` (object, required) Parent object when amount is applied as an Amount or a Percent. - `RequestedPricingModifiers.PricingModifiersAirChange.BrandPreference` (array) - `RequestedPricingModifiers.PricingModifiersAirChange.keepToBrandInd` (boolean) If true, the offerings returned will be of the same brand as the original Offer Example: true - `RequestedPricingModifiers.PricingModifiersAirChange.returnMostRestrictiveBrandInd` (boolean) if true, the most restrictive brand will be returned in the response when there are different brands present in the Offering Example: true - `RequestedPricingModifiers.PricingModifiersAirChange.doNotNetInd` (boolean) If true, this exchange will not net any residual/refundable amounts against due amounts. - `RequestedPricingModifiers.lowFareFinderInd` (boolean) Provides pricing flexibility around class of service. If not sent, the response returns fares only in the requested class of service. If true, returns the lowest fares available in any class of service available, which may not be the same as the requested class. Note that if lowFareFinderInd is sent with true and CabinPreference is sent, the only supported value for CabinPreference/type is Permitted. When lowFareFindInd=true and brand attributes are not disabled (inhibitBrandContentInd), AirPrice uses only the brand tier (and any other pricing modifiers) to find the lowest fare within a brand tier regardless of class of service. GDS only; not supported for NDC. Example: true - `RequestedPricingModifiers.keepToBrandInd` (boolean) If true, the original brand will be maintained during the exchange process. Example: true - `RequestedPricingModifiers.lowFareFindAndRebookInd` (boolean) If true, the original flights in the reservation will be rebooked or replaced with the new exchanged flights. - `PassengerCriteriaRefs` (array) NDC only; not supported for GDS. Returned for NDC if a traveler identifier was sent for this traveler in the previous workflow requests. Example: ["passengerCriteria_1"] - `FlightPassCredits` (integer) The number of flight pass credits consumed for this pricebreakdown. Example: 1 - PriceBreakdownAncillary: - `inclusiveOfTaxInd` (boolean) If true, this ancillary is sold inclusive of tax. Example: true - `quantity` (integer) The quantity of ancillary items included in this PriceBreakdown. Example: 1 - `Description` (object) A description of the ancillary with description codes. - `Description.value` (string) The text description of the ancillary. Example: "Vegetarian Meal" - `Description.code` (string) The ATPCO group code. Example: "BG" - `Description.subCode` (string) The ATPCO RFISC subcode. Example: "0D4" - `Description.subGroup` (string) The ATPCO sub group code. Example: "SP" - `Description.codeContext` (string) The code context value. Example: "ATPCO" - `Description.ssrCode` (string) The four character AIRIMP SSR code for this ancillary. Example: "VGML" - `Description.issuanceReasonCode` (string) The airline provided reason for issuance code. Example: "C" - `Description.geographicSpecification` (string) How the ancillary is applied across the itinerary. Enum: same as `Ancillary.Description.geographicSpecification` in "ProductAncillary" (3 values) - `ProductRef` (string) The product ref this PriceBreakdown applies to. If no productRef exists then the PriceBreakdown applies to all Products within the Offer. Example: "p_1" - `Discount` (object) NDC only; not supported for GDS. Returned for a fare discounted from the published price, such as a promotional discount. Not returned for privately negotiated discounts such as private fares. - `Discount.value` (number) The amount value of the discount Example: 20.22 - `Discount.description` (string) The text description for the discount. Example: "Spring discount on group bookings" - `Discount.currencyCode` (string, required) Currency code discount is returned in. Example: "USD" - `Discount.codeAuthority` (string, required) Not used. Currency code Authority. Example: "ISO" - `Discount.decimalPlace` (integer, required) Number of decimal places in the currency the discount is returned in. Example: 2 - `Discount.decimalAuthority` (string) Not used. Decimal Authority. Example: "ISO" - `TravelerIdentifierRef` (object) Identifier references as object both within a message payload or an object held in cache that may be used for subsequent workflows. Returned for NDC in the Price response if age was sent for this traveler in the previous workflow requests. - `TravelerIdentifierRef.name` (string) Traveler identifier - `TravelerIdentifierRef.passengerTypeCode` (string) Passenger Type code Example: "ADT" - `TravelerIdentifierRef.ages` (array) The ages of the travelers associated to a particular ptc. For NDC, this value will be returned in PriceBreakdownAir if sent as part of the PassengerCriteria in the Air Search request. Example: [15] - `TravelerIdentifierRef.passengerCriteriaRef` (string) Allows the user to associate passenger criteria information. Example: "passengerCriteria_1" - `TravelerIdentifierRef.value` (string) - `TravelerIdentifierRef.id` (string) A locally referenced ID - `TravelerIdentifierRef.description` (string) Descriptive text used to identify the contents of a target object - `TravelerIdentifierRef.uris` (array) Uniform Resource Identifier Example: ["google.com"] - `TravelerIdentifierRef.age` (integer) Replaced with ages array. The age of the traveler. Example: 11 - `AncillaryPriceApplicationCode` (object) Determines how an ancillary price has been built. - `AncillaryPriceApplicationCode.value` (string) Example: "3" - `AncillaryPriceApplicationCode.application` (string) Associated text. Example: "PerItem" - PriceBreakdownHospitality: - `roomPricingType` (string) A string provided by the hotel to describe how a service is priced, such as per night or per stay. Enum: same as `roomPricingType` in "PriceBreakdownHospitality" (5 values) - `Description` (string) Example: "Advance Purchase-Ro-Free WiFi" - `NightlyRate` (array) - `NightlyRate.@type` (string) - `NightlyRate.startDate` (string, required) Start date for the nightly rate in YYYY-MM-DD format. - `NightlyRate.nights` (integer) Number of nights the nightly rate is valid. - `NightlyRate.Amount` (object, required) Amount represents the cost applied - `AverageNightlyRate` (array) The average nightly rate for a given offer. - `AverageNightlyRate.value` (number) The amount of a given currency. Example: 124.56 - `AverageNightlyRate.code` (string) An ISO 4217 alpha character code (3 characters) that specifies a money unit. Example: "USD" - `AverageNightlyRate.minorUnit` (integer) Minor units are a mechanism for expressing the relationship between a major currency unit and its corresponding minor currency unit. It is the smallest unit of a given currency. For example; the smallest denomination in USD is the cent, which is 1/100 of a USD, and the minor unit value is 2. Not all currencies have a minor unit. Example: 2 - `AverageNightlyRate.currencySource` (string) The system requesting or returning the currency code specified in the attribute Enum: same as `MinimumAdcolAmount.currencySource` in "ChangePermitted" (3 values) - `AverageNightlyRate.approximateInd` (boolean) "If true, the currency amount has been converted from the original amount. For Air Exchange Eligibility, returned only if a currency is converted. If returned, the value is always true, indicating that the fee is approximate because of currency conversion. For Hotel Availability and Rules, true indicates this is a calculated value; false indicates this is the value returned by the property." Example: true - `AmenitySurcharges` (object) Amenity Surcharges information. - `AmenitySurcharges.@type` (string, required) Discriminator classes AmenitySurcharges or AmenitySurchargesDetail Example: "AmenitySurchargesDetail" - `AmenitySurcharges.TotalSurcharges` (number) A monetary amount, up to 4 decimal places. Decimal place needs to be included. Example: 211.11 - `AmenitySurcharges.approximateInd` (boolean) if true, the surcharge amounts are approximate - `AmenitySurcharges.Surcharge` (array, required) - `AmenitySurcharges.Surcharge.value` (number) Surcharge amount Example: 12 - `AmenitySurcharges.Surcharge.currencyCode` (string) ISO 4217 currency code for the surcharge. Example: "USD" - `AmenitySurcharges.Surcharge.surchargeCode` (string) Surcharge code Example: "ADDITIONAL COSTS" - `AmenitySurcharges.Surcharge.reportingAuthority` (string) Not used. Surcharge reporting authority Example: "Federal register" - `AmenitySurcharges.Surcharge.purpose` (string) Surcharge purpose. For Air workflows possible values include Weekend Surcharge, Stopover Charge, Multiple Stopover Charges, Other (default value that covers all other surcharges such as fuel surcharges). Example: "Weekend Surcharge" - `AmenitySurcharges.Surcharge.description` (string) Description of the surcharge. Example: "Rollaway Surcharge" - `AmenitySurcharges.Surcharge.surchargeApplication` (string) Application values (such as the application of a fee) like per person or per room. Enum: same as `Surcharge.surchargeApplication` (7 values) - `AmenitySurcharges.Surcharge.surchargeFrequency` (string) The frequency of a fee such as per night or per stay. Enum: same as `Surcharge.surchargeFrequency` (6 values) - `AmenitySurcharges.Surcharge.codeAuthority` (string) Not used. Currency code authority. Example: "ISO 4217" - `AmenitySurcharges.Surcharge.decimalPlace` (integer) Decimal place for the currency unit. Example: 4 - `AmenitySurcharges.Surcharge.decimalAuthority` (string) Not used. Currency code decimal authority. Example: "ISO 4217" - `priceChangesDuringStayInd` (boolean) "If true, indicates the price changes at least once during requested dates. If roomPricingType = Per night, multiple instances of priceChangesDuringStayInd are returned." - `shortRateDescription` (string) A normalized rate description for comparing rates across multiple aggregators. Example: "Flexible Rate" - PriceBreakdownVehiclePrice: - `VehiclePrice` (object, required) Rate summary for rental of the vehicle. - `VehiclePrice.@type` (string, required) Example: "VehiclePrice" - `VehiclePrice.id` (string) Internal ID - `VehiclePrice.rateSource` (string) Assigned Type: c-1100:StringTiny - `VehiclePrice.rateGuaranteedInd` (boolean) Assigned Type: c-1100:OptionalIndicator - `VehiclePrice.ratePeriod` (string) The time period for a rate such as daily, weekly, monthly Enum: same as `VehiclePrice.ratePeriod` in "PriceBreakdownVehiclePrice" (15 values) - `VehiclePrice.RateDistance` (object) Rate for the period defined by the attributes - `VehiclePrice.RateDistance.value` (number) - `VehiclePrice.RateDistance.unlimitedDistanceInd` (boolean) if true unlimited miles is included with the rental - `VehiclePrice.RateDistance.requestedCodeAppliedInd` (boolean) if true, the requested code has been applied - `VehiclePrice.RateDistance.allowance` (integer) The distance allowance permitted with this rate. Use in combination with distanceUnits and ratePeriod - `VehiclePrice.RateDistance.distanceUnits` (string) For Hotels: Optional object to request either miles or kilometers for the search radius from the specified location. If unitOfDistance is not specified, the search defaults to miles for properties in the United States, Myanmar, and Liberia. The search defaults to kilometers in all other countries. Enum: same as `Vehicle.VehicleDateLocation.RentalPickup.GeoLocation.altitudeUnitOfDistance` in "ProductVehicle" (2 values) - `VehiclePrice.RateDistance.ratePeriod` (string) The time period for a rate such as daily, weekly, monthly Enum: same as `VehiclePrice.ratePeriod` in "PriceBreakdownVehiclePrice" (15 values) - `VehiclePrice.RateDescription` (array) - `sequence` (integer) The order of the text block, if there are more than one block. Example: 2 - `description` (string) Text block detail description Example: "description" - `Image` (object) Each instance is one image and its accompanying details, including a link to the image. Key value pairs; not all may be returned. - `Image.value` (string) URL of the image - `Image.dimensionCategory` (string) Deprecated and replaced by imageSize - `Image.width` (integer) Image width Example: 42 - `Image.height` (integer) Image height Example: 43 - `Image.caption` (string) Image caption Example: "Ticket" - `Image.pictureCategory` (integer) deprecated and replaced by pictureOf Example: 5 - `Image.imageSize` (string) A size for the image to return, allowing you to set image quality. Hospitality APIs no longer support thumbnail. Enum: same as `Vehicle.Image.imageSize` in "ProductVehicle" (5 values) - `Image.pictureOf` (string) The image category Enum: same as `Vehicle.Image.pictureOf` in "ProductVehicle" (26 values) - `URL` (string) A URL for this block - `DateCreateModify` (object, required) Time stamp of the creation. - `DateCreateModify.value` (string) Example: "2026-03-04T11:22:00Z" - `DateCreateModify.creatorID` (string) ID of creator. Software system identifier or an employee id Example: "c1234563" - `DateCreateModify.lastModify` (string) Time stamp of last modification. Example: "2026-03-04T11:24:00Z" - `DateCreateModify.lastModifierID` (string) Identifies the last software system or person to modify a record Example: "m346789" - `DateCreateModify.purge` (string) Date an item will be purged from a system of record Example: "2026-03-03" - `VehiclePrice.RateDescription.@type` (string, required) Discriminator classes TextBlock or TextBlockDetail Example: "TextBlockDetail" - `VehiclePrice.RateDescription.title` (string) "The title of the rule or information. For TermsAndConditionsFullHospitality, may include any of the following Rule Types; Promotional Data, Rate Description, Room Rate Data, Rate Text, Guarantee, Cancellation, Deposit, Check in/out, Room detail, Extra charges, Packages, Property, Location, Miscellaneous, Rate Amount, Alternate Rate Amount, Rate Comment, FAX, Phone, Special Information, Information, Room Hold Expiration Time. Not every property returns all of these types. Some properties do not return any title. Only English is supported for these values." Example: "Baggage Details" - `VehiclePrice.RateDescription.id` (string) Internally referenced id Example: "2" - `VehiclePrice.RateDescription.TextFormatted` (array, required) - `VehiclePrice.RateAvailability` (string) Options are available to sell, need to call, or closed Enum: same as `VehiclePrice.RateAvailability` in "PriceBreakdownVehiclePrice" (3 values) - `VehiclePrice.SupplierRate` (object, required) Estimated total amount - Monetary amounts expressed in another currency. - `VehiclePrice.SupplierRate.@type` (string, required) Example: "SupplierRate" - `VehiclePrice.SupplierRate.BaseRate` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.SupplierRate.BaseRate.value` (number) The amount of a given currency. Example: 124.56 - `VehiclePrice.SupplierRate.BaseRate.code` (string) An ISO 4217 alpha character code (3 characters) that specifies a money unit. Example: "USD" - `VehiclePrice.SupplierRate.BaseRate.minorUnit` (integer) Minor units are a mechanism for expressing the relationship between a major currency unit and its corresponding minor currency unit. It is the smallest unit of a given currency. For example; the smallest denomination in USD is the cent, which is 1/100 of a USD, and the minor unit value is 2. Not all currencies have a minor unit. Example: 2 - `VehiclePrice.SupplierRate.BaseRate.currencySource` (string) The system requesting or returning the currency code specified in the attribute Enum: same as `MinimumAdcolAmount.currencySource` in "ChangePermitted" (3 values) - `VehiclePrice.SupplierRate.BaseRate.approximateInd` (boolean) "If true, the currency amount has been converted from the original amount. For Air Exchange Eligibility, returned only if a currency is converted. If returned, the value is always true, indicating that the fee is approximate because of currency conversion. For Hotel Availability and Rules, true indicates this is a calculated value; false indicates this is the value returned by the property." Example: true - `VehiclePrice.SupplierRate.RateForPeriod` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.SupplierRate.DropOffCharge` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.SupplierRate.ExtraMileageCharge` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.SupplierRate.EstimatedTotalAmount` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.ApproximateRate` (object) Estimated total amount - Monetary amounts expressed in another currency. - `VehiclePrice.ApproximateRate.@type` (string, required) Example: "ApproximateRate" - `VehiclePrice.ApproximateRate.BaseRate` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.ApproximateRate.RateForPeriod` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.ApproximateRate.DropOffCharge` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.ApproximateRate.ExtraMileageCharge` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.ApproximateRate.EstimatedTotalAmount` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.CustomerLoyalty` (object) Specifies the ID for the membership program. Object for sending customer loyalty information, such as for a frequent flyer program. For Hotel send the loyalty card number in the value field, followed by programID with the hotel chain code, and supplierType: Hotel. For Air send the loyalty card number in the value field, followed by airline code in "supplier". For cross accrual use the "shareWithSupplier" field to submit to partner airlines. - `VehiclePrice.CustomerLoyalty.value` (string, required) Number on loyalty card. Example: "132456" - `VehiclePrice.CustomerLoyalty.id` (string) Optional Customer Loyalty Id. Not saved Example: "Loyalty_1" - `VehiclePrice.CustomerLoyalty.priority` (integer) Optional Numeric Priority Code Example: 2 - `VehiclePrice.CustomerLoyalty.programId` (string) "Specifies an identifier to indicate the company owner of the loyalty program. Typically two characters. For frequent guest number, the hotel supplier or brand code. For frequent flyer number, the air supplier code of the loyalty program." Example: "HY" - `VehiclePrice.CustomerLoyalty.programName` (string) Supplier's loyalty program name. Example: "Frontier-EarlyReturns" - `VehiclePrice.CustomerLoyalty.supplierType` (string) The type of supplier of a loyalty program. Uses 'hotel' for frequent guest number or 'air' for frequent flyer number. Example: "Hotel" - `VehiclePrice.CustomerLoyalty.supplier` (string) Supplier of a loyalty program (typically 2 characters representing the hotel, brand, or airline). Example: "UA" - `VehiclePrice.CustomerLoyalty.tier` (string) Customer Loyalty tier Example: "Silver" - `VehiclePrice.CustomerLoyalty.shareWithSupplier` (array) The list of suppliers that the CustomerLoyalty number is shared. Used for cross accrual. Example: ["LH"] - `VehiclePrice.CustomerLoyalty.cardHolderName` (string) Customer loyalty member name; up to 128 characters are supported. In Air Search, for discounted offers to be returned, the name must be sent as LAST FIRST; e.g.,if SMITH is the last name and JORDAN the first name, send as SMITH JORDAN Example: "John Smith" - `VehiclePrice.CustomerLoyalty.validatedInd` (boolean) Customer loyalty number has been validated by the supplier Example: true - `VehiclePrice.CustomerLoyalty.prefix` (string) The cardholder name prefix title like Mr, Mrs, Dr Example: "Dr" - `VehiclePrice.CustomerLoyalty.given` (string) The First Name of the Cardholder Example: "John" - `VehiclePrice.CustomerLoyalty.middle` (string) Middle Name of the Cardholder Example: "Wilkinson" - `VehiclePrice.CustomerLoyalty.surname` (string) Last Name of the Cardholder Example: "Smith" - `VehiclePrice.RateQualifier` (string) A closed enumeration of possible rate qualifiers for vehicle rental Enum: same as `VehiclePrice.RateQualifier` in "PriceBreakdownVehiclePrice" (5 values) - `rateGuaranteedInd` (boolean) - PriceBreakdownVehicleDeposit: - `totalPayableNowInd` (boolean) If True the Amount is the total amount payable now - `totalPayableLaterInd` (boolean) If True the Amount is the total amount payable later - PriceBreakdownVehicleCharges: - `VehicleCharges` (object) - `VehicleCharges.@type` (string, required) Example: "VehicleCharges" - `VehicleCharges.description` (string) Assigned Type: c-1100:String - `VehicleCharges.VehicleChargePurposeCode` (object) Any code used to specify an item, for example a type of traveler, service code, room amenity, etc. - `VehicleCharges.VehicleChargePurposeCode.value` (string) Example: "INS" - `VehicleCharges.VehicleChargePurposeCode.codeContext` (string) Code Context Example: "ACRISS" - `VehicleCharges.ratePeriod` (string) The time period for a rate such as daily, weekly, monthly Enum: same as `VehiclePrice.ratePeriod` in "PriceBreakdownVehiclePrice" (15 values) - `VehicleCharges.rateChargeInfo` (string) Assigned Type: c-1100:String - `VehicleCharges.RateCategory` (string) For Hotel Search, request a rate category by sending up to 8 OTA rate categories to search for. If the supplier has rates available for the requested category, the response contains those rates and indicates them as such. Some properties do not return these rates unless explicitly requested. For a Hotel Rules request, this value can be found, if returned, in the Availability response's ProductRateCodeInfo/RateCodeInfo/rateCategory. Enum: same as `VehicleCharges.RateCategory` in "PriceBreakdownVehicleCharges" (32 values) - `VehicleCharges.VehicleCoverageTypeCode` (object) The OTA code defined for the Vehicle Coverage Type - `VehicleCharges.VehicleCoverageTypeCode.value` (string) Example: "INS" - `VehicleCharges.VehicleCoverageTypeCode.codeContext` (string) Code Context Example: "ACRISS" - `VehicleCharges.Calculation` (array) - `VehicleCharges.Calculation.@type` (string, required) Example: "Calculation" - `VehicleCharges.Calculation.UnitAmount` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehicleCharges.Calculation.UnitAmount.value` (number) The amount of a given currency. Example: 124.56 - `VehicleCharges.Calculation.UnitAmount.code` (string) An ISO 4217 alpha character code (3 characters) that specifies a money unit. Example: "USD" - `VehicleCharges.Calculation.UnitAmount.minorUnit` (integer) Minor units are a mechanism for expressing the relationship between a major currency unit and its corresponding minor currency unit. It is the smallest unit of a given currency. For example; the smallest denomination in USD is the cent, which is 1/100 of a USD, and the minor unit value is 2. Not all currencies have a minor unit. Example: 2 - `VehicleCharges.Calculation.UnitAmount.currencySource` (string) The system requesting or returning the currency code specified in the attribute Enum: same as `MinimumAdcolAmount.currencySource` in "ChangePermitted" (3 values) - `VehicleCharges.Calculation.UnitAmount.approximateInd` (boolean) "If true, the currency amount has been converted from the original amount. For Air Exchange Eligibility, returned only if a currency is converted. If returned, the value is always true, indicating that the fee is approximate because of currency conversion. For Hotel Availability and Rules, true indicates this is a calculated value; false indicates this is the value returned by the property." Example: true - `VehicleCharges.Calculation.UnitName` (string) The time period for a rate such as daily, weekly, monthly Enum: same as `VehiclePrice.ratePeriod` in "PriceBreakdownVehiclePrice" (15 values) - `VehicleCharges.Calculation.Quantity` (integer) The quantity used in the calculation of the vehicle charge e.g 2 x $500 per week - `VehicleCharges.Calculation.MaxQuantity` (integer) The maximum quantity allowed for a charge e.g Baby seat charged at $10 per day for a maximum of 10 days - `VehicleCharges.Calculation.TotalAmount` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehicleCharges.Calculation.Percent` (number) Used when the charge is based on a percentage of a TotalAmount - `VehicleCharges.Calculation.Applicability` (object) Textual information. - `VehicleCharges.Calculation.Applicability.value` (string) Actual text. May be restricted by character limits based on the type of comment (e.g. Notepad remarks limited to 87 characters). Example: "Additional comments" - `VehicleCharges.Calculation.Applicability.id` (string) Local identifier within a given message for this object. Example: "comment_1" - `VehicleCharges.Calculation.Applicability.name` (string) Title of comment or type of remark. Example: "Comment name" - `VehicleCharges.Calculation.Applicability.language` (string) Language code using ISO-639 standard Example: "EN" - `VehicleCharges.taxInclusiveInd` (boolean) - `VehicleCharges.guaranteedInd` (boolean) - `VehicleCharges.payNowInd` (boolean) If true the vehicle charge must be paid now and is included in the totalPrice calculation - `VehicleCharges.includedInEstimatedTotalInd` (boolean) - `VehicleCharges.includedInBaseRateInd` (boolean) If true the Vehicle Charge has been included in the base rate of the Vehicle price - `PriceBreakdown.@type` (string, required) Discriminator - Air Search and Air Price APIs child classes are PriceBreakdownAir and PriceBreakdownAncillary. - Search Ancillaries and Seat Availabilities child classes are PriceBreakdown, PriceBreakdownAncillary, and PriceBreakdownAncillaryAir. - All Hotel API child classes are PriceBreakdownHospitality. - Vehicle API child classes are PriceBreakdownVehicleCharges, PriceBreakdownVehicleDeposit, PriceBreakdownVehiclePrice, and PriceBreakdownAncillaryVehicle. - Reservation and Reservation Workbench APIs are PriceBreakdownAir, PriceBreakdownAncillary, PriceBreakdownHospitality, PriceBreakdownVehicleCharges, PriceBreakdownVehicleDeposit, PriceBreakdownVehiclePrice, and PriceBreakdownAncillaryVehicle. Example: "PriceBreakdownAir" - `PriceBreakdown.Amount` (object) Amount represents the cost applied - `PriceBreakdown.Amount.@type` (string) - `PriceBreakdown.Amount.currencySource` (string) The system requesting or returning the currency code specified in the attribute Enum: same as `MinimumAdcolAmount.currencySource` in "ChangePermitted" (3 values) - `PriceBreakdown.Amount.CurrencyCode` (object) Currency codes are the three-letter alphabetic codes that represent the various currencies used throughout the world. Unless changed in the request, the currency is the default associated with your provisioned PCC from Travelport. For Hotel: SourceCurrency is based on the location of the hotel and used for all rates in the response. TargetCurrency is the currency code sent in the request in requestedCurrency. - `PriceBreakdown.Amount.Base` (number) The base price prior to all applicable taxes or fees of a product, such as the amount for a room or fare for a flight (one passenger). Example: 120.2 - `PriceBreakdown.Amount.Taxes` (object) Summary of all individual taxes. Child class TaxesDetail provides the breakdown of individual taxes. - `Tax` (array) - `TaxPercent` (object) Returned when the tax is expressed as a percentage of the amount. - `TaxPercent.value` (number) The tax percentage amount. Example: 5.5 - `TaxPercent.taxCode` (string) Any code for the tax. Example: "971 - IRS Notice" - `TaxPercent.reportingAuthority` (string) Tax reporting authority Example: "Georgia Department of Revenue" - `TaxPercent.purpose` (string) Purpose of tax Example: "statutory tax" - `TaxPercent.description` (string) Description Example: "1.5% of SGST" - `TaxPercent.includedInBase` (string) Yes , No , Unknown Enum: same as `instantPurchase` in "AdvanceReservationRequired" (3 values) - `PriceBreakdown.Amount.Fees` (object) Includes TotalFees object to return the sum total of any fees. May include array of Fee objects to break down individual fees. Child class FeesDetail may also include a breakdown of the individual fees. - `Fee` (array) Array of individual fees. - `PriceBreakdown.Amount.Total` (number) "Specifies the total price including base + taxes + fees. In PriceBreakdownHospitality, this total is for a given group of nights. In PriceBreakdownAir this is the total of base cost and all fees and taxes for one passenger of this PTC type." Example: 230.13 - `PriceBreakdown.Amount.approximateInd` (boolean) if true this amount has been converted from the original amount Example: true - `PriceBreakdown.Commission` (object) — one of (discriminator: @type): GDS only; not supported for NDC. Commission information. Any commission filed by an airline in a CAT35 fare is returned in PriceBreakdownAir/Commission. The amount is either a percent of the fare component (@type CommissionPercent and the Percent object) or an amount (@type CommissionAmount and the Amount object)." - CommissionAmount: - `Amount` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `Amount.value` (number) The amount of a given currency. Example: 124.56 - `Amount.code` (string) An ISO 4217 alpha character code (3 characters) that specifies a money unit. Example: "USD" - `Amount.minorUnit` (integer) Minor units are a mechanism for expressing the relationship between a major currency unit and its corresponding minor currency unit. It is the smallest unit of a given currency. For example; the smallest denomination in USD is the cent, which is 1/100 of a USD, and the minor unit value is 2. Not all currencies have a minor unit. Example: 2 - `Amount.currencySource` (string) The system requesting or returning the currency code specified in the attribute Enum: same as `MinimumAdcolAmount.currencySource` in "ChangePermitted" (3 values) - `Amount.approximateInd` (boolean) "If true, the currency amount has been converted from the original amount. For Air Exchange Eligibility, returned only if a currency is converted. If returned, the value is always true, indicating that the fee is approximate because of currency conversion. For Hotel Availability and Rules, true indicates this is a calculated value; false indicates this is the value returned by the property." Example: true - CommissionPercent: - `Percent` (number) Percent amount of commission Example: 20 - `PriceBreakdown.Commission.@type` (string, required) Discriminator. Child classes CommissionAmount or CommissionPercent Example: "CommissionAmount" - `PriceBreakdown.Commission.application` (string) Type of commission Enum: same as `PriceBreakdown.Commission.application` (6 values) - `Price.@type` (string, required) Discriminator classes Price or PriceDetail Example: "PriceDetail" - `Price.id` (string) Internally referenced id Example: "2" - `Price.CurrencyCode` (object) Currency codes are the three-letter alphabetic codes that represent the various currencies used throughout the world. Unless changed in the request, the currency is the default associated with your provisioned PCC from Travelport. For Hotel: SourceCurrency is based on the location of the hotel and used for all rates in the response. TargetCurrency is the currency code sent in the request in requestedCurrency. - `Price.CurrencyCode.value` (string) An ISO 4217 currency code. Example: "USD" - `Price.CurrencyCode.codeAuthority` (string) Currency code authority Example: "ISO 4217" - `Price.CurrencyCode.decimalPlace` (integer) Number of decimal places for the currency. Example: 4 - `Price.CurrencyCode.decimalAuthority` (string) Currency code decimal authority Example: "ISO 4217" - `Price.Base` (number) "Base price before taxes and fees. For Hotel, may not be returned by all suppliers." Example: 20.2 - `Price.TotalTaxes` (number) "Total taxes applied to the base price. For Hotel, may not be returned by all suppliers." Example: 34.4 - `Price.TotalFees` (number) Total fees included in Total Price. Example: 201 - `Price.TotalPrice` (number) Total price of this offer including the base price and all taxes and fees. Example: 34 - `Price.VendorCurrencyTotal` (object) No longer used. Previously used to expose the local vendor currency when it is different to the purchased currency - `Price.VendorCurrencyTotal.@type` (string) - `Price.VendorCurrencyTotal.currencySource` (string) The system requesting or returning the currency code specified in the attribute Enum: same as `MinimumAdcolAmount.currencySource` in "ChangePermitted" (3 values) - `Price.VendorCurrencyTotal.CurrencyCode` (object) Currency codes are the three-letter alphabetic codes that represent the various currencies used throughout the world. Unless changed in the request, the currency is the default associated with your provisioned PCC from Travelport. For Hotel: SourceCurrency is based on the location of the hotel and used for all rates in the response. TargetCurrency is the currency code sent in the request in requestedCurrency. - `Price.VendorCurrencyTotal.Base` (number) The price prior to all applicable taxes of a product such as the rate for a room or fare for a flight. Example: 120.2 - `Price.VendorCurrencyTotal.Taxes` (object) Summary of all individual taxes. Child class TaxesDetail provides the breakdown of individual taxes. - `Tax` (array) - `Tax.value` (number) Amount of the tax. Returned as 0 if a tax was marked as exempt with TaxExemption. Example: 12.2 - `Tax.currencyCode` (string) A ISO 4217 currency code associated to the value. Example: "USD" - `Tax.taxCode` (string) "Code for the tax. For Hotels this is the OTA code." Example: "XF2" - `Tax.reportingAuthority` (string) Identifies the reporting authority such as airport code for XF taxes Example: "JFK1" - `Tax.purpose` (string) Supplier returned description of tax. Example: "Fuel surcharge" - `Tax.description` (string) "Short summary of the tax. In Air workflows this is returned only for NDC. Note that descriptions are not returned for tax codes YQ and YR, which are fees charged by airlines and not government-imposed taxes. For Hotels this is the OTA tax description." Example: "Lodging tax" - `Tax.includedInBase` (string) Yes , No , Unknown Enum: same as `instantPurchase` in "AdvanceReservationRequired" (3 values) - `Tax.codeAuthority` (string) Not used. Currency Code Authority Example: "ISO" - `Tax.decimalPlace` (integer) Permitted number of decimals. Associated to the currency value. Example: 2 - `Tax.decimalAuthority` (string) Not used. Currency decimal authority Example: "ISO" - `Tax.exemptInd` (boolean) GDS only; not supported for NDC. Returned if a tax was marked exempt in a prior request with the TaxExemption pricing modifer. If true, this tax is exempt" Example: true - `Tax.nonRefundableInd` (boolean) If true, the tax is non refundable. This indicator is only supported for exchange search and exchange price quote transactions. Example: true - `Tax.excludedFromTotalPriceInd` (boolean) Returned in Hotel APIs when a tax is not included in the TotalPrice. Default behavior is for taxes to be included in TotalPrice. Example: true - `TaxPercent` (object) Returned when the tax is expressed as a percentage of the amount. - `TaxPercent.value` (number) The tax percentage amount. Example: 5.5 - `TaxPercent.taxCode` (string) Any code for the tax. Example: "971 - IRS Notice" - `TaxPercent.reportingAuthority` (string) Tax reporting authority Example: "Georgia Department of Revenue" - `TaxPercent.purpose` (string) Purpose of tax Example: "statutory tax" - `TaxPercent.description` (string) Description Example: "1.5% of SGST" - `TaxPercent.includedInBase` (string) Yes , No , Unknown Enum: same as `instantPurchase` in "AdvanceReservationRequired" (3 values) - `Price.VendorCurrencyTotal.Taxes.@type` (string, required) Discriminator class is TaxesDetail Example: "TaxesDetail" - `Price.VendorCurrencyTotal.Taxes.TotalTaxes` (number) A monetary amount, representing the total of all taxes included in this offer. Supports up to 4 decimal places; decimal place must be included. Example: 330.1 - `Price.VendorCurrencyTotal.Taxes.TaxInfo` (array) Returned for TripChange APIS only. - `Price.VendorCurrencyTotal.Taxes.TaxInfo.@type` (string) Example: "TaxInfo" - `Price.VendorCurrencyTotal.Taxes.TaxInfo.TaxCode` (string, required) The tax code Example: "XF" - `Price.VendorCurrencyTotal.Taxes.TaxInfo.CurrencyCode` (object) Currency codes are the three-letter alphabetic codes that represent the various currencies used throughout the world. Unless changed in the request, the currency is the default associated with your provisioned PCC from Travelport. For Hotel: SourceCurrency is based on the location of the hotel and used for all rates in the response. TargetCurrency is the currency code sent in the request in requestedCurrency. - `Price.VendorCurrencyTotal.Taxes.TaxInfo.Amount` (number, required) The amount of the tax applied - `Price.VendorCurrencyTotal.Taxes.TaxInfo.TaxBreakdown` (array, required) The breakdown of the tax for this tax code - `Price.VendorCurrencyTotal.Fees` (object) Includes TotalFees object to return the sum total of any fees. May include array of Fee objects to break down individual fees. Child class FeesDetail may also include a breakdown of the individual fees. - `Fee` (array) Array of individual fees. - `Fee.@type` (string) - `Fee.feeCode` (string) For Hotel, the Hotel provider's explanation of the fee; can be returned either as a code or as text. For Air, the code for the fee, such as 'OB' for OB fees." Example: "1011" - `Fee.reportingAuthority` (string) Not used. Identifies the reporting authority. Example: "OPRA" - `Fee.purpose` (string) Not used. Fee purpose Example: "Service charge" - `Fee.description` (string) Any description or text explanation of the charge. Example: "Resort Fee" - `Fee.feeApplication` (string) Application values (such as the application of a fee) like per person or per room. Enum: same as `Surcharge.surchargeApplication` (7 values) - `Fee.feeFrequency` (string) The frequency of a fee such as per night or per stay. Enum: same as `Surcharge.surchargeFrequency` (6 values) - `Fee.FeeAmountOrPercent` (object, required) Defines whether the fee is charged as an amount or percentage. - `Fee.Tax` (array) - `Fee.includedinBaseInd` (boolean) If true, indicates the fee is included in Base Price. - `Fee.includedInTotalPriceInd` (boolean) If true, indicates the fee is included in Total Price. Default behavior is for fees not to be included in TotalPrice. - `Fee.collectionMethod` (string) List of change fee method Enum: "EMD", "MCO", "Tax", "Unknown" - `Price.VendorCurrencyTotal.Fees.@type` (string, required) Discriminator. Child class FeesDetail Example: "FeesDetail" - `Price.VendorCurrencyTotal.Fees.TotalFees` (number) Total fees included in the TotalPrice. Supports up to 4 decimal places; decimal place needs to be included. Example: 111.11 - `Price.VendorCurrencyTotal.Fees.TotalAdditionalFeesPayableLocally` (number) Fees due separately at the property. Expected to be paid in local currency. These fees are not included in the Offer TotalPrice. Example: 2.1 - `Price.VendorCurrencyTotal.Total` (number) Specifies the total price including base + taxes + fees Example: 30.13 - `Price.VendorCurrencyTotal.approximateInd` (boolean) True if this amount has been converted from the original amount Example: true - `FareRuleListResponse.ReferenceList.@type` (string, required) Discriminator - Air Search child classes are ReferenceListAmenity, ReferenceListBrand, ReferenceListFlight, ReferenceListProduct, ReferenceListTermsAndConditions, and ReferenceListUniversalProductAttribute. - Air Price child classes are ReferenceListAmenity and ReferenceListBrand. - FareRules child class is ReferenceListFlight. - Search Ancillaries child class is ReferenceListFlight. - Seat Map child class is ReferenceListSeatingChart. - Hotel Availability child class is ReferenceListPropertyDates. - Reservation and Reservation Workbench child classes are ReferenceListAmenity, ReferenceListBrand, and ReferenceListUniversalProductAttribute. - Exchange Search child classes are ReferenceListBrand, ReferenceListFlight, and ReferenceListExchangedPrice. - Reservation Receipt child classes are ReferenceListOffer and ReferenceListTraveler. - Book_Traveler child class is ReferenceListTraveler. Example: "ReferenceListFlight" - `FareRuleListResponse.ReferenceList.id` (string) Uniquely identifies for the Reference List ## Response 400 fields (application/json): - `ErrorResponse` (object) Base common error response - `ErrorResponse.@type` (string) Example: "response" - `ErrorResponse.transactionId` (string) A unique system-generated (128 bit GUID format) transaction/tracking id for a single request and response (i.e. for a single transaction) used for internal tracking and troubleshooting. Also known as E2ETrackingId. Not returned in all Hotel API responses. Example: "49f58f5f-c443-43b4-9f5d-be405fd00a01" - `ErrorResponse.traceId` (string) Used in hospitality workflows to provide a Unique transaction or tracking id for a single request and response. For Air Eligibility, returned if a custom trace ID was sent in the request header. For Hotel Rules, returned if a custom trace ID was sent in the request header. Example: "TraceID_123456" - `ErrorResponse.correlationId` (string) Identifier used to correlate hotel API invocations across a multi-call business flow. - `ErrorResponse.reservationStatus` (string) Status of reservation or offer completion. Enum: "Success", "Fail", "Partial", "Pending", "OnHold", "Retry", "Other" - `ErrorResponse.Result` (object) Returns the error and/or warning message information, if applicable. - `ErrorResponse.Identifier` (object) A globally unique identifier key often used to reference a given option (such as Pricing, Booking, Rules, or additional workflows) or to retrieve information (such as Hotel pagination). - `ErrorResponse.NextSteps` (object) Container for the steps that describe actions that may be taken on the containing object. Not applicable for an Eligibility or Exchange response. - `ErrorResponse.NextSteps.baseURI` (string, required) The base portion of the uri in order to shorten the uris in the individual steps - `ErrorResponse.NextSteps.id` (string) Optional internally referenced id Example: "5" - `ErrorResponse.NextSteps.NextStep` (array, required) - `ErrorResponse.NextSteps.NextStep.value` (string) Example: "www.resourcelocation.com" - `ErrorResponse.NextSteps.NextStep.id` (string) Identifier for the Next Step Example: "2" - `ErrorResponse.NextSteps.NextStep.action` (string, required) The action this next step is intended to achieve Example: "cancel" - `ErrorResponse.NextSteps.NextStep.method` (string, required) Describes the set of potential methods that can be taken after an operation. Enum: "GET", "DELETE", "PUT", "POST" - `ErrorResponse.NextSteps.NextStep.description` (string) Additional clarification for the next step Example: "remove offer from the order" - `ErrorResponse.ReferenceList` (array) — one of (discriminator: @type): - ReferenceListSeatingChart: - `SeatingChart` (array) - `SeatingChart.@type` (string, required) Discriminator. Example: "SeatingChart" - `SeatingChart.id` (string) Internally reference id - `SeatingChart.Cabin` (array, required) - `SeatingChart.Cabin.@type` (string) Example: "Cabin" - `SeatingChart.Cabin.name` (string, required) The name of the cabin Example: "Economy" - `SeatingChart.Cabin.Layout` (array, required) - `SeatingChart.Cabin.Layout.value` (string) - `SeatingChart.Cabin.Layout.position` (array, required) Enum: same as `SeatingChart.Cabin.Layout.position` in "ReferenceListSeatingChart" (7 values) - `SeatingChart.Cabin.Layout.startRow` (integer, required) Start row for this Cabin Layout - `SeatingChart.Cabin.Layout.endRow` (integer, required) End row for this Cabin Layout - `SeatingChart.Cabin.Row` (array, required) - `SeatingChart.Cabin.Row.@type` (string) Example: "Row" - `SeatingChart.Cabin.Row.label` (string) The identifier for the row Example: "78" - `SeatingChart.Cabin.Row.Space` (array, required) - `SeatingChart.Cabin.Row.Characteristic` (array) - ReferenceListFlight: - `Flight` (array, required) - `AvailabilitySourceCode` (string) GDS only; not supported for NDC. Optional but Recommended to send in the full payload request. Returned to assist in troubleshooting. Returned in the Search, Air Availability, Exchange Search, AirPrice, and Workbench Commit responses. Not returned for Ancillary Shop or Fare Rules. Recommended to send in the AirPrice Full Payload and Add Offer Full Payload requests. Enum: same as `AvailabilitySourceCode` (23 values) - `Flight.@type` (string, required) Discriminator. Child classes Flight and FlightDetail. Example: "FlightDetail" - `Flight.id` (string) Local id within a given message to support referencing this object - an internal flight identifier. Example: "126" - `Flight.FlightRef` (string) Reference id that corresponds to the flight 'id' in ReferenceListFlight.Flight. Example: "s1" - `Flight.Identifier` (object) A globally unique identifier key often used to reference a given option (such as Pricing, Booking, Rules, or additional workflows) or to retrieve information (such as Hotel pagination). - `Flight.distance` (integer) Distance covered by the flight. Example: 6574 - `Flight.stops` (integer) Number of stops Example: 2 - `Flight.duration` (string) Elapsed flight time. Represented in hours (H) and minutes (M) OR the format PT{x}H{x}M, in which P is the duration designator, T is the time designator, {x}H is the number of hours for the connection, and {x}H is the number of minutes for the connection. Example: "PT1H40M" - `Flight.carrier` (string, required) The airline code. Example: "BA" - `Flight.number` (string, required) The marketing carrier flight number. Example: "98" - `Flight.operatingCarrier` (string) The operating airline code. Shown in codeshare situations when the operating carrier is different to the marketing carrier. Example: "BA" - `Flight.operatingCarrierName` (string) The operating carrier name Example: "Liberty Aerospace" - `Flight.operatingCarrierNumber` (string) Operating airline flight number. If there is no operating carrier number, then CO2 emission estimates for operating carriers is not supported. GDS only; not returned for NDC. Returned only in Search response. Example: "091" - `Flight.equipment` (string) Equipment model. Note that TRN, TRS, and BUS equipment codes indicate ground transportation. Example: "777" - `Flight.Departure` (object, required) Departure details for a given leg. - `terminal` (string) Departure terminal, returned when available. Example: "Terminal 1" - `country` (string) Country of to departure or arrival Example: "US" - `Flight.Departure.@type` (string, required) Discriminator classes Departure or DepartureDetail Example: "DepartureDetail" - `Flight.Departure.location` (string, required) IATA code for departure airport or city for this leg of the itinerary. Example: "AMS" - `Flight.Departure.date` (string, required) Departure date in YYYY-MM-DD format. Example: "0011-10-17" - `Flight.Departure.time` (string, required) Departure date in HH:mm:ss (24-hour format). Example: "04:45:00" - `Flight.Arrival` (object, required) - `terminal` (string) Arrival terminal, returned when available. Example: "Terminal 1" - `country` (string) Country of to departure or arrival Example: "US" - `Flight.Arrival.@type` (string, required) Discriminator classes Arrival or ArrivalDetail Example: "ArrivalDetail" - `Flight.Arrival.location` (string, required) IATA code for arrival airport or city for this leg of the itinerary. Example: "MAD" - `Flight.Arrival.date` (string, required) Arrival date in YYYY-MM-DD format. Example: "0011-10-17" - `Flight.Arrival.time` (string) Arrival date in HH:mm:ss (24-hour format). Example: "04:45:00" - `Flight.IntermediateStop` (array) - `Flight.IntermediateStop.value` (string) The IATA airport code for the airport where the intermediate stop occurs. - `Flight.IntermediateStop.arrivalFlightDuration` (string) Duration in hours and minutes of the flight arriving at the intermediate stop. ISO 8601 format Example: "PT2H35M" - `Flight.IntermediateStop.departureFlightDuration` (string) Duration in hours and minutes of the flight departing the intermediate stop. ISO 8601 format Example: "PT1H35M" - `Flight.IntermediateStop.duration` (string) Duration in hours and minutes between the arrival and departure at the intermediate stop. ISO 8601 format Example: "PT1H35M" - `Flight.IntermediateStop.equipment` (string) Equipment model, if there is a change of equipment during the stop. Example: "777" - `Flight.IntermediateStop.arrivalDate` (string) The local date the aircraft arrives at the intermediate stop Example: "2026-04-30" - `Flight.IntermediateStop.departureDate` (string) The local date the aircraft departs from the intermediate stop Example: "2026-04-30" - `Flight.IntermediateStop.arrivalTime` (string) The local time the aircraft arrives at the intermediate stop Example: "68400" - `Flight.IntermediateStop.departurelTime` (string) The local time the aircraft departs from the intermediate stop Example: "72000" - `Flight.IntermediateStop.arrivalTerminal` (string) Arrival terminal of the intermediate stop airport Example: "Terminal2" - `Flight.IntermediateStop.departureTerminal` (string) Departure terminal of the intermediate stop airport Example: "Terminal4" - `Flight.subjectToGovernmentApprovalInd` (boolean) If true, the airline has filed in its schedule that availability for a specific flight is subject to government approval. GDS only, not supported for NDC. Returned only in the Air Search API response. Example: true - ReferenceListAmenity: - `Amenity` (array, required) One instance for each specific amenity. - `Amenity.@type` (string, required) Discriminator. No child classes. Example: "Amenity" - `Amenity.id` (string, required) A unique Travelport-assigned amenity id used for cross-referencing by each flight with this amenity. Example: "amenity_001" - `Amenity.Category` (string, required) Flight amenity categories may include the following data as provided by ATPCO. - Aircraft: cabin pressure, model and type. - Beverage: alcoholic and non-alcoholic beverages and whether available for a fee or free; highlights premium beverages in business/first. - Entertainment: passenger entertainment options. - Flight: airline flight schedules and equipment types with the associated amenities ID for each carrier. - Food: food per flight and flight cabin and whether available for a fee or free; food is classified as breakfast, lunch, dinner, snacks, and light meals, and as premium when available in business/first. - Layout: seating layout such as classic layouts to premium cabin configurations. - Power: availability of AC power outlets, USB ports, or both. - Seat: physical seat type for every sub fleet in every cabin of the aircraft, including legroom, pitch, width, flatness and type. Note that seat metrics are returned in centimeters because the default language is English. - WiFi: availability, type, coverage, rollout, performance, and whether available free or for a fee. Example: "Entertainment" - `Amenity.Text` (object) A free text description of the amenity. - `Amenity.Text.value` (string) A short free text description. - `Amenity.Text.language` (string) The language the text is provided in. ISO639 format. Example: "EN" - ReferenceListProduct: - `Product` (array) — one of (discriminator: @type): - ProductAir: - `totalDuration` (string) Total duration of the combined segments in hours (H) and minutes (M). ISO 8601 format. Example: "PT2H40M" - `FlightSegment` (array, required) One instance for each flight segment in the product. - `FlightSegment.@type` (string) Discriminator. No child classes. Example: "FlightSegment" - `FlightSegment.id` (string) Local identifier within a given message for this object. For AirPrice this identifier starts with s as in s1, s2, etc. Example: "flightSegment_01" - `FlightSegment.sequence` (integer, required) Order of the flight segment. e.g. 1 for the first segment on the leg. Example: 1 - `FlightSegment.connectionDuration` (string) When a flight connection exists, this is the lapsed time between the connecting flights in the format PT{x}H{x}M, in which P is the duration designator, T is the time designator, {x}H is the number of hours for the connection, and {x}M is the number of minutes for the connection. Example: "PT1H3M" - `FlightSegment.amenityRefs` (array) If RouteHappy flight amenities were requested (includeFlightAmenitiesInd=true), amenityRefs is returned to cross-reference the amenities available on this flight and listed in ReferenceList/ReferenceListAmenity. Example: ["[\"amenity_1\",\"amenity_2\"]"] - `FlightSegment.universalProductAttributeRefs` (array) If universal product attributes (UPAs) for RouteHappy data were requested (includeUniversalProductAttributesInd=true) along with RouteHappy flight amenities, universalProductAttributeRefs is returned. Cross-reference the universalProductAttributeRef with the universalProductAttribute 'id' in ReferenceListUniversalProductAttribute.UniversalProductAttribute. UPAs provide images, icons, and URLs as provided by ATPCO. RouteHappy data must have also been requested per amenityRefs above. Example: ["[\"upa_1\",\"upa_2\"]"] - `FlightSegment.Flight` (object, required) Flight common schema. Used across Air workflow. One instance for each flight in the FlightSegment. A direct flight option has one Flight object while connecting flights have a Flight object for each flight on the leg. - `distance` (integer) Distance covered by the flight. Example: 6574 - `stops` (integer) Number of stops Example: 2 - `duration` (string) Elapsed flight time. Represented in hours (H) and minutes (M) OR the format PT{x}H{x}M, in which P is the duration designator, T is the time designator, {x}H is the number of hours for the connection, and {x}H is the number of minutes for the connection. Example: "PT1H40M" - `carrier` (string, required) The airline code. Example: "BA" - `number` (string, required) The marketing carrier flight number. Example: "98" - `operatingCarrier` (string) The operating airline code. Shown in codeshare situations when the operating carrier is different to the marketing carrier. Example: "BA" - `operatingCarrierName` (string) The operating carrier name Example: "Liberty Aerospace" - `operatingCarrierNumber` (string) Operating airline flight number. If there is no operating carrier number, then CO2 emission estimates for operating carriers is not supported. GDS only; not returned for NDC. Returned only in Search response. Example: "091" - `equipment` (string) Equipment model. Note that TRN, TRS, and BUS equipment codes indicate ground transportation. Example: "777" - `Departure` (object, required) Departure details for a given leg. - `terminal` (string) Departure terminal, returned when available. Example: "Terminal 1" - `country` (string) Country of to departure or arrival Example: "US" - `Departure.@type` (string, required) Discriminator classes Departure or DepartureDetail Example: "DepartureDetail" - `Departure.location` (string, required) IATA code for departure airport or city for this leg of the itinerary. Example: "AMS" - `Departure.date` (string, required) Departure date in YYYY-MM-DD format. Example: "0011-10-17" - `Departure.time` (string, required) Departure date in HH:mm:ss (24-hour format). Example: "04:45:00" - `Arrival` (object, required) - `terminal` (string) Arrival terminal, returned when available. Example: "Terminal 1" - `country` (string) Country of to departure or arrival Example: "US" - `Arrival.@type` (string, required) Discriminator classes Arrival or ArrivalDetail Example: "ArrivalDetail" - `Arrival.location` (string, required) IATA code for arrival airport or city for this leg of the itinerary. Example: "MAD" - `Arrival.date` (string, required) Arrival date in YYYY-MM-DD format. Example: "0011-10-17" - `Arrival.time` (string) Arrival date in HH:mm:ss (24-hour format). Example: "04:45:00" - `IntermediateStop` (array) - `IntermediateStop.value` (string) The IATA airport code for the airport where the intermediate stop occurs. - `IntermediateStop.arrivalFlightDuration` (string) Duration in hours and minutes of the flight arriving at the intermediate stop. ISO 8601 format Example: "PT2H35M" - `IntermediateStop.departureFlightDuration` (string) Duration in hours and minutes of the flight departing the intermediate stop. ISO 8601 format Example: "PT1H35M" - `IntermediateStop.duration` (string) Duration in hours and minutes between the arrival and departure at the intermediate stop. ISO 8601 format Example: "PT1H35M" - `IntermediateStop.equipment` (string) Equipment model, if there is a change of equipment during the stop. Example: "777" - `IntermediateStop.arrivalDate` (string) The local date the aircraft arrives at the intermediate stop Example: "2026-04-30" - `IntermediateStop.departureDate` (string) The local date the aircraft departs from the intermediate stop Example: "2026-04-30" - `IntermediateStop.arrivalTime` (string) The local time the aircraft arrives at the intermediate stop Example: "68400" - `IntermediateStop.departurelTime` (string) The local time the aircraft departs from the intermediate stop Example: "72000" - `IntermediateStop.arrivalTerminal` (string) Arrival terminal of the intermediate stop airport Example: "Terminal2" - `IntermediateStop.departureTerminal` (string) Departure terminal of the intermediate stop airport Example: "Terminal4" - `subjectToGovernmentApprovalInd` (boolean) If true, the airline has filed in its schedule that availability for a specific flight is subject to government approval. GDS only, not supported for NDC. Returned only in the Air Search API response. Example: true - `FlightSegment.IntermediateStopAmenities` (array) - `FlightSegment.IntermediateStopAmenities.@type` (string, required) Discriminator. No child classes. Example: "IntermediateStopAmenities" - `FlightSegment.IntermediateStopAmenities.departureLocation` (string, required) The departure location. Example: "NYC" - `FlightSegment.IntermediateStopAmenities.arrivalLocation` (string, required) The arrival location. Example: "DEN" - `FlightSegment.IntermediateStopAmenities.amenityRefs` (array) List of amenity references for this portion of the flight. Example: ["amenity_1"] - `FlightSegment.IntermediateStopAmenities.universalProductAttributeRefs` (array) List of UPA references for this portion of the flight. Example: ["upa_1"] - `FlightSegment.OperationalStatus` (object) The operational status of the flight - `FlightSegment.OperationalStatus.value` (string) List of operational flight status Enum: same as `FlightSegment.OperationalStatus.value` in "ProductAir" (5 values) - `FlightSegment.boundFlightsInd` (boolean) GDS only; not supported for NDC. Indicates flight segments are married/bound. When 'true', indicates the flight segments in a single or double connection must be sold together. When true, the indicator is returned for all leading segments on one leg of the flight, and not returned for the last segment of the bound flight leg journey, indicating where the bound flights end. For example, if an origin and destination pair has 3 flight segments, boundFlightsInd is returned for the first two segments on that leg. If the segments are not bound, boundFlightsInd is false and not returned. Example: true - `FlightSegment.CO2Actual` (object) Used for dimensional units (width, height, depth) or weight - `FlightSegment.CO2Actual.value` (number) Example: 2.22 - `FlightSegment.CO2Actual.measurementType` (string) The type of measurement such as width, height, weight Enum: same as `FlightSegment.CO2Actual.measurementType` in "ProductAir" (5 values) - `FlightSegment.CO2Actual.unit` (string) The unit of measure in a code format. Refer to OpenTravel Code List Unit of Measure Code (UOM). Enum: same as `FlightSegment.CO2Actual.unit` in "ProductAir" (28 values) - `PassengerFlight` (array, required) - `PassengerFlight.@type` (string) Discriminator. No child classes. Example: "PassengerFlight" - `PassengerFlight.passengerQuantity` (integer) Number of passengers of the specified passenger type code. Example: 26 - `PassengerFlight.passengerTypeCode` (string) Passenger type code applicable to the offer/offering. This may be different to the requested passenger type code sent in PassengerCriteria. Example: "ADT" - `PassengerFlight.FlightProduct` (array) - `PassengerFlight.FlightProduct.@type` (string) Discriminator. No child classes. Example: "FlightProduct" - `PassengerFlight.FlightProduct.segmentSequence` (array, required) Order of the corresponding flight in the sequence. Note that the segmentSequence value for connecting flights is the same; for example, for two connecting flights on the outbound or first leg of the itinerary, both flights have the segmentSequence value 1. Example: [1] - `PassengerFlight.FlightProduct.classOfService` (string) The class of service code. Example: "F" - `PassengerFlight.FlightProduct.cabin` (string) Specifies the cabin type. If sent for Flight Specific Search, this field is ignored. Many carriers use Business and First as the same cabin. If the request is for Business and only First is available, the response returns only First and returns a message that the cabin class may differ from the class requested. Some carriers do not support lowFareFinderInd with Premium First cabin class. Enum: same as `PassengerFlight.FlightProduct.cabin` in "ProductAir" (5 values) - `PassengerFlight.FlightProduct.fareBasisCode` (string) Fare basis code for the flight. For NDC, also returns the ticket designator after a slash (/) following the fare basis code. GDS ticket designators are returned in ticketDesignator." Example: "YEE1Y" - `PassengerFlight.FlightProduct.fareType` (string) Indicates the type of fare that applies to this Offer/Offering. NetFare is not supported for NDC. Enum: same as `PassengerFlight.FlightProduct.fareType` in "ProductAir" (4 values) - `PassengerFlight.FlightProduct.carCode` (string) The car code or deal code. Net remit. May be a Commercial Airline Agreement number." AirPrice returns the net ticket data (NTD) if a fare returned has a private fare component and private fares were requested (fareType of AgencyPrivateFare). GDS only; not supported for NDC. Example: "P1234" - `PassengerFlight.FlightProduct.valueCode` (string) The value code for the fare. Net remit. AirPrice returns the net ticket data (NTD) if a fare returned has a private fare component and private fares were requested (fareType of AgencyPrivateFare). GDS only; not supported for NDC. Example: "365" - `PassengerFlight.FlightProduct.Brand` (object) Brand ID parent class, returned for branded fares. - `name` (string, required) Brand name from the supplier. Example: "Main Cabin Extra" - `tier` (integer) The brand tier. Not returned for NDC. Example: 2 - `shelfNumbers` (array) ATPCO shelf number. If the carrier has provided it for this brand, the shelf number is the number for a grouping of comparable brands that share similar ticket and flight attributes. Example: [1,4,5] - `code` (string) The ATPCO Brand Code. Example: "REFMAIN" - `BrandAttribute` (array) A list of enumerated features that are included, chargeable, or not offered for this brand. Contains one or more instances of the two paired key value pairs classification and inclusion. The return of brand attributes can be disabled in the AirPrice Reference Payload request. - `AdditionalBrandAttribute` (array) Array of non-enumerated features that are included, chargeable, or not offered for this brand. Contains one or more instances of the two paired key value pairs classification and inclusion. - `ImageURL` (array) Example: ["http:/imageurl.com"] - `PassengerFlight.FlightProduct.Brand.@type` (string, required) Discriminator. Child classes BrandID and Brand. BrandCompleteInfo is no longer in use. Example: "BrandID" - `PassengerFlight.FlightProduct.Brand.id` (string) Local id within a given message to support referencing this object. Example: "brand_001" - `PassengerFlight.FlightProduct.Brand.BrandRef` (string) Reference id that corresponds to the brand 'id' in ReferenceListBrand.Brand. Example: "brandRef_001" - `PassengerFlight.FlightProduct.Brand.Identifier` (object) A globally unique identifier key often used to reference a given option (such as Pricing, Booking, Rules, or additional workflows) or to retrieve information (such as Hotel pagination). - `PassengerFlight.FlightProduct.CustomerLoyaltyCredit` (array) - `PassengerFlight.FlightProduct.ClassOfServiceAvailability` (array) - `PassengerFlight.FlightProduct.stopoverPriced` (string) Yes , No , Unknown Enum: same as `instantPurchase` in "AdvanceReservationRequired" (3 values) - `PassengerFlight.FlightProduct.ticketDesignator` (string) GDS only; not supported for NDC. (NDC ticket designators are returned in fareBasisCode after a slash (/), following the fare basis code.) Returns the ticket designator for GDS. The ticket designator is a code used by airlines to indicate the type of discount applied to a fare. An airline may have a specific ticket designator used to differentiate its fares, which may also signify anything from private fares, wholesale, promotion, or discounted fares." Example: "BB5662Y" - `PassengerFlight.FlightProduct.fareTypeCode` (string) GDS only; not supported for NDC. Identifies whether the fare is bundled or unbundled by providing the ATPCO defined fare type code when the coresponding response includes unbundled fares." Example: "ERU" - `PassengerFlight.FlightProduct.FareQualifierString` (string) NDC only. Not supported for GDS. Fare qualifier of a private leisure fares. Example: "[\"Tour\"]" - `PassengerFlight.FlightProduct.FareQualifier` (object) deprecated - do not use - `PassengerFlight.FlightProduct.FareQualifier.value` (string) Deprecated - do not use. Replaced by FareQualiferString Enum: same as `PassengerFlight.FlightProduct.FareQualifier.value` in "ProductAir" (11 values) - ProductAncillary: - `Ancillary` (object) - `FlightRef` (array) The list of travel segments the ancillary applies to - `Ancillary.@type` (string, required) Discriminator classes Ancillary, AncillaryAir, AncillaryAirBaggage, and AncillaryAirSeat Example: "AncillaryAir" - `Ancillary.quantity` (integer) The quantity value - `Ancillary.Description` (array) - `Ancillary.Description.value` (string) The text description of the ancillary. Example: "Vegetarian Meal" - `Ancillary.Description.code` (string) The ATPCO group code. Example: "BG" - `Ancillary.Description.subCode` (string) The ATPCO RFISC subcode. Example: "0D4" - `Ancillary.Description.subGroup` (string) The ATPCO sub group code. Example: "SP" - `Ancillary.Description.codeContext` (string) The code context value. Example: "ATPCO" - `Ancillary.Description.ssrCode` (string) The four character AIRIMP SSR code for this ancillary. Example: "VGML" - `Ancillary.Description.issuanceReasonCode` (string) The airline provided reason for issuance code. Example: "C" - `Ancillary.Description.geographicSpecification` (string) How the ancillary is applied across the itinerary. Enum: same as `Ancillary.Description.geographicSpecification` in "ProductAncillary" (3 values) - `Ancillary.Comments` (object) Comments object to relay free text information In ProductAncillary.Ancillary this is used to expose when additional comments are required to book the ancillary. In BuildAncillaryOffersFromCatalogOfferings this is used to pass additional ancillary text required to book the ancillary. - `Ancillary.Comments.@type` (string) Example: "Comments" - `Ancillary.Comments.Comment` (array) - `Ancillary.Comments.Comment.value` (string) Actual text. May be restricted by character limits based on the type of comment (e.g. Notepad remarks limited to 87 characters). Example: "Additional comments" - `Ancillary.Comments.Comment.id` (string) Local identifier within a given message for this object. Example: "comment_1" - `Ancillary.Comments.Comment.name` (string) Title of comment or type of remark. Example: "Comment name" - `Ancillary.Comments.Comment.language` (string) Language code using ISO-639 standard Example: "EN" - `selectedByDefaultInd` (boolean) - `bundledInd` (boolean) If true, this product is the lead ancillary bundle and is followed by a list of individual ancillary products. - ProductSeatAvailability: - `SeatAvailability` (array, required) - `SeatAvailability.value` (array) - `SeatAvailability.seatAvailabilityStatus` (string) The list of availabile statuses of the seat for a traveler. Enum: same as `SeatAvailability.seatAvailabilityStatus` in "ProductSeatAvailability" (7 values) - `SeatAvailability.codeContext` (string) The code context value Example: "ATPCO" - `SeatAvailability.paidSeatInd` (boolean) If true, the seat is a paid ancillary seat. This seat may be zero value due to traveler specific conditions - `Brand` (object) Brand ID parent class, returned for branded fares. - `name` (string, required) Brand name from the supplier. Example: "Main Cabin Extra" - `tier` (integer) The brand tier. Not returned for NDC. Example: 2 - `shelfNumbers` (array) ATPCO shelf number. If the carrier has provided it for this brand, the shelf number is the number for a grouping of comparable brands that share similar ticket and flight attributes. Example: [1,4,5] - `code` (string) The ATPCO Brand Code. Example: "REFMAIN" - `BrandAttribute` (array) A list of enumerated features that are included, chargeable, or not offered for this brand. Contains one or more instances of the two paired key value pairs classification and inclusion. The return of brand attributes can be disabled in the AirPrice Reference Payload request. - `BrandAttribute.@type` (string, required) Discriminator. No child classes. Example: "BrandAttribute" - `BrandAttribute.classification` (string, required) The Travelport classification used for a category of ancillaries. Additional items can be sent in AdditionalClassification Enum: same as `BrandAttribute.classification` (11 values) - `BrandAttribute.inclusion` (string, required) The indicator as to how the brand and the product are associated. Enum: same as `BrandAttribute.inclusion` (3 values) - `BrandAttribute.ImageURL` (array) URL for an image for the brand, when available. Example: ["http:/imageurl.com"] - `BrandAttribute.matchedAttributeInd` (boolean) Returned only if true for any attribute requested in ProductInclusionPreference.Classification. Example: true - `BrandAttribute.groupCode` (string) Carrier group code. Returned if filed by the carrier. Example: "BG" - `BrandAttribute.subGroupCode` (string) Carrier sub group code. Returned if filed by the carrier. Example: "CY" - `BrandAttribute.subCode` (string) Carrier sub code. Returned if filed by the carrier. Example: "08A" - `AdditionalBrandAttribute` (array) Array of non-enumerated features that are included, chargeable, or not offered for this brand. Contains one or more instances of the two paired key value pairs classification and inclusion. - `AdditionalBrandAttribute.@type` (string, required) Discriminator. No child classes. Example: "AdditionalBrandAttribute" - `AdditionalBrandAttribute.Classification` (string, required) The Travelport classification used for categories of ancillaries. Supported attributes currently include ChauffeurTransfer, ExtraLegroom, InFlightEntertainment, LoungeAccess, PriorityBaggage, PriorityBoarding, PriorityCheckIn, PrioritySecurity, PriorityServices,MileageAccrual, Upgrades, USB. Example: "ChauffeurTransfer" - `AdditionalBrandAttribute.Inclusion` (string, required) The indicator as to how the brand and the product are associated. Enum: same as `BrandAttribute.inclusion` (3 values) - `AdditionalBrandAttribute.ImageURL` (array) URL for an image for the brand, when available. Example: ["https:/travelport/image/profile/firstviewimage"] - `AdditionalBrandAttribute.matchedAttributeInd` (boolean) Returned only if true for any attribute requested in ProductInclusionPreference.Classification. Example: true - `AdditionalBrandAttribute.groupCode` (string) Carrier group code. Returned if filed by the carrier. Example: "BG" - `AdditionalBrandAttribute.subGroupCode` (string) Carrier sub group code. Returned if filed by the carrier. Example: "CY" - `AdditionalBrandAttribute.subCode` (string) Carrier sub code. Returned if filed by the carrier. Example: "08A" - `ImageURL` (array) Example: ["http:/imageurl.com"] - `Brand.@type` (string, required) Discriminator. Child classes BrandID and Brand. BrandCompleteInfo is no longer in use. Example: "BrandID" - `Brand.id` (string) Local id within a given message to support referencing this object. Example: "brand_001" - `Brand.BrandRef` (string) Reference id that corresponds to the brand 'id' in ReferenceListBrand.Brand. Example: "brandRef_001" - `Brand.Identifier` (object) A globally unique identifier key often used to reference a given option (such as Pricing, Booking, Rules, or additional workflows) or to retrieve information (such as Hotel pagination). - `SeatingChartRef` (string) The reference id of the SeatingChart in the reference list - ProductHospitality: - `bookingCode` (string) Send the value returned from the Availability response ProductOptions/ProductBooking. - `passiveBookingReasonCode` (string) Enum: same as `passiveBookingReasonCode` in "ProductHospitality" (8 values) - `guests` (integer) Total number of guests. Numeric values 1-9 inclusive supported. - `moreRatesToken` (string) More rates token - `adaCompliant` (string) Yes , No , Unknown Enum: same as `instantPurchase` in "AdvanceReservationRequired" (3 values) - `propertyName` (string) Name of property offering this product. Example: "Hilton Garden Inn Brighton" - `associatedCityCode` (string) The logistically closest city associated to the property Example: "LON" - `associatedAirportCode` (string) The logistically closest airport associated to the property Example: "LGW" - `PropertyAddress` (object) The property or billing address information. - `addressType` (string) OTA code for address type Example: "CLT" - `use` (string) OTA code for address use Example: "AUT" - `Comment` (object) Textual information. - `Comment.value` (string) Actual text. May be restricted by character limits based on the type of comment (e.g. Notepad remarks limited to 87 characters). Example: "Additional comments" - `Comment.id` (string) Local identifier within a given message for this object. Example: "comment_1" - `Comment.name` (string) Title of comment or type of remark. Example: "Comment name" - `Comment.language` (string) Language code using ISO-639 standard Example: "EN" - `Privacy` (object) Confidential details for marketing purpose - `Privacy.id` (string) Optional internally referenced id Example: "2" - `Privacy.shareMarketing` (string) Used to indicate marketing preferences, Yes, No, Inherit Enum: same as `Privacy.shareMarketing` (3 values) - `Privacy.shareSync` (string) Used to indicate marketing preferences, Yes, No, Inherit Enum: same as `Privacy.shareMarketing` (3 values) - `Privacy.optOutInd` (string) Used to indicate marketing preferences, Yes, No, Inherit Enum: same as `Privacy.shareMarketing` (3 values) - `Privacy.optInStatus` (string) Used to indicate marketing preferences, OptIn, OptOut Enum: same as `Privacy.optInStatus` (3 values) - `Privacy.optInDate` (string) The datetime of receiving the opt in notice Example: "2026-08-07T12:12:00Z" - `Privacy.optOutDate` (string) The datetime the opt out notice was received Example: "2026-08-07T12:12:00Z" - `Priority` (integer) The priority ranking within the group Example: 1 - `validInd` (boolean) If true, this is a valid and complete mailing address that has been verified through an address verification service or previously mailed materials have not been returned. - `provisionedInd` (boolean) If true, this address came into the system through provisioning - `PropertyAddress.@type` (string, required) Discriminator classes Address or AddressDetail Example: "AddressDetail" - `PropertyAddress.id` (string) unique address id Example: "Address_1" - `PropertyAddress.BldgRoom` (object) Address with building and room number - `PropertyAddress.BldgRoom.value` (string) Example: "Moore House" - `PropertyAddress.BldgRoom.buldingInd` (boolean) When true, the information is a building name. When false, it is an apartment or room # Example: true - `PropertyAddress.Number` (object) The street number alone is the numerical number that precedes the street name in the address. - `PropertyAddress.Number.value` (string) Street number value. Example: "23B" - `PropertyAddress.Number.streetNmbrSuffix` (string) Street Number Suffix Example: "B" - `PropertyAddress.Number.streetDirection` (string) Direction of the Street Example: "NW" - `PropertyAddress.Number.ruralRouteNmbr` (string) RuralRoute Number Example: "76" - `PropertyAddress.Number.po_Box` (string) PO Box Number Example: "1001" - `PropertyAddress.Street` (string) Street name. May also contain the street number when the Number element is missing. Example: "ABC Street" - `PropertyAddress.AddressLine` (array) Property street address. Used in place of Street and Number. Each element of the array represents an address line. Example: ["2035 S Havana street"] - `PropertyAddress.City` (string, required) Full name of the city, town, or postal station (i.e., a postal service territory, often used in a military address). Example: "Dublin" - `PropertyAddress.County` (string) County or Region Name. Example: "Berkshire" - `PropertyAddress.StateProv` (object) The standard code or abbreviation for the state, province, or region. May also include full length name. - `PropertyAddress.StateProv.value` (string) State, province, or region code needed to identify location (typically two characters). Example: "CA" - `PropertyAddress.StateProv.name` (string) State, province, or region name needed to identify location. Example: "California" - `PropertyAddress.Country` (object) Contains the information needed to identify a country. - `PropertyAddress.Country.value` (string) The ISO 3166 code for the property's address. Example: "US" - `PropertyAddress.Country.id` (string) Custom user-assigned identifier for the country. Example: "23" - `PropertyAddress.Country.name` (string) The full name of the country for the property's address. Example: "United States" - `PropertyAddress.Country.codeContext` (string) The source of a code, such as the organization that provided the id number Example: "IATA" - `PropertyAddress.PostalCode` (string) Postal code for the address. Example: "Sl6 1AB" - `PropertyAddress.Addressee` (string) The name of the company or person to be addressed Example: "ACME INC" - `PropertyAddress.role` (string) Defines the type of location the address is assigned to. For TravelAgency address leave blank or use "Other". Enum: same as `PropertyAddress.role` in "ProductHospitality" (7 values) - `Telephone` (object) - `phoneLocationType` (string) Location of the phone Example: "Agency" - `phoneTechType` (string) Indicates the type of technology associated with the telephone number Example: "Voice" - `phoneUseType` (string) Agency code for how phone is used (e.g., Home, Business, Emergency Contact, Travel Arranger, Day, Evening). Example: "Home" - `pin` (string) Additional codes used for telephone Example: "3456" - `priority` (integer) Priority Example: 1 - `Privacy` (object) Confidential details for marketing purpose - `Privacy.id` (string) Optional internally referenced id Example: "2" - `Privacy.shareMarketing` (string) Used to indicate marketing preferences, Yes, No, Inherit Enum: same as `Privacy.shareMarketing` (3 values) - `Privacy.shareSync` (string) Used to indicate marketing preferences, Yes, No, Inherit Enum: same as `Privacy.shareMarketing` (3 values) - `Privacy.optOutInd` (string) Used to indicate marketing preferences, Yes, No, Inherit Enum: same as `Privacy.shareMarketing` (3 values) - `Privacy.optInStatus` (string) Used to indicate marketing preferences, OptIn, OptOut Enum: same as `Privacy.optInStatus` (3 values) - `Privacy.optInDate` (string) The datetime of receiving the opt in notice Example: "2026-08-07T12:12:00Z" - `Privacy.optOutDate` (string) The datetime the opt out notice was received Example: "2026-08-07T12:12:00Z" - `Enum_TelephoneRole` (string) Defines the type of location the Telephone is assigned to. For Travel Agency telephone select "Other" or leave blank. Enum: same as `Enum_TelephoneRole` (6 values) - `Comment` (object) Textual information. - `Comment.value` (string) Actual text. May be restricted by character limits based on the type of comment (e.g. Notepad remarks limited to 87 characters). Example: "Additional comments" - `Comment.id` (string) Local identifier within a given message for this object. Example: "comment_1" - `Comment.name` (string) Title of comment or type of remark. Example: "Comment name" - `Comment.language` (string) Language code using ISO-639 standard Example: "EN" - `defaultInd` (boolean) When true, indicates a default value should be used. Example: true - `provisionedInd` (boolean) true indicates this phone number was created through provisioned - `Telephone.@type` (string, required) Discriminator classes Telephone or TelephoneDetail Example: "Telephone" - `Telephone.countryAccessCode` (string) Phone country code Example: "1" - `Telephone.areaCityCode` (string) Phone local area code Example: "972" - `Telephone.phoneNumber` (string, required) Mobile/Telephone Number. Accepted characters are numeric, dash, space, and period. Example: "972-000-787" - `Telephone.extension` (string) Telephone extension number Example: "234" - `Telephone.id` (string) Optional internally referenced id Example: "3" - `Telephone.cityCode` (string) IATA city code if referenced by phone number. Example: "DEN" - `Telephone.role` (string) Defines the type of location the Telephone is assigned to. For Travel Agency telephone select "Other" or leave blank. Enum: same as `Enum_TelephoneRole` (6 values) - `Email` (object) Electronic email addresses, in IETF specified format. Booking.com requires a traveler email address in the Hotel Create Reservation and Add Reservation requests. A system-generated confirmation email is sent to the traveler after the booking completes. - `Email.value` (string) Example: "exampledomain@example.com" - `Email.id` (string) Electronic email addresses, in IETF specified format. Example: "email_1" - `Email.emailType` (string) Use email type to specify if the email is to be sent "TO" or sent "FROM" Example: "FROM" - `Email.comment` (string) Comments associated to the email - `Email.preferredFormat` (string) Mime media type Example: "text/html" - `Email.shareMarketing` (string) Used to indicate marketing preferences, Yes, No, Inherit Enum: same as `Privacy.shareMarketing` (3 values) - `Email.shareSync` (string) Used to indicate marketing preferences, Yes, No, Inherit Enum: same as `Privacy.shareMarketing` (3 values) - `Email.optOutInd` (string) Used to indicate marketing preferences, Yes, No, Inherit Enum: same as `Privacy.shareMarketing` (3 values) - `Email.optInStatus` (string) Used to indicate marketing preferences, OptIn, OptOut Enum: same as `Privacy.optInStatus` (3 values) - `Email.optInDate` (string) The datetime of receiving the opt in notice Example: "2026-03-03T11:11:00Z" - `Email.optOutDate` (string) The datetime the opt out notice was received Example: "2026-03-03T11:11:00Z" - `Email.validInd` (boolean) If true, this is a valid email address that has been system verified via a successful email transmission. Example: true - `Email.provisionedInd` (boolean) If true then the email address came from the provisioning process Example: true - `GuestCounts` (object) The number and age(s) of guests within the room. - `GuestCounts.@type` (string) Example: "GuestCounts" - `GuestCounts.GuestCount` (array, required) - `GuestCounts.GuestCount.@type` (string) Example: "GuestCount" - `GuestCounts.GuestCount.age` (integer) The age of the guest. Required only when request includes a child in the room. Example: 21 - `GuestCounts.GuestCount.count` (integer) Number of guests. Supports numeric values 1-9 inclusive. Example: 2 - `GuestCounts.GuestCount.ageQualifyingCode` (string) "Required only for children or if traveler age is relevant, such as for a senior discount. Supported values include '8' and '10'. 8: Traveler in this GuestCount is a child. 10: Traveler in this GuestCount is an adult." Example: "10" - `PropertyKey` (object, required) Contains up to 250 PropertyKey objects. Each PropertyKey object identifies one property. - `PropertyKey.@type` (string) - `PropertyKey.chainCode` (string, required) Code for the hotel chain (typically 2 characters) Example: "UR" - `PropertyKey.propertyCode` (string, required) The property code of the requested property (typically 5 characters). Example: "G3375" - `TravelerContact` (object) Identifies the traveler contact information delivered to the hotel supplier for this segment - `TravelerContact.@type` (string, required) Example: "TravelerContact" - `TravelerContact.Email` (object) Electronic email addresses, in IETF specified format. Booking.com requires a traveler email address in the Hotel Create Reservation and Add Reservation requests. A system-generated confirmation email is sent to the traveler after the booking completes. - `TravelerContact.Telephone` (object) - `phoneLocationType` (string) Location of the phone Example: "Agency" - `phoneTechType` (string) Indicates the type of technology associated with the telephone number Example: "Voice" - `phoneUseType` (string) Agency code for how phone is used (e.g., Home, Business, Emergency Contact, Travel Arranger, Day, Evening). Example: "Home" - `pin` (string) Additional codes used for telephone Example: "3456" - `priority` (integer) Priority Example: 1 - `Privacy` (object) Confidential details for marketing purpose - `Privacy.id` (string) Optional internally referenced id Example: "2" - `Privacy.shareMarketing` (string) Used to indicate marketing preferences, Yes, No, Inherit Enum: same as `Privacy.shareMarketing` (3 values) - `Privacy.shareSync` (string) Used to indicate marketing preferences, Yes, No, Inherit Enum: same as `Privacy.shareMarketing` (3 values) - `Privacy.optOutInd` (string) Used to indicate marketing preferences, Yes, No, Inherit Enum: same as `Privacy.shareMarketing` (3 values) - `Privacy.optInStatus` (string) Used to indicate marketing preferences, OptIn, OptOut Enum: same as `Privacy.optInStatus` (3 values) - `Privacy.optInDate` (string) The datetime of receiving the opt in notice Example: "2026-08-07T12:12:00Z" - `Privacy.optOutDate` (string) The datetime the opt out notice was received Example: "2026-08-07T12:12:00Z" - `Enum_TelephoneRole` (string) Defines the type of location the Telephone is assigned to. For Travel Agency telephone select "Other" or leave blank. Enum: same as `Enum_TelephoneRole` (6 values) - `Comment` (object) Textual information. - `Comment.value` (string) Actual text. May be restricted by character limits based on the type of comment (e.g. Notepad remarks limited to 87 characters). Example: "Additional comments" - `Comment.id` (string) Local identifier within a given message for this object. Example: "comment_1" - `Comment.name` (string) Title of comment or type of remark. Example: "Comment name" - `Comment.language` (string) Language code using ISO-639 standard Example: "EN" - `defaultInd` (boolean) When true, indicates a default value should be used. Example: true - `provisionedInd` (boolean) true indicates this phone number was created through provisioned - `RoomType` (object) Provides details regarding rooms, such as characteristics, descriptions, and amenities. - `numberOfUnits` (integer) The number of rooms that have been combined to create this room type. - `reqdGuaranteeType` (string) TODO-(Should this be Guarantee?)Denotes the form of guarantee for this room. - `AdditionalDetails` (object) A collection of AdditionalDetail. - `AdditionalDetails.@type` (string) Example: "AdditionalDetails" - `AdditionalDetails.AdditionalDetail` (array, required) - `AdditionalDetails.AdditionalDetail.@type` (string) Example: "AdditionalDetail" - `AdditionalDetails.AdditionalDetail.detailType` (string) OTA Code - `AdditionalDetails.AdditionalDetail.code` (string) Partner code - `AdditionalDetails.AdditionalDetail.Amount` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `AdditionalDetails.AdditionalDetail.Amount.value` (number) The amount of a given currency. Example: 124.56 - `AdditionalDetails.AdditionalDetail.Amount.code` (string) An ISO 4217 alpha character code (3 characters) that specifies a money unit. Example: "USD" - `AdditionalDetails.AdditionalDetail.Amount.minorUnit` (integer) Minor units are a mechanism for expressing the relationship between a major currency unit and its corresponding minor currency unit. It is the smallest unit of a given currency. For example; the smallest denomination in USD is the cent, which is 1/100 of a USD, and the minor unit value is 2. Not all currencies have a minor unit. Example: 2 - `AdditionalDetails.AdditionalDetail.Amount.currencySource` (string) The system requesting or returning the currency code specified in the attribute Enum: same as `MinimumAdcolAmount.currencySource` in "ChangePermitted" (3 values) - `AdditionalDetails.AdditionalDetail.Amount.approximateInd` (boolean) "If true, the currency amount has been converted from the original amount. For Air Exchange Eligibility, returned only if a currency is converted. If returned, the value is always true, indicating that the fee is approximate because of currency conversion. For Hotel Availability and Rules, true indicates this is a calculated value; false indicates this is the value returned by the property." Example: true - `AdditionalDetails.AdditionalDetail.Description` (object) A descriptive text string and the related language. - `RoomOccupancy` (array) - `RoomOccupancy.@type` (string) - `RoomOccupancy.minOccupancy` (integer) The minimum occupancy - `RoomOccupancy.maxOccupancy` (integer) The maximum number of room occupants. - `RoomOccupancy.AgeQualifying` (array) - `RoomOccupancy.AgeQualifying.@type` (string) Example: "AgeQualifying" - `RoomOccupancy.AgeQualifying.minAge` (integer) MinAge: The minimum age to qualify for AgeQualifyingCode. - `RoomOccupancy.AgeQualifying.maxAge` (integer) Max Age: The maximum age to qualify for AgeQualifyingCode. - `RoomOccupancy.AgeQualifying.ageBucket` (string) The age bucket - `RoomOccupancy.AgeQualifying.count` (integer) The number of age qualifying - `RoomOccupancy.AgeQualifying.ageQualifyingCode` (string) Enter 10 for an adult or 08 for a child Example: "10" - `roomInd` (boolean) Indicates the room is a sleeping room when true. - `convertedInd` (boolean) Indicates the room is converted when true. - `alternateInd` (boolean) Indicates the room is an alternate room type to the requested room type when true. - `RoomType.@type` (string, required) Example: "RoomType" - `RoomType.RoomCharacteristics` (object) Used to define a room (eg. its location, configuration, view). - `RoomType.RoomCharacteristics.@type` (string) - `RoomType.RoomCharacteristics.typeCode` (string) OTA room type code. - `RoomType.RoomCharacteristics.viewCode` (string) OTA code describing the view. - `RoomType.RoomCharacteristics.viewDescription` (string) Free text describing the view Example: "Mountain View" - `RoomType.RoomCharacteristics.smokingAllowed` (string) Yes , No , Unknown Enum: same as `instantPurchase` in "AdvanceReservationRequired" (3 values) - `RoomType.RoomCharacteristics.wifiIncluded` (string) Yes , No , Unknown Enum: same as `instantPurchase` in "AdvanceReservationRequired" (3 values) - `RoomType.RoomCharacteristics.BedConfiguration` (array) - `RoomType.RoomCharacteristics.BedConfiguration.quantity` (integer) The number of beds of a specified type in the room. - `RoomType.RoomCharacteristics.BedConfiguration.bedType` (string) Bed type. Possible values include King Bed(s), Queen Bed(s), Twin Bed(s), Sofa Bed(s), and OTHER Bed(s). - `RoomType.RoomCharacteristics.BedConfiguration.size` (string) Approximate measurement/size of the bed(s) in the room. - `RoomType.RoomCharacteristics.nonSmokingInd` (boolean) - `RoomType.RoomCharacteristics.accessibleRoom` (string) Yes , No , Unknown Enum: same as `instantPurchase` in "AdvanceReservationRequired" (3 values) - `RoomType.RoomCharacteristics.category` (string) Category of the room. - `RoomType.RoomCharacteristics.shortRoomDescription` (string) Normalized text for grouping rates against similar room types. Example: "2 Queen bed(s) Standard Room Smoking" - `RoomType.Description` (object) A descriptive text string and the related language. - `RoomType.Description.value` (string) Descriptive text provided by the supplier. Example: "Ticket exchanged, room description text, or check in/out policy details." - `RoomType.Description.languages` (array) The language code of the description text. Example: ["English"] - `RoomType.Description.title` (string) Title of the Text Example: "Group details." - `RoomType.RoomAmenity` (array) - `RoomType.RoomAmenity.@type` (string) - `RoomType.RoomAmenity.description` (string) Description of amenity received from supplier. Example: "WiFi" - `RoomType.RoomAmenity.quantity` (integer) quantity of amenity - `RoomType.RoomAmenity.Name` (string) Room Amenity Name Example: "24 hour Room Service" - `RoomType.RoomAmenity.Inclusion` (array) - `RoomType.RoomAmenity.includedInd` (boolean) Represents if the amenity is included with the rate - `RoomType.RoomAmenity.surchargeInd` (boolean) Represents if the amenity attracts a surcharge. - `RoomType.RoomAmenity.code` (string) OTA code used to describe the room amenity. This is optional in the Properties Search request but mandatory in the response. - `DateRange` (object) Specifies the begin and end date of an event, such as check-in and check-out dates. - `DateRange.start` (string, required) Specifies the start date for an event, such as a booking or check-in date in YYYY-MM-DD format. Example: "2026-03-03" - `DateRange.end` (string, required) Specifies the end date an event, such as a booking or check-out date in YYYY-MM-DD format. Example: "2026-03-03" - `SpecialInstruction` (string) Customer generated special instructions transmitted to the hotel. Example: "Guest prefers room on first floor." - ProductVehicle: - `Vehicle` (object) Vehicles such as rental cars, buses, trams, motorcycles. - `Vehicle.@type` (string, required) Example: "VehicleDetail" - `Vehicle.TransmissionTypeCode` (object) Any code used to specify an item, for example a type of traveler, service code, room amenity, etc. - `Vehicle.TransmissionTypeCode.value` (string) Example: "INS" - `Vehicle.TransmissionTypeCode.codeContext` (string) Code Context Example: "ACRISS" - `Vehicle.VehicleCategoryCode` (object) Any code used to specify an item, for example a type of traveler, service code, room amenity, etc. - `Vehicle.FuelTypeCode` (object) Any code used to specify an item, for example a type of traveler, service code, room amenity, etc. - `Vehicle.VehicleSizeCode` (object) Any code used to specify an item, for example a type of traveler, service code, room amenity, etc. - `Vehicle.VehicleClassCode` (object) Any code used to specify an item, for example a type of traveler, service code, room amenity, etc. - `Vehicle.baggageQuantity` (integer) Baggage Quantity that is able to fit into the car with passengers - `Vehicle.passengerQuantity` (string) Assigned Type: c-1100:StringTiny - `Vehicle.doorCount` (string) The number of doors for the vehicle - `Vehicle.Image` (object) Each instance is one image and its accompanying details, including a link to the image. Key value pairs; not all may be returned. - `Vehicle.Image.value` (string) URL of the image - `Vehicle.Image.dimensionCategory` (string) Deprecated and replaced by imageSize - `Vehicle.Image.width` (integer) Image width Example: 42 - `Vehicle.Image.height` (integer) Image height Example: 43 - `Vehicle.Image.caption` (string) Image caption Example: "Ticket" - `Vehicle.Image.pictureCategory` (integer) deprecated and replaced by pictureOf Example: 5 - `Vehicle.Image.imageSize` (string) A size for the image to return, allowing you to set image quality. Hospitality APIs no longer support thumbnail. Enum: same as `Vehicle.Image.imageSize` in "ProductVehicle" (5 values) - `Vehicle.Image.pictureOf` (string) The image category Enum: same as `Vehicle.Image.pictureOf` in "ProductVehicle" (26 values) - `Vehicle.VehicleMakeModel` (object) The make and model of the vehicle along with a description - `Vehicle.VehicleMakeModel.value` (string) - `Vehicle.VehicleMakeModel.code` (string) The 4 character code for the make and model of the vehicle. Example: "ECMR" - `Vehicle.VehicleMakeModel.supplierReference` (string) - `Vehicle.VehicleMakeModel.codeContext` (string) Code context Example: "ISO" - `Vehicle.VehicleMakeModel.vendorCode` (string) The 2 character vendor code Example: "ZI" - `Vehicle.VehicleMakeModel.operatingSupplierCode` (string) - `Vehicle.VehicleMakeModel.operatingSupplierName` (string) - `Vehicle.airConditioningInd` (boolean) True if vehicle has air conditioning - `Vehicle.VehicleDateLocation` (object) Pickup, return and vendor datetime and locations. - `Vehicle.VehicleDateLocation.@type` (string, required) Example: "VehicleDateLocation" - `Vehicle.VehicleDateLocation.RentalPickup` (object, required) - `Vehicle.VehicleDateLocation.RentalPickup.@type` (string, required) Example: "RentalPickup" - `Vehicle.VehicleDateLocation.RentalPickup.date` (string, required) The local date of the pickup or return Example: "2024-10-23" - `Vehicle.VehicleDateLocation.RentalPickup.time` (string, required) The local time of the pickup or return - `Vehicle.VehicleDateLocation.RentalPickup.VendorLocation` (object, required) The vendor's location number for pickup or return - `Vehicle.VehicleDateLocation.RentalPickup.VendorLocation.@type` (string, required) Example: "VendorLocation" - `Vehicle.VehicleDateLocation.RentalPickup.VendorLocation.rentalLocationNumber` (string) Assigned Type: ctvh-1100:RentalLocationNumber - `Vehicle.VehicleDateLocation.RentalPickup.VendorLocation.vendorCode` (string) The two character vendor code Example: "ZI" - `Vehicle.VehicleDateLocation.RentalPickup.VendorLocation.RentalLocationCode` (object) Locations based on the OTA VWF list - `Vehicle.VehicleDateLocation.RentalPickup.VendorLocation.RentalLocationCode.value` (string) Example: "INS" - `Vehicle.VehicleDateLocation.RentalPickup.VendorLocation.RentalLocationCode.codeContext` (string) Code Context Example: "ACRISS" - `Vehicle.VehicleDateLocation.RentalPickup.VendorLocation.CounterLocationCode` (object) Counter location of the vehicle rental - `Vehicle.VehicleDateLocation.RentalPickup.VendorLocation.CounterLocationCode.value` (string) Example: "INS" - `Vehicle.VehicleDateLocation.RentalPickup.VendorLocation.CounterLocationCode.codeContext` (string) Code Context Example: "ACRISS" - `Vehicle.VehicleDateLocation.RentalPickup.VendorLocation.rentalLocationName` (string) Assigned Type: c-1100:StringShort - `Vehicle.VehicleDateLocation.RentalPickup.VendorLocation.code` (string, required) The vendor location code - `Vehicle.VehicleDateLocation.RentalPickup.VendorLocation.Address` (object) The property or billing address information. - `addressType` (string) OTA code for address type Example: "CLT" - `use` (string) OTA code for address use Example: "AUT" - `Comment` (object) Textual information. - `Privacy` (object) Confidential details for marketing purpose - `Priority` (integer) The priority ranking within the group Example: 1 - `validInd` (boolean) If true, this is a valid and complete mailing address that has been verified through an address verification service or previously mailed materials have not been returned. - `provisionedInd` (boolean) If true, this address came into the system through provisioning - `Vehicle.VehicleDateLocation.RentalPickup.VendorLocation.Address.@type` (string, required) Discriminator classes Address or AddressDetail Example: "AddressDetail" - `Vehicle.VehicleDateLocation.RentalPickup.VendorLocation.Address.id` (string) unique address id Example: "Address_1" - `Vehicle.VehicleDateLocation.RentalPickup.VendorLocation.Address.BldgRoom` (object) Address with building and room number - `Vehicle.VehicleDateLocation.RentalPickup.VendorLocation.Address.Number` (object) The street number alone is the numerical number that precedes the street name in the address. - `Vehicle.VehicleDateLocation.RentalPickup.VendorLocation.Address.Street` (string) Street name. May also contain the street number when the Number element is missing. Example: "ABC Street" - `Vehicle.VehicleDateLocation.RentalPickup.VendorLocation.Address.AddressLine` (array) Property street address. Used in place of Street and Number. Each element of the array represents an address line. Example: ["2035 S Havana street"] - `Vehicle.VehicleDateLocation.RentalPickup.VendorLocation.Address.City` (string, required) Full name of the city, town, or postal station (i.e., a postal service territory, often used in a military address). Example: "Dublin" - `Vehicle.VehicleDateLocation.RentalPickup.VendorLocation.Address.County` (string) County or Region Name. Example: "Berkshire" - `Vehicle.VehicleDateLocation.RentalPickup.VendorLocation.Address.StateProv` (object) The standard code or abbreviation for the state, province, or region. May also include full length name. - `Vehicle.VehicleDateLocation.RentalPickup.VendorLocation.Address.Country` (object) Contains the information needed to identify a country. - `Vehicle.VehicleDateLocation.RentalPickup.VendorLocation.Address.PostalCode` (string) Postal code for the address. Example: "Sl6 1AB" - `Vehicle.VehicleDateLocation.RentalPickup.VendorLocation.Address.Addressee` (string) The name of the company or person to be addressed Example: "ACME INC" - `Vehicle.VehicleDateLocation.RentalPickup.VendorLocation.Address.role` (string) Defines the type of location the address is assigned to. For TravelAgency address leave blank or use "Other". Enum: same as `PropertyAddress.role` in "ProductHospitality" (7 values) - `Vehicle.VehicleDateLocation.RentalPickup.VendorLocation.Telephone` (array) - `phoneLocationType` (string) Location of the phone Example: "Agency" - `phoneTechType` (string) Indicates the type of technology associated with the telephone number Example: "Voice" - `phoneUseType` (string) Agency code for how phone is used (e.g., Home, Business, Emergency Contact, Travel Arranger, Day, Evening). Example: "Home" - `pin` (string) Additional codes used for telephone Example: "3456" - `priority` (integer) Priority Example: 1 - `Privacy` (object) Confidential details for marketing purpose - `Enum_TelephoneRole` (string) Defines the type of location the Telephone is assigned to. For Travel Agency telephone select "Other" or leave blank. Enum: same as `Enum_TelephoneRole` (6 values) - `Comment` (object) Textual information. - `defaultInd` (boolean) When true, indicates a default value should be used. Example: true - `provisionedInd` (boolean) true indicates this phone number was created through provisioned - `Vehicle.VehicleDateLocation.RentalPickup.VendorLocation.Description` (string) Detailed location information on where to pick up and return a vehicle - `Vehicle.VehicleDateLocation.RentalPickup.VendorLocation.OperationTimes` (array) - `Vehicle.VehicleDateLocation.RentalPickup.VendorLocation.Directions` (string) Directions for collecting the vehicle - `Vehicle.VehicleDateLocation.RentalPickup.VendorLocation.AdditionalInstructions` (string) Additional instructions regarding the vendor location - `Vehicle.VehicleDateLocation.RentalPickup.VendorLocation.ShuttleService` (string) Information on shuttle service - `Vehicle.VehicleDateLocation.RentalPickup.GeoLocation` (object) For Hotel: the geographic coordinates of the property. - `Vehicle.VehicleDateLocation.RentalPickup.GeoLocation.latitude` (number, required) Numeric value representing latitude of search center point in degrees and decimal minutes. Example: 38.8951 - `Vehicle.VehicleDateLocation.RentalPickup.GeoLocation.longitude` (number, required) Numeric value representing longitude of search center point in degrees and decimal minutes. Example: -77.0364 - `Vehicle.VehicleDateLocation.RentalPickup.GeoLocation.altitude` (number) The height of a location, typically measured above sea level Example: 5280 - `Vehicle.VehicleDateLocation.RentalPickup.GeoLocation.altitudeUnitOfDistance` (string) For Hotels: Optional object to request either miles or kilometers for the search radius from the specified location. If unitOfDistance is not specified, the search defaults to miles for properties in the United States, Myanmar, and Liberia. The search defaults to kilometers in all other countries. Enum: same as `Vehicle.VehicleDateLocation.RentalPickup.GeoLocation.altitudeUnitOfDistance` in "ProductVehicle" (2 values) - `Vehicle.VehicleDateLocation.RentalPickup.GeoLocation.positionAccuracy` (string) Specifies the level of accuracy for the position Enum: same as `Vehicle.VehicleDateLocation.RentalPickup.GeoLocation.positionAccuracy` in "ProductVehicle" (11 values) - `Vehicle.VehicleDateLocation.RentalPickup.GeoLocation.mapURL` (string) link for embedded map showing location Example: "www.destinationmap.com" - `Vehicle.VehicleDateLocation.RentalPickup.GeoLocation.formatURL` (string) The URL to the format for the latitude and longitude for this location. Example: "www.destinationmap.com" - `Vehicle.VehicleDateLocation.RentalPickup.timeString` (string) - `Vehicle.VehicleDateLocation.RentalReturn` (object, required) - `Vehicle.VehicleDateLocation.RentalReturn.@type` (string, required) Example: "RentalReturn" - `Vehicle.VehicleDateLocation.RentalReturn.date` (string, required) The local date of the pickup or return Example: "2024-10-23" - `Vehicle.VehicleDateLocation.RentalReturn.time` (string, required) The local time of the pickup or return Example: "54000" - `Vehicle.VehicleDateLocation.RentalReturn.VendorLocation` (object, required) The vendor's location number for pickup or return - `Vehicle.VehicleDateLocation.RentalReturn.GeoLocation` (object) For Hotel: the geographic coordinates of the property. - `Product.@type` (string, required) Discriminator. - Air Search child classes are ProductAir and ProductAncillary. - Exchange Search child class is ProductAir. - Ancillary Search child class is ProductAncillary. - Seat Map child class is ProductSeatAvailability. - Air Price child classes are ProductAir and ProductAncillary. - Hotel Availability child classes are ProductHospitality and ProductHospitalityOffer. - Hotel Rules and HotelReservation child classes are ProductHospitality. - All Vehicle APIs child classes are ProductVehicle and ProductAncillaryVehicle. - Reservation and Reservation Workbench child classes are ProductAir, ProductAncillary, ProductHospitality, ProductVehicle, and ProductAncillaryVehicle. Example: "ProductAir" - `Product.id` (string) Local id within a given message to support referencing this object. Example: "product_1" - `Product.productRef` (string) Reference id that corresponds to the product 'id' in ReferenceListProduct.Product. To find flight details for a product, use the ProductRef id to identify the product in ReferenceListProduct.Product, and use the Flight id's (e.g., s3, s4) to match to flight information in ReferenceListFlight.Flight. Example: "product_1" - `Product.Identifier` (object) A globally unique identifier key often used to reference a given option (such as Pricing, Booking, Rules, or additional workflows) or to retrieve information (such as Hotel pagination). - `Product.Quantity` (integer) "The quantity of the product. For Hotel Create Reservation (Full Payload) request, the number of rooms requested; 1-9 inclusive supported. If not provided, default is 1. For Hotel responses, the number of rooms currently available matching this rate. In Air Search quantity represents the number of seats available for that Product. If the Product has connecting flights, Quantity returns the lowest number available. For example, if the first flight has 9 seats in Y class and the connecting flight has 4 seats in Y class, Quantity returns a value of 4." Example: 2 - ReferenceListTraveler: - `Traveler` (array) - `Traveler.@type` (string, required) Discriminator classes TravelerID or Traveler Example: "Traveler" - `Traveler.id` (string) - `Traveler.TravelerRef` (string) - `Traveler.Identifier` (object) A globally unique identifier key often used to reference a given option (such as Pricing, Booking, Rules, or additional workflows) or to retrieve information (such as Hotel pagination). - `Traveler.birthDate` (string) Date of Birth YYYY-MM-DD Example: "2021-06-05" - `Traveler.gender` (string) Gender Type Male, Female etc. This field is not used by Hotel APIs and will be ignored. Enum: same as `Traveler.gender` in "ReferenceListTraveler" (4 values) - `Traveler.PersonName` (object, required) Travelport+ limits the combination of Given and Surname to 22 characters. Given name must have at least one character. Any PersonName exceeding 22 characters is truncated in the response. - `personNameType` (string) OTA Code Enum: same as `personNameType` (4 values) - `language` (string) 'ISO639 code of the language the name is represented Example: "EN" - `SurnamePrefix` (string) The surname prefix Example: "Von" - `Suffix` (string) Hold various name suffixes and letters Example: "Jr." - `Title` (string) Degree or honors Example: "DR" - `Privacy` (object) Confidential details for marketing purpose - `Privacy.id` (string) Optional internally referenced id Example: "2" - `Privacy.shareMarketing` (string) Used to indicate marketing preferences, Yes, No, Inherit Enum: same as `Privacy.shareMarketing` (3 values) - `Privacy.shareSync` (string) Used to indicate marketing preferences, Yes, No, Inherit Enum: same as `Privacy.shareMarketing` (3 values) - `Privacy.optOutInd` (string) Used to indicate marketing preferences, Yes, No, Inherit Enum: same as `Privacy.shareMarketing` (3 values) - `Privacy.optInStatus` (string) Used to indicate marketing preferences, OptIn, OptOut Enum: same as `Privacy.optInStatus` (3 values) - `Privacy.optInDate` (string) The datetime of receiving the opt in notice Example: "2026-08-07T12:12:00Z" - `Privacy.optOutDate` (string) The datetime the opt out notice was received Example: "2026-08-07T12:12:00Z" - `defaultInd` (boolean) If true, this is the default or primary name within a collection of names. Example: true - `Traveler.PersonName.@type` (string, required) Discriminator classes PersonName or PersonNameDetail Example: "PersonNameDetail" - `Traveler.PersonName.Prefix` (string) Salutation of honorific (e.g. Mr., Mrs., Ms., Miss, Dr.) Example: "Mr" - `Traveler.PersonName.Given` (string) Given name, first name or names. Example: "John" - `Traveler.PersonName.Middle` (string) The middle name of the person name. Example: "Erick" - `Traveler.PersonName.Surname` (string, required) Family name, last name. Example: "Smith" - `Traveler.Address` (array) - `addressType` (string) OTA code for address type Example: "CLT" - `use` (string) OTA code for address use Example: "AUT" - `Comment` (object) Textual information. - `Comment.value` (string) Actual text. May be restricted by character limits based on the type of comment (e.g. Notepad remarks limited to 87 characters). Example: "Additional comments" - `Comment.id` (string) Local identifier within a given message for this object. Example: "comment_1" - `Comment.name` (string) Title of comment or type of remark. Example: "Comment name" - `Comment.language` (string) Language code using ISO-639 standard Example: "EN" - `Privacy` (object) Confidential details for marketing purpose - `Privacy.id` (string) Optional internally referenced id Example: "2" - `Privacy.shareMarketing` (string) Used to indicate marketing preferences, Yes, No, Inherit Enum: same as `Privacy.shareMarketing` (3 values) - `Privacy.shareSync` (string) Used to indicate marketing preferences, Yes, No, Inherit Enum: same as `Privacy.shareMarketing` (3 values) - `Privacy.optOutInd` (string) Used to indicate marketing preferences, Yes, No, Inherit Enum: same as `Privacy.shareMarketing` (3 values) - `Privacy.optInStatus` (string) Used to indicate marketing preferences, OptIn, OptOut Enum: same as `Privacy.optInStatus` (3 values) - `Privacy.optInDate` (string) The datetime of receiving the opt in notice Example: "2026-08-07T12:12:00Z" - `Privacy.optOutDate` (string) The datetime the opt out notice was received Example: "2026-08-07T12:12:00Z" - `Priority` (integer) The priority ranking within the group Example: 1 - `validInd` (boolean) If true, this is a valid and complete mailing address that has been verified through an address verification service or previously mailed materials have not been returned. - `provisionedInd` (boolean) If true, this address came into the system through provisioning - `Traveler.Address.@type` (string, required) Discriminator classes Address or AddressDetail Example: "AddressDetail" - `Traveler.Address.id` (string) unique address id Example: "Address_1" - `Traveler.Address.BldgRoom` (object) Address with building and room number - `Traveler.Address.BldgRoom.value` (string) Example: "Moore House" - `Traveler.Address.BldgRoom.buldingInd` (boolean) When true, the information is a building name. When false, it is an apartment or room # Example: true - `Traveler.Address.Number` (object) The street number alone is the numerical number that precedes the street name in the address. - `Traveler.Address.Number.value` (string) Street number value. Example: "23B" - `Traveler.Address.Number.streetNmbrSuffix` (string) Street Number Suffix Example: "B" - `Traveler.Address.Number.streetDirection` (string) Direction of the Street Example: "NW" - `Traveler.Address.Number.ruralRouteNmbr` (string) RuralRoute Number Example: "76" - `Traveler.Address.Number.po_Box` (string) PO Box Number Example: "1001" - `Traveler.Address.Street` (string) Street name. May also contain the street number when the Number element is missing. Example: "ABC Street" - `Traveler.Address.AddressLine` (array) Property street address. Used in place of Street and Number. Each element of the array represents an address line. Example: ["2035 S Havana street"] - `Traveler.Address.City` (string, required) Full name of the city, town, or postal station (i.e., a postal service territory, often used in a military address). Example: "Dublin" - `Traveler.Address.County` (string) County or Region Name. Example: "Berkshire" - `Traveler.Address.StateProv` (object) The standard code or abbreviation for the state, province, or region. May also include full length name. - `Traveler.Address.StateProv.value` (string) State, province, or region code needed to identify location (typically two characters). Example: "CA" - `Traveler.Address.StateProv.name` (string) State, province, or region name needed to identify location. Example: "California" - `Traveler.Address.Country` (object) Contains the information needed to identify a country. - `Traveler.Address.Country.value` (string) The ISO 3166 code for the property's address. Example: "US" - `Traveler.Address.Country.id` (string) Custom user-assigned identifier for the country. Example: "23" - `Traveler.Address.Country.name` (string) The full name of the country for the property's address. Example: "United States" - `Traveler.Address.Country.codeContext` (string) The source of a code, such as the organization that provided the id number Example: "IATA" - `Traveler.Address.PostalCode` (string) Postal code for the address. Example: "Sl6 1AB" - `Traveler.Address.Addressee` (string) The name of the company or person to be addressed Example: "ACME INC" - `Traveler.Address.role` (string) Defines the type of location the address is assigned to. For TravelAgency address leave blank or use "Other". Enum: same as `PropertyAddress.role` in "ProductHospitality" (7 values) - `Traveler.Telephone` (array) - `phoneLocationType` (string) Location of the phone Example: "Agency" - `phoneTechType` (string) Indicates the type of technology associated with the telephone number Example: "Voice" - `phoneUseType` (string) Agency code for how phone is used (e.g., Home, Business, Emergency Contact, Travel Arranger, Day, Evening). Example: "Home" - `pin` (string) Additional codes used for telephone Example: "3456" - `priority` (integer) Priority Example: 1 - `Privacy` (object) Confidential details for marketing purpose - `Privacy.id` (string) Optional internally referenced id Example: "2" - `Privacy.shareMarketing` (string) Used to indicate marketing preferences, Yes, No, Inherit Enum: same as `Privacy.shareMarketing` (3 values) - `Privacy.shareSync` (string) Used to indicate marketing preferences, Yes, No, Inherit Enum: same as `Privacy.shareMarketing` (3 values) - `Privacy.optOutInd` (string) Used to indicate marketing preferences, Yes, No, Inherit Enum: same as `Privacy.shareMarketing` (3 values) - `Privacy.optInStatus` (string) Used to indicate marketing preferences, OptIn, OptOut Enum: same as `Privacy.optInStatus` (3 values) - `Privacy.optInDate` (string) The datetime of receiving the opt in notice Example: "2026-08-07T12:12:00Z" - `Privacy.optOutDate` (string) The datetime the opt out notice was received Example: "2026-08-07T12:12:00Z" - `Enum_TelephoneRole` (string) Defines the type of location the Telephone is assigned to. For Travel Agency telephone select "Other" or leave blank. Enum: same as `Enum_TelephoneRole` (6 values) - `Comment` (object) Textual information. - `Comment.value` (string) Actual text. May be restricted by character limits based on the type of comment (e.g. Notepad remarks limited to 87 characters). Example: "Additional comments" - `Comment.id` (string) Local identifier within a given message for this object. Example: "comment_1" - `Comment.name` (string) Title of comment or type of remark. Example: "Comment name" - `Comment.language` (string) Language code using ISO-639 standard Example: "EN" - `defaultInd` (boolean) When true, indicates a default value should be used. Example: true - `provisionedInd` (boolean) true indicates this phone number was created through provisioned - `Traveler.Telephone.@type` (string, required) Discriminator classes Telephone or TelephoneDetail Example: "Telephone" - `Traveler.Telephone.countryAccessCode` (string) Phone country code Example: "1" - `Traveler.Telephone.areaCityCode` (string) Phone local area code Example: "972" - `Traveler.Telephone.phoneNumber` (string, required) Mobile/Telephone Number. Accepted characters are numeric, dash, space, and period. Example: "972-000-787" - `Traveler.Telephone.extension` (string) Telephone extension number Example: "234" - `Traveler.Telephone.id` (string) Optional internally referenced id Example: "3" - `Traveler.Telephone.cityCode` (string) IATA city code if referenced by phone number. Example: "DEN" - `Traveler.Telephone.role` (string) Defines the type of location the Telephone is assigned to. For Travel Agency telephone select "Other" or leave blank. Enum: same as `Enum_TelephoneRole` (6 values) - `Traveler.Email` (array) - `Traveler.Email.value` (string) Example: "exampledomain@example.com" - `Traveler.Email.id` (string) Electronic email addresses, in IETF specified format. Example: "email_1" - `Traveler.Email.emailType` (string) Use email type to specify if the email is to be sent "TO" or sent "FROM" Example: "FROM" - `Traveler.Email.comment` (string) Comments associated to the email - `Traveler.Email.preferredFormat` (string) Mime media type Example: "text/html" - `Traveler.Email.shareMarketing` (string) Used to indicate marketing preferences, Yes, No, Inherit Enum: same as `Privacy.shareMarketing` (3 values) - `Traveler.Email.shareSync` (string) Used to indicate marketing preferences, Yes, No, Inherit Enum: same as `Privacy.shareMarketing` (3 values) - `Traveler.Email.optOutInd` (string) Used to indicate marketing preferences, Yes, No, Inherit Enum: same as `Privacy.shareMarketing` (3 values) - `Traveler.Email.optInStatus` (string) Used to indicate marketing preferences, OptIn, OptOut Enum: same as `Privacy.optInStatus` (3 values) - `Traveler.Email.optInDate` (string) The datetime of receiving the opt in notice Example: "2026-03-03T11:11:00Z" - `Traveler.Email.optOutDate` (string) The datetime the opt out notice was received Example: "2026-03-03T11:11:00Z" - `Traveler.Email.validInd` (boolean) If true, this is a valid email address that has been system verified via a successful email transmission. Example: true - `Traveler.Email.provisionedInd` (boolean) If true then the email address came from the provisioning process Example: true - `Traveler.passengerTypeCode` (string) Passenger type code Example: "CHD" - `Traveler.nationality` (string) Nationality on country code ISO Example: "AL" - `Traveler.age` (integer) The age of the traveller at the time of travel Example: 13 - `Traveler.CustomerLoyalty` (array) - `Traveler.CustomerLoyalty.value` (string, required) Number on loyalty card. Example: "132456" - `Traveler.CustomerLoyalty.id` (string) Optional Customer Loyalty Id. Not saved Example: "Loyalty_1" - `Traveler.CustomerLoyalty.priority` (integer) Optional Numeric Priority Code Example: 2 - `Traveler.CustomerLoyalty.programId` (string) "Specifies an identifier to indicate the company owner of the loyalty program. Typically two characters. For frequent guest number, the hotel supplier or brand code. For frequent flyer number, the air supplier code of the loyalty program." Example: "HY" - `Traveler.CustomerLoyalty.programName` (string) Supplier's loyalty program name. Example: "Frontier-EarlyReturns" - `Traveler.CustomerLoyalty.supplierType` (string) The type of supplier of a loyalty program. Uses 'hotel' for frequent guest number or 'air' for frequent flyer number. Example: "Hotel" - `Traveler.CustomerLoyalty.supplier` (string) Supplier of a loyalty program (typically 2 characters representing the hotel, brand, or airline). Example: "UA" - `Traveler.CustomerLoyalty.tier` (string) Customer Loyalty tier Example: "Silver" - `Traveler.CustomerLoyalty.shareWithSupplier` (array) The list of suppliers that the CustomerLoyalty number is shared. Used for cross accrual. Example: ["LH"] - `Traveler.CustomerLoyalty.cardHolderName` (string) Customer loyalty member name; up to 128 characters are supported. In Air Search, for discounted offers to be returned, the name must be sent as LAST FIRST; e.g.,if SMITH is the last name and JORDAN the first name, send as SMITH JORDAN Example: "John Smith" - `Traveler.CustomerLoyalty.validatedInd` (boolean) Customer loyalty number has been validated by the supplier Example: true - `Traveler.CustomerLoyalty.prefix` (string) The cardholder name prefix title like Mr, Mrs, Dr Example: "Dr" - `Traveler.CustomerLoyalty.given` (string) The First Name of the Cardholder Example: "John" - `Traveler.CustomerLoyalty.middle` (string) Middle Name of the Cardholder Example: "Wilkinson" - `Traveler.CustomerLoyalty.surname` (string) Last Name of the Cardholder Example: "Smith" - `Traveler.AlternateContact` (array) - `Traveler.AlternateContact.@type` (string) Example: "AlternateContact" - `Traveler.AlternateContact.id` (string) - `Traveler.AlternateContact.contactType` (string) Contact type value Example: "Relative" - `Traveler.AlternateContact.relation` (string) Relation value Example: "Mother" - `Traveler.AlternateContact.PersonName` (object, required) Travelport+ limits the combination of Given and Surname to 22 characters. Given name must have at least one character. Any PersonName exceeding 22 characters is truncated in the response. - `personNameType` (string) OTA Code Enum: same as `personNameType` (4 values) - `language` (string) 'ISO639 code of the language the name is represented Example: "EN" - `SurnamePrefix` (string) The surname prefix Example: "Von" - `Suffix` (string) Hold various name suffixes and letters Example: "Jr." - `Title` (string) Degree or honors Example: "DR" - `Privacy` (object) Confidential details for marketing purpose - `Privacy.id` (string) Optional internally referenced id Example: "2" - `Privacy.shareMarketing` (string) Used to indicate marketing preferences, Yes, No, Inherit Enum: same as `Privacy.shareMarketing` (3 values) - `Privacy.shareSync` (string) Used to indicate marketing preferences, Yes, No, Inherit Enum: same as `Privacy.shareMarketing` (3 values) - `Privacy.optOutInd` (string) Used to indicate marketing preferences, Yes, No, Inherit Enum: same as `Privacy.shareMarketing` (3 values) - `Privacy.optInStatus` (string) Used to indicate marketing preferences, OptIn, OptOut Enum: same as `Privacy.optInStatus` (3 values) - `Privacy.optInDate` (string) The datetime of receiving the opt in notice Example: "2026-08-07T12:12:00Z" - `Privacy.optOutDate` (string) The datetime the opt out notice was received Example: "2026-08-07T12:12:00Z" - `defaultInd` (boolean) If true, this is the default or primary name within a collection of names. Example: true - `Traveler.AlternateContact.Address` (array) - `addressType` (string) OTA code for address type Example: "CLT" - `use` (string) OTA code for address use Example: "AUT" - `Comment` (object) Textual information. - `Comment.value` (string) Actual text. May be restricted by character limits based on the type of comment (e.g. Notepad remarks limited to 87 characters). Example: "Additional comments" - `Comment.id` (string) Local identifier within a given message for this object. Example: "comment_1" - `Comment.name` (string) Title of comment or type of remark. Example: "Comment name" - `Comment.language` (string) Language code using ISO-639 standard Example: "EN" - `Privacy` (object) Confidential details for marketing purpose - `Privacy.id` (string) Optional internally referenced id Example: "2" - `Privacy.shareMarketing` (string) Used to indicate marketing preferences, Yes, No, Inherit Enum: same as `Privacy.shareMarketing` (3 values) - `Privacy.shareSync` (string) Used to indicate marketing preferences, Yes, No, Inherit Enum: same as `Privacy.shareMarketing` (3 values) - `Privacy.optOutInd` (string) Used to indicate marketing preferences, Yes, No, Inherit Enum: same as `Privacy.shareMarketing` (3 values) - `Privacy.optInStatus` (string) Used to indicate marketing preferences, OptIn, OptOut Enum: same as `Privacy.optInStatus` (3 values) - `Privacy.optInDate` (string) The datetime of receiving the opt in notice Example: "2026-08-07T12:12:00Z" - `Privacy.optOutDate` (string) The datetime the opt out notice was received Example: "2026-08-07T12:12:00Z" - `Priority` (integer) The priority ranking within the group Example: 1 - `validInd` (boolean) If true, this is a valid and complete mailing address that has been verified through an address verification service or previously mailed materials have not been returned. - `provisionedInd` (boolean) If true, this address came into the system through provisioning - `Traveler.AlternateContact.Telephone` (array) - `phoneLocationType` (string) Location of the phone Example: "Agency" - `phoneTechType` (string) Indicates the type of technology associated with the telephone number Example: "Voice" - `phoneUseType` (string) Agency code for how phone is used (e.g., Home, Business, Emergency Contact, Travel Arranger, Day, Evening). Example: "Home" - `pin` (string) Additional codes used for telephone Example: "3456" - `priority` (integer) Priority Example: 1 - `Privacy` (object) Confidential details for marketing purpose - `Privacy.id` (string) Optional internally referenced id Example: "2" - `Privacy.shareMarketing` (string) Used to indicate marketing preferences, Yes, No, Inherit Enum: same as `Privacy.shareMarketing` (3 values) - `Privacy.shareSync` (string) Used to indicate marketing preferences, Yes, No, Inherit Enum: same as `Privacy.shareMarketing` (3 values) - `Privacy.optOutInd` (string) Used to indicate marketing preferences, Yes, No, Inherit Enum: same as `Privacy.shareMarketing` (3 values) - `Privacy.optInStatus` (string) Used to indicate marketing preferences, OptIn, OptOut Enum: same as `Privacy.optInStatus` (3 values) - `Privacy.optInDate` (string) The datetime of receiving the opt in notice Example: "2026-08-07T12:12:00Z" - `Privacy.optOutDate` (string) The datetime the opt out notice was received Example: "2026-08-07T12:12:00Z" - `Enum_TelephoneRole` (string) Defines the type of location the Telephone is assigned to. For Travel Agency telephone select "Other" or leave blank. Enum: same as `Enum_TelephoneRole` (6 values) - `Comment` (object) Textual information. - `Comment.value` (string) Actual text. May be restricted by character limits based on the type of comment (e.g. Notepad remarks limited to 87 characters). Example: "Additional comments" - `Comment.id` (string) Local identifier within a given message for this object. Example: "comment_1" - `Comment.name` (string) Title of comment or type of remark. Example: "Comment name" - `Comment.language` (string) Language code using ISO-639 standard Example: "EN" - `defaultInd` (boolean) When true, indicates a default value should be used. Example: true - `provisionedInd` (boolean) true indicates this phone number was created through provisioned - `Traveler.AlternateContact.Email` (array) - `Traveler.AlternateContact.emergencyInd` (boolean) This is the contact in case of an emergency Example: true - `Traveler.AlternateContact.defaultInd` (boolean) This is the default contact Example: true - `Traveler.TravelDocument` (array) - `IssuedForGeoPoliticalArea` (object) The location code of the geographical location. Codes from Ref Pub - `IssuedForGeoPoliticalArea.value` (string) Example: "G" - `IssuedForGeoPoliticalArea.level` (string) Represents the type of geopolitical area (country, Continent, State etc) Enum: same as `IssuedForGeoPoliticalArea.level` (8 values) - `IssuedForGeoPoliticalArea.id` (string) Optional internally referenced id Example: "2" - `Address` (object) The property or billing address information. - `addressType` (string) OTA code for address type Example: "CLT" - `use` (string) OTA code for address use Example: "AUT" - `Comment` (object) Textual information. - `Comment.value` (string) Actual text. May be restricted by character limits based on the type of comment (e.g. Notepad remarks limited to 87 characters). Example: "Additional comments" - `Comment.id` (string) Local identifier within a given message for this object. Example: "comment_1" - `Comment.name` (string) Title of comment or type of remark. Example: "Comment name" - `Comment.language` (string) Language code using ISO-639 standard Example: "EN" - `Privacy` (object) Confidential details for marketing purpose - `Privacy.id` (string) Optional internally referenced id Example: "2" - `Privacy.shareMarketing` (string) Used to indicate marketing preferences, Yes, No, Inherit Enum: same as `Privacy.shareMarketing` (3 values) - `Privacy.shareSync` (string) Used to indicate marketing preferences, Yes, No, Inherit Enum: same as `Privacy.shareMarketing` (3 values) - `Privacy.optOutInd` (string) Used to indicate marketing preferences, Yes, No, Inherit Enum: same as `Privacy.shareMarketing` (3 values) - `Privacy.optInStatus` (string) Used to indicate marketing preferences, OptIn, OptOut Enum: same as `Privacy.optInStatus` (3 values) - `Privacy.optInDate` (string) The datetime of receiving the opt in notice Example: "2026-08-07T12:12:00Z" - `Privacy.optOutDate` (string) The datetime the opt out notice was received Example: "2026-08-07T12:12:00Z" - `Priority` (integer) The priority ranking within the group Example: 1 - `validInd` (boolean) If true, this is a valid and complete mailing address that has been verified through an address verification service or previously mailed materials have not been returned. - `provisionedInd` (boolean) If true, this address came into the system through provisioning - `Traveler.TravelDocument.@type` (string, required) Discriminator classes TravelDocument or TravelDocumentDetail Example: "TravelDocumentDetail" - `Traveler.TravelDocument.docNumber` (string) Document number value Example: "B37201" - `Traveler.TravelDocument.docType` (string) Codes from OTA DOC - Document Type Enum: same as `Traveler.TravelDocument.docType` in "ReferenceListTraveler" (27 values) - `Traveler.TravelDocument.issueDate` (string) Date of Issue Example: "2002-10-13" - `Traveler.TravelDocument.expireDate` (string) Date of expiration Example: "2002-11-13" - `Traveler.TravelDocument.stateProvCode` (string) State Province Code value Example: "44" - `Traveler.TravelDocument.placeOfIssue` (string) Place of issue value Example: "Birmingham" - `Traveler.TravelDocument.issueCountry` (string) Issue country on Country Code ISO Example: "CA" - `Traveler.TravelDocument.birthDate` (string) The date of birth of the document holder Example: "1995-04-22" - `Traveler.TravelDocument.birthCountry` (string) Birth country on Country Code ISO value Example: "AR" - `Traveler.TravelDocument.birthPlace` (string) Birth place value Example: "Ontario" - `Traveler.TravelDocument.residence` (string) Residence value Example: "1st section 8th st" - `Traveler.TravelDocument.id` (string) Locally referenced id Example: "34" - `Traveler.TravelDocument.Gender` (string, required) Gender Type Male, Female etc. This field is not used by Hotel APIs and will be ignored. Enum: same as `Traveler.gender` in "ReferenceListTraveler" (4 values) - `Traveler.TravelDocument.Nationality` (string) Specifies a 2 character country code as defined in ISO3166. Example: "BR" - `Traveler.TravelDocument.PersonName` (object, required) Travelport+ limits the combination of Given and Surname to 22 characters. Given name must have at least one character. Any PersonName exceeding 22 characters is truncated in the response. - `personNameType` (string) OTA Code Enum: same as `personNameType` (4 values) - `language` (string) 'ISO639 code of the language the name is represented Example: "EN" - `SurnamePrefix` (string) The surname prefix Example: "Von" - `Suffix` (string) Hold various name suffixes and letters Example: "Jr." - `Title` (string) Degree or honors Example: "DR" - `Privacy` (object) Confidential details for marketing purpose - `Privacy.id` (string) Optional internally referenced id Example: "2" - `Privacy.shareMarketing` (string) Used to indicate marketing preferences, Yes, No, Inherit Enum: same as `Privacy.shareMarketing` (3 values) - `Privacy.shareSync` (string) Used to indicate marketing preferences, Yes, No, Inherit Enum: same as `Privacy.shareMarketing` (3 values) - `Privacy.optOutInd` (string) Used to indicate marketing preferences, Yes, No, Inherit Enum: same as `Privacy.shareMarketing` (3 values) - `Privacy.optInStatus` (string) Used to indicate marketing preferences, OptIn, OptOut Enum: same as `Privacy.optInStatus` (3 values) - `Privacy.optInDate` (string) The datetime of receiving the opt in notice Example: "2026-08-07T12:12:00Z" - `Privacy.optOutDate` (string) The datetime the opt out notice was received Example: "2026-08-07T12:12:00Z" - `defaultInd` (boolean) If true, this is the default or primary name within a collection of names. Example: true - `Traveler.Comments` (object) Comments object to relay free text information In ProductAncillary.Ancillary this is used to expose when additional comments are required to book the ancillary. In BuildAncillaryOffersFromCatalogOfferings this is used to pass additional ancillary text required to book the ancillary. - `Traveler.Comments.@type` (string) Example: "Comments" - `Traveler.Comments.Comment` (array) - `Traveler.Comments.Comment.value` (string) Actual text. May be restricted by character limits based on the type of comment (e.g. Notepad remarks limited to 87 characters). Example: "Additional comments" - `Traveler.Comments.Comment.id` (string) Local identifier within a given message for this object. Example: "comment_1" - `Traveler.Comments.Comment.name` (string) Title of comment or type of remark. Example: "Comment name" - `Traveler.Comments.Comment.language` (string) Language code using ISO-639 standard Example: "EN" - `Traveler.RailDiscountCard` (array) - `Traveler.RailDiscountCard.value` (string) Example: "Rail1234546" - `Traveler.RailDiscountCard.supplierCode` (string, required) Code of the Supplier Example: "Enco" - `Traveler.RailDiscountCard.referenceNumber` (string) ReferenceNumber Example: "134256" - `Traveler.accompaniedByInfantInd` (boolean) Example: true - ReferenceListOffer: - `Offer` (array) — one of (discriminator: @type): - OfferAncillaryModify: - `ModifyPrice` (object) - `PriceBreakdown` (array) — one of (discriminator: @type): - PriceBreakdownAir: - `quantity` (integer) Quantity of passengers in that PTC. Example: 2 - `requestedPassengerType` (string) The PTC to which the PriceBreakdown applies. Example: "CHD" - `FiledAmount` (object) Returned only in the Price APIs. GDS only; not supported for NDC. The base amount of a ticket price or net price that is filed in local currency. Returned when the origin currency is not the same as the PCC currency to show the currency in which the base fare has been filed. When used for NetBaseAmount: Net ticket data (NTD) is returned in the AirPrice, AirReservation, Exchange Search, and Reservation Retrieve responses for any GDS fare that has a private fare component (fareType=AgencyPrivateFare). When NTD is returned, TermsAndConditionsFuill includes FareGuaranteePolicy to return the fare calculation indicator for the fare. When NTD is returned, PriceBreakdown may include NetBaseAmount. - `FiledAmount.value` (number) Filed amount value Example: 43.3422 - `FiledAmount.currencyCode` (string) Code for the currency in which the base fare was filed. Example: "USD" - `FiledAmount.codeAuthority` (string) Filed amount currency code authority Example: "Australian Dollar" - `FiledAmount.decimalPlace` (integer, required) Number of decimal places in the currency in ISO 4217 standard format. Example: 3 - `FiledAmount.decimalAuthority` (string) ISO 4217 standard decimal authority Example: "ISO 4217" - `Discount` (object) NDC only; not supported for GDS. Returned for a fare discounted from the published price, such as a promotional discount. Not returned for privately negotiated discounts such as private fares. - `Discount.value` (number) The amount value of the discount Example: 20.22 - `Discount.description` (string) The text description for the discount. Example: "Spring discount on group bookings" - `Discount.currencyCode` (string, required) Currency code discount is returned in. Example: "USD" - `Discount.codeAuthority` (string, required) Not used. Currency code Authority. Example: "ISO" - `Discount.decimalPlace` (integer, required) Number of decimal places in the currency the discount is returned in. Example: 2 - `Discount.decimalAuthority` (string) Not used. Decimal Authority. Example: "ISO" - `NetFareInfo` (object) Detailed information on the net fare used. - `NetFareInfo.@type` (string, required) Example: "NetFareInfo" - `NetFareInfo.passengerTypeCode` (string) PassengerTypeCode Example: "ADT" - `NetFareInfo.NetFareBreakdownConstruction` (array) - `NetFareInfo.NetFareBreakdownConstruction.value` (string) - `NetFareInfo.NetFareBreakdownConstruction.fareType` (string) Assigned Type: c-1100:StringTiny - `NetFareInfo.NetFareBreakdownConstruction.rateOfExchange` (number) The rate of exchange applied to the fare breakdown - `NetFareInfo.TicketBaseAudit` (object) Returned only in the Price APIs. GDS only; not supported for NDC. The base amount of a ticket price or net price that is filed in local currency. Returned when the origin currency is not the same as the PCC currency to show the currency in which the base fare has been filed. When used for NetBaseAmount: Net ticket data (NTD) is returned in the AirPrice, AirReservation, Exchange Search, and Reservation Retrieve responses for any GDS fare that has a private fare component (fareType=AgencyPrivateFare). When NTD is returned, TermsAndConditionsFuill includes FareGuaranteePolicy to return the fare calculation indicator for the fare. When NTD is returned, PriceBreakdown may include NetBaseAmount. - `NetFareInfo.TicketBasePassenger` (object) The monetary value - `NetFareInfo.TicketBasePassenger.value` (number) - `NetFareInfo.TicketBasePassenger.currencyCode` (string) Assigned Type: c-1100:CurrencyCode - `NetFareInfo.TicketBasePassenger.codeAuthority` (string, required) Assigned Type: c-1100:CodeContext - `NetFareInfo.TicketBasePassenger.decimalPlace` (integer, required) Assigned Type: c-1100:CurrencyMinorUnit - `NetFareInfo.TicketBasePassenger.decimalAuthority` (string) Assigned Type: c-1100:CodeContext - `NetFareInfo.TicketBasePassenger.bTInd` (boolean) If true, this is a bulk ticket fare - `NetFareInfo.TicketBasePassenger.iTInd` (boolean) If true, this is an inclusive tour fare - `TravelerIdentifierRef` (object) Identifier references as object both within a message payload or an object held in cache that may be used for subsequent workflows. Returned for NDC in the Price response if age was sent for this traveler in the previous workflow requests. - `TravelerIdentifierRef.name` (string) Traveler identifier - `TravelerIdentifierRef.passengerTypeCode` (string) Passenger Type code Example: "ADT" - `TravelerIdentifierRef.ages` (array) The ages of the travelers associated to a particular ptc. For NDC, this value will be returned in PriceBreakdownAir if sent as part of the PassengerCriteria in the Air Search request. Example: [15] - `TravelerIdentifierRef.passengerCriteriaRef` (string) Allows the user to associate passenger criteria information. Example: "passengerCriteria_1" - `TravelerIdentifierRef.value` (string) - `TravelerIdentifierRef.id` (string) A locally referenced ID - `TravelerIdentifierRef.description` (string) Descriptive text used to identify the contents of a target object - `TravelerIdentifierRef.uris` (array) Uniform Resource Identifier Example: ["google.com"] - `TravelerIdentifierRef.age` (integer) Replaced with ages array. The age of the traveler. Example: 11 - `NetBaseAmount` (object) Returned only in the Price APIs. GDS only; not supported for NDC. The base amount of a ticket price or net price that is filed in local currency. Returned when the origin currency is not the same as the PCC currency to show the currency in which the base fare has been filed. When used for NetBaseAmount: Net ticket data (NTD) is returned in the AirPrice, AirReservation, Exchange Search, and Reservation Retrieve responses for any GDS fare that has a private fare component (fareType=AgencyPrivateFare). When NTD is returned, TermsAndConditionsFuill includes FareGuaranteePolicy to return the fare calculation indicator for the fare. When NTD is returned, PriceBreakdown may include NetBaseAmount. - `FareCalculation` (string) GDS only; not supported for NDC. For each PTC, when available, FareCalculation returns the fare calculation ladder for all public and private fare types filed by an agency or an airline. Example: "LON BA SYD R564.00YEE1Y BA LON R564.00YEE1Y NUC1128.00END ROE0.787855" - `Surcharges` (object) In AirSearch workflow this applies to GDS only. Not supported for NDC, which does not return surcharges. Returned if surcharges apply to this offer. For GDS only, for a multi-city offer with stopovers (see multi-city offers with stopovers for details), surcharges and commission amounts are for the entire journey. For all other offers, the surcharges and commission amounts are for each leg (origin and destination pair). A multi-city offer can be identified by the jc in its CombinabilityCode: jc1, jc2. Surcharges can be omitted from the Search response with excludeSurchargesInd. - `Surcharge` (array, required) - `Surcharge.value` (number) Surcharge amount Example: 12 - `Surcharge.currencyCode` (string) ISO 4217 currency code for the surcharge. Example: "USD" - `Surcharge.surchargeCode` (string) Surcharge code Example: "ADDITIONAL COSTS" - `Surcharge.reportingAuthority` (string) Not used. Surcharge reporting authority Example: "Federal register" - `Surcharge.purpose` (string) Surcharge purpose. For Air workflows possible values include Weekend Surcharge, Stopover Charge, Multiple Stopover Charges, Other (default value that covers all other surcharges such as fuel surcharges). Example: "Weekend Surcharge" - `Surcharge.description` (string) Description of the surcharge. Example: "Rollaway Surcharge" - `Surcharge.surchargeApplication` (string) Application values (such as the application of a fee) like per person or per room. Enum: same as `Surcharge.surchargeApplication` (7 values) - `Surcharge.surchargeFrequency` (string) The frequency of a fee such as per night or per stay. Enum: same as `Surcharge.surchargeFrequency` (6 values) - `Surcharge.codeAuthority` (string) Not used. Currency code authority. Example: "ISO 4217" - `Surcharge.decimalPlace` (integer) Decimal place for the currency unit. Example: 4 - `Surcharge.decimalAuthority` (string) Not used. Currency code decimal authority. Example: "ISO 4217" - `Surcharges.@type` (string, required) Discriminator class is SurchargesDetail Example: "SurchargesDetail" - `Surcharges.TotalSurcharges` (number) A monetary amount, up to 4 decimal places. Example: 211.11 - `Surcharges.approximateInd` (boolean) If true, the surcharge amounts are approximate. - `TravelerRefs` (array) Returned only in Reservation Retrieve to identify the traveler associated with this instance of PriceBreakdown in case of multiple offers on the booking. Example: ["[\"traveler_1\",\"traveler2\"]"] - `PaidTaxes` (object) Summary Taxes object - `Tax` (array) - `Tax.value` (number) Amount of the tax. Returned as 0 if a tax was marked as exempt with TaxExemption. Example: 12.2 - `Tax.currencyCode` (string) A ISO 4217 currency code associated to the value. Example: "USD" - `Tax.taxCode` (string) "Code for the tax. For Hotels this is the OTA code." Example: "XF2" - `Tax.reportingAuthority` (string) Identifies the reporting authority such as airport code for XF taxes Example: "JFK1" - `Tax.purpose` (string) Supplier returned description of tax. Example: "Fuel surcharge" - `Tax.description` (string) "Short summary of the tax. In Air workflows this is returned only for NDC. Note that descriptions are not returned for tax codes YQ and YR, which are fees charged by airlines and not government-imposed taxes. For Hotels this is the OTA tax description." Example: "Lodging tax" - `Tax.includedInBase` (string) Yes , No , Unknown Enum: same as `instantPurchase` in "AdvanceReservationRequired" (3 values) - `Tax.codeAuthority` (string) Not used. Currency Code Authority Example: "ISO" - `Tax.decimalPlace` (integer) Permitted number of decimals. Associated to the currency value. Example: 2 - `Tax.decimalAuthority` (string) Not used. Currency decimal authority Example: "ISO" - `Tax.exemptInd` (boolean) GDS only; not supported for NDC. Returned if a tax was marked exempt in a prior request with the TaxExemption pricing modifer. If true, this tax is exempt" Example: true - `Tax.nonRefundableInd` (boolean) If true, the tax is non refundable. This indicator is only supported for exchange search and exchange price quote transactions. Example: true - `Tax.excludedFromTotalPriceInd` (boolean) Returned in Hotel APIs when a tax is not included in the TotalPrice. Default behavior is for taxes to be included in TotalPrice. Example: true - `TaxPercent` (object) Returned when the tax is expressed as a percentage of the amount. - `TaxPercent.value` (number) The tax percentage amount. Example: 5.5 - `TaxPercent.taxCode` (string) Any code for the tax. Example: "971 - IRS Notice" - `TaxPercent.reportingAuthority` (string) Tax reporting authority Example: "Georgia Department of Revenue" - `TaxPercent.purpose` (string) Purpose of tax Example: "statutory tax" - `TaxPercent.description` (string) Description Example: "1.5% of SGST" - `TaxPercent.includedInBase` (string) Yes , No , Unknown Enum: same as `instantPurchase` in "AdvanceReservationRequired" (3 values) - `PaidTaxes.@type` (string, required) Discriminator classes PaidTaxes or PaidTaxesDetail Example: "PaidTaxesDetail" - `PaidTaxes.TotalTaxes` (number) A monetary amount, up to 4 decimal places. Decimal place needs to be included. Example: 220.12 - `RequestedPricingModifiers` (array) - `RequestedPricingModifiers.@type` (string, required) Discriminator. Example: "RequestedPricingModifiers" - `RequestedPricingModifiers.PassengerCriteria` (object) Defines the passenger criteria. Send one PassengerCriteria for each passenger type code (PTC). Search supports up to 9 total passengers. A maximum of 6 PTCs are supported for GDS. NDC does not have a PTC limitation. AirPrice supports up to nine total passengers across all PTCs. - `TravelerIdentifierRef` (object, required) Identifier references as object both within a message payload or an object held in cache that may be used for subsequent workflows. Returned for NDC in the Price response if age was sent for this traveler in the previous workflow requests. - `RequestedPricingModifiers.PassengerCriteria.@type` (string, required) Discriminator. No child classes. Example: "PassengerCriteria" - `RequestedPricingModifiers.PassengerCriteria.number` (integer, required) The amount of passengers associated with this passenger type code. Default is 1. Example: 1 - `RequestedPricingModifiers.PassengerCriteria.age` (integer) The age of the passenger. Notes on PTC and age: - Travelport recommends sending age only with PTCs that require age for pricing. - If the age is sent in the request, for NDC only, the age is returned in the pricing response. - For child passengers, Travelport recommends sending the age of the child in the age attribute plus the PTC CNN. Travelport recommends against sending CNN without age, or the CHD PTC. Not all fares cannot be quoted for CHD. - The age for CNN is generally between 2 and 11 inclusive, with ADT fares returned for ages 12 and up; however, this can vary by airline and country. - The age for INF must be either 0 or 1. - During booking, date of birth is required for all child and infant PTCs (Add Traveler payload in Traveler/birthDate). Example: 26 - `RequestedPricingModifiers.PassengerCriteria.passengerTypeCode` (string) The passenger type code (PTC) for the passengers on the itinerary. Required field for Air Search and Flight specific search. Common PTCs are: - ADT: adult - CHD: child of unknown age - For child passengers, Travelport recommends sending the age of the child in the age attribute plus the PTC CNN. Travelport recommends against sending CNN without age, or the CHD PTC. Many fares cannot be quoted for CHD. - CNN: child when age is known - The age for CNN is generally between 2 and 11 inclusive, with ADT fares returned for ages 12 and up; however, this can vary by airline and country. - INF: infant without a seat - INS: infant with a seat - UNN: unaccompanied child. See API guides to download a full list of PTCs. NDC carriers BA, SQ, AV, AA, and AF/KLM offer teen/young adult tax exemptions from the UK Air Passenger Duty (GB tax). Send PTC with the value YTH and send the passengers age per below. The PTC may be returned as ADT, or Cxx in which xx is the age, but the tax exemption is applied in the pricing on these NDC carriers. For marine fares, send the PTC value SEA. You must also send OSI remarks at Add Traveler with the vessel name and location. Marine fares are private fares for travelers going to or from a vessel. NDC only; not supported for GDS. When running a multiple passenger search for NDC on Qantas, Qantas supports only these PTCs: ADT, CHD, CNN, INF. Sending any other PTC may result in an error at ticketing. Any traveler sent without a PTC value is defaulted to ADT. PTC can be sent or omitted for ADT passenger. AirReservation defaults the PTC to ADT and returns it in the Reservation Retrieve. Example: "ADT" - `RequestedPricingModifiers.PassengerCriteria.birthDate` (string) The date of birth of the passenger. May be used in age validation for fares with age restrictions. Example: "2020-01-16" - `RequestedPricingModifiers.PassengerCriteria.id` (string) Unique id to support referencing of this specific passenger criteria. Example: "passengercriteria_001" - `RequestedPricingModifiers.PassengerCriteria.CustomerLoyalty` (array) NDC only; not supported for GDS. Optional object for sending customer loyalty information, such as for a frequent flyer program. If CustomerLoyalty is sent in the Search request, it must also be sent in the Air Price request and the Add Traveler request. As some carriers validate frequent traveler data through the workflow, failing to send the same CustomerLoyalty details, even if invalid, may cause a booking failure. If an invalid number is sent, the response returns a warning message that the FQTV is invalid, and the invalid number is cached to prevent a potential booking failure. - `RequestedPricingModifiers.PassengerCriteria.TravelerGeographicLocation` (object) For AirSearch: supported/validated only for NDC to support local citizen fares. For AirPrice and AirReservation: GDS only; not supported for NDC. Optional object for requesting local citizen/local resident fares for Spain and associated islands. You must also send a PTC relevant to the local resident fares; e.g., ADR for adult resident, CHR for child resident. Any discount applied through TravelerGeographicLocation applies to all travelers, not only to the traveler in this instance of PassengerCriteria. If the discount must apply only to an individual traveler, that traveler requires a separate search and book workflow. - `RequestedPricingModifiers.PassengerCriteria.specifiedPassengerTypeCodeOnlyInd` (boolean) GDS only; not supported for NDC. - If true: returns only offers for the specified PTC. If no fares are available for the specified PTC, returns an error message that there is no valid fare. - If false (default behavior): If no fares are available for the specified PTC, returns fares for the default ADT (adult) PTC instead. Example: true - `RequestedPricingModifiers.PricingModifiersAir` (object) A selection of Pricing Modifiers that can be used to influence the Price of an Offer. - For the AirPrice reference payload request, if any price modifiers were included in the preceding Search request and no price modifiers are sent in the AirPrice request, the cached price modifiers sent at Search are sent with the AirPrice request. If any price modifiers are sent in the AirPrice reference payload request, all cached Search modifiers are discarded and only the modifiers sent in that AirPrice request are used. - For the Add Offer request, you may optionally store fares with one or more pricing modifiers. If a pricing modifier is not added, the auto stored fare is added to the reservation. There is no change in the AirReservation response when pricing modifiers are requested. AirReservation applies modifiers from Add Offer and earlier steps as follows: - Modifiers sent in the Add Offer request (supported for both full and reference payload). - If no modifiers are sent in Add Offer, any pricing modifiers sent in AirPrice are applied. - If no modifiers were sent in AirPrice, or if AirPrice was not sent, any pricing modifiers sent in Search are applied. GDS only; pricing modifiers not supported for NDC. If the requested modifier does not have any fares associated with it, the workbench commit fails and returns the error message 'No Fare Found'. Pricing happens at commit, not at Add Offer. - `Brand` (object) Information on airline Brand offerings. If brand attributes were not excluded with inhibitBrandContentInd=true (GDS only), then brand attributes are returned and consolidated in ReferenceList/ReferenceListBrand. In this case Brand does not return the name or Identifier objects but instead returns only BrandRef, which matches to the brand identifier (e.g., b1) in ReferenceListBrand. - `RequestedPricingModifiers.PricingModifiersAir.@type` (string, required) Discriminator. Child classes PricingModifiersAir and PricingModifersAirDetail Example: "PricingModifiersAir" - `RequestedPricingModifiers.PricingModifiersAir.currencyCode` (string) In an API request, send the currency type to return if you want to override the default currency specified with your PCC. Example: "GBP" - `RequestedPricingModifiers.PricingModifiersAir.FareSelection` (object) Requests the return of fare types including private fares (negotiated), public fares (published), or net fares (consolidator fares, or any negotiated wholesale price that is further marked up for sale to customers). May be used to request fares with specific restrictions, change, or refund options. - `RequestedPricingModifiers.PricingModifiersAir.OrganizationInformation` (object) Use to send account codes for negotiated fares or to send optional India GST SSR Remarks in GSTRegistrationNumber. For NDC supports corporate loyalty program and GST Information. This information is returned in TermsAndConditions." - `RequestedPricingModifiers.PricingModifiersAir.TaxExemption` (object) GDS only, not supported for NDC. Use to mark some or all taxes as exempt. Specify all taxes, only specific tax codes, or all taxes in specific countries. Must include either allTaxesExemptInd OR both countries and taxCodes. TaxExemption supports up to nine values for countries, taxCodes, or both combined. The response returns any exempt taxes with exemptInd=true and value=0. - `RequestedPricingModifiers.PricingModifiersAir.PromotionalCode` (array) - `RequestedPricingModifiers.PricingModifiersAir.SellCity` (string) GDS only, not supported for NDC. The IATA location code for a city. Overrides the sell city of the requester to specify an alternate sale location and return fares based on that location. The response returns pricing in the local currency for the specified sell city instead of the PCC's default currency. Example: "NYC" - `RequestedPricingModifiers.PricingModifiersAir.TicketCity` (string) GDS only, not supported for NDC. The IATA location code for a city. Overrides the ticketing city of the requester to specify an alternate ticket location and return fares based on that location; the response returns pricing in the local currency for the specified ticket city instead of the PCC's default currency. Example: "NYC" - `RequestedPricingModifiers.PricingModifiersAir.PricingPCC` (string) GDS only, not supported for NDC. Use to send a faring PCC for which a selective access or code group agreement exists between that PCC and the PCC associated with your account. The following combinations of PricingPCC and FareSelection/fareType=PrivateFaresOnly return results as follows: - PricingPCC sent and PrivateFaresOnly not requested: If a selective access or group agreement exists, both public and any available private fares are returned for the requesting and providing PCC. - If no selective access or group agreement exists, only public fares are returned. - PricingPCC sent and PrivateFaresOnly is requested: If a selective access or group agreement exists that allows private fare access, only available private fares are returned for the requesting and providing PCC. - If no agreement exists, or if an agreement exists but does not allow private fares access, an error is returned. Example: "0Bx3" - `RequestedPricingModifiers.PricingModifiersAir.FareBasisCodeOverride` (array) - `RequestedPricingModifiers.PricingModifiersAir.MultiPricingAgency` (array) The customer can send up to 3 Pseudo City Codes (PCCs) in PricingModifiersAir, MultiPricingAgency. If a customer sends more than 3 PCCs in MultiPricingAgency, only the first 3 are validated. If a customer sends both PricingPCC and MultiPricingAgency with PCCs, the PCC in PricingPCC is ignored. Example: ["[\"0XS4\",\"0YBZ\",\"J80K\"]"] - `RequestedPricingModifiers.PricingModifiersAir.TicketingPCC` (string) GDS only, not supported for NDC. In an API request, overrides the ticketing PCC associated with your account to specify an alternate PCC and return fares based on that PCC. Example: "0XS4" - `RequestedPricingModifiers.PricingModifiersAir.CalculatedFareAdjustment` (object) Used in Exchange Search to modify the Price of the Fare. Discriminator classes CalculatedFareAdjustmentDiscount or CalculatedFareAdjustmentIncrease - `RequestedPricingModifiers.PricingModifiersAir.ManualFareAdjustment` (array) Send to manually adjust the base fare amount on all fares for a specific PTC. - `RequestedPricingModifiers.PricingModifiersAir.BrandPreference` (array) - `RequestedPricingModifiers.PricingModifiersAir.includeSplitPaymentInd` (boolean) Requests request split ticketing, which returns outbound and inbound one-way fares in addition to round trip options in the Search API response. This may result in lower fares than the same or similar round-trip itinerary. If true, requests split ticketing. If false or omitted split ticketing options are not returned. Default is false. GDS only, not supported for NDC. When split ticketing is requested, the Search response returns offers in the following order: Outbound one-way offers, Inbound one-way offers, Round trip offers. The response identifies all one-way outbound and inbound offers with CombinabilityCode j0. CombinabilityCode values for round trip offers start at j1 and increment by one for each offer. Only the following are in scope for split ticketing: Search (not supported for Next Leg Search or Flight Specific Search), Round-trip journey-based offerings ( isJourney header not sent or sent as true, or CustomResponseModifiersAir/SearchRepresentation not sent or sent with value Journey ) Upsells. Split ticketing is not supported for round-trip leg-based searches, virtual interlining, or NDC. Split ticketing is available only for customers specifically provisioned for split ticketing. Split ticketing returns one-way outbound and one-way inbound fares in addition to round-trip offers. Split ticket offers are identified with CombinabilityCode j0. If your account is not configured for split ticketing, sending includeSplitPaymentInd returns a response without split ticket offers and a warning message. GDS only, not supported for NDC. In Air Price, For split ticketing, the request must send offers that are identified in the Search response with CombinabilityCode j0, which identifies those offers as one-way outbound and one-way inbound split ticketing offers. A combination of j0 and any non-j0 value offer returns an error message that split pricing is not supported - `RequestedPricingModifiers.PricingModifiersAir.returnMostRestrictiveBrandInd` (boolean) In Search API, when there are different brands on a connecting flight, return information for either the most restrictive brand or the brand on the most significant segment on the itinerary. If true, return the offer brand of the most restrictive brand. If false or omitted, return the offer brand of the most significant segment of the itinerary. GDS only, not supported for NDC. - `RequestedPricingModifiers.PricingModifiersAir.splitPaymentOfferings` (number) Number between 0 and 99. Send with includeSplitPaymentInd to configure the percentage of round trip offers to return in a split ticketing response. By default, Search divides the split ticketing response into 34% round-trip offerings and the remainder as split ticketing offers, which are combined outbound and inbound one-way fares. To change this percentage, send SplitPaymentOfferings with the percentage value of round trip offers to return. Example: 25 - `RequestedPricingModifiers.CabinPreference` (object) Requests a fare based on the cabin class. Only one cabin preferenceType (Permitted, Preferred, PreferredWithUpgrade) is allowed per request, but there is no limit to the number of cabins that can be sent. Any CabinPreference in the initial Search request is applied to any subsequent Next Leg Search and reference Flight Specific Search requests. In AirPrice and AirReservation only one cabin preference type is allowed per request, but there is no limit to the number of cabins that can be sent. If CabinPreference was sent in the Search request, it is cached and sent with the AirPrice reference payload request. If you send CabinPreference in the AirPrice request, all cached modifiers are discarded and only the modifiers sent in the AirPrice request are used. Can be combined with lowFareFinderInd=true to return lowest fare in the requested cabin or cabins. When using CabinPreference and lowFareFinderInd, if both CabinPreference and a class of service are sent, class of service is ignored. If CabinPreference is sent without a class of service, the response returns the lowest fare in the cabin requested. If that cabin is not available, the response may upgrade or downgrade to a different cabin. If a different cabin than requested is returned, the response returns the message that the cabin class may differ from the class requested. If lowFareFinderInd=false and CabinPreference are sent in the request, AirPrice ignores the preferred cabin and returns a message that the preferred cabin was ignored. If CabinPreference is set to All, no cabin preference is applied." - `RequestedPricingModifiers.CabinPreference.@type` (string, required) Discriminator. No child classes exist Example: "CabinPreference" - `RequestedPricingModifiers.CabinPreference.preferenceType` (string) Type of cabin preference. Sending a mix of preferenceType values is not supported. For example, you cannot send an instance of CabinPreference with a preferenceType of Permitted and another instance with preferenceType of Prohibited. In this case the results default to the Preferred preference. Note that if lowFareFinderInd is sent with true and CabinPreference is sent, the only supported value for CabinPreference/type is Permitted. Enum: same as `RequestedPricingModifiers.CabinPreference.preferenceType` in "PriceBreakdownAir" (4 values) - `RequestedPricingModifiers.CabinPreference.cabins` (array) A space-delimited list of cabins. Enum: same as `PassengerFlight.FlightProduct.cabin` in "ProductAir" (5 values) - `RequestedPricingModifiers.CabinPreference.legSequence` (array) Limits preference to the specified leg referenced in SearchCriteriaFlight. You can apply the preference to only some legs of the itinerary, or different preferences to different legs. To apply preference to the entire itinerary, do not send legSequence. GDS only, not supported for NDC. Not supported at Price or Book. Example: [1,2] - `RequestedPricingModifiers.FlightType` (object) The type of flight connection - `RequestedPricingModifiers.FlightType.@type` (string, required) Discriminator. No child classes. Example: "FlightType" - `RequestedPricingModifiers.FlightType.connectionType` (string) Limits the connection type returned. Each value returns the specified type and all higher types. For example, StopDirect could return both flights that stop without a change of planes (StopDirect) and non-stop direct flights (NonStopDirect). SingleConnection or DoubleConnection will not exclude StopDirect flights from the journey. For example, SingleConnection could return an itinerary with two flight numbers, and either of these flights could have intermediate stops. Enum: same as `RequestedPricingModifiers.FlightType.connectionType` in "PriceBreakdownAir" (5 values) - `RequestedPricingModifiers.FlightType.excludeInterlineConnectionsInd` (boolean) Excludes interline connectionsClosed from results. If true, does not return offers with interline connections. If false or omitted, may return interline connections in results. Default is false. GDS only, not supported for NDC. When a product contains multiple interline air segments, brand details return only the brand of the significant carrier, not the validating/plating carrier brand information. The IATA rules for determining the significant carrier on an itinerary are based on the areas in which the transportation takes place. Example: true - `RequestedPricingModifiers.CustomResponseModifiersAir` (object) Contains additional modifiers to customize the result set. Includes optional indicators for returning or excluding specified response content. Values sent at Search can carry forward into the Next Leg Search request and are not re-sent. - `RequestedPricingModifiers.CustomResponseModifiersAir.@type` (string, required) discriminator Example: "CustomResponseModifiersAir" - `RequestedPricingModifiers.CustomResponseModifiersAir.BrandAttributeInclusion` (array) Supported in AirSearch and AirPrice. Returns only information about the brand attributes specified and does not return any other brand attributes. - `RequestedPricingModifiers.CustomResponseModifiersAir.SearchRepresentation` (string) Specifies either a journey or leg-based response. Journey returns offers for all legs of the itinerary. Journey is the default. Leg returns offers for only the first leg of the itinerary. Must be followed with a Next Leg Search to select an offer for the first leg and return offers on the subsequent leg to combine with it.Customize search result set as leg or journey based. Next Leg Search requests, and Flight Specific Search requests for less than the full itinerary, are supported only after a leg-based Search, not a journey-based Search. If these requests follow a journey-based Search request, an error message is returned. Enum: same as `RequestedPricingModifiers.CustomResponseModifiersAir.SearchRepresentation` in "PriceBreakdownAir" (3 values) - `RequestedPricingModifiers.CustomResponseModifiersAir.excludePenaltiesInd` (boolean) GDS only; not supported for NDC. Indicator to omit change and cancel penalties. - If true: omits all penalty information from the response. - If false (default behavior): returns any change and penalty details provided by carrier for each offer in TermsAndConditionsFullAir/Penalties. If sent in Search but not in AirPrice, the value sent in Search is cached and applied to the AirPrice results. However, you can override the value sent in Search by sending excludePenaltiesInd in the AirPrice request with the opposite value. For example, if the Search request sends excludePenaltiesInd=true and the AirPrice request sends excludePenaltiesInd=false, the Search response does not return penalties and the AirPrice response does return penalties. Example: true - `RequestedPricingModifiers.CustomResponseModifiersAir.excludeBaggageFeesInd` (boolean) GDS only; not supported for NDC. Indicator to exclude baggage details. - If true: excludes baggage fees, carry on fees, and embargo information from the response. Baggage quantity or weight is returned instead. - If false (default behavior): baggage details returned in response. Default is false. Example: true - `RequestedPricingModifiers.CustomResponseModifiersAir.includeFareCalculationInd` (boolean) GDS only; not supported for NDC or in the Flight Specific Search full payload request. Indicator to request the return of the fare calculation ladder. - If true: returns the fare calculation ladder in BestCombinablePrice.PriceBreakdownAir.FareCalculation. - If false (default behavior): fare calculation ladder is not returned. Example: true - `RequestedPricingModifiers.CustomResponseModifiersAir.excludeSurchargesInd` (boolean) GDS only; not supported for NDC. Indicator to exclude a surcharge breakdown. - If true: excludes a surcharge breakdown from the response. Baggage quantity or kilos is returned instead. - If false (default behavior): surcharge breakdown returned in response. Example: true - `RequestedPricingModifiers.CustomResponseModifiersAir.excludeUnbundledFaresInd` (boolean) GDS only, not supported for NDC. Sets whether to return unbundled fares. Supported in AirSearch and AirPrice. - If true: does not return unbundled fares. - If false (default behavior): returns unbundled and bundled fares as available. Example: true - `RequestedPricingModifiers.CustomResponseModifiersAir.includeCO2EmissionsDataInd` (boolean) Indicator to return CO2 emission data in the Search and Next Leg Search responses. - If true: returns CO2 emission data. - If false (default behavior): CO2 emission data not returned. Example: true - `RequestedPricingModifiers.CustomResponseModifiersAir.includeFlightAmenitiesInd` (boolean) Indicator to return flight amenities from ATPCO RouteHappy data. - If true: includes amenities in the response if available. - If false: Does not return ATPCO RouteHappy amenities. Example: true - `RequestedPricingModifiers.CustomResponseModifiersAir.includeUniversalProductAttributesInd` (boolean) Indicator to return universal product attributes (UPAs), which include images, icons, and URLs as provided by ATPCO. Must also send includeFlightAmenitiesInd=true. - If true: returns universal product attributes if available. - If false (default behavior): Universal product attributes not returned. UPAs are not returned for direct flights with intermediate stops, non-flight segments such as trains, or for Premium Business class. Example: true - `RequestedPricingModifiers.CustomResponseModifiersAir.includeBundledAncillariesInd` (boolean) NDC only. If true: the search and price response will include bundled air and ancillary offerings/offers. Search and Price response will contain both ProductAir and ProductAncillary plus a new child class of PriceBreakdown: PriceBreakdownAncillaryAir to define the ancillary inclusion and pricing. Example: true - `RequestedPricingModifiers.CustomResponseModifiersAir.includeFullPenaltyDisclosureInd` (boolean) If true, penalty information sourced from ATPCO Cat 31 and 33 will be disclosed. Penalties may be exposed at fare component level and include time windows. - `RequestedPricingModifiers.PricingModifiersAirChange` (object) Pricing Modifiers that can be used to influence the Price of an Exchanged Offer - `RequestedPricingModifiers.PricingModifiersAirChange.@type` (string) Example: "PricingModifiersAirChange" - `RequestedPricingModifiers.PricingModifiersAirChange.currencyCode` (string) ISO 4217 currency code Example: "USD" - `RequestedPricingModifiers.PricingModifiersAirChange.FareSelection` (object) Requests the return of fare types including private fares (negotiated), public fares (published), or net fares (consolidator fares, or any negotiated wholesale price that is further marked up for sale to customers). May be used to request fares with specific restrictions, change, or refund options. - `RequestedPricingModifiers.PricingModifiersAirChange.OrganizationInformation` (object) Use to send account codes for negotiated fares or to send optional India GST SSR Remarks in GSTRegistrationNumber. For NDC supports corporate loyalty program and GST Information. This information is returned in TermsAndConditions." - `RequestedPricingModifiers.PricingModifiersAirChange.WaiverCode` (object) A code assigned by an airline to support waiver of fees or ticket value as a result of disruption to the passenger. - `RequestedPricingModifiers.PricingModifiersAirChange.TaxExemption` (object) GDS only, not supported for NDC. Use to mark some or all taxes as exempt. Specify all taxes, only specific tax codes, or all taxes in specific countries. Must include either allTaxesExemptInd OR both countries and taxCodes. TaxExemption supports up to nine values for countries, taxCodes, or both combined. The response returns any exempt taxes with exemptInd=true and value=0. - `RequestedPricingModifiers.PricingModifiersAirChange.PromotionalCode` (object) NDC only. Not supported for GDS. Any NDC airline designated promotional code. - `RequestedPricingModifiers.PricingModifiersAirChange.SellCity` (string) Overrides the sell city of the requestor Example: "MEX" - `RequestedPricingModifiers.PricingModifiersAirChange.TicketCity` (string) Overrides the ticket city of the requestor Example: "MEX" - `RequestedPricingModifiers.PricingModifiersAirChange.PricingPCC` (string) Overrides the pricing PCC of the requestor Example: "0XS4" - `RequestedPricingModifiers.PricingModifiersAirChange.TicketingPCC` (string) Overrides the ticketing PCC of the requestor Example: "0XCD" - `RequestedPricingModifiers.PricingModifiersAirChange.CalculatedFareAdjustment` (object) Used in Exchange Search to modify the Price of the Fare. Discriminator classes CalculatedFareAdjustmentDiscount or CalculatedFareAdjustmentIncrease - `RequestedPricingModifiers.PricingModifiersAirChange.BrandPreference` (array) - `RequestedPricingModifiers.PricingModifiersAirChange.keepToBrandInd` (boolean) If true, the offerings returned will be of the same brand as the original Offer Example: true - `RequestedPricingModifiers.PricingModifiersAirChange.returnMostRestrictiveBrandInd` (boolean) if true, the most restrictive brand will be returned in the response when there are different brands present in the Offering Example: true - `RequestedPricingModifiers.PricingModifiersAirChange.doNotNetInd` (boolean) If true, this exchange will not net any residual/refundable amounts against due amounts. - `RequestedPricingModifiers.lowFareFinderInd` (boolean) Provides pricing flexibility around class of service. If not sent, the response returns fares only in the requested class of service. If true, returns the lowest fares available in any class of service available, which may not be the same as the requested class. Note that if lowFareFinderInd is sent with true and CabinPreference is sent, the only supported value for CabinPreference/type is Permitted. When lowFareFindInd=true and brand attributes are not disabled (inhibitBrandContentInd), AirPrice uses only the brand tier (and any other pricing modifiers) to find the lowest fare within a brand tier regardless of class of service. GDS only; not supported for NDC. Example: true - `RequestedPricingModifiers.keepToBrandInd` (boolean) If true, the original brand will be maintained during the exchange process. Example: true - `RequestedPricingModifiers.lowFareFindAndRebookInd` (boolean) If true, the original flights in the reservation will be rebooked or replaced with the new exchanged flights. - `PassengerCriteriaRefs` (array) NDC only; not supported for GDS. Returned for NDC if a traveler identifier was sent for this traveler in the previous workflow requests. Example: ["passengerCriteria_1"] - `FlightPassCredits` (integer) The number of flight pass credits consumed for this pricebreakdown. Example: 1 - PriceBreakdownAncillary: - `inclusiveOfTaxInd` (boolean) If true, this ancillary is sold inclusive of tax. Example: true - `quantity` (integer) The quantity of ancillary items included in this PriceBreakdown. Example: 1 - `Description` (object) A description of the ancillary with description codes. - `Description.value` (string) The text description of the ancillary. Example: "Vegetarian Meal" - `Description.code` (string) The ATPCO group code. Example: "BG" - `Description.subCode` (string) The ATPCO RFISC subcode. Example: "0D4" - `Description.subGroup` (string) The ATPCO sub group code. Example: "SP" - `Description.codeContext` (string) The code context value. Example: "ATPCO" - `Description.ssrCode` (string) The four character AIRIMP SSR code for this ancillary. Example: "VGML" - `Description.issuanceReasonCode` (string) The airline provided reason for issuance code. Example: "C" - `Description.geographicSpecification` (string) How the ancillary is applied across the itinerary. Enum: same as `Ancillary.Description.geographicSpecification` in "ProductAncillary" (3 values) - `ProductRef` (string) The product ref this PriceBreakdown applies to. If no productRef exists then the PriceBreakdown applies to all Products within the Offer. Example: "p_1" - `Discount` (object) NDC only; not supported for GDS. Returned for a fare discounted from the published price, such as a promotional discount. Not returned for privately negotiated discounts such as private fares. - `Discount.value` (number) The amount value of the discount Example: 20.22 - `Discount.description` (string) The text description for the discount. Example: "Spring discount on group bookings" - `Discount.currencyCode` (string, required) Currency code discount is returned in. Example: "USD" - `Discount.codeAuthority` (string, required) Not used. Currency code Authority. Example: "ISO" - `Discount.decimalPlace` (integer, required) Number of decimal places in the currency the discount is returned in. Example: 2 - `Discount.decimalAuthority` (string) Not used. Decimal Authority. Example: "ISO" - `TravelerIdentifierRef` (object) Identifier references as object both within a message payload or an object held in cache that may be used for subsequent workflows. Returned for NDC in the Price response if age was sent for this traveler in the previous workflow requests. - `TravelerIdentifierRef.name` (string) Traveler identifier - `TravelerIdentifierRef.passengerTypeCode` (string) Passenger Type code Example: "ADT" - `TravelerIdentifierRef.ages` (array) The ages of the travelers associated to a particular ptc. For NDC, this value will be returned in PriceBreakdownAir if sent as part of the PassengerCriteria in the Air Search request. Example: [15] - `TravelerIdentifierRef.passengerCriteriaRef` (string) Allows the user to associate passenger criteria information. Example: "passengerCriteria_1" - `TravelerIdentifierRef.value` (string) - `TravelerIdentifierRef.id` (string) A locally referenced ID - `TravelerIdentifierRef.description` (string) Descriptive text used to identify the contents of a target object - `TravelerIdentifierRef.uris` (array) Uniform Resource Identifier Example: ["google.com"] - `TravelerIdentifierRef.age` (integer) Replaced with ages array. The age of the traveler. Example: 11 - `AncillaryPriceApplicationCode` (object) Determines how an ancillary price has been built. - `AncillaryPriceApplicationCode.value` (string) Example: "3" - `AncillaryPriceApplicationCode.application` (string) Associated text. Example: "PerItem" - PriceBreakdownHospitality: - `roomPricingType` (string) A string provided by the hotel to describe how a service is priced, such as per night or per stay. Enum: same as `roomPricingType` in "PriceBreakdownHospitality" (5 values) - `Description` (string) Example: "Advance Purchase-Ro-Free WiFi" - `NightlyRate` (array) - `NightlyRate.@type` (string) - `NightlyRate.startDate` (string, required) Start date for the nightly rate in YYYY-MM-DD format. - `NightlyRate.nights` (integer) Number of nights the nightly rate is valid. - `NightlyRate.Amount` (object, required) Amount represents the cost applied - `AverageNightlyRate` (array) The average nightly rate for a given offer. - `AverageNightlyRate.value` (number) The amount of a given currency. Example: 124.56 - `AverageNightlyRate.code` (string) An ISO 4217 alpha character code (3 characters) that specifies a money unit. Example: "USD" - `AverageNightlyRate.minorUnit` (integer) Minor units are a mechanism for expressing the relationship between a major currency unit and its corresponding minor currency unit. It is the smallest unit of a given currency. For example; the smallest denomination in USD is the cent, which is 1/100 of a USD, and the minor unit value is 2. Not all currencies have a minor unit. Example: 2 - `AverageNightlyRate.currencySource` (string) The system requesting or returning the currency code specified in the attribute Enum: same as `MinimumAdcolAmount.currencySource` in "ChangePermitted" (3 values) - `AverageNightlyRate.approximateInd` (boolean) "If true, the currency amount has been converted from the original amount. For Air Exchange Eligibility, returned only if a currency is converted. If returned, the value is always true, indicating that the fee is approximate because of currency conversion. For Hotel Availability and Rules, true indicates this is a calculated value; false indicates this is the value returned by the property." Example: true - `AmenitySurcharges` (object) Amenity Surcharges information. - `AmenitySurcharges.@type` (string, required) Discriminator classes AmenitySurcharges or AmenitySurchargesDetail Example: "AmenitySurchargesDetail" - `AmenitySurcharges.TotalSurcharges` (number) A monetary amount, up to 4 decimal places. Decimal place needs to be included. Example: 211.11 - `AmenitySurcharges.approximateInd` (boolean) if true, the surcharge amounts are approximate - `AmenitySurcharges.Surcharge` (array, required) - `AmenitySurcharges.Surcharge.value` (number) Surcharge amount Example: 12 - `AmenitySurcharges.Surcharge.currencyCode` (string) ISO 4217 currency code for the surcharge. Example: "USD" - `AmenitySurcharges.Surcharge.surchargeCode` (string) Surcharge code Example: "ADDITIONAL COSTS" - `AmenitySurcharges.Surcharge.reportingAuthority` (string) Not used. Surcharge reporting authority Example: "Federal register" - `AmenitySurcharges.Surcharge.purpose` (string) Surcharge purpose. For Air workflows possible values include Weekend Surcharge, Stopover Charge, Multiple Stopover Charges, Other (default value that covers all other surcharges such as fuel surcharges). Example: "Weekend Surcharge" - `AmenitySurcharges.Surcharge.description` (string) Description of the surcharge. Example: "Rollaway Surcharge" - `AmenitySurcharges.Surcharge.surchargeApplication` (string) Application values (such as the application of a fee) like per person or per room. Enum: same as `Surcharge.surchargeApplication` (7 values) - `AmenitySurcharges.Surcharge.surchargeFrequency` (string) The frequency of a fee such as per night or per stay. Enum: same as `Surcharge.surchargeFrequency` (6 values) - `AmenitySurcharges.Surcharge.codeAuthority` (string) Not used. Currency code authority. Example: "ISO 4217" - `AmenitySurcharges.Surcharge.decimalPlace` (integer) Decimal place for the currency unit. Example: 4 - `AmenitySurcharges.Surcharge.decimalAuthority` (string) Not used. Currency code decimal authority. Example: "ISO 4217" - `priceChangesDuringStayInd` (boolean) "If true, indicates the price changes at least once during requested dates. If roomPricingType = Per night, multiple instances of priceChangesDuringStayInd are returned." - `shortRateDescription` (string) A normalized rate description for comparing rates across multiple aggregators. Example: "Flexible Rate" - PriceBreakdownVehiclePrice: - `VehiclePrice` (object, required) Rate summary for rental of the vehicle. - `VehiclePrice.@type` (string, required) Example: "VehiclePrice" - `VehiclePrice.id` (string) Internal ID - `VehiclePrice.rateSource` (string) Assigned Type: c-1100:StringTiny - `VehiclePrice.rateGuaranteedInd` (boolean) Assigned Type: c-1100:OptionalIndicator - `VehiclePrice.ratePeriod` (string) The time period for a rate such as daily, weekly, monthly Enum: same as `VehiclePrice.ratePeriod` in "PriceBreakdownVehiclePrice" (15 values) - `VehiclePrice.RateDistance` (object) Rate for the period defined by the attributes - `VehiclePrice.RateDistance.value` (number) - `VehiclePrice.RateDistance.unlimitedDistanceInd` (boolean) if true unlimited miles is included with the rental - `VehiclePrice.RateDistance.requestedCodeAppliedInd` (boolean) if true, the requested code has been applied - `VehiclePrice.RateDistance.allowance` (integer) The distance allowance permitted with this rate. Use in combination with distanceUnits and ratePeriod - `VehiclePrice.RateDistance.distanceUnits` (string) For Hotels: Optional object to request either miles or kilometers for the search radius from the specified location. If unitOfDistance is not specified, the search defaults to miles for properties in the United States, Myanmar, and Liberia. The search defaults to kilometers in all other countries. Enum: same as `Vehicle.VehicleDateLocation.RentalPickup.GeoLocation.altitudeUnitOfDistance` in "ProductVehicle" (2 values) - `VehiclePrice.RateDistance.ratePeriod` (string) The time period for a rate such as daily, weekly, monthly Enum: same as `VehiclePrice.ratePeriod` in "PriceBreakdownVehiclePrice" (15 values) - `VehiclePrice.RateDescription` (array) - `sequence` (integer) The order of the text block, if there are more than one block. Example: 2 - `description` (string) Text block detail description Example: "description" - `Image` (object) Each instance is one image and its accompanying details, including a link to the image. Key value pairs; not all may be returned. - `Image.value` (string) URL of the image - `Image.dimensionCategory` (string) Deprecated and replaced by imageSize - `Image.width` (integer) Image width Example: 42 - `Image.height` (integer) Image height Example: 43 - `Image.caption` (string) Image caption Example: "Ticket" - `Image.pictureCategory` (integer) deprecated and replaced by pictureOf Example: 5 - `Image.imageSize` (string) A size for the image to return, allowing you to set image quality. Hospitality APIs no longer support thumbnail. Enum: same as `Vehicle.Image.imageSize` in "ProductVehicle" (5 values) - `Image.pictureOf` (string) The image category Enum: same as `Vehicle.Image.pictureOf` in "ProductVehicle" (26 values) - `URL` (string) A URL for this block - `DateCreateModify` (object, required) Time stamp of the creation. - `DateCreateModify.value` (string) Example: "2026-03-04T11:22:00Z" - `DateCreateModify.creatorID` (string) ID of creator. Software system identifier or an employee id Example: "c1234563" - `DateCreateModify.lastModify` (string) Time stamp of last modification. Example: "2026-03-04T11:24:00Z" - `DateCreateModify.lastModifierID` (string) Identifies the last software system or person to modify a record Example: "m346789" - `DateCreateModify.purge` (string) Date an item will be purged from a system of record Example: "2026-03-03" - `VehiclePrice.RateDescription.@type` (string, required) Discriminator classes TextBlock or TextBlockDetail Example: "TextBlockDetail" - `VehiclePrice.RateDescription.title` (string) "The title of the rule or information. For TermsAndConditionsFullHospitality, may include any of the following Rule Types; Promotional Data, Rate Description, Room Rate Data, Rate Text, Guarantee, Cancellation, Deposit, Check in/out, Room detail, Extra charges, Packages, Property, Location, Miscellaneous, Rate Amount, Alternate Rate Amount, Rate Comment, FAX, Phone, Special Information, Information, Room Hold Expiration Time. Not every property returns all of these types. Some properties do not return any title. Only English is supported for these values." Example: "Baggage Details" - `VehiclePrice.RateDescription.id` (string) Internally referenced id Example: "2" - `VehiclePrice.RateDescription.TextFormatted` (array, required) - `VehiclePrice.RateAvailability` (string) Options are available to sell, need to call, or closed Enum: same as `VehiclePrice.RateAvailability` in "PriceBreakdownVehiclePrice" (3 values) - `VehiclePrice.SupplierRate` (object, required) Estimated total amount - Monetary amounts expressed in another currency. - `VehiclePrice.SupplierRate.@type` (string, required) Example: "SupplierRate" - `VehiclePrice.SupplierRate.BaseRate` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.SupplierRate.BaseRate.value` (number) The amount of a given currency. Example: 124.56 - `VehiclePrice.SupplierRate.BaseRate.code` (string) An ISO 4217 alpha character code (3 characters) that specifies a money unit. Example: "USD" - `VehiclePrice.SupplierRate.BaseRate.minorUnit` (integer) Minor units are a mechanism for expressing the relationship between a major currency unit and its corresponding minor currency unit. It is the smallest unit of a given currency. For example; the smallest denomination in USD is the cent, which is 1/100 of a USD, and the minor unit value is 2. Not all currencies have a minor unit. Example: 2 - `VehiclePrice.SupplierRate.BaseRate.currencySource` (string) The system requesting or returning the currency code specified in the attribute Enum: same as `MinimumAdcolAmount.currencySource` in "ChangePermitted" (3 values) - `VehiclePrice.SupplierRate.BaseRate.approximateInd` (boolean) "If true, the currency amount has been converted from the original amount. For Air Exchange Eligibility, returned only if a currency is converted. If returned, the value is always true, indicating that the fee is approximate because of currency conversion. For Hotel Availability and Rules, true indicates this is a calculated value; false indicates this is the value returned by the property." Example: true - `VehiclePrice.SupplierRate.RateForPeriod` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.SupplierRate.DropOffCharge` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.SupplierRate.ExtraMileageCharge` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.SupplierRate.EstimatedTotalAmount` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.ApproximateRate` (object) Estimated total amount - Monetary amounts expressed in another currency. - `VehiclePrice.ApproximateRate.@type` (string, required) Example: "ApproximateRate" - `VehiclePrice.ApproximateRate.BaseRate` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.ApproximateRate.RateForPeriod` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.ApproximateRate.DropOffCharge` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.ApproximateRate.ExtraMileageCharge` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.ApproximateRate.EstimatedTotalAmount` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.CustomerLoyalty` (object) Specifies the ID for the membership program. Object for sending customer loyalty information, such as for a frequent flyer program. For Hotel send the loyalty card number in the value field, followed by programID with the hotel chain code, and supplierType: Hotel. For Air send the loyalty card number in the value field, followed by airline code in "supplier". For cross accrual use the "shareWithSupplier" field to submit to partner airlines. - `VehiclePrice.CustomerLoyalty.value` (string, required) Number on loyalty card. Example: "132456" - `VehiclePrice.CustomerLoyalty.id` (string) Optional Customer Loyalty Id. Not saved Example: "Loyalty_1" - `VehiclePrice.CustomerLoyalty.priority` (integer) Optional Numeric Priority Code Example: 2 - `VehiclePrice.CustomerLoyalty.programId` (string) "Specifies an identifier to indicate the company owner of the loyalty program. Typically two characters. For frequent guest number, the hotel supplier or brand code. For frequent flyer number, the air supplier code of the loyalty program." Example: "HY" - `VehiclePrice.CustomerLoyalty.programName` (string) Supplier's loyalty program name. Example: "Frontier-EarlyReturns" - `VehiclePrice.CustomerLoyalty.supplierType` (string) The type of supplier of a loyalty program. Uses 'hotel' for frequent guest number or 'air' for frequent flyer number. Example: "Hotel" - `VehiclePrice.CustomerLoyalty.supplier` (string) Supplier of a loyalty program (typically 2 characters representing the hotel, brand, or airline). Example: "UA" - `VehiclePrice.CustomerLoyalty.tier` (string) Customer Loyalty tier Example: "Silver" - `VehiclePrice.CustomerLoyalty.shareWithSupplier` (array) The list of suppliers that the CustomerLoyalty number is shared. Used for cross accrual. Example: ["LH"] - `VehiclePrice.CustomerLoyalty.cardHolderName` (string) Customer loyalty member name; up to 128 characters are supported. In Air Search, for discounted offers to be returned, the name must be sent as LAST FIRST; e.g.,if SMITH is the last name and JORDAN the first name, send as SMITH JORDAN Example: "John Smith" - `VehiclePrice.CustomerLoyalty.validatedInd` (boolean) Customer loyalty number has been validated by the supplier Example: true - `VehiclePrice.CustomerLoyalty.prefix` (string) The cardholder name prefix title like Mr, Mrs, Dr Example: "Dr" - `VehiclePrice.CustomerLoyalty.given` (string) The First Name of the Cardholder Example: "John" - `VehiclePrice.CustomerLoyalty.middle` (string) Middle Name of the Cardholder Example: "Wilkinson" - `VehiclePrice.CustomerLoyalty.surname` (string) Last Name of the Cardholder Example: "Smith" - `VehiclePrice.RateQualifier` (string) A closed enumeration of possible rate qualifiers for vehicle rental Enum: same as `VehiclePrice.RateQualifier` in "PriceBreakdownVehiclePrice" (5 values) - `rateGuaranteedInd` (boolean) - PriceBreakdownVehicleDeposit: - `totalPayableNowInd` (boolean) If True the Amount is the total amount payable now - `totalPayableLaterInd` (boolean) If True the Amount is the total amount payable later - PriceBreakdownVehicleCharges: - `VehicleCharges` (object) - `VehicleCharges.@type` (string, required) Example: "VehicleCharges" - `VehicleCharges.description` (string) Assigned Type: c-1100:String - `VehicleCharges.VehicleChargePurposeCode` (object) Any code used to specify an item, for example a type of traveler, service code, room amenity, etc. - `VehicleCharges.VehicleChargePurposeCode.value` (string) Example: "INS" - `VehicleCharges.VehicleChargePurposeCode.codeContext` (string) Code Context Example: "ACRISS" - `VehicleCharges.ratePeriod` (string) The time period for a rate such as daily, weekly, monthly Enum: same as `VehiclePrice.ratePeriod` in "PriceBreakdownVehiclePrice" (15 values) - `VehicleCharges.rateChargeInfo` (string) Assigned Type: c-1100:String - `VehicleCharges.RateCategory` (string) For Hotel Search, request a rate category by sending up to 8 OTA rate categories to search for. If the supplier has rates available for the requested category, the response contains those rates and indicates them as such. Some properties do not return these rates unless explicitly requested. For a Hotel Rules request, this value can be found, if returned, in the Availability response's ProductRateCodeInfo/RateCodeInfo/rateCategory. Enum: same as `VehicleCharges.RateCategory` in "PriceBreakdownVehicleCharges" (32 values) - `VehicleCharges.VehicleCoverageTypeCode` (object) The OTA code defined for the Vehicle Coverage Type - `VehicleCharges.VehicleCoverageTypeCode.value` (string) Example: "INS" - `VehicleCharges.VehicleCoverageTypeCode.codeContext` (string) Code Context Example: "ACRISS" - `VehicleCharges.Calculation` (array) - `VehicleCharges.Calculation.@type` (string, required) Example: "Calculation" - `VehicleCharges.Calculation.UnitAmount` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehicleCharges.Calculation.UnitName` (string) The time period for a rate such as daily, weekly, monthly Enum: same as `VehiclePrice.ratePeriod` in "PriceBreakdownVehiclePrice" (15 values) - `VehicleCharges.Calculation.Quantity` (integer) The quantity used in the calculation of the vehicle charge e.g 2 x $500 per week - `VehicleCharges.Calculation.MaxQuantity` (integer) The maximum quantity allowed for a charge e.g Baby seat charged at $10 per day for a maximum of 10 days - `VehicleCharges.Calculation.TotalAmount` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehicleCharges.Calculation.Percent` (number) Used when the charge is based on a percentage of a TotalAmount - `VehicleCharges.Calculation.Applicability` (object) Textual information. - `VehicleCharges.taxInclusiveInd` (boolean) - `VehicleCharges.guaranteedInd` (boolean) - `VehicleCharges.payNowInd` (boolean) If true the vehicle charge must be paid now and is included in the totalPrice calculation - `VehicleCharges.includedInEstimatedTotalInd` (boolean) - `VehicleCharges.includedInBaseRateInd` (boolean) If true the Vehicle Charge has been included in the base rate of the Vehicle price - `PriceBreakdown.@type` (string, required) Discriminator - Air Search and Air Price APIs child classes are PriceBreakdownAir and PriceBreakdownAncillary. - Search Ancillaries and Seat Availabilities child classes are PriceBreakdown, PriceBreakdownAncillary, and PriceBreakdownAncillaryAir. - All Hotel API child classes are PriceBreakdownHospitality. - Vehicle API child classes are PriceBreakdownVehicleCharges, PriceBreakdownVehicleDeposit, PriceBreakdownVehiclePrice, and PriceBreakdownAncillaryVehicle. - Reservation and Reservation Workbench APIs are PriceBreakdownAir, PriceBreakdownAncillary, PriceBreakdownHospitality, PriceBreakdownVehicleCharges, PriceBreakdownVehicleDeposit, PriceBreakdownVehiclePrice, and PriceBreakdownAncillaryVehicle. Example: "PriceBreakdownAir" - `PriceBreakdown.Amount` (object) Amount represents the cost applied - `PriceBreakdown.Amount.@type` (string) - `PriceBreakdown.Amount.currencySource` (string) The system requesting or returning the currency code specified in the attribute Enum: same as `MinimumAdcolAmount.currencySource` in "ChangePermitted" (3 values) - `PriceBreakdown.Amount.CurrencyCode` (object) Currency codes are the three-letter alphabetic codes that represent the various currencies used throughout the world. Unless changed in the request, the currency is the default associated with your provisioned PCC from Travelport. For Hotel: SourceCurrency is based on the location of the hotel and used for all rates in the response. TargetCurrency is the currency code sent in the request in requestedCurrency. - `PriceBreakdown.Amount.Base` (number) The base price prior to all applicable taxes or fees of a product, such as the amount for a room or fare for a flight (one passenger). Example: 120.2 - `PriceBreakdown.Amount.Taxes` (object) Summary of all individual taxes. Child class TaxesDetail provides the breakdown of individual taxes. - `Tax` (array) - `TaxPercent` (object) Returned when the tax is expressed as a percentage of the amount. - `PriceBreakdown.Amount.Fees` (object) Includes TotalFees object to return the sum total of any fees. May include array of Fee objects to break down individual fees. Child class FeesDetail may also include a breakdown of the individual fees. - `Fee` (array) Array of individual fees. - `PriceBreakdown.Amount.Total` (number) "Specifies the total price including base + taxes + fees. In PriceBreakdownHospitality, this total is for a given group of nights. In PriceBreakdownAir this is the total of base cost and all fees and taxes for one passenger of this PTC type." Example: 230.13 - `PriceBreakdown.Amount.approximateInd` (boolean) if true this amount has been converted from the original amount Example: true - `PriceBreakdown.Commission` (object) — one of (discriminator: @type): GDS only; not supported for NDC. Commission information. Any commission filed by an airline in a CAT35 fare is returned in PriceBreakdownAir/Commission. The amount is either a percent of the fare component (@type CommissionPercent and the Percent object) or an amount (@type CommissionAmount and the Amount object)." - CommissionAmount: - `Amount` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `Amount.value` (number) The amount of a given currency. Example: 124.56 - `Amount.code` (string) An ISO 4217 alpha character code (3 characters) that specifies a money unit. Example: "USD" - `Amount.minorUnit` (integer) Minor units are a mechanism for expressing the relationship between a major currency unit and its corresponding minor currency unit. It is the smallest unit of a given currency. For example; the smallest denomination in USD is the cent, which is 1/100 of a USD, and the minor unit value is 2. Not all currencies have a minor unit. Example: 2 - `Amount.currencySource` (string) The system requesting or returning the currency code specified in the attribute Enum: same as `MinimumAdcolAmount.currencySource` in "ChangePermitted" (3 values) - `Amount.approximateInd` (boolean) "If true, the currency amount has been converted from the original amount. For Air Exchange Eligibility, returned only if a currency is converted. If returned, the value is always true, indicating that the fee is approximate because of currency conversion. For Hotel Availability and Rules, true indicates this is a calculated value; false indicates this is the value returned by the property." Example: true - CommissionPercent: - `Percent` (number) Percent amount of commission Example: 20 - `PriceBreakdown.Commission.@type` (string, required) Discriminator. Child classes CommissionAmount or CommissionPercent Example: "CommissionAmount" - `PriceBreakdown.Commission.application` (string) Type of commission Enum: same as `PriceBreakdown.Commission.application` (6 values) - `ModifyPrice.@type` (string, required) Discriminator classes ModifyPrice or ModifyPriceDetail Example: "ModifyPriceDetail" - `ModifyPrice.id` (string) Internally referenced id Example: "2" - `ModifyPrice.CurrencyCode` (object) Currency codes are the three-letter alphabetic codes that represent the various currencies used throughout the world. Unless changed in the request, the currency is the default associated with your provisioned PCC from Travelport. For Hotel: SourceCurrency is based on the location of the hotel and used for all rates in the response. TargetCurrency is the currency code sent in the request in requestedCurrency. - `ModifyPrice.Base` (number) The total amount not including taxes and\/or fees Example: 20.2 - `ModifyPrice.TotalTaxes` (number) The total of the taxes included in the total price Example: 34.4 - `ModifyPrice.TotalFees` (number) The total of the fees included in the total price Example: 201 - `ModifyPrice.TotalPrice` (number) The total price of the product in the currency indicated Example: 34 - `ModifyPrice.VendorCurrencyTotal` (object) No longer used. Previously used to expose the local vendor currency when it is different to the purchased currency - OfferModify: - `isNetted` (string) Used to indicate if all, some, or none of the fare components can be exchanged or refunded. Enum: same as `isNetted` in "OfferModify" (3 values) - `OfferIdentifier` (object) Travelport-generated offer identifier number. - `OfferIdentifier.id` (string) Local identifier within a given message for this object. Example: "offer_1" - `OfferIdentifier.offerRef` (string) Used to reference another instance of this object in the same message Example: "offer_1" - `OfferIdentifier.Identifier` (object) A globally unique identifier key often used to reference a given option (such as Pricing, Booking, Rules, or additional workflows) or to retrieve information (such as Hotel pagination). - `ModifyPrice` (object, required) The extended class of Modify Price. - `ModifyPrice.@type` (string, required) Discriminator classes ModifyPrice or ModifyPriceDetail Example: "ModifyPriceDetail" - `ModifyPrice.id` (string) Internally referenced id Example: "2" - `ModifyPrice.CurrencyCode` (object) Currency codes are the three-letter alphabetic codes that represent the various currencies used throughout the world. Unless changed in the request, the currency is the default associated with your provisioned PCC from Travelport. For Hotel: SourceCurrency is based on the location of the hotel and used for all rates in the response. TargetCurrency is the currency code sent in the request in requestedCurrency. - `ModifyPrice.Base` (number) The total amount not including taxes and\/or fees Example: 20.2 - `ModifyPrice.TotalTaxes` (number) The total of the taxes included in the total price Example: 34.4 - `ModifyPrice.TotalFees` (number) The total of the fees included in the total price Example: 201 - `ModifyPrice.TotalPrice` (number) The total price of the product in the currency indicated Example: 34 - `ModifyPrice.PriceBreakdown` (array) — one of (discriminator: @type): - PriceBreakdownAir: - `quantity` (integer) Quantity of passengers in that PTC. Example: 2 - `requestedPassengerType` (string) The PTC to which the PriceBreakdown applies. Example: "CHD" - `FiledAmount` (object) Returned only in the Price APIs. GDS only; not supported for NDC. The base amount of a ticket price or net price that is filed in local currency. Returned when the origin currency is not the same as the PCC currency to show the currency in which the base fare has been filed. When used for NetBaseAmount: Net ticket data (NTD) is returned in the AirPrice, AirReservation, Exchange Search, and Reservation Retrieve responses for any GDS fare that has a private fare component (fareType=AgencyPrivateFare). When NTD is returned, TermsAndConditionsFuill includes FareGuaranteePolicy to return the fare calculation indicator for the fare. When NTD is returned, PriceBreakdown may include NetBaseAmount. - `FiledAmount.value` (number) Filed amount value Example: 43.3422 - `FiledAmount.currencyCode` (string) Code for the currency in which the base fare was filed. Example: "USD" - `FiledAmount.codeAuthority` (string) Filed amount currency code authority Example: "Australian Dollar" - `FiledAmount.decimalPlace` (integer, required) Number of decimal places in the currency in ISO 4217 standard format. Example: 3 - `FiledAmount.decimalAuthority` (string) ISO 4217 standard decimal authority Example: "ISO 4217" - `Discount` (object) NDC only; not supported for GDS. Returned for a fare discounted from the published price, such as a promotional discount. Not returned for privately negotiated discounts such as private fares. - `Discount.value` (number) The amount value of the discount Example: 20.22 - `Discount.description` (string) The text description for the discount. Example: "Spring discount on group bookings" - `Discount.currencyCode` (string, required) Currency code discount is returned in. Example: "USD" - `Discount.codeAuthority` (string, required) Not used. Currency code Authority. Example: "ISO" - `Discount.decimalPlace` (integer, required) Number of decimal places in the currency the discount is returned in. Example: 2 - `Discount.decimalAuthority` (string) Not used. Decimal Authority. Example: "ISO" - `NetFareInfo` (object) Detailed information on the net fare used. - `NetFareInfo.@type` (string, required) Example: "NetFareInfo" - `NetFareInfo.passengerTypeCode` (string) PassengerTypeCode Example: "ADT" - `NetFareInfo.NetFareBreakdownConstruction` (array) - `NetFareInfo.NetFareBreakdownConstruction.value` (string) - `NetFareInfo.NetFareBreakdownConstruction.fareType` (string) Assigned Type: c-1100:StringTiny - `NetFareInfo.NetFareBreakdownConstruction.rateOfExchange` (number) The rate of exchange applied to the fare breakdown - `NetFareInfo.TicketBaseAudit` (object) Returned only in the Price APIs. GDS only; not supported for NDC. The base amount of a ticket price or net price that is filed in local currency. Returned when the origin currency is not the same as the PCC currency to show the currency in which the base fare has been filed. When used for NetBaseAmount: Net ticket data (NTD) is returned in the AirPrice, AirReservation, Exchange Search, and Reservation Retrieve responses for any GDS fare that has a private fare component (fareType=AgencyPrivateFare). When NTD is returned, TermsAndConditionsFuill includes FareGuaranteePolicy to return the fare calculation indicator for the fare. When NTD is returned, PriceBreakdown may include NetBaseAmount. - `NetFareInfo.TicketBasePassenger` (object) The monetary value - `NetFareInfo.TicketBasePassenger.value` (number) - `NetFareInfo.TicketBasePassenger.currencyCode` (string) Assigned Type: c-1100:CurrencyCode - `NetFareInfo.TicketBasePassenger.codeAuthority` (string, required) Assigned Type: c-1100:CodeContext - `NetFareInfo.TicketBasePassenger.decimalPlace` (integer, required) Assigned Type: c-1100:CurrencyMinorUnit - `NetFareInfo.TicketBasePassenger.decimalAuthority` (string) Assigned Type: c-1100:CodeContext - `NetFareInfo.TicketBasePassenger.bTInd` (boolean) If true, this is a bulk ticket fare - `NetFareInfo.TicketBasePassenger.iTInd` (boolean) If true, this is an inclusive tour fare - `TravelerIdentifierRef` (object) Identifier references as object both within a message payload or an object held in cache that may be used for subsequent workflows. Returned for NDC in the Price response if age was sent for this traveler in the previous workflow requests. - `TravelerIdentifierRef.name` (string) Traveler identifier - `TravelerIdentifierRef.passengerTypeCode` (string) Passenger Type code Example: "ADT" - `TravelerIdentifierRef.ages` (array) The ages of the travelers associated to a particular ptc. For NDC, this value will be returned in PriceBreakdownAir if sent as part of the PassengerCriteria in the Air Search request. Example: [15] - `TravelerIdentifierRef.passengerCriteriaRef` (string) Allows the user to associate passenger criteria information. Example: "passengerCriteria_1" - `TravelerIdentifierRef.value` (string) - `TravelerIdentifierRef.id` (string) A locally referenced ID - `TravelerIdentifierRef.description` (string) Descriptive text used to identify the contents of a target object - `TravelerIdentifierRef.uris` (array) Uniform Resource Identifier Example: ["google.com"] - `TravelerIdentifierRef.age` (integer) Replaced with ages array. The age of the traveler. Example: 11 - `NetBaseAmount` (object) Returned only in the Price APIs. GDS only; not supported for NDC. The base amount of a ticket price or net price that is filed in local currency. Returned when the origin currency is not the same as the PCC currency to show the currency in which the base fare has been filed. When used for NetBaseAmount: Net ticket data (NTD) is returned in the AirPrice, AirReservation, Exchange Search, and Reservation Retrieve responses for any GDS fare that has a private fare component (fareType=AgencyPrivateFare). When NTD is returned, TermsAndConditionsFuill includes FareGuaranteePolicy to return the fare calculation indicator for the fare. When NTD is returned, PriceBreakdown may include NetBaseAmount. - `FareCalculation` (string) GDS only; not supported for NDC. For each PTC, when available, FareCalculation returns the fare calculation ladder for all public and private fare types filed by an agency or an airline. Example: "LON BA SYD R564.00YEE1Y BA LON R564.00YEE1Y NUC1128.00END ROE0.787855" - `Surcharges` (object) In AirSearch workflow this applies to GDS only. Not supported for NDC, which does not return surcharges. Returned if surcharges apply to this offer. For GDS only, for a multi-city offer with stopovers (see multi-city offers with stopovers for details), surcharges and commission amounts are for the entire journey. For all other offers, the surcharges and commission amounts are for each leg (origin and destination pair). A multi-city offer can be identified by the jc in its CombinabilityCode: jc1, jc2. Surcharges can be omitted from the Search response with excludeSurchargesInd. - `Surcharge` (array, required) - `Surcharge.value` (number) Surcharge amount Example: 12 - `Surcharge.currencyCode` (string) ISO 4217 currency code for the surcharge. Example: "USD" - `Surcharge.surchargeCode` (string) Surcharge code Example: "ADDITIONAL COSTS" - `Surcharge.reportingAuthority` (string) Not used. Surcharge reporting authority Example: "Federal register" - `Surcharge.purpose` (string) Surcharge purpose. For Air workflows possible values include Weekend Surcharge, Stopover Charge, Multiple Stopover Charges, Other (default value that covers all other surcharges such as fuel surcharges). Example: "Weekend Surcharge" - `Surcharge.description` (string) Description of the surcharge. Example: "Rollaway Surcharge" - `Surcharge.surchargeApplication` (string) Application values (such as the application of a fee) like per person or per room. Enum: same as `Surcharge.surchargeApplication` (7 values) - `Surcharge.surchargeFrequency` (string) The frequency of a fee such as per night or per stay. Enum: same as `Surcharge.surchargeFrequency` (6 values) - `Surcharge.codeAuthority` (string) Not used. Currency code authority. Example: "ISO 4217" - `Surcharge.decimalPlace` (integer) Decimal place for the currency unit. Example: 4 - `Surcharge.decimalAuthority` (string) Not used. Currency code decimal authority. Example: "ISO 4217" - `Surcharges.@type` (string, required) Discriminator class is SurchargesDetail Example: "SurchargesDetail" - `Surcharges.TotalSurcharges` (number) A monetary amount, up to 4 decimal places. Example: 211.11 - `Surcharges.approximateInd` (boolean) If true, the surcharge amounts are approximate. - `TravelerRefs` (array) Returned only in Reservation Retrieve to identify the traveler associated with this instance of PriceBreakdown in case of multiple offers on the booking. Example: ["[\"traveler_1\",\"traveler2\"]"] - `PaidTaxes` (object) Summary Taxes object - `Tax` (array) - `Tax.value` (number) Amount of the tax. Returned as 0 if a tax was marked as exempt with TaxExemption. Example: 12.2 - `Tax.currencyCode` (string) A ISO 4217 currency code associated to the value. Example: "USD" - `Tax.taxCode` (string) "Code for the tax. For Hotels this is the OTA code." Example: "XF2" - `Tax.reportingAuthority` (string) Identifies the reporting authority such as airport code for XF taxes Example: "JFK1" - `Tax.purpose` (string) Supplier returned description of tax. Example: "Fuel surcharge" - `Tax.description` (string) "Short summary of the tax. In Air workflows this is returned only for NDC. Note that descriptions are not returned for tax codes YQ and YR, which are fees charged by airlines and not government-imposed taxes. For Hotels this is the OTA tax description." Example: "Lodging tax" - `Tax.includedInBase` (string) Yes , No , Unknown Enum: same as `instantPurchase` in "AdvanceReservationRequired" (3 values) - `Tax.codeAuthority` (string) Not used. Currency Code Authority Example: "ISO" - `Tax.decimalPlace` (integer) Permitted number of decimals. Associated to the currency value. Example: 2 - `Tax.decimalAuthority` (string) Not used. Currency decimal authority Example: "ISO" - `Tax.exemptInd` (boolean) GDS only; not supported for NDC. Returned if a tax was marked exempt in a prior request with the TaxExemption pricing modifer. If true, this tax is exempt" Example: true - `Tax.nonRefundableInd` (boolean) If true, the tax is non refundable. This indicator is only supported for exchange search and exchange price quote transactions. Example: true - `Tax.excludedFromTotalPriceInd` (boolean) Returned in Hotel APIs when a tax is not included in the TotalPrice. Default behavior is for taxes to be included in TotalPrice. Example: true - `TaxPercent` (object) Returned when the tax is expressed as a percentage of the amount. - `TaxPercent.value` (number) The tax percentage amount. Example: 5.5 - `TaxPercent.taxCode` (string) Any code for the tax. Example: "971 - IRS Notice" - `TaxPercent.reportingAuthority` (string) Tax reporting authority Example: "Georgia Department of Revenue" - `TaxPercent.purpose` (string) Purpose of tax Example: "statutory tax" - `TaxPercent.description` (string) Description Example: "1.5% of SGST" - `TaxPercent.includedInBase` (string) Yes , No , Unknown Enum: same as `instantPurchase` in "AdvanceReservationRequired" (3 values) - `PaidTaxes.@type` (string, required) Discriminator classes PaidTaxes or PaidTaxesDetail Example: "PaidTaxesDetail" - `PaidTaxes.TotalTaxes` (number) A monetary amount, up to 4 decimal places. Decimal place needs to be included. Example: 220.12 - `RequestedPricingModifiers` (array) - `RequestedPricingModifiers.@type` (string, required) Discriminator. Example: "RequestedPricingModifiers" - `RequestedPricingModifiers.PassengerCriteria` (object) Defines the passenger criteria. Send one PassengerCriteria for each passenger type code (PTC). Search supports up to 9 total passengers. A maximum of 6 PTCs are supported for GDS. NDC does not have a PTC limitation. AirPrice supports up to nine total passengers across all PTCs. - `TravelerIdentifierRef` (object, required) Identifier references as object both within a message payload or an object held in cache that may be used for subsequent workflows. Returned for NDC in the Price response if age was sent for this traveler in the previous workflow requests. - `RequestedPricingModifiers.PassengerCriteria.@type` (string, required) Discriminator. No child classes. Example: "PassengerCriteria" - `RequestedPricingModifiers.PassengerCriteria.number` (integer, required) The amount of passengers associated with this passenger type code. Default is 1. Example: 1 - `RequestedPricingModifiers.PassengerCriteria.age` (integer) The age of the passenger. Notes on PTC and age: - Travelport recommends sending age only with PTCs that require age for pricing. - If the age is sent in the request, for NDC only, the age is returned in the pricing response. - For child passengers, Travelport recommends sending the age of the child in the age attribute plus the PTC CNN. Travelport recommends against sending CNN without age, or the CHD PTC. Not all fares cannot be quoted for CHD. - The age for CNN is generally between 2 and 11 inclusive, with ADT fares returned for ages 12 and up; however, this can vary by airline and country. - The age for INF must be either 0 or 1. - During booking, date of birth is required for all child and infant PTCs (Add Traveler payload in Traveler/birthDate). Example: 26 - `RequestedPricingModifiers.PassengerCriteria.passengerTypeCode` (string) The passenger type code (PTC) for the passengers on the itinerary. Required field for Air Search and Flight specific search. Common PTCs are: - ADT: adult - CHD: child of unknown age - For child passengers, Travelport recommends sending the age of the child in the age attribute plus the PTC CNN. Travelport recommends against sending CNN without age, or the CHD PTC. Many fares cannot be quoted for CHD. - CNN: child when age is known - The age for CNN is generally between 2 and 11 inclusive, with ADT fares returned for ages 12 and up; however, this can vary by airline and country. - INF: infant without a seat - INS: infant with a seat - UNN: unaccompanied child. See API guides to download a full list of PTCs. NDC carriers BA, SQ, AV, AA, and AF/KLM offer teen/young adult tax exemptions from the UK Air Passenger Duty (GB tax). Send PTC with the value YTH and send the passengers age per below. The PTC may be returned as ADT, or Cxx in which xx is the age, but the tax exemption is applied in the pricing on these NDC carriers. For marine fares, send the PTC value SEA. You must also send OSI remarks at Add Traveler with the vessel name and location. Marine fares are private fares for travelers going to or from a vessel. NDC only; not supported for GDS. When running a multiple passenger search for NDC on Qantas, Qantas supports only these PTCs: ADT, CHD, CNN, INF. Sending any other PTC may result in an error at ticketing. Any traveler sent without a PTC value is defaulted to ADT. PTC can be sent or omitted for ADT passenger. AirReservation defaults the PTC to ADT and returns it in the Reservation Retrieve. Example: "ADT" - `RequestedPricingModifiers.PassengerCriteria.birthDate` (string) The date of birth of the passenger. May be used in age validation for fares with age restrictions. Example: "2020-01-16" - `RequestedPricingModifiers.PassengerCriteria.id` (string) Unique id to support referencing of this specific passenger criteria. Example: "passengercriteria_001" - `RequestedPricingModifiers.PassengerCriteria.CustomerLoyalty` (array) NDC only; not supported for GDS. Optional object for sending customer loyalty information, such as for a frequent flyer program. If CustomerLoyalty is sent in the Search request, it must also be sent in the Air Price request and the Add Traveler request. As some carriers validate frequent traveler data through the workflow, failing to send the same CustomerLoyalty details, even if invalid, may cause a booking failure. If an invalid number is sent, the response returns a warning message that the FQTV is invalid, and the invalid number is cached to prevent a potential booking failure. - `RequestedPricingModifiers.PassengerCriteria.TravelerGeographicLocation` (object) For AirSearch: supported/validated only for NDC to support local citizen fares. For AirPrice and AirReservation: GDS only; not supported for NDC. Optional object for requesting local citizen/local resident fares for Spain and associated islands. You must also send a PTC relevant to the local resident fares; e.g., ADR for adult resident, CHR for child resident. Any discount applied through TravelerGeographicLocation applies to all travelers, not only to the traveler in this instance of PassengerCriteria. If the discount must apply only to an individual traveler, that traveler requires a separate search and book workflow. - `RequestedPricingModifiers.PassengerCriteria.specifiedPassengerTypeCodeOnlyInd` (boolean) GDS only; not supported for NDC. - If true: returns only offers for the specified PTC. If no fares are available for the specified PTC, returns an error message that there is no valid fare. - If false (default behavior): If no fares are available for the specified PTC, returns fares for the default ADT (adult) PTC instead. Example: true - `RequestedPricingModifiers.PricingModifiersAir` (object) A selection of Pricing Modifiers that can be used to influence the Price of an Offer. - For the AirPrice reference payload request, if any price modifiers were included in the preceding Search request and no price modifiers are sent in the AirPrice request, the cached price modifiers sent at Search are sent with the AirPrice request. If any price modifiers are sent in the AirPrice reference payload request, all cached Search modifiers are discarded and only the modifiers sent in that AirPrice request are used. - For the Add Offer request, you may optionally store fares with one or more pricing modifiers. If a pricing modifier is not added, the auto stored fare is added to the reservation. There is no change in the AirReservation response when pricing modifiers are requested. AirReservation applies modifiers from Add Offer and earlier steps as follows: - Modifiers sent in the Add Offer request (supported for both full and reference payload). - If no modifiers are sent in Add Offer, any pricing modifiers sent in AirPrice are applied. - If no modifiers were sent in AirPrice, or if AirPrice was not sent, any pricing modifiers sent in Search are applied. GDS only; pricing modifiers not supported for NDC. If the requested modifier does not have any fares associated with it, the workbench commit fails and returns the error message 'No Fare Found'. Pricing happens at commit, not at Add Offer. - `Brand` (object) Information on airline Brand offerings. If brand attributes were not excluded with inhibitBrandContentInd=true (GDS only), then brand attributes are returned and consolidated in ReferenceList/ReferenceListBrand. In this case Brand does not return the name or Identifier objects but instead returns only BrandRef, which matches to the brand identifier (e.g., b1) in ReferenceListBrand. - `RequestedPricingModifiers.PricingModifiersAir.@type` (string, required) Discriminator. Child classes PricingModifiersAir and PricingModifersAirDetail Example: "PricingModifiersAir" - `RequestedPricingModifiers.PricingModifiersAir.currencyCode` (string) In an API request, send the currency type to return if you want to override the default currency specified with your PCC. Example: "GBP" - `RequestedPricingModifiers.PricingModifiersAir.FareSelection` (object) Requests the return of fare types including private fares (negotiated), public fares (published), or net fares (consolidator fares, or any negotiated wholesale price that is further marked up for sale to customers). May be used to request fares with specific restrictions, change, or refund options. - `RequestedPricingModifiers.PricingModifiersAir.OrganizationInformation` (object) Use to send account codes for negotiated fares or to send optional India GST SSR Remarks in GSTRegistrationNumber. For NDC supports corporate loyalty program and GST Information. This information is returned in TermsAndConditions." - `RequestedPricingModifiers.PricingModifiersAir.TaxExemption` (object) GDS only, not supported for NDC. Use to mark some or all taxes as exempt. Specify all taxes, only specific tax codes, or all taxes in specific countries. Must include either allTaxesExemptInd OR both countries and taxCodes. TaxExemption supports up to nine values for countries, taxCodes, or both combined. The response returns any exempt taxes with exemptInd=true and value=0. - `RequestedPricingModifiers.PricingModifiersAir.PromotionalCode` (array) - `RequestedPricingModifiers.PricingModifiersAir.SellCity` (string) GDS only, not supported for NDC. The IATA location code for a city. Overrides the sell city of the requester to specify an alternate sale location and return fares based on that location. The response returns pricing in the local currency for the specified sell city instead of the PCC's default currency. Example: "NYC" - `RequestedPricingModifiers.PricingModifiersAir.TicketCity` (string) GDS only, not supported for NDC. The IATA location code for a city. Overrides the ticketing city of the requester to specify an alternate ticket location and return fares based on that location; the response returns pricing in the local currency for the specified ticket city instead of the PCC's default currency. Example: "NYC" - `RequestedPricingModifiers.PricingModifiersAir.PricingPCC` (string) GDS only, not supported for NDC. Use to send a faring PCC for which a selective access or code group agreement exists between that PCC and the PCC associated with your account. The following combinations of PricingPCC and FareSelection/fareType=PrivateFaresOnly return results as follows: - PricingPCC sent and PrivateFaresOnly not requested: If a selective access or group agreement exists, both public and any available private fares are returned for the requesting and providing PCC. - If no selective access or group agreement exists, only public fares are returned. - PricingPCC sent and PrivateFaresOnly is requested: If a selective access or group agreement exists that allows private fare access, only available private fares are returned for the requesting and providing PCC. - If no agreement exists, or if an agreement exists but does not allow private fares access, an error is returned. Example: "0Bx3" - `RequestedPricingModifiers.PricingModifiersAir.FareBasisCodeOverride` (array) - `RequestedPricingModifiers.PricingModifiersAir.MultiPricingAgency` (array) The customer can send up to 3 Pseudo City Codes (PCCs) in PricingModifiersAir, MultiPricingAgency. If a customer sends more than 3 PCCs in MultiPricingAgency, only the first 3 are validated. If a customer sends both PricingPCC and MultiPricingAgency with PCCs, the PCC in PricingPCC is ignored. Example: ["[\"0XS4\",\"0YBZ\",\"J80K\"]"] - `RequestedPricingModifiers.PricingModifiersAir.TicketingPCC` (string) GDS only, not supported for NDC. In an API request, overrides the ticketing PCC associated with your account to specify an alternate PCC and return fares based on that PCC. Example: "0XS4" - `RequestedPricingModifiers.PricingModifiersAir.CalculatedFareAdjustment` (object) Used in Exchange Search to modify the Price of the Fare. Discriminator classes CalculatedFareAdjustmentDiscount or CalculatedFareAdjustmentIncrease - `RequestedPricingModifiers.PricingModifiersAir.ManualFareAdjustment` (array) Send to manually adjust the base fare amount on all fares for a specific PTC. - `RequestedPricingModifiers.PricingModifiersAir.BrandPreference` (array) - `RequestedPricingModifiers.PricingModifiersAir.includeSplitPaymentInd` (boolean) Requests request split ticketing, which returns outbound and inbound one-way fares in addition to round trip options in the Search API response. This may result in lower fares than the same or similar round-trip itinerary. If true, requests split ticketing. If false or omitted split ticketing options are not returned. Default is false. GDS only, not supported for NDC. When split ticketing is requested, the Search response returns offers in the following order: Outbound one-way offers, Inbound one-way offers, Round trip offers. The response identifies all one-way outbound and inbound offers with CombinabilityCode j0. CombinabilityCode values for round trip offers start at j1 and increment by one for each offer. Only the following are in scope for split ticketing: Search (not supported for Next Leg Search or Flight Specific Search), Round-trip journey-based offerings ( isJourney header not sent or sent as true, or CustomResponseModifiersAir/SearchRepresentation not sent or sent with value Journey ) Upsells. Split ticketing is not supported for round-trip leg-based searches, virtual interlining, or NDC. Split ticketing is available only for customers specifically provisioned for split ticketing. Split ticketing returns one-way outbound and one-way inbound fares in addition to round-trip offers. Split ticket offers are identified with CombinabilityCode j0. If your account is not configured for split ticketing, sending includeSplitPaymentInd returns a response without split ticket offers and a warning message. GDS only, not supported for NDC. In Air Price, For split ticketing, the request must send offers that are identified in the Search response with CombinabilityCode j0, which identifies those offers as one-way outbound and one-way inbound split ticketing offers. A combination of j0 and any non-j0 value offer returns an error message that split pricing is not supported - `RequestedPricingModifiers.PricingModifiersAir.returnMostRestrictiveBrandInd` (boolean) In Search API, when there are different brands on a connecting flight, return information for either the most restrictive brand or the brand on the most significant segment on the itinerary. If true, return the offer brand of the most restrictive brand. If false or omitted, return the offer brand of the most significant segment of the itinerary. GDS only, not supported for NDC. - `RequestedPricingModifiers.PricingModifiersAir.splitPaymentOfferings` (number) Number between 0 and 99. Send with includeSplitPaymentInd to configure the percentage of round trip offers to return in a split ticketing response. By default, Search divides the split ticketing response into 34% round-trip offerings and the remainder as split ticketing offers, which are combined outbound and inbound one-way fares. To change this percentage, send SplitPaymentOfferings with the percentage value of round trip offers to return. Example: 25 - `RequestedPricingModifiers.CabinPreference` (object) Requests a fare based on the cabin class. Only one cabin preferenceType (Permitted, Preferred, PreferredWithUpgrade) is allowed per request, but there is no limit to the number of cabins that can be sent. Any CabinPreference in the initial Search request is applied to any subsequent Next Leg Search and reference Flight Specific Search requests. In AirPrice and AirReservation only one cabin preference type is allowed per request, but there is no limit to the number of cabins that can be sent. If CabinPreference was sent in the Search request, it is cached and sent with the AirPrice reference payload request. If you send CabinPreference in the AirPrice request, all cached modifiers are discarded and only the modifiers sent in the AirPrice request are used. Can be combined with lowFareFinderInd=true to return lowest fare in the requested cabin or cabins. When using CabinPreference and lowFareFinderInd, if both CabinPreference and a class of service are sent, class of service is ignored. If CabinPreference is sent without a class of service, the response returns the lowest fare in the cabin requested. If that cabin is not available, the response may upgrade or downgrade to a different cabin. If a different cabin than requested is returned, the response returns the message that the cabin class may differ from the class requested. If lowFareFinderInd=false and CabinPreference are sent in the request, AirPrice ignores the preferred cabin and returns a message that the preferred cabin was ignored. If CabinPreference is set to All, no cabin preference is applied." - `RequestedPricingModifiers.CabinPreference.@type` (string, required) Discriminator. No child classes exist Example: "CabinPreference" - `RequestedPricingModifiers.CabinPreference.preferenceType` (string) Type of cabin preference. Sending a mix of preferenceType values is not supported. For example, you cannot send an instance of CabinPreference with a preferenceType of Permitted and another instance with preferenceType of Prohibited. In this case the results default to the Preferred preference. Note that if lowFareFinderInd is sent with true and CabinPreference is sent, the only supported value for CabinPreference/type is Permitted. Enum: same as `RequestedPricingModifiers.CabinPreference.preferenceType` in "PriceBreakdownAir" (4 values) - `RequestedPricingModifiers.CabinPreference.cabins` (array) A space-delimited list of cabins. Enum: same as `PassengerFlight.FlightProduct.cabin` in "ProductAir" (5 values) - `RequestedPricingModifiers.CabinPreference.legSequence` (array) Limits preference to the specified leg referenced in SearchCriteriaFlight. You can apply the preference to only some legs of the itinerary, or different preferences to different legs. To apply preference to the entire itinerary, do not send legSequence. GDS only, not supported for NDC. Not supported at Price or Book. Example: [1,2] - `RequestedPricingModifiers.FlightType` (object) The type of flight connection - `RequestedPricingModifiers.FlightType.@type` (string, required) Discriminator. No child classes. Example: "FlightType" - `RequestedPricingModifiers.FlightType.connectionType` (string) Limits the connection type returned. Each value returns the specified type and all higher types. For example, StopDirect could return both flights that stop without a change of planes (StopDirect) and non-stop direct flights (NonStopDirect). SingleConnection or DoubleConnection will not exclude StopDirect flights from the journey. For example, SingleConnection could return an itinerary with two flight numbers, and either of these flights could have intermediate stops. Enum: same as `RequestedPricingModifiers.FlightType.connectionType` in "PriceBreakdownAir" (5 values) - `RequestedPricingModifiers.FlightType.excludeInterlineConnectionsInd` (boolean) Excludes interline connectionsClosed from results. If true, does not return offers with interline connections. If false or omitted, may return interline connections in results. Default is false. GDS only, not supported for NDC. When a product contains multiple interline air segments, brand details return only the brand of the significant carrier, not the validating/plating carrier brand information. The IATA rules for determining the significant carrier on an itinerary are based on the areas in which the transportation takes place. Example: true - `RequestedPricingModifiers.CustomResponseModifiersAir` (object) Contains additional modifiers to customize the result set. Includes optional indicators for returning or excluding specified response content. Values sent at Search can carry forward into the Next Leg Search request and are not re-sent. - `RequestedPricingModifiers.CustomResponseModifiersAir.@type` (string, required) discriminator Example: "CustomResponseModifiersAir" - `RequestedPricingModifiers.CustomResponseModifiersAir.BrandAttributeInclusion` (array) Supported in AirSearch and AirPrice. Returns only information about the brand attributes specified and does not return any other brand attributes. - `RequestedPricingModifiers.CustomResponseModifiersAir.SearchRepresentation` (string) Specifies either a journey or leg-based response. Journey returns offers for all legs of the itinerary. Journey is the default. Leg returns offers for only the first leg of the itinerary. Must be followed with a Next Leg Search to select an offer for the first leg and return offers on the subsequent leg to combine with it.Customize search result set as leg or journey based. Next Leg Search requests, and Flight Specific Search requests for less than the full itinerary, are supported only after a leg-based Search, not a journey-based Search. If these requests follow a journey-based Search request, an error message is returned. Enum: same as `RequestedPricingModifiers.CustomResponseModifiersAir.SearchRepresentation` in "PriceBreakdownAir" (3 values) - `RequestedPricingModifiers.CustomResponseModifiersAir.excludePenaltiesInd` (boolean) GDS only; not supported for NDC. Indicator to omit change and cancel penalties. - If true: omits all penalty information from the response. - If false (default behavior): returns any change and penalty details provided by carrier for each offer in TermsAndConditionsFullAir/Penalties. If sent in Search but not in AirPrice, the value sent in Search is cached and applied to the AirPrice results. However, you can override the value sent in Search by sending excludePenaltiesInd in the AirPrice request with the opposite value. For example, if the Search request sends excludePenaltiesInd=true and the AirPrice request sends excludePenaltiesInd=false, the Search response does not return penalties and the AirPrice response does return penalties. Example: true - `RequestedPricingModifiers.CustomResponseModifiersAir.excludeBaggageFeesInd` (boolean) GDS only; not supported for NDC. Indicator to exclude baggage details. - If true: excludes baggage fees, carry on fees, and embargo information from the response. Baggage quantity or weight is returned instead. - If false (default behavior): baggage details returned in response. Default is false. Example: true - `RequestedPricingModifiers.CustomResponseModifiersAir.includeFareCalculationInd` (boolean) GDS only; not supported for NDC or in the Flight Specific Search full payload request. Indicator to request the return of the fare calculation ladder. - If true: returns the fare calculation ladder in BestCombinablePrice.PriceBreakdownAir.FareCalculation. - If false (default behavior): fare calculation ladder is not returned. Example: true - `RequestedPricingModifiers.CustomResponseModifiersAir.excludeSurchargesInd` (boolean) GDS only; not supported for NDC. Indicator to exclude a surcharge breakdown. - If true: excludes a surcharge breakdown from the response. Baggage quantity or kilos is returned instead. - If false (default behavior): surcharge breakdown returned in response. Example: true - `RequestedPricingModifiers.CustomResponseModifiersAir.excludeUnbundledFaresInd` (boolean) GDS only, not supported for NDC. Sets whether to return unbundled fares. Supported in AirSearch and AirPrice. - If true: does not return unbundled fares. - If false (default behavior): returns unbundled and bundled fares as available. Example: true - `RequestedPricingModifiers.CustomResponseModifiersAir.includeCO2EmissionsDataInd` (boolean) Indicator to return CO2 emission data in the Search and Next Leg Search responses. - If true: returns CO2 emission data. - If false (default behavior): CO2 emission data not returned. Example: true - `RequestedPricingModifiers.CustomResponseModifiersAir.includeFlightAmenitiesInd` (boolean) Indicator to return flight amenities from ATPCO RouteHappy data. - If true: includes amenities in the response if available. - If false: Does not return ATPCO RouteHappy amenities. Example: true - `RequestedPricingModifiers.CustomResponseModifiersAir.includeUniversalProductAttributesInd` (boolean) Indicator to return universal product attributes (UPAs), which include images, icons, and URLs as provided by ATPCO. Must also send includeFlightAmenitiesInd=true. - If true: returns universal product attributes if available. - If false (default behavior): Universal product attributes not returned. UPAs are not returned for direct flights with intermediate stops, non-flight segments such as trains, or for Premium Business class. Example: true - `RequestedPricingModifiers.CustomResponseModifiersAir.includeBundledAncillariesInd` (boolean) NDC only. If true: the search and price response will include bundled air and ancillary offerings/offers. Search and Price response will contain both ProductAir and ProductAncillary plus a new child class of PriceBreakdown: PriceBreakdownAncillaryAir to define the ancillary inclusion and pricing. Example: true - `RequestedPricingModifiers.CustomResponseModifiersAir.includeFullPenaltyDisclosureInd` (boolean) If true, penalty information sourced from ATPCO Cat 31 and 33 will be disclosed. Penalties may be exposed at fare component level and include time windows. - `RequestedPricingModifiers.PricingModifiersAirChange` (object) Pricing Modifiers that can be used to influence the Price of an Exchanged Offer - `RequestedPricingModifiers.PricingModifiersAirChange.@type` (string) Example: "PricingModifiersAirChange" - `RequestedPricingModifiers.PricingModifiersAirChange.currencyCode` (string) ISO 4217 currency code Example: "USD" - `RequestedPricingModifiers.PricingModifiersAirChange.FareSelection` (object) Requests the return of fare types including private fares (negotiated), public fares (published), or net fares (consolidator fares, or any negotiated wholesale price that is further marked up for sale to customers). May be used to request fares with specific restrictions, change, or refund options. - `RequestedPricingModifiers.PricingModifiersAirChange.OrganizationInformation` (object) Use to send account codes for negotiated fares or to send optional India GST SSR Remarks in GSTRegistrationNumber. For NDC supports corporate loyalty program and GST Information. This information is returned in TermsAndConditions." - `RequestedPricingModifiers.PricingModifiersAirChange.WaiverCode` (object) A code assigned by an airline to support waiver of fees or ticket value as a result of disruption to the passenger. - `RequestedPricingModifiers.PricingModifiersAirChange.TaxExemption` (object) GDS only, not supported for NDC. Use to mark some or all taxes as exempt. Specify all taxes, only specific tax codes, or all taxes in specific countries. Must include either allTaxesExemptInd OR both countries and taxCodes. TaxExemption supports up to nine values for countries, taxCodes, or both combined. The response returns any exempt taxes with exemptInd=true and value=0. - `RequestedPricingModifiers.PricingModifiersAirChange.PromotionalCode` (object) NDC only. Not supported for GDS. Any NDC airline designated promotional code. - `RequestedPricingModifiers.PricingModifiersAirChange.SellCity` (string) Overrides the sell city of the requestor Example: "MEX" - `RequestedPricingModifiers.PricingModifiersAirChange.TicketCity` (string) Overrides the ticket city of the requestor Example: "MEX" - `RequestedPricingModifiers.PricingModifiersAirChange.PricingPCC` (string) Overrides the pricing PCC of the requestor Example: "0XS4" - `RequestedPricingModifiers.PricingModifiersAirChange.TicketingPCC` (string) Overrides the ticketing PCC of the requestor Example: "0XCD" - `RequestedPricingModifiers.PricingModifiersAirChange.CalculatedFareAdjustment` (object) Used in Exchange Search to modify the Price of the Fare. Discriminator classes CalculatedFareAdjustmentDiscount or CalculatedFareAdjustmentIncrease - `RequestedPricingModifiers.PricingModifiersAirChange.BrandPreference` (array) - `RequestedPricingModifiers.PricingModifiersAirChange.keepToBrandInd` (boolean) If true, the offerings returned will be of the same brand as the original Offer Example: true - `RequestedPricingModifiers.PricingModifiersAirChange.returnMostRestrictiveBrandInd` (boolean) if true, the most restrictive brand will be returned in the response when there are different brands present in the Offering Example: true - `RequestedPricingModifiers.PricingModifiersAirChange.doNotNetInd` (boolean) If true, this exchange will not net any residual/refundable amounts against due amounts. - `RequestedPricingModifiers.lowFareFinderInd` (boolean) Provides pricing flexibility around class of service. If not sent, the response returns fares only in the requested class of service. If true, returns the lowest fares available in any class of service available, which may not be the same as the requested class. Note that if lowFareFinderInd is sent with true and CabinPreference is sent, the only supported value for CabinPreference/type is Permitted. When lowFareFindInd=true and brand attributes are not disabled (inhibitBrandContentInd), AirPrice uses only the brand tier (and any other pricing modifiers) to find the lowest fare within a brand tier regardless of class of service. GDS only; not supported for NDC. Example: true - `RequestedPricingModifiers.keepToBrandInd` (boolean) If true, the original brand will be maintained during the exchange process. Example: true - `RequestedPricingModifiers.lowFareFindAndRebookInd` (boolean) If true, the original flights in the reservation will be rebooked or replaced with the new exchanged flights. - `PassengerCriteriaRefs` (array) NDC only; not supported for GDS. Returned for NDC if a traveler identifier was sent for this traveler in the previous workflow requests. Example: ["passengerCriteria_1"] - `FlightPassCredits` (integer) The number of flight pass credits consumed for this pricebreakdown. Example: 1 - PriceBreakdownAncillary: - `inclusiveOfTaxInd` (boolean) If true, this ancillary is sold inclusive of tax. Example: true - `quantity` (integer) The quantity of ancillary items included in this PriceBreakdown. Example: 1 - `Description` (object) A description of the ancillary with description codes. - `Description.value` (string) The text description of the ancillary. Example: "Vegetarian Meal" - `Description.code` (string) The ATPCO group code. Example: "BG" - `Description.subCode` (string) The ATPCO RFISC subcode. Example: "0D4" - `Description.subGroup` (string) The ATPCO sub group code. Example: "SP" - `Description.codeContext` (string) The code context value. Example: "ATPCO" - `Description.ssrCode` (string) The four character AIRIMP SSR code for this ancillary. Example: "VGML" - `Description.issuanceReasonCode` (string) The airline provided reason for issuance code. Example: "C" - `Description.geographicSpecification` (string) How the ancillary is applied across the itinerary. Enum: same as `Ancillary.Description.geographicSpecification` in "ProductAncillary" (3 values) - `ProductRef` (string) The product ref this PriceBreakdown applies to. If no productRef exists then the PriceBreakdown applies to all Products within the Offer. Example: "p_1" - `Discount` (object) NDC only; not supported for GDS. Returned for a fare discounted from the published price, such as a promotional discount. Not returned for privately negotiated discounts such as private fares. - `Discount.value` (number) The amount value of the discount Example: 20.22 - `Discount.description` (string) The text description for the discount. Example: "Spring discount on group bookings" - `Discount.currencyCode` (string, required) Currency code discount is returned in. Example: "USD" - `Discount.codeAuthority` (string, required) Not used. Currency code Authority. Example: "ISO" - `Discount.decimalPlace` (integer, required) Number of decimal places in the currency the discount is returned in. Example: 2 - `Discount.decimalAuthority` (string) Not used. Decimal Authority. Example: "ISO" - `TravelerIdentifierRef` (object) Identifier references as object both within a message payload or an object held in cache that may be used for subsequent workflows. Returned for NDC in the Price response if age was sent for this traveler in the previous workflow requests. - `TravelerIdentifierRef.name` (string) Traveler identifier - `TravelerIdentifierRef.passengerTypeCode` (string) Passenger Type code Example: "ADT" - `TravelerIdentifierRef.ages` (array) The ages of the travelers associated to a particular ptc. For NDC, this value will be returned in PriceBreakdownAir if sent as part of the PassengerCriteria in the Air Search request. Example: [15] - `TravelerIdentifierRef.passengerCriteriaRef` (string) Allows the user to associate passenger criteria information. Example: "passengerCriteria_1" - `TravelerIdentifierRef.value` (string) - `TravelerIdentifierRef.id` (string) A locally referenced ID - `TravelerIdentifierRef.description` (string) Descriptive text used to identify the contents of a target object - `TravelerIdentifierRef.uris` (array) Uniform Resource Identifier Example: ["google.com"] - `TravelerIdentifierRef.age` (integer) Replaced with ages array. The age of the traveler. Example: 11 - `AncillaryPriceApplicationCode` (object) Determines how an ancillary price has been built. - `AncillaryPriceApplicationCode.value` (string) Example: "3" - `AncillaryPriceApplicationCode.application` (string) Associated text. Example: "PerItem" - PriceBreakdownHospitality: - `roomPricingType` (string) A string provided by the hotel to describe how a service is priced, such as per night or per stay. Enum: same as `roomPricingType` in "PriceBreakdownHospitality" (5 values) - `Description` (string) Example: "Advance Purchase-Ro-Free WiFi" - `NightlyRate` (array) - `NightlyRate.@type` (string) - `NightlyRate.startDate` (string, required) Start date for the nightly rate in YYYY-MM-DD format. - `NightlyRate.nights` (integer) Number of nights the nightly rate is valid. - `NightlyRate.Amount` (object, required) Amount represents the cost applied - `AverageNightlyRate` (array) The average nightly rate for a given offer. - `AverageNightlyRate.value` (number) The amount of a given currency. Example: 124.56 - `AverageNightlyRate.code` (string) An ISO 4217 alpha character code (3 characters) that specifies a money unit. Example: "USD" - `AverageNightlyRate.minorUnit` (integer) Minor units are a mechanism for expressing the relationship between a major currency unit and its corresponding minor currency unit. It is the smallest unit of a given currency. For example; the smallest denomination in USD is the cent, which is 1/100 of a USD, and the minor unit value is 2. Not all currencies have a minor unit. Example: 2 - `AverageNightlyRate.currencySource` (string) The system requesting or returning the currency code specified in the attribute Enum: same as `MinimumAdcolAmount.currencySource` in "ChangePermitted" (3 values) - `AverageNightlyRate.approximateInd` (boolean) "If true, the currency amount has been converted from the original amount. For Air Exchange Eligibility, returned only if a currency is converted. If returned, the value is always true, indicating that the fee is approximate because of currency conversion. For Hotel Availability and Rules, true indicates this is a calculated value; false indicates this is the value returned by the property." Example: true - `AmenitySurcharges` (object) Amenity Surcharges information. - `AmenitySurcharges.@type` (string, required) Discriminator classes AmenitySurcharges or AmenitySurchargesDetail Example: "AmenitySurchargesDetail" - `AmenitySurcharges.TotalSurcharges` (number) A monetary amount, up to 4 decimal places. Decimal place needs to be included. Example: 211.11 - `AmenitySurcharges.approximateInd` (boolean) if true, the surcharge amounts are approximate - `AmenitySurcharges.Surcharge` (array, required) - `AmenitySurcharges.Surcharge.value` (number) Surcharge amount Example: 12 - `AmenitySurcharges.Surcharge.currencyCode` (string) ISO 4217 currency code for the surcharge. Example: "USD" - `AmenitySurcharges.Surcharge.surchargeCode` (string) Surcharge code Example: "ADDITIONAL COSTS" - `AmenitySurcharges.Surcharge.reportingAuthority` (string) Not used. Surcharge reporting authority Example: "Federal register" - `AmenitySurcharges.Surcharge.purpose` (string) Surcharge purpose. For Air workflows possible values include Weekend Surcharge, Stopover Charge, Multiple Stopover Charges, Other (default value that covers all other surcharges such as fuel surcharges). Example: "Weekend Surcharge" - `AmenitySurcharges.Surcharge.description` (string) Description of the surcharge. Example: "Rollaway Surcharge" - `AmenitySurcharges.Surcharge.surchargeApplication` (string) Application values (such as the application of a fee) like per person or per room. Enum: same as `Surcharge.surchargeApplication` (7 values) - `AmenitySurcharges.Surcharge.surchargeFrequency` (string) The frequency of a fee such as per night or per stay. Enum: same as `Surcharge.surchargeFrequency` (6 values) - `AmenitySurcharges.Surcharge.codeAuthority` (string) Not used. Currency code authority. Example: "ISO 4217" - `AmenitySurcharges.Surcharge.decimalPlace` (integer) Decimal place for the currency unit. Example: 4 - `AmenitySurcharges.Surcharge.decimalAuthority` (string) Not used. Currency code decimal authority. Example: "ISO 4217" - `priceChangesDuringStayInd` (boolean) "If true, indicates the price changes at least once during requested dates. If roomPricingType = Per night, multiple instances of priceChangesDuringStayInd are returned." - `shortRateDescription` (string) A normalized rate description for comparing rates across multiple aggregators. Example: "Flexible Rate" - PriceBreakdownVehiclePrice: - `VehiclePrice` (object, required) Rate summary for rental of the vehicle. - `VehiclePrice.@type` (string, required) Example: "VehiclePrice" - `VehiclePrice.id` (string) Internal ID - `VehiclePrice.rateSource` (string) Assigned Type: c-1100:StringTiny - `VehiclePrice.rateGuaranteedInd` (boolean) Assigned Type: c-1100:OptionalIndicator - `VehiclePrice.ratePeriod` (string) The time period for a rate such as daily, weekly, monthly Enum: same as `VehiclePrice.ratePeriod` in "PriceBreakdownVehiclePrice" (15 values) - `VehiclePrice.RateDistance` (object) Rate for the period defined by the attributes - `VehiclePrice.RateDistance.value` (number) - `VehiclePrice.RateDistance.unlimitedDistanceInd` (boolean) if true unlimited miles is included with the rental - `VehiclePrice.RateDistance.requestedCodeAppliedInd` (boolean) if true, the requested code has been applied - `VehiclePrice.RateDistance.allowance` (integer) The distance allowance permitted with this rate. Use in combination with distanceUnits and ratePeriod - `VehiclePrice.RateDistance.distanceUnits` (string) For Hotels: Optional object to request either miles or kilometers for the search radius from the specified location. If unitOfDistance is not specified, the search defaults to miles for properties in the United States, Myanmar, and Liberia. The search defaults to kilometers in all other countries. Enum: same as `Vehicle.VehicleDateLocation.RentalPickup.GeoLocation.altitudeUnitOfDistance` in "ProductVehicle" (2 values) - `VehiclePrice.RateDistance.ratePeriod` (string) The time period for a rate such as daily, weekly, monthly Enum: same as `VehiclePrice.ratePeriod` in "PriceBreakdownVehiclePrice" (15 values) - `VehiclePrice.RateDescription` (array) - `sequence` (integer) The order of the text block, if there are more than one block. Example: 2 - `description` (string) Text block detail description Example: "description" - `Image` (object) Each instance is one image and its accompanying details, including a link to the image. Key value pairs; not all may be returned. - `Image.value` (string) URL of the image - `Image.dimensionCategory` (string) Deprecated and replaced by imageSize - `Image.width` (integer) Image width Example: 42 - `Image.height` (integer) Image height Example: 43 - `Image.caption` (string) Image caption Example: "Ticket" - `Image.pictureCategory` (integer) deprecated and replaced by pictureOf Example: 5 - `Image.imageSize` (string) A size for the image to return, allowing you to set image quality. Hospitality APIs no longer support thumbnail. Enum: same as `Vehicle.Image.imageSize` in "ProductVehicle" (5 values) - `Image.pictureOf` (string) The image category Enum: same as `Vehicle.Image.pictureOf` in "ProductVehicle" (26 values) - `URL` (string) A URL for this block - `DateCreateModify` (object, required) Time stamp of the creation. - `DateCreateModify.value` (string) Example: "2026-03-04T11:22:00Z" - `DateCreateModify.creatorID` (string) ID of creator. Software system identifier or an employee id Example: "c1234563" - `DateCreateModify.lastModify` (string) Time stamp of last modification. Example: "2026-03-04T11:24:00Z" - `DateCreateModify.lastModifierID` (string) Identifies the last software system or person to modify a record Example: "m346789" - `DateCreateModify.purge` (string) Date an item will be purged from a system of record Example: "2026-03-03" - `VehiclePrice.RateDescription.@type` (string, required) Discriminator classes TextBlock or TextBlockDetail Example: "TextBlockDetail" - `VehiclePrice.RateDescription.title` (string) "The title of the rule or information. For TermsAndConditionsFullHospitality, may include any of the following Rule Types; Promotional Data, Rate Description, Room Rate Data, Rate Text, Guarantee, Cancellation, Deposit, Check in/out, Room detail, Extra charges, Packages, Property, Location, Miscellaneous, Rate Amount, Alternate Rate Amount, Rate Comment, FAX, Phone, Special Information, Information, Room Hold Expiration Time. Not every property returns all of these types. Some properties do not return any title. Only English is supported for these values." Example: "Baggage Details" - `VehiclePrice.RateDescription.id` (string) Internally referenced id Example: "2" - `VehiclePrice.RateDescription.TextFormatted` (array, required) - `VehiclePrice.RateAvailability` (string) Options are available to sell, need to call, or closed Enum: same as `VehiclePrice.RateAvailability` in "PriceBreakdownVehiclePrice" (3 values) - `VehiclePrice.SupplierRate` (object, required) Estimated total amount - Monetary amounts expressed in another currency. - `VehiclePrice.SupplierRate.@type` (string, required) Example: "SupplierRate" - `VehiclePrice.SupplierRate.BaseRate` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.SupplierRate.BaseRate.value` (number) The amount of a given currency. Example: 124.56 - `VehiclePrice.SupplierRate.BaseRate.code` (string) An ISO 4217 alpha character code (3 characters) that specifies a money unit. Example: "USD" - `VehiclePrice.SupplierRate.BaseRate.minorUnit` (integer) Minor units are a mechanism for expressing the relationship between a major currency unit and its corresponding minor currency unit. It is the smallest unit of a given currency. For example; the smallest denomination in USD is the cent, which is 1/100 of a USD, and the minor unit value is 2. Not all currencies have a minor unit. Example: 2 - `VehiclePrice.SupplierRate.BaseRate.currencySource` (string) The system requesting or returning the currency code specified in the attribute Enum: same as `MinimumAdcolAmount.currencySource` in "ChangePermitted" (3 values) - `VehiclePrice.SupplierRate.BaseRate.approximateInd` (boolean) "If true, the currency amount has been converted from the original amount. For Air Exchange Eligibility, returned only if a currency is converted. If returned, the value is always true, indicating that the fee is approximate because of currency conversion. For Hotel Availability and Rules, true indicates this is a calculated value; false indicates this is the value returned by the property." Example: true - `VehiclePrice.SupplierRate.RateForPeriod` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.SupplierRate.DropOffCharge` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.SupplierRate.ExtraMileageCharge` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.SupplierRate.EstimatedTotalAmount` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.ApproximateRate` (object) Estimated total amount - Monetary amounts expressed in another currency. - `VehiclePrice.ApproximateRate.@type` (string, required) Example: "ApproximateRate" - `VehiclePrice.ApproximateRate.BaseRate` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.ApproximateRate.RateForPeriod` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.ApproximateRate.DropOffCharge` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.ApproximateRate.ExtraMileageCharge` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.ApproximateRate.EstimatedTotalAmount` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.CustomerLoyalty` (object) Specifies the ID for the membership program. Object for sending customer loyalty information, such as for a frequent flyer program. For Hotel send the loyalty card number in the value field, followed by programID with the hotel chain code, and supplierType: Hotel. For Air send the loyalty card number in the value field, followed by airline code in "supplier". For cross accrual use the "shareWithSupplier" field to submit to partner airlines. - `VehiclePrice.CustomerLoyalty.value` (string, required) Number on loyalty card. Example: "132456" - `VehiclePrice.CustomerLoyalty.id` (string) Optional Customer Loyalty Id. Not saved Example: "Loyalty_1" - `VehiclePrice.CustomerLoyalty.priority` (integer) Optional Numeric Priority Code Example: 2 - `VehiclePrice.CustomerLoyalty.programId` (string) "Specifies an identifier to indicate the company owner of the loyalty program. Typically two characters. For frequent guest number, the hotel supplier or brand code. For frequent flyer number, the air supplier code of the loyalty program." Example: "HY" - `VehiclePrice.CustomerLoyalty.programName` (string) Supplier's loyalty program name. Example: "Frontier-EarlyReturns" - `VehiclePrice.CustomerLoyalty.supplierType` (string) The type of supplier of a loyalty program. Uses 'hotel' for frequent guest number or 'air' for frequent flyer number. Example: "Hotel" - `VehiclePrice.CustomerLoyalty.supplier` (string) Supplier of a loyalty program (typically 2 characters representing the hotel, brand, or airline). Example: "UA" - `VehiclePrice.CustomerLoyalty.tier` (string) Customer Loyalty tier Example: "Silver" - `VehiclePrice.CustomerLoyalty.shareWithSupplier` (array) The list of suppliers that the CustomerLoyalty number is shared. Used for cross accrual. Example: ["LH"] - `VehiclePrice.CustomerLoyalty.cardHolderName` (string) Customer loyalty member name; up to 128 characters are supported. In Air Search, for discounted offers to be returned, the name must be sent as LAST FIRST; e.g.,if SMITH is the last name and JORDAN the first name, send as SMITH JORDAN Example: "John Smith" - `VehiclePrice.CustomerLoyalty.validatedInd` (boolean) Customer loyalty number has been validated by the supplier Example: true - `VehiclePrice.CustomerLoyalty.prefix` (string) The cardholder name prefix title like Mr, Mrs, Dr Example: "Dr" - `VehiclePrice.CustomerLoyalty.given` (string) The First Name of the Cardholder Example: "John" - `VehiclePrice.CustomerLoyalty.middle` (string) Middle Name of the Cardholder Example: "Wilkinson" - `VehiclePrice.CustomerLoyalty.surname` (string) Last Name of the Cardholder Example: "Smith" - `VehiclePrice.RateQualifier` (string) A closed enumeration of possible rate qualifiers for vehicle rental Enum: same as `VehiclePrice.RateQualifier` in "PriceBreakdownVehiclePrice" (5 values) - `rateGuaranteedInd` (boolean) - PriceBreakdownVehicleDeposit: - `totalPayableNowInd` (boolean) If True the Amount is the total amount payable now - `totalPayableLaterInd` (boolean) If True the Amount is the total amount payable later - PriceBreakdownVehicleCharges: - `VehicleCharges` (object) - `VehicleCharges.@type` (string, required) Example: "VehicleCharges" - `VehicleCharges.description` (string) Assigned Type: c-1100:String - `VehicleCharges.VehicleChargePurposeCode` (object) Any code used to specify an item, for example a type of traveler, service code, room amenity, etc. - `VehicleCharges.VehicleChargePurposeCode.value` (string) Example: "INS" - `VehicleCharges.VehicleChargePurposeCode.codeContext` (string) Code Context Example: "ACRISS" - `VehicleCharges.ratePeriod` (string) The time period for a rate such as daily, weekly, monthly Enum: same as `VehiclePrice.ratePeriod` in "PriceBreakdownVehiclePrice" (15 values) - `VehicleCharges.rateChargeInfo` (string) Assigned Type: c-1100:String - `VehicleCharges.RateCategory` (string) For Hotel Search, request a rate category by sending up to 8 OTA rate categories to search for. If the supplier has rates available for the requested category, the response contains those rates and indicates them as such. Some properties do not return these rates unless explicitly requested. For a Hotel Rules request, this value can be found, if returned, in the Availability response's ProductRateCodeInfo/RateCodeInfo/rateCategory. Enum: same as `VehicleCharges.RateCategory` in "PriceBreakdownVehicleCharges" (32 values) - `VehicleCharges.VehicleCoverageTypeCode` (object) The OTA code defined for the Vehicle Coverage Type - `VehicleCharges.VehicleCoverageTypeCode.value` (string) Example: "INS" - `VehicleCharges.VehicleCoverageTypeCode.codeContext` (string) Code Context Example: "ACRISS" - `VehicleCharges.Calculation` (array) - `VehicleCharges.Calculation.@type` (string, required) Example: "Calculation" - `VehicleCharges.Calculation.UnitAmount` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehicleCharges.Calculation.UnitName` (string) The time period for a rate such as daily, weekly, monthly Enum: same as `VehiclePrice.ratePeriod` in "PriceBreakdownVehiclePrice" (15 values) - `VehicleCharges.Calculation.Quantity` (integer) The quantity used in the calculation of the vehicle charge e.g 2 x $500 per week - `VehicleCharges.Calculation.MaxQuantity` (integer) The maximum quantity allowed for a charge e.g Baby seat charged at $10 per day for a maximum of 10 days - `VehicleCharges.Calculation.TotalAmount` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehicleCharges.Calculation.Percent` (number) Used when the charge is based on a percentage of a TotalAmount - `VehicleCharges.Calculation.Applicability` (object) Textual information. - `VehicleCharges.taxInclusiveInd` (boolean) - `VehicleCharges.guaranteedInd` (boolean) - `VehicleCharges.payNowInd` (boolean) If true the vehicle charge must be paid now and is included in the totalPrice calculation - `VehicleCharges.includedInEstimatedTotalInd` (boolean) - `VehicleCharges.includedInBaseRateInd` (boolean) If true the Vehicle Charge has been included in the base rate of the Vehicle price - `ModifyPrice.PriceBreakdown.@type` (string, required) Discriminator - Air Search and Air Price APIs child classes are PriceBreakdownAir and PriceBreakdownAncillary. - Search Ancillaries and Seat Availabilities child classes are PriceBreakdown, PriceBreakdownAncillary, and PriceBreakdownAncillaryAir. - All Hotel API child classes are PriceBreakdownHospitality. - Vehicle API child classes are PriceBreakdownVehicleCharges, PriceBreakdownVehicleDeposit, PriceBreakdownVehiclePrice, and PriceBreakdownAncillaryVehicle. - Reservation and Reservation Workbench APIs are PriceBreakdownAir, PriceBreakdownAncillary, PriceBreakdownHospitality, PriceBreakdownVehicleCharges, PriceBreakdownVehicleDeposit, PriceBreakdownVehiclePrice, and PriceBreakdownAncillaryVehicle. Example: "PriceBreakdownAir" - `ModifyPrice.PriceBreakdown.Amount` (object) Amount represents the cost applied - `ModifyPrice.PriceBreakdown.Amount.@type` (string) - `ModifyPrice.PriceBreakdown.Amount.currencySource` (string) The system requesting or returning the currency code specified in the attribute Enum: same as `MinimumAdcolAmount.currencySource` in "ChangePermitted" (3 values) - `ModifyPrice.PriceBreakdown.Amount.CurrencyCode` (object) Currency codes are the three-letter alphabetic codes that represent the various currencies used throughout the world. Unless changed in the request, the currency is the default associated with your provisioned PCC from Travelport. For Hotel: SourceCurrency is based on the location of the hotel and used for all rates in the response. TargetCurrency is the currency code sent in the request in requestedCurrency. - `ModifyPrice.PriceBreakdown.Amount.Base` (number) The base price prior to all applicable taxes or fees of a product, such as the amount for a room or fare for a flight (one passenger). Example: 120.2 - `ModifyPrice.PriceBreakdown.Amount.Taxes` (object) Summary of all individual taxes. Child class TaxesDetail provides the breakdown of individual taxes. - `Tax` (array) - `TaxPercent` (object) Returned when the tax is expressed as a percentage of the amount. - `ModifyPrice.PriceBreakdown.Amount.Fees` (object) Includes TotalFees object to return the sum total of any fees. May include array of Fee objects to break down individual fees. Child class FeesDetail may also include a breakdown of the individual fees. - `Fee` (array) Array of individual fees. - `ModifyPrice.PriceBreakdown.Amount.Total` (number) "Specifies the total price including base + taxes + fees. In PriceBreakdownHospitality, this total is for a given group of nights. In PriceBreakdownAir this is the total of base cost and all fees and taxes for one passenger of this PTC type." Example: 230.13 - `ModifyPrice.PriceBreakdown.Amount.approximateInd` (boolean) if true this amount has been converted from the original amount Example: true - `ModifyPrice.PriceBreakdown.Commission` (object) — one of (discriminator: @type): GDS only; not supported for NDC. Commission information. Any commission filed by an airline in a CAT35 fare is returned in PriceBreakdownAir/Commission. The amount is either a percent of the fare component (@type CommissionPercent and the Percent object) or an amount (@type CommissionAmount and the Amount object)." - CommissionAmount: - `Amount` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `Amount.value` (number) The amount of a given currency. Example: 124.56 - `Amount.code` (string) An ISO 4217 alpha character code (3 characters) that specifies a money unit. Example: "USD" - `Amount.minorUnit` (integer) Minor units are a mechanism for expressing the relationship between a major currency unit and its corresponding minor currency unit. It is the smallest unit of a given currency. For example; the smallest denomination in USD is the cent, which is 1/100 of a USD, and the minor unit value is 2. Not all currencies have a minor unit. Example: 2 - `Amount.currencySource` (string) The system requesting or returning the currency code specified in the attribute Enum: same as `MinimumAdcolAmount.currencySource` in "ChangePermitted" (3 values) - `Amount.approximateInd` (boolean) "If true, the currency amount has been converted from the original amount. For Air Exchange Eligibility, returned only if a currency is converted. If returned, the value is always true, indicating that the fee is approximate because of currency conversion. For Hotel Availability and Rules, true indicates this is a calculated value; false indicates this is the value returned by the property." Example: true - CommissionPercent: - `Percent` (number) Percent amount of commission Example: 20 - `ModifyPrice.PriceBreakdown.Commission.@type` (string, required) Discriminator. Child classes CommissionAmount or CommissionPercent Example: "CommissionAmount" - `ModifyPrice.PriceBreakdown.Commission.application` (string) Type of commission Enum: same as `PriceBreakdown.Commission.application` (6 values) - `ModifyPrice.VendorCurrencyTotal` (object) No longer used. Previously used to expose the local vendor currency when it is different to the purchased currency - `retainedValueInd` (boolean) If true, the value will be retained on a document for future use Example: true - `productsUpdatedInd` (boolean) If present and true, the products in the host copy of the reservation have already been updated Example: true - `priceUpdatedInd` (boolean) If present and true, the price in the host copy of the reservation has already been updated Example: true - `documentVoidPeriodInd` (boolean) If true, when the Offer is cancelled the document will be voided. Example: true - `refundValueInd` (boolean) If true, when the Offer is cancelled the document value can be refunded. Example: true - `SupplierRetainedPrice` (object) Child class of Price. This includes all of the Price object plus the Pricebreakdown which gives detailed Price information per PTC or Hotel offering. For a Hotels Create Reservation (Full Payload) request, find the values to send in the Price objects from either Availability (returned in CatalogOffering/Price) or Rules (returned in Offer/Price). Although you can send the price returned in either API, the Rules pricing may be more accurate. If you sent a Rules request, send the value from that response. You must include CurrencyCode, Base, TotalTaxes, and TotalPrice. When returned from the previous steps, additionally send TermsAndConditionsFull, ProductRateCodeInfo, and RateCodeInfo. - `SupplierRetainedPrice.@type` (string, required) Discriminator classes Price or PriceDetail Example: "PriceDetail" - `SupplierRetainedPrice.id` (string) Internally referenced id Example: "2" - `SupplierRetainedPrice.CurrencyCode` (object) Currency codes are the three-letter alphabetic codes that represent the various currencies used throughout the world. Unless changed in the request, the currency is the default associated with your provisioned PCC from Travelport. For Hotel: SourceCurrency is based on the location of the hotel and used for all rates in the response. TargetCurrency is the currency code sent in the request in requestedCurrency. - `SupplierRetainedPrice.Base` (number) "Base price before taxes and fees. For Hotel, may not be returned by all suppliers." Example: 20.2 - `SupplierRetainedPrice.TotalTaxes` (number) "Total taxes applied to the base price. For Hotel, may not be returned by all suppliers." Example: 34.4 - `SupplierRetainedPrice.TotalFees` (number) Total fees included in Total Price. Example: 201 - `SupplierRetainedPrice.TotalPrice` (number) Total price of this offer including the base price and all taxes and fees. Example: 34 - `SupplierRetainedPrice.FlightPassCredits` (integer) The total number of flight pass credits consumed for this offer. Example: 2 - `SupplierRetainedPrice.PriceBreakdown` (array) — one of (discriminator: @type): - PriceBreakdownAir: - `quantity` (integer) Quantity of passengers in that PTC. Example: 2 - `requestedPassengerType` (string) The PTC to which the PriceBreakdown applies. Example: "CHD" - `FiledAmount` (object) Returned only in the Price APIs. GDS only; not supported for NDC. The base amount of a ticket price or net price that is filed in local currency. Returned when the origin currency is not the same as the PCC currency to show the currency in which the base fare has been filed. When used for NetBaseAmount: Net ticket data (NTD) is returned in the AirPrice, AirReservation, Exchange Search, and Reservation Retrieve responses for any GDS fare that has a private fare component (fareType=AgencyPrivateFare). When NTD is returned, TermsAndConditionsFuill includes FareGuaranteePolicy to return the fare calculation indicator for the fare. When NTD is returned, PriceBreakdown may include NetBaseAmount. - `FiledAmount.value` (number) Filed amount value Example: 43.3422 - `FiledAmount.currencyCode` (string) Code for the currency in which the base fare was filed. Example: "USD" - `FiledAmount.codeAuthority` (string) Filed amount currency code authority Example: "Australian Dollar" - `FiledAmount.decimalPlace` (integer, required) Number of decimal places in the currency in ISO 4217 standard format. Example: 3 - `FiledAmount.decimalAuthority` (string) ISO 4217 standard decimal authority Example: "ISO 4217" - `Discount` (object) NDC only; not supported for GDS. Returned for a fare discounted from the published price, such as a promotional discount. Not returned for privately negotiated discounts such as private fares. - `Discount.value` (number) The amount value of the discount Example: 20.22 - `Discount.description` (string) The text description for the discount. Example: "Spring discount on group bookings" - `Discount.currencyCode` (string, required) Currency code discount is returned in. Example: "USD" - `Discount.codeAuthority` (string, required) Not used. Currency code Authority. Example: "ISO" - `Discount.decimalPlace` (integer, required) Number of decimal places in the currency the discount is returned in. Example: 2 - `Discount.decimalAuthority` (string) Not used. Decimal Authority. Example: "ISO" - `NetFareInfo` (object) Detailed information on the net fare used. - `NetFareInfo.@type` (string, required) Example: "NetFareInfo" - `NetFareInfo.passengerTypeCode` (string) PassengerTypeCode Example: "ADT" - `NetFareInfo.NetFareBreakdownConstruction` (array) - `NetFareInfo.NetFareBreakdownConstruction.value` (string) - `NetFareInfo.NetFareBreakdownConstruction.fareType` (string) Assigned Type: c-1100:StringTiny - `NetFareInfo.NetFareBreakdownConstruction.rateOfExchange` (number) The rate of exchange applied to the fare breakdown - `NetFareInfo.TicketBaseAudit` (object) Returned only in the Price APIs. GDS only; not supported for NDC. The base amount of a ticket price or net price that is filed in local currency. Returned when the origin currency is not the same as the PCC currency to show the currency in which the base fare has been filed. When used for NetBaseAmount: Net ticket data (NTD) is returned in the AirPrice, AirReservation, Exchange Search, and Reservation Retrieve responses for any GDS fare that has a private fare component (fareType=AgencyPrivateFare). When NTD is returned, TermsAndConditionsFuill includes FareGuaranteePolicy to return the fare calculation indicator for the fare. When NTD is returned, PriceBreakdown may include NetBaseAmount. - `NetFareInfo.TicketBasePassenger` (object) The monetary value - `NetFareInfo.TicketBasePassenger.value` (number) - `NetFareInfo.TicketBasePassenger.currencyCode` (string) Assigned Type: c-1100:CurrencyCode - `NetFareInfo.TicketBasePassenger.codeAuthority` (string, required) Assigned Type: c-1100:CodeContext - `NetFareInfo.TicketBasePassenger.decimalPlace` (integer, required) Assigned Type: c-1100:CurrencyMinorUnit - `NetFareInfo.TicketBasePassenger.decimalAuthority` (string) Assigned Type: c-1100:CodeContext - `NetFareInfo.TicketBasePassenger.bTInd` (boolean) If true, this is a bulk ticket fare - `NetFareInfo.TicketBasePassenger.iTInd` (boolean) If true, this is an inclusive tour fare - `TravelerIdentifierRef` (object) Identifier references as object both within a message payload or an object held in cache that may be used for subsequent workflows. Returned for NDC in the Price response if age was sent for this traveler in the previous workflow requests. - `TravelerIdentifierRef.name` (string) Traveler identifier - `TravelerIdentifierRef.passengerTypeCode` (string) Passenger Type code Example: "ADT" - `TravelerIdentifierRef.ages` (array) The ages of the travelers associated to a particular ptc. For NDC, this value will be returned in PriceBreakdownAir if sent as part of the PassengerCriteria in the Air Search request. Example: [15] - `TravelerIdentifierRef.passengerCriteriaRef` (string) Allows the user to associate passenger criteria information. Example: "passengerCriteria_1" - `TravelerIdentifierRef.value` (string) - `TravelerIdentifierRef.id` (string) A locally referenced ID - `TravelerIdentifierRef.description` (string) Descriptive text used to identify the contents of a target object - `TravelerIdentifierRef.uris` (array) Uniform Resource Identifier Example: ["google.com"] - `TravelerIdentifierRef.age` (integer) Replaced with ages array. The age of the traveler. Example: 11 - `NetBaseAmount` (object) Returned only in the Price APIs. GDS only; not supported for NDC. The base amount of a ticket price or net price that is filed in local currency. Returned when the origin currency is not the same as the PCC currency to show the currency in which the base fare has been filed. When used for NetBaseAmount: Net ticket data (NTD) is returned in the AirPrice, AirReservation, Exchange Search, and Reservation Retrieve responses for any GDS fare that has a private fare component (fareType=AgencyPrivateFare). When NTD is returned, TermsAndConditionsFuill includes FareGuaranteePolicy to return the fare calculation indicator for the fare. When NTD is returned, PriceBreakdown may include NetBaseAmount. - `FareCalculation` (string) GDS only; not supported for NDC. For each PTC, when available, FareCalculation returns the fare calculation ladder for all public and private fare types filed by an agency or an airline. Example: "LON BA SYD R564.00YEE1Y BA LON R564.00YEE1Y NUC1128.00END ROE0.787855" - `Surcharges` (object) In AirSearch workflow this applies to GDS only. Not supported for NDC, which does not return surcharges. Returned if surcharges apply to this offer. For GDS only, for a multi-city offer with stopovers (see multi-city offers with stopovers for details), surcharges and commission amounts are for the entire journey. For all other offers, the surcharges and commission amounts are for each leg (origin and destination pair). A multi-city offer can be identified by the jc in its CombinabilityCode: jc1, jc2. Surcharges can be omitted from the Search response with excludeSurchargesInd. - `Surcharge` (array, required) - `Surcharge.value` (number) Surcharge amount Example: 12 - `Surcharge.currencyCode` (string) ISO 4217 currency code for the surcharge. Example: "USD" - `Surcharge.surchargeCode` (string) Surcharge code Example: "ADDITIONAL COSTS" - `Surcharge.reportingAuthority` (string) Not used. Surcharge reporting authority Example: "Federal register" - `Surcharge.purpose` (string) Surcharge purpose. For Air workflows possible values include Weekend Surcharge, Stopover Charge, Multiple Stopover Charges, Other (default value that covers all other surcharges such as fuel surcharges). Example: "Weekend Surcharge" - `Surcharge.description` (string) Description of the surcharge. Example: "Rollaway Surcharge" - `Surcharge.surchargeApplication` (string) Application values (such as the application of a fee) like per person or per room. Enum: same as `Surcharge.surchargeApplication` (7 values) - `Surcharge.surchargeFrequency` (string) The frequency of a fee such as per night or per stay. Enum: same as `Surcharge.surchargeFrequency` (6 values) - `Surcharge.codeAuthority` (string) Not used. Currency code authority. Example: "ISO 4217" - `Surcharge.decimalPlace` (integer) Decimal place for the currency unit. Example: 4 - `Surcharge.decimalAuthority` (string) Not used. Currency code decimal authority. Example: "ISO 4217" - `Surcharges.@type` (string, required) Discriminator class is SurchargesDetail Example: "SurchargesDetail" - `Surcharges.TotalSurcharges` (number) A monetary amount, up to 4 decimal places. Example: 211.11 - `Surcharges.approximateInd` (boolean) If true, the surcharge amounts are approximate. - `TravelerRefs` (array) Returned only in Reservation Retrieve to identify the traveler associated with this instance of PriceBreakdown in case of multiple offers on the booking. Example: ["[\"traveler_1\",\"traveler2\"]"] - `PaidTaxes` (object) Summary Taxes object - `Tax` (array) - `Tax.value` (number) Amount of the tax. Returned as 0 if a tax was marked as exempt with TaxExemption. Example: 12.2 - `Tax.currencyCode` (string) A ISO 4217 currency code associated to the value. Example: "USD" - `Tax.taxCode` (string) "Code for the tax. For Hotels this is the OTA code." Example: "XF2" - `Tax.reportingAuthority` (string) Identifies the reporting authority such as airport code for XF taxes Example: "JFK1" - `Tax.purpose` (string) Supplier returned description of tax. Example: "Fuel surcharge" - `Tax.description` (string) "Short summary of the tax. In Air workflows this is returned only for NDC. Note that descriptions are not returned for tax codes YQ and YR, which are fees charged by airlines and not government-imposed taxes. For Hotels this is the OTA tax description." Example: "Lodging tax" - `Tax.includedInBase` (string) Yes , No , Unknown Enum: same as `instantPurchase` in "AdvanceReservationRequired" (3 values) - `Tax.codeAuthority` (string) Not used. Currency Code Authority Example: "ISO" - `Tax.decimalPlace` (integer) Permitted number of decimals. Associated to the currency value. Example: 2 - `Tax.decimalAuthority` (string) Not used. Currency decimal authority Example: "ISO" - `Tax.exemptInd` (boolean) GDS only; not supported for NDC. Returned if a tax was marked exempt in a prior request with the TaxExemption pricing modifer. If true, this tax is exempt" Example: true - `Tax.nonRefundableInd` (boolean) If true, the tax is non refundable. This indicator is only supported for exchange search and exchange price quote transactions. Example: true - `Tax.excludedFromTotalPriceInd` (boolean) Returned in Hotel APIs when a tax is not included in the TotalPrice. Default behavior is for taxes to be included in TotalPrice. Example: true - `TaxPercent` (object) Returned when the tax is expressed as a percentage of the amount. - `TaxPercent.value` (number) The tax percentage amount. Example: 5.5 - `TaxPercent.taxCode` (string) Any code for the tax. Example: "971 - IRS Notice" - `TaxPercent.reportingAuthority` (string) Tax reporting authority Example: "Georgia Department of Revenue" - `TaxPercent.purpose` (string) Purpose of tax Example: "statutory tax" - `TaxPercent.description` (string) Description Example: "1.5% of SGST" - `TaxPercent.includedInBase` (string) Yes , No , Unknown Enum: same as `instantPurchase` in "AdvanceReservationRequired" (3 values) - `PaidTaxes.@type` (string, required) Discriminator classes PaidTaxes or PaidTaxesDetail Example: "PaidTaxesDetail" - `PaidTaxes.TotalTaxes` (number) A monetary amount, up to 4 decimal places. Decimal place needs to be included. Example: 220.12 - `RequestedPricingModifiers` (array) - `RequestedPricingModifiers.@type` (string, required) Discriminator. Example: "RequestedPricingModifiers" - `RequestedPricingModifiers.PassengerCriteria` (object) Defines the passenger criteria. Send one PassengerCriteria for each passenger type code (PTC). Search supports up to 9 total passengers. A maximum of 6 PTCs are supported for GDS. NDC does not have a PTC limitation. AirPrice supports up to nine total passengers across all PTCs. - `TravelerIdentifierRef` (object, required) Identifier references as object both within a message payload or an object held in cache that may be used for subsequent workflows. Returned for NDC in the Price response if age was sent for this traveler in the previous workflow requests. - `RequestedPricingModifiers.PassengerCriteria.@type` (string, required) Discriminator. No child classes. Example: "PassengerCriteria" - `RequestedPricingModifiers.PassengerCriteria.number` (integer, required) The amount of passengers associated with this passenger type code. Default is 1. Example: 1 - `RequestedPricingModifiers.PassengerCriteria.age` (integer) The age of the passenger. Notes on PTC and age: - Travelport recommends sending age only with PTCs that require age for pricing. - If the age is sent in the request, for NDC only, the age is returned in the pricing response. - For child passengers, Travelport recommends sending the age of the child in the age attribute plus the PTC CNN. Travelport recommends against sending CNN without age, or the CHD PTC. Not all fares cannot be quoted for CHD. - The age for CNN is generally between 2 and 11 inclusive, with ADT fares returned for ages 12 and up; however, this can vary by airline and country. - The age for INF must be either 0 or 1. - During booking, date of birth is required for all child and infant PTCs (Add Traveler payload in Traveler/birthDate). Example: 26 - `RequestedPricingModifiers.PassengerCriteria.passengerTypeCode` (string) The passenger type code (PTC) for the passengers on the itinerary. Required field for Air Search and Flight specific search. Common PTCs are: - ADT: adult - CHD: child of unknown age - For child passengers, Travelport recommends sending the age of the child in the age attribute plus the PTC CNN. Travelport recommends against sending CNN without age, or the CHD PTC. Many fares cannot be quoted for CHD. - CNN: child when age is known - The age for CNN is generally between 2 and 11 inclusive, with ADT fares returned for ages 12 and up; however, this can vary by airline and country. - INF: infant without a seat - INS: infant with a seat - UNN: unaccompanied child. See API guides to download a full list of PTCs. NDC carriers BA, SQ, AV, AA, and AF/KLM offer teen/young adult tax exemptions from the UK Air Passenger Duty (GB tax). Send PTC with the value YTH and send the passengers age per below. The PTC may be returned as ADT, or Cxx in which xx is the age, but the tax exemption is applied in the pricing on these NDC carriers. For marine fares, send the PTC value SEA. You must also send OSI remarks at Add Traveler with the vessel name and location. Marine fares are private fares for travelers going to or from a vessel. NDC only; not supported for GDS. When running a multiple passenger search for NDC on Qantas, Qantas supports only these PTCs: ADT, CHD, CNN, INF. Sending any other PTC may result in an error at ticketing. Any traveler sent without a PTC value is defaulted to ADT. PTC can be sent or omitted for ADT passenger. AirReservation defaults the PTC to ADT and returns it in the Reservation Retrieve. Example: "ADT" - `RequestedPricingModifiers.PassengerCriteria.birthDate` (string) The date of birth of the passenger. May be used in age validation for fares with age restrictions. Example: "2020-01-16" - `RequestedPricingModifiers.PassengerCriteria.id` (string) Unique id to support referencing of this specific passenger criteria. Example: "passengercriteria_001" - `RequestedPricingModifiers.PassengerCriteria.CustomerLoyalty` (array) NDC only; not supported for GDS. Optional object for sending customer loyalty information, such as for a frequent flyer program. If CustomerLoyalty is sent in the Search request, it must also be sent in the Air Price request and the Add Traveler request. As some carriers validate frequent traveler data through the workflow, failing to send the same CustomerLoyalty details, even if invalid, may cause a booking failure. If an invalid number is sent, the response returns a warning message that the FQTV is invalid, and the invalid number is cached to prevent a potential booking failure. - `RequestedPricingModifiers.PassengerCriteria.TravelerGeographicLocation` (object) For AirSearch: supported/validated only for NDC to support local citizen fares. For AirPrice and AirReservation: GDS only; not supported for NDC. Optional object for requesting local citizen/local resident fares for Spain and associated islands. You must also send a PTC relevant to the local resident fares; e.g., ADR for adult resident, CHR for child resident. Any discount applied through TravelerGeographicLocation applies to all travelers, not only to the traveler in this instance of PassengerCriteria. If the discount must apply only to an individual traveler, that traveler requires a separate search and book workflow. - `RequestedPricingModifiers.PassengerCriteria.specifiedPassengerTypeCodeOnlyInd` (boolean) GDS only; not supported for NDC. - If true: returns only offers for the specified PTC. If no fares are available for the specified PTC, returns an error message that there is no valid fare. - If false (default behavior): If no fares are available for the specified PTC, returns fares for the default ADT (adult) PTC instead. Example: true - `RequestedPricingModifiers.PricingModifiersAir` (object) A selection of Pricing Modifiers that can be used to influence the Price of an Offer. - For the AirPrice reference payload request, if any price modifiers were included in the preceding Search request and no price modifiers are sent in the AirPrice request, the cached price modifiers sent at Search are sent with the AirPrice request. If any price modifiers are sent in the AirPrice reference payload request, all cached Search modifiers are discarded and only the modifiers sent in that AirPrice request are used. - For the Add Offer request, you may optionally store fares with one or more pricing modifiers. If a pricing modifier is not added, the auto stored fare is added to the reservation. There is no change in the AirReservation response when pricing modifiers are requested. AirReservation applies modifiers from Add Offer and earlier steps as follows: - Modifiers sent in the Add Offer request (supported for both full and reference payload). - If no modifiers are sent in Add Offer, any pricing modifiers sent in AirPrice are applied. - If no modifiers were sent in AirPrice, or if AirPrice was not sent, any pricing modifiers sent in Search are applied. GDS only; pricing modifiers not supported for NDC. If the requested modifier does not have any fares associated with it, the workbench commit fails and returns the error message 'No Fare Found'. Pricing happens at commit, not at Add Offer. - `Brand` (object) Information on airline Brand offerings. If brand attributes were not excluded with inhibitBrandContentInd=true (GDS only), then brand attributes are returned and consolidated in ReferenceList/ReferenceListBrand. In this case Brand does not return the name or Identifier objects but instead returns only BrandRef, which matches to the brand identifier (e.g., b1) in ReferenceListBrand. - `RequestedPricingModifiers.PricingModifiersAir.@type` (string, required) Discriminator. Child classes PricingModifiersAir and PricingModifersAirDetail Example: "PricingModifiersAir" - `RequestedPricingModifiers.PricingModifiersAir.currencyCode` (string) In an API request, send the currency type to return if you want to override the default currency specified with your PCC. Example: "GBP" - `RequestedPricingModifiers.PricingModifiersAir.FareSelection` (object) Requests the return of fare types including private fares (negotiated), public fares (published), or net fares (consolidator fares, or any negotiated wholesale price that is further marked up for sale to customers). May be used to request fares with specific restrictions, change, or refund options. - `RequestedPricingModifiers.PricingModifiersAir.OrganizationInformation` (object) Use to send account codes for negotiated fares or to send optional India GST SSR Remarks in GSTRegistrationNumber. For NDC supports corporate loyalty program and GST Information. This information is returned in TermsAndConditions." - `RequestedPricingModifiers.PricingModifiersAir.TaxExemption` (object) GDS only, not supported for NDC. Use to mark some or all taxes as exempt. Specify all taxes, only specific tax codes, or all taxes in specific countries. Must include either allTaxesExemptInd OR both countries and taxCodes. TaxExemption supports up to nine values for countries, taxCodes, or both combined. The response returns any exempt taxes with exemptInd=true and value=0. - `RequestedPricingModifiers.PricingModifiersAir.PromotionalCode` (array) - `RequestedPricingModifiers.PricingModifiersAir.SellCity` (string) GDS only, not supported for NDC. The IATA location code for a city. Overrides the sell city of the requester to specify an alternate sale location and return fares based on that location. The response returns pricing in the local currency for the specified sell city instead of the PCC's default currency. Example: "NYC" - `RequestedPricingModifiers.PricingModifiersAir.TicketCity` (string) GDS only, not supported for NDC. The IATA location code for a city. Overrides the ticketing city of the requester to specify an alternate ticket location and return fares based on that location; the response returns pricing in the local currency for the specified ticket city instead of the PCC's default currency. Example: "NYC" - `RequestedPricingModifiers.PricingModifiersAir.PricingPCC` (string) GDS only, not supported for NDC. Use to send a faring PCC for which a selective access or code group agreement exists between that PCC and the PCC associated with your account. The following combinations of PricingPCC and FareSelection/fareType=PrivateFaresOnly return results as follows: - PricingPCC sent and PrivateFaresOnly not requested: If a selective access or group agreement exists, both public and any available private fares are returned for the requesting and providing PCC. - If no selective access or group agreement exists, only public fares are returned. - PricingPCC sent and PrivateFaresOnly is requested: If a selective access or group agreement exists that allows private fare access, only available private fares are returned for the requesting and providing PCC. - If no agreement exists, or if an agreement exists but does not allow private fares access, an error is returned. Example: "0Bx3" - `RequestedPricingModifiers.PricingModifiersAir.FareBasisCodeOverride` (array) - `RequestedPricingModifiers.PricingModifiersAir.MultiPricingAgency` (array) The customer can send up to 3 Pseudo City Codes (PCCs) in PricingModifiersAir, MultiPricingAgency. If a customer sends more than 3 PCCs in MultiPricingAgency, only the first 3 are validated. If a customer sends both PricingPCC and MultiPricingAgency with PCCs, the PCC in PricingPCC is ignored. Example: ["[\"0XS4\",\"0YBZ\",\"J80K\"]"] - `RequestedPricingModifiers.PricingModifiersAir.TicketingPCC` (string) GDS only, not supported for NDC. In an API request, overrides the ticketing PCC associated with your account to specify an alternate PCC and return fares based on that PCC. Example: "0XS4" - `RequestedPricingModifiers.PricingModifiersAir.CalculatedFareAdjustment` (object) Used in Exchange Search to modify the Price of the Fare. Discriminator classes CalculatedFareAdjustmentDiscount or CalculatedFareAdjustmentIncrease - `RequestedPricingModifiers.PricingModifiersAir.ManualFareAdjustment` (array) Send to manually adjust the base fare amount on all fares for a specific PTC. - `RequestedPricingModifiers.PricingModifiersAir.BrandPreference` (array) - `RequestedPricingModifiers.PricingModifiersAir.includeSplitPaymentInd` (boolean) Requests request split ticketing, which returns outbound and inbound one-way fares in addition to round trip options in the Search API response. This may result in lower fares than the same or similar round-trip itinerary. If true, requests split ticketing. If false or omitted split ticketing options are not returned. Default is false. GDS only, not supported for NDC. When split ticketing is requested, the Search response returns offers in the following order: Outbound one-way offers, Inbound one-way offers, Round trip offers. The response identifies all one-way outbound and inbound offers with CombinabilityCode j0. CombinabilityCode values for round trip offers start at j1 and increment by one for each offer. Only the following are in scope for split ticketing: Search (not supported for Next Leg Search or Flight Specific Search), Round-trip journey-based offerings ( isJourney header not sent or sent as true, or CustomResponseModifiersAir/SearchRepresentation not sent or sent with value Journey ) Upsells. Split ticketing is not supported for round-trip leg-based searches, virtual interlining, or NDC. Split ticketing is available only for customers specifically provisioned for split ticketing. Split ticketing returns one-way outbound and one-way inbound fares in addition to round-trip offers. Split ticket offers are identified with CombinabilityCode j0. If your account is not configured for split ticketing, sending includeSplitPaymentInd returns a response without split ticket offers and a warning message. GDS only, not supported for NDC. In Air Price, For split ticketing, the request must send offers that are identified in the Search response with CombinabilityCode j0, which identifies those offers as one-way outbound and one-way inbound split ticketing offers. A combination of j0 and any non-j0 value offer returns an error message that split pricing is not supported - `RequestedPricingModifiers.PricingModifiersAir.returnMostRestrictiveBrandInd` (boolean) In Search API, when there are different brands on a connecting flight, return information for either the most restrictive brand or the brand on the most significant segment on the itinerary. If true, return the offer brand of the most restrictive brand. If false or omitted, return the offer brand of the most significant segment of the itinerary. GDS only, not supported for NDC. - `RequestedPricingModifiers.PricingModifiersAir.splitPaymentOfferings` (number) Number between 0 and 99. Send with includeSplitPaymentInd to configure the percentage of round trip offers to return in a split ticketing response. By default, Search divides the split ticketing response into 34% round-trip offerings and the remainder as split ticketing offers, which are combined outbound and inbound one-way fares. To change this percentage, send SplitPaymentOfferings with the percentage value of round trip offers to return. Example: 25 - `RequestedPricingModifiers.CabinPreference` (object) Requests a fare based on the cabin class. Only one cabin preferenceType (Permitted, Preferred, PreferredWithUpgrade) is allowed per request, but there is no limit to the number of cabins that can be sent. Any CabinPreference in the initial Search request is applied to any subsequent Next Leg Search and reference Flight Specific Search requests. In AirPrice and AirReservation only one cabin preference type is allowed per request, but there is no limit to the number of cabins that can be sent. If CabinPreference was sent in the Search request, it is cached and sent with the AirPrice reference payload request. If you send CabinPreference in the AirPrice request, all cached modifiers are discarded and only the modifiers sent in the AirPrice request are used. Can be combined with lowFareFinderInd=true to return lowest fare in the requested cabin or cabins. When using CabinPreference and lowFareFinderInd, if both CabinPreference and a class of service are sent, class of service is ignored. If CabinPreference is sent without a class of service, the response returns the lowest fare in the cabin requested. If that cabin is not available, the response may upgrade or downgrade to a different cabin. If a different cabin than requested is returned, the response returns the message that the cabin class may differ from the class requested. If lowFareFinderInd=false and CabinPreference are sent in the request, AirPrice ignores the preferred cabin and returns a message that the preferred cabin was ignored. If CabinPreference is set to All, no cabin preference is applied." - `RequestedPricingModifiers.CabinPreference.@type` (string, required) Discriminator. No child classes exist Example: "CabinPreference" - `RequestedPricingModifiers.CabinPreference.preferenceType` (string) Type of cabin preference. Sending a mix of preferenceType values is not supported. For example, you cannot send an instance of CabinPreference with a preferenceType of Permitted and another instance with preferenceType of Prohibited. In this case the results default to the Preferred preference. Note that if lowFareFinderInd is sent with true and CabinPreference is sent, the only supported value for CabinPreference/type is Permitted. Enum: same as `RequestedPricingModifiers.CabinPreference.preferenceType` in "PriceBreakdownAir" (4 values) - `RequestedPricingModifiers.CabinPreference.cabins` (array) A space-delimited list of cabins. Enum: same as `PassengerFlight.FlightProduct.cabin` in "ProductAir" (5 values) - `RequestedPricingModifiers.CabinPreference.legSequence` (array) Limits preference to the specified leg referenced in SearchCriteriaFlight. You can apply the preference to only some legs of the itinerary, or different preferences to different legs. To apply preference to the entire itinerary, do not send legSequence. GDS only, not supported for NDC. Not supported at Price or Book. Example: [1,2] - `RequestedPricingModifiers.FlightType` (object) The type of flight connection - `RequestedPricingModifiers.FlightType.@type` (string, required) Discriminator. No child classes. Example: "FlightType" - `RequestedPricingModifiers.FlightType.connectionType` (string) Limits the connection type returned. Each value returns the specified type and all higher types. For example, StopDirect could return both flights that stop without a change of planes (StopDirect) and non-stop direct flights (NonStopDirect). SingleConnection or DoubleConnection will not exclude StopDirect flights from the journey. For example, SingleConnection could return an itinerary with two flight numbers, and either of these flights could have intermediate stops. Enum: same as `RequestedPricingModifiers.FlightType.connectionType` in "PriceBreakdownAir" (5 values) - `RequestedPricingModifiers.FlightType.excludeInterlineConnectionsInd` (boolean) Excludes interline connectionsClosed from results. If true, does not return offers with interline connections. If false or omitted, may return interline connections in results. Default is false. GDS only, not supported for NDC. When a product contains multiple interline air segments, brand details return only the brand of the significant carrier, not the validating/plating carrier brand information. The IATA rules for determining the significant carrier on an itinerary are based on the areas in which the transportation takes place. Example: true - `RequestedPricingModifiers.CustomResponseModifiersAir` (object) Contains additional modifiers to customize the result set. Includes optional indicators for returning or excluding specified response content. Values sent at Search can carry forward into the Next Leg Search request and are not re-sent. - `RequestedPricingModifiers.CustomResponseModifiersAir.@type` (string, required) discriminator Example: "CustomResponseModifiersAir" - `RequestedPricingModifiers.CustomResponseModifiersAir.BrandAttributeInclusion` (array) Supported in AirSearch and AirPrice. Returns only information about the brand attributes specified and does not return any other brand attributes. - `RequestedPricingModifiers.CustomResponseModifiersAir.SearchRepresentation` (string) Specifies either a journey or leg-based response. Journey returns offers for all legs of the itinerary. Journey is the default. Leg returns offers for only the first leg of the itinerary. Must be followed with a Next Leg Search to select an offer for the first leg and return offers on the subsequent leg to combine with it.Customize search result set as leg or journey based. Next Leg Search requests, and Flight Specific Search requests for less than the full itinerary, are supported only after a leg-based Search, not a journey-based Search. If these requests follow a journey-based Search request, an error message is returned. Enum: same as `RequestedPricingModifiers.CustomResponseModifiersAir.SearchRepresentation` in "PriceBreakdownAir" (3 values) - `RequestedPricingModifiers.CustomResponseModifiersAir.excludePenaltiesInd` (boolean) GDS only; not supported for NDC. Indicator to omit change and cancel penalties. - If true: omits all penalty information from the response. - If false (default behavior): returns any change and penalty details provided by carrier for each offer in TermsAndConditionsFullAir/Penalties. If sent in Search but not in AirPrice, the value sent in Search is cached and applied to the AirPrice results. However, you can override the value sent in Search by sending excludePenaltiesInd in the AirPrice request with the opposite value. For example, if the Search request sends excludePenaltiesInd=true and the AirPrice request sends excludePenaltiesInd=false, the Search response does not return penalties and the AirPrice response does return penalties. Example: true - `RequestedPricingModifiers.CustomResponseModifiersAir.excludeBaggageFeesInd` (boolean) GDS only; not supported for NDC. Indicator to exclude baggage details. - If true: excludes baggage fees, carry on fees, and embargo information from the response. Baggage quantity or weight is returned instead. - If false (default behavior): baggage details returned in response. Default is false. Example: true - `RequestedPricingModifiers.CustomResponseModifiersAir.includeFareCalculationInd` (boolean) GDS only; not supported for NDC or in the Flight Specific Search full payload request. Indicator to request the return of the fare calculation ladder. - If true: returns the fare calculation ladder in BestCombinablePrice.PriceBreakdownAir.FareCalculation. - If false (default behavior): fare calculation ladder is not returned. Example: true - `RequestedPricingModifiers.CustomResponseModifiersAir.excludeSurchargesInd` (boolean) GDS only; not supported for NDC. Indicator to exclude a surcharge breakdown. - If true: excludes a surcharge breakdown from the response. Baggage quantity or kilos is returned instead. - If false (default behavior): surcharge breakdown returned in response. Example: true - `RequestedPricingModifiers.CustomResponseModifiersAir.excludeUnbundledFaresInd` (boolean) GDS only, not supported for NDC. Sets whether to return unbundled fares. Supported in AirSearch and AirPrice. - If true: does not return unbundled fares. - If false (default behavior): returns unbundled and bundled fares as available. Example: true - `RequestedPricingModifiers.CustomResponseModifiersAir.includeCO2EmissionsDataInd` (boolean) Indicator to return CO2 emission data in the Search and Next Leg Search responses. - If true: returns CO2 emission data. - If false (default behavior): CO2 emission data not returned. Example: true - `RequestedPricingModifiers.CustomResponseModifiersAir.includeFlightAmenitiesInd` (boolean) Indicator to return flight amenities from ATPCO RouteHappy data. - If true: includes amenities in the response if available. - If false: Does not return ATPCO RouteHappy amenities. Example: true - `RequestedPricingModifiers.CustomResponseModifiersAir.includeUniversalProductAttributesInd` (boolean) Indicator to return universal product attributes (UPAs), which include images, icons, and URLs as provided by ATPCO. Must also send includeFlightAmenitiesInd=true. - If true: returns universal product attributes if available. - If false (default behavior): Universal product attributes not returned. UPAs are not returned for direct flights with intermediate stops, non-flight segments such as trains, or for Premium Business class. Example: true - `RequestedPricingModifiers.CustomResponseModifiersAir.includeBundledAncillariesInd` (boolean) NDC only. If true: the search and price response will include bundled air and ancillary offerings/offers. Search and Price response will contain both ProductAir and ProductAncillary plus a new child class of PriceBreakdown: PriceBreakdownAncillaryAir to define the ancillary inclusion and pricing. Example: true - `RequestedPricingModifiers.CustomResponseModifiersAir.includeFullPenaltyDisclosureInd` (boolean) If true, penalty information sourced from ATPCO Cat 31 and 33 will be disclosed. Penalties may be exposed at fare component level and include time windows. - `RequestedPricingModifiers.PricingModifiersAirChange` (object) Pricing Modifiers that can be used to influence the Price of an Exchanged Offer - `RequestedPricingModifiers.PricingModifiersAirChange.@type` (string) Example: "PricingModifiersAirChange" - `RequestedPricingModifiers.PricingModifiersAirChange.currencyCode` (string) ISO 4217 currency code Example: "USD" - `RequestedPricingModifiers.PricingModifiersAirChange.FareSelection` (object) Requests the return of fare types including private fares (negotiated), public fares (published), or net fares (consolidator fares, or any negotiated wholesale price that is further marked up for sale to customers). May be used to request fares with specific restrictions, change, or refund options. - `RequestedPricingModifiers.PricingModifiersAirChange.OrganizationInformation` (object) Use to send account codes for negotiated fares or to send optional India GST SSR Remarks in GSTRegistrationNumber. For NDC supports corporate loyalty program and GST Information. This information is returned in TermsAndConditions." - `RequestedPricingModifiers.PricingModifiersAirChange.WaiverCode` (object) A code assigned by an airline to support waiver of fees or ticket value as a result of disruption to the passenger. - `RequestedPricingModifiers.PricingModifiersAirChange.TaxExemption` (object) GDS only, not supported for NDC. Use to mark some or all taxes as exempt. Specify all taxes, only specific tax codes, or all taxes in specific countries. Must include either allTaxesExemptInd OR both countries and taxCodes. TaxExemption supports up to nine values for countries, taxCodes, or both combined. The response returns any exempt taxes with exemptInd=true and value=0. - `RequestedPricingModifiers.PricingModifiersAirChange.PromotionalCode` (object) NDC only. Not supported for GDS. Any NDC airline designated promotional code. - `RequestedPricingModifiers.PricingModifiersAirChange.SellCity` (string) Overrides the sell city of the requestor Example: "MEX" - `RequestedPricingModifiers.PricingModifiersAirChange.TicketCity` (string) Overrides the ticket city of the requestor Example: "MEX" - `RequestedPricingModifiers.PricingModifiersAirChange.PricingPCC` (string) Overrides the pricing PCC of the requestor Example: "0XS4" - `RequestedPricingModifiers.PricingModifiersAirChange.TicketingPCC` (string) Overrides the ticketing PCC of the requestor Example: "0XCD" - `RequestedPricingModifiers.PricingModifiersAirChange.CalculatedFareAdjustment` (object) Used in Exchange Search to modify the Price of the Fare. Discriminator classes CalculatedFareAdjustmentDiscount or CalculatedFareAdjustmentIncrease - `RequestedPricingModifiers.PricingModifiersAirChange.BrandPreference` (array) - `RequestedPricingModifiers.PricingModifiersAirChange.keepToBrandInd` (boolean) If true, the offerings returned will be of the same brand as the original Offer Example: true - `RequestedPricingModifiers.PricingModifiersAirChange.returnMostRestrictiveBrandInd` (boolean) if true, the most restrictive brand will be returned in the response when there are different brands present in the Offering Example: true - `RequestedPricingModifiers.PricingModifiersAirChange.doNotNetInd` (boolean) If true, this exchange will not net any residual/refundable amounts against due amounts. - `RequestedPricingModifiers.lowFareFinderInd` (boolean) Provides pricing flexibility around class of service. If not sent, the response returns fares only in the requested class of service. If true, returns the lowest fares available in any class of service available, which may not be the same as the requested class. Note that if lowFareFinderInd is sent with true and CabinPreference is sent, the only supported value for CabinPreference/type is Permitted. When lowFareFindInd=true and brand attributes are not disabled (inhibitBrandContentInd), AirPrice uses only the brand tier (and any other pricing modifiers) to find the lowest fare within a brand tier regardless of class of service. GDS only; not supported for NDC. Example: true - `RequestedPricingModifiers.keepToBrandInd` (boolean) If true, the original brand will be maintained during the exchange process. Example: true - `RequestedPricingModifiers.lowFareFindAndRebookInd` (boolean) If true, the original flights in the reservation will be rebooked or replaced with the new exchanged flights. - `PassengerCriteriaRefs` (array) NDC only; not supported for GDS. Returned for NDC if a traveler identifier was sent for this traveler in the previous workflow requests. Example: ["passengerCriteria_1"] - `FlightPassCredits` (integer) The number of flight pass credits consumed for this pricebreakdown. Example: 1 - PriceBreakdownAncillary: - `inclusiveOfTaxInd` (boolean) If true, this ancillary is sold inclusive of tax. Example: true - `quantity` (integer) The quantity of ancillary items included in this PriceBreakdown. Example: 1 - `Description` (object) A description of the ancillary with description codes. - `Description.value` (string) The text description of the ancillary. Example: "Vegetarian Meal" - `Description.code` (string) The ATPCO group code. Example: "BG" - `Description.subCode` (string) The ATPCO RFISC subcode. Example: "0D4" - `Description.subGroup` (string) The ATPCO sub group code. Example: "SP" - `Description.codeContext` (string) The code context value. Example: "ATPCO" - `Description.ssrCode` (string) The four character AIRIMP SSR code for this ancillary. Example: "VGML" - `Description.issuanceReasonCode` (string) The airline provided reason for issuance code. Example: "C" - `Description.geographicSpecification` (string) How the ancillary is applied across the itinerary. Enum: same as `Ancillary.Description.geographicSpecification` in "ProductAncillary" (3 values) - `ProductRef` (string) The product ref this PriceBreakdown applies to. If no productRef exists then the PriceBreakdown applies to all Products within the Offer. Example: "p_1" - `Discount` (object) NDC only; not supported for GDS. Returned for a fare discounted from the published price, such as a promotional discount. Not returned for privately negotiated discounts such as private fares. - `Discount.value` (number) The amount value of the discount Example: 20.22 - `Discount.description` (string) The text description for the discount. Example: "Spring discount on group bookings" - `Discount.currencyCode` (string, required) Currency code discount is returned in. Example: "USD" - `Discount.codeAuthority` (string, required) Not used. Currency code Authority. Example: "ISO" - `Discount.decimalPlace` (integer, required) Number of decimal places in the currency the discount is returned in. Example: 2 - `Discount.decimalAuthority` (string) Not used. Decimal Authority. Example: "ISO" - `TravelerIdentifierRef` (object) Identifier references as object both within a message payload or an object held in cache that may be used for subsequent workflows. Returned for NDC in the Price response if age was sent for this traveler in the previous workflow requests. - `TravelerIdentifierRef.name` (string) Traveler identifier - `TravelerIdentifierRef.passengerTypeCode` (string) Passenger Type code Example: "ADT" - `TravelerIdentifierRef.ages` (array) The ages of the travelers associated to a particular ptc. For NDC, this value will be returned in PriceBreakdownAir if sent as part of the PassengerCriteria in the Air Search request. Example: [15] - `TravelerIdentifierRef.passengerCriteriaRef` (string) Allows the user to associate passenger criteria information. Example: "passengerCriteria_1" - `TravelerIdentifierRef.value` (string) - `TravelerIdentifierRef.id` (string) A locally referenced ID - `TravelerIdentifierRef.description` (string) Descriptive text used to identify the contents of a target object - `TravelerIdentifierRef.uris` (array) Uniform Resource Identifier Example: ["google.com"] - `TravelerIdentifierRef.age` (integer) Replaced with ages array. The age of the traveler. Example: 11 - `AncillaryPriceApplicationCode` (object) Determines how an ancillary price has been built. - `AncillaryPriceApplicationCode.value` (string) Example: "3" - `AncillaryPriceApplicationCode.application` (string) Associated text. Example: "PerItem" - PriceBreakdownHospitality: - `roomPricingType` (string) A string provided by the hotel to describe how a service is priced, such as per night or per stay. Enum: same as `roomPricingType` in "PriceBreakdownHospitality" (5 values) - `Description` (string) Example: "Advance Purchase-Ro-Free WiFi" - `NightlyRate` (array) - `NightlyRate.@type` (string) - `NightlyRate.startDate` (string, required) Start date for the nightly rate in YYYY-MM-DD format. - `NightlyRate.nights` (integer) Number of nights the nightly rate is valid. - `NightlyRate.Amount` (object, required) Amount represents the cost applied - `AverageNightlyRate` (array) The average nightly rate for a given offer. - `AverageNightlyRate.value` (number) The amount of a given currency. Example: 124.56 - `AverageNightlyRate.code` (string) An ISO 4217 alpha character code (3 characters) that specifies a money unit. Example: "USD" - `AverageNightlyRate.minorUnit` (integer) Minor units are a mechanism for expressing the relationship between a major currency unit and its corresponding minor currency unit. It is the smallest unit of a given currency. For example; the smallest denomination in USD is the cent, which is 1/100 of a USD, and the minor unit value is 2. Not all currencies have a minor unit. Example: 2 - `AverageNightlyRate.currencySource` (string) The system requesting or returning the currency code specified in the attribute Enum: same as `MinimumAdcolAmount.currencySource` in "ChangePermitted" (3 values) - `AverageNightlyRate.approximateInd` (boolean) "If true, the currency amount has been converted from the original amount. For Air Exchange Eligibility, returned only if a currency is converted. If returned, the value is always true, indicating that the fee is approximate because of currency conversion. For Hotel Availability and Rules, true indicates this is a calculated value; false indicates this is the value returned by the property." Example: true - `AmenitySurcharges` (object) Amenity Surcharges information. - `AmenitySurcharges.@type` (string, required) Discriminator classes AmenitySurcharges or AmenitySurchargesDetail Example: "AmenitySurchargesDetail" - `AmenitySurcharges.TotalSurcharges` (number) A monetary amount, up to 4 decimal places. Decimal place needs to be included. Example: 211.11 - `AmenitySurcharges.approximateInd` (boolean) if true, the surcharge amounts are approximate - `AmenitySurcharges.Surcharge` (array, required) - `AmenitySurcharges.Surcharge.value` (number) Surcharge amount Example: 12 - `AmenitySurcharges.Surcharge.currencyCode` (string) ISO 4217 currency code for the surcharge. Example: "USD" - `AmenitySurcharges.Surcharge.surchargeCode` (string) Surcharge code Example: "ADDITIONAL COSTS" - `AmenitySurcharges.Surcharge.reportingAuthority` (string) Not used. Surcharge reporting authority Example: "Federal register" - `AmenitySurcharges.Surcharge.purpose` (string) Surcharge purpose. For Air workflows possible values include Weekend Surcharge, Stopover Charge, Multiple Stopover Charges, Other (default value that covers all other surcharges such as fuel surcharges). Example: "Weekend Surcharge" - `AmenitySurcharges.Surcharge.description` (string) Description of the surcharge. Example: "Rollaway Surcharge" - `AmenitySurcharges.Surcharge.surchargeApplication` (string) Application values (such as the application of a fee) like per person or per room. Enum: same as `Surcharge.surchargeApplication` (7 values) - `AmenitySurcharges.Surcharge.surchargeFrequency` (string) The frequency of a fee such as per night or per stay. Enum: same as `Surcharge.surchargeFrequency` (6 values) - `AmenitySurcharges.Surcharge.codeAuthority` (string) Not used. Currency code authority. Example: "ISO 4217" - `AmenitySurcharges.Surcharge.decimalPlace` (integer) Decimal place for the currency unit. Example: 4 - `AmenitySurcharges.Surcharge.decimalAuthority` (string) Not used. Currency code decimal authority. Example: "ISO 4217" - `priceChangesDuringStayInd` (boolean) "If true, indicates the price changes at least once during requested dates. If roomPricingType = Per night, multiple instances of priceChangesDuringStayInd are returned." - `shortRateDescription` (string) A normalized rate description for comparing rates across multiple aggregators. Example: "Flexible Rate" - PriceBreakdownVehiclePrice: - `VehiclePrice` (object, required) Rate summary for rental of the vehicle. - `VehiclePrice.@type` (string, required) Example: "VehiclePrice" - `VehiclePrice.id` (string) Internal ID - `VehiclePrice.rateSource` (string) Assigned Type: c-1100:StringTiny - `VehiclePrice.rateGuaranteedInd` (boolean) Assigned Type: c-1100:OptionalIndicator - `VehiclePrice.ratePeriod` (string) The time period for a rate such as daily, weekly, monthly Enum: same as `VehiclePrice.ratePeriod` in "PriceBreakdownVehiclePrice" (15 values) - `VehiclePrice.RateDistance` (object) Rate for the period defined by the attributes - `VehiclePrice.RateDistance.value` (number) - `VehiclePrice.RateDistance.unlimitedDistanceInd` (boolean) if true unlimited miles is included with the rental - `VehiclePrice.RateDistance.requestedCodeAppliedInd` (boolean) if true, the requested code has been applied - `VehiclePrice.RateDistance.allowance` (integer) The distance allowance permitted with this rate. Use in combination with distanceUnits and ratePeriod - `VehiclePrice.RateDistance.distanceUnits` (string) For Hotels: Optional object to request either miles or kilometers for the search radius from the specified location. If unitOfDistance is not specified, the search defaults to miles for properties in the United States, Myanmar, and Liberia. The search defaults to kilometers in all other countries. Enum: same as `Vehicle.VehicleDateLocation.RentalPickup.GeoLocation.altitudeUnitOfDistance` in "ProductVehicle" (2 values) - `VehiclePrice.RateDistance.ratePeriod` (string) The time period for a rate such as daily, weekly, monthly Enum: same as `VehiclePrice.ratePeriod` in "PriceBreakdownVehiclePrice" (15 values) - `VehiclePrice.RateDescription` (array) - `sequence` (integer) The order of the text block, if there are more than one block. Example: 2 - `description` (string) Text block detail description Example: "description" - `Image` (object) Each instance is one image and its accompanying details, including a link to the image. Key value pairs; not all may be returned. - `Image.value` (string) URL of the image - `Image.dimensionCategory` (string) Deprecated and replaced by imageSize - `Image.width` (integer) Image width Example: 42 - `Image.height` (integer) Image height Example: 43 - `Image.caption` (string) Image caption Example: "Ticket" - `Image.pictureCategory` (integer) deprecated and replaced by pictureOf Example: 5 - `Image.imageSize` (string) A size for the image to return, allowing you to set image quality. Hospitality APIs no longer support thumbnail. Enum: same as `Vehicle.Image.imageSize` in "ProductVehicle" (5 values) - `Image.pictureOf` (string) The image category Enum: same as `Vehicle.Image.pictureOf` in "ProductVehicle" (26 values) - `URL` (string) A URL for this block - `DateCreateModify` (object, required) Time stamp of the creation. - `DateCreateModify.value` (string) Example: "2026-03-04T11:22:00Z" - `DateCreateModify.creatorID` (string) ID of creator. Software system identifier or an employee id Example: "c1234563" - `DateCreateModify.lastModify` (string) Time stamp of last modification. Example: "2026-03-04T11:24:00Z" - `DateCreateModify.lastModifierID` (string) Identifies the last software system or person to modify a record Example: "m346789" - `DateCreateModify.purge` (string) Date an item will be purged from a system of record Example: "2026-03-03" - `VehiclePrice.RateDescription.@type` (string, required) Discriminator classes TextBlock or TextBlockDetail Example: "TextBlockDetail" - `VehiclePrice.RateDescription.title` (string) "The title of the rule or information. For TermsAndConditionsFullHospitality, may include any of the following Rule Types; Promotional Data, Rate Description, Room Rate Data, Rate Text, Guarantee, Cancellation, Deposit, Check in/out, Room detail, Extra charges, Packages, Property, Location, Miscellaneous, Rate Amount, Alternate Rate Amount, Rate Comment, FAX, Phone, Special Information, Information, Room Hold Expiration Time. Not every property returns all of these types. Some properties do not return any title. Only English is supported for these values." Example: "Baggage Details" - `VehiclePrice.RateDescription.id` (string) Internally referenced id Example: "2" - `VehiclePrice.RateDescription.TextFormatted` (array, required) - `VehiclePrice.RateAvailability` (string) Options are available to sell, need to call, or closed Enum: same as `VehiclePrice.RateAvailability` in "PriceBreakdownVehiclePrice" (3 values) - `VehiclePrice.SupplierRate` (object, required) Estimated total amount - Monetary amounts expressed in another currency. - `VehiclePrice.SupplierRate.@type` (string, required) Example: "SupplierRate" - `VehiclePrice.SupplierRate.BaseRate` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.SupplierRate.BaseRate.value` (number) The amount of a given currency. Example: 124.56 - `VehiclePrice.SupplierRate.BaseRate.code` (string) An ISO 4217 alpha character code (3 characters) that specifies a money unit. Example: "USD" - `VehiclePrice.SupplierRate.BaseRate.minorUnit` (integer) Minor units are a mechanism for expressing the relationship between a major currency unit and its corresponding minor currency unit. It is the smallest unit of a given currency. For example; the smallest denomination in USD is the cent, which is 1/100 of a USD, and the minor unit value is 2. Not all currencies have a minor unit. Example: 2 - `VehiclePrice.SupplierRate.BaseRate.currencySource` (string) The system requesting or returning the currency code specified in the attribute Enum: same as `MinimumAdcolAmount.currencySource` in "ChangePermitted" (3 values) - `VehiclePrice.SupplierRate.BaseRate.approximateInd` (boolean) "If true, the currency amount has been converted from the original amount. For Air Exchange Eligibility, returned only if a currency is converted. If returned, the value is always true, indicating that the fee is approximate because of currency conversion. For Hotel Availability and Rules, true indicates this is a calculated value; false indicates this is the value returned by the property." Example: true - `VehiclePrice.SupplierRate.RateForPeriod` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.SupplierRate.DropOffCharge` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.SupplierRate.ExtraMileageCharge` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.SupplierRate.EstimatedTotalAmount` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.ApproximateRate` (object) Estimated total amount - Monetary amounts expressed in another currency. - `VehiclePrice.ApproximateRate.@type` (string, required) Example: "ApproximateRate" - `VehiclePrice.ApproximateRate.BaseRate` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.ApproximateRate.RateForPeriod` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.ApproximateRate.DropOffCharge` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.ApproximateRate.ExtraMileageCharge` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.ApproximateRate.EstimatedTotalAmount` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.CustomerLoyalty` (object) Specifies the ID for the membership program. Object for sending customer loyalty information, such as for a frequent flyer program. For Hotel send the loyalty card number in the value field, followed by programID with the hotel chain code, and supplierType: Hotel. For Air send the loyalty card number in the value field, followed by airline code in "supplier". For cross accrual use the "shareWithSupplier" field to submit to partner airlines. - `VehiclePrice.CustomerLoyalty.value` (string, required) Number on loyalty card. Example: "132456" - `VehiclePrice.CustomerLoyalty.id` (string) Optional Customer Loyalty Id. Not saved Example: "Loyalty_1" - `VehiclePrice.CustomerLoyalty.priority` (integer) Optional Numeric Priority Code Example: 2 - `VehiclePrice.CustomerLoyalty.programId` (string) "Specifies an identifier to indicate the company owner of the loyalty program. Typically two characters. For frequent guest number, the hotel supplier or brand code. For frequent flyer number, the air supplier code of the loyalty program." Example: "HY" - `VehiclePrice.CustomerLoyalty.programName` (string) Supplier's loyalty program name. Example: "Frontier-EarlyReturns" - `VehiclePrice.CustomerLoyalty.supplierType` (string) The type of supplier of a loyalty program. Uses 'hotel' for frequent guest number or 'air' for frequent flyer number. Example: "Hotel" - `VehiclePrice.CustomerLoyalty.supplier` (string) Supplier of a loyalty program (typically 2 characters representing the hotel, brand, or airline). Example: "UA" - `VehiclePrice.CustomerLoyalty.tier` (string) Customer Loyalty tier Example: "Silver" - `VehiclePrice.CustomerLoyalty.shareWithSupplier` (array) The list of suppliers that the CustomerLoyalty number is shared. Used for cross accrual. Example: ["LH"] - `VehiclePrice.CustomerLoyalty.cardHolderName` (string) Customer loyalty member name; up to 128 characters are supported. In Air Search, for discounted offers to be returned, the name must be sent as LAST FIRST; e.g.,if SMITH is the last name and JORDAN the first name, send as SMITH JORDAN Example: "John Smith" - `VehiclePrice.CustomerLoyalty.validatedInd` (boolean) Customer loyalty number has been validated by the supplier Example: true - `VehiclePrice.CustomerLoyalty.prefix` (string) The cardholder name prefix title like Mr, Mrs, Dr Example: "Dr" - `VehiclePrice.CustomerLoyalty.given` (string) The First Name of the Cardholder Example: "John" - `VehiclePrice.CustomerLoyalty.middle` (string) Middle Name of the Cardholder Example: "Wilkinson" - `VehiclePrice.CustomerLoyalty.surname` (string) Last Name of the Cardholder Example: "Smith" - `VehiclePrice.RateQualifier` (string) A closed enumeration of possible rate qualifiers for vehicle rental Enum: same as `VehiclePrice.RateQualifier` in "PriceBreakdownVehiclePrice" (5 values) - `rateGuaranteedInd` (boolean) - PriceBreakdownVehicleDeposit: - `totalPayableNowInd` (boolean) If True the Amount is the total amount payable now - `totalPayableLaterInd` (boolean) If True the Amount is the total amount payable later - PriceBreakdownVehicleCharges: - `VehicleCharges` (object) - `VehicleCharges.@type` (string, required) Example: "VehicleCharges" - `VehicleCharges.description` (string) Assigned Type: c-1100:String - `VehicleCharges.VehicleChargePurposeCode` (object) Any code used to specify an item, for example a type of traveler, service code, room amenity, etc. - `VehicleCharges.VehicleChargePurposeCode.value` (string) Example: "INS" - `VehicleCharges.VehicleChargePurposeCode.codeContext` (string) Code Context Example: "ACRISS" - `VehicleCharges.ratePeriod` (string) The time period for a rate such as daily, weekly, monthly Enum: same as `VehiclePrice.ratePeriod` in "PriceBreakdownVehiclePrice" (15 values) - `VehicleCharges.rateChargeInfo` (string) Assigned Type: c-1100:String - `VehicleCharges.RateCategory` (string) For Hotel Search, request a rate category by sending up to 8 OTA rate categories to search for. If the supplier has rates available for the requested category, the response contains those rates and indicates them as such. Some properties do not return these rates unless explicitly requested. For a Hotel Rules request, this value can be found, if returned, in the Availability response's ProductRateCodeInfo/RateCodeInfo/rateCategory. Enum: same as `VehicleCharges.RateCategory` in "PriceBreakdownVehicleCharges" (32 values) - `VehicleCharges.VehicleCoverageTypeCode` (object) The OTA code defined for the Vehicle Coverage Type - `VehicleCharges.VehicleCoverageTypeCode.value` (string) Example: "INS" - `VehicleCharges.VehicleCoverageTypeCode.codeContext` (string) Code Context Example: "ACRISS" - `VehicleCharges.Calculation` (array) - `VehicleCharges.Calculation.@type` (string, required) Example: "Calculation" - `VehicleCharges.Calculation.UnitAmount` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehicleCharges.Calculation.UnitName` (string) The time period for a rate such as daily, weekly, monthly Enum: same as `VehiclePrice.ratePeriod` in "PriceBreakdownVehiclePrice" (15 values) - `VehicleCharges.Calculation.Quantity` (integer) The quantity used in the calculation of the vehicle charge e.g 2 x $500 per week - `VehicleCharges.Calculation.MaxQuantity` (integer) The maximum quantity allowed for a charge e.g Baby seat charged at $10 per day for a maximum of 10 days - `VehicleCharges.Calculation.TotalAmount` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehicleCharges.Calculation.Percent` (number) Used when the charge is based on a percentage of a TotalAmount - `VehicleCharges.Calculation.Applicability` (object) Textual information. - `VehicleCharges.taxInclusiveInd` (boolean) - `VehicleCharges.guaranteedInd` (boolean) - `VehicleCharges.payNowInd` (boolean) If true the vehicle charge must be paid now and is included in the totalPrice calculation - `VehicleCharges.includedInEstimatedTotalInd` (boolean) - `VehicleCharges.includedInBaseRateInd` (boolean) If true the Vehicle Charge has been included in the base rate of the Vehicle price - `SupplierRetainedPrice.VendorCurrencyTotal` (object) No longer used. Previously used to expose the local vendor currency when it is different to the purchased currency - `ConsumedPrice` (object) Child class of Price. This includes all of the Price object plus the Pricebreakdown which gives detailed Price information per PTC or Hotel offering. For a Hotels Create Reservation (Full Payload) request, find the values to send in the Price objects from either Availability (returned in CatalogOffering/Price) or Rules (returned in Offer/Price). Although you can send the price returned in either API, the Rules pricing may be more accurate. If you sent a Rules request, send the value from that response. You must include CurrencyCode, Base, TotalTaxes, and TotalPrice. When returned from the previous steps, additionally send TermsAndConditionsFull, ProductRateCodeInfo, and RateCodeInfo. - `ResidualPrice` (object) The Residual amount that will be refunded separately for this transaction. - `ResidualPrice.@type` (string, required) Example: "ResidualPriceDetail" - `ResidualPrice.id` (string) Internally referenced id - `ResidualPrice.CurrencyCode` (object) Currency codes are the three-letter alphabetic codes that represent the various currencies used throughout the world. Unless changed in the request, the currency is the default associated with your provisioned PCC from Travelport. For Hotel: SourceCurrency is based on the location of the hotel and used for all rates in the response. TargetCurrency is the currency code sent in the request in requestedCurrency. - `ResidualPrice.Base` (number) The total amount not including taxes and/or fees Example: 12.2 - `ResidualPrice.TotalTaxes` (number) The total of the taxes included in the total price Example: 24 - `ResidualPrice.TotalFees` (number) The total of the fees included in the total price Example: 10.5 - `ResidualPrice.TotalPrice` (number) The total price of the product in the currency indicated Example: 34.7 - `ResidualPrice.PriceBreakdown` (array) — one of (discriminator: @type): - PriceBreakdownAir: - `quantity` (integer) Quantity of passengers in that PTC. Example: 2 - `requestedPassengerType` (string) The PTC to which the PriceBreakdown applies. Example: "CHD" - `FiledAmount` (object) Returned only in the Price APIs. GDS only; not supported for NDC. The base amount of a ticket price or net price that is filed in local currency. Returned when the origin currency is not the same as the PCC currency to show the currency in which the base fare has been filed. When used for NetBaseAmount: Net ticket data (NTD) is returned in the AirPrice, AirReservation, Exchange Search, and Reservation Retrieve responses for any GDS fare that has a private fare component (fareType=AgencyPrivateFare). When NTD is returned, TermsAndConditionsFuill includes FareGuaranteePolicy to return the fare calculation indicator for the fare. When NTD is returned, PriceBreakdown may include NetBaseAmount. - `FiledAmount.value` (number) Filed amount value Example: 43.3422 - `FiledAmount.currencyCode` (string) Code for the currency in which the base fare was filed. Example: "USD" - `FiledAmount.codeAuthority` (string) Filed amount currency code authority Example: "Australian Dollar" - `FiledAmount.decimalPlace` (integer, required) Number of decimal places in the currency in ISO 4217 standard format. Example: 3 - `FiledAmount.decimalAuthority` (string) ISO 4217 standard decimal authority Example: "ISO 4217" - `Discount` (object) NDC only; not supported for GDS. Returned for a fare discounted from the published price, such as a promotional discount. Not returned for privately negotiated discounts such as private fares. - `Discount.value` (number) The amount value of the discount Example: 20.22 - `Discount.description` (string) The text description for the discount. Example: "Spring discount on group bookings" - `Discount.currencyCode` (string, required) Currency code discount is returned in. Example: "USD" - `Discount.codeAuthority` (string, required) Not used. Currency code Authority. Example: "ISO" - `Discount.decimalPlace` (integer, required) Number of decimal places in the currency the discount is returned in. Example: 2 - `Discount.decimalAuthority` (string) Not used. Decimal Authority. Example: "ISO" - `NetFareInfo` (object) Detailed information on the net fare used. - `NetFareInfo.@type` (string, required) Example: "NetFareInfo" - `NetFareInfo.passengerTypeCode` (string) PassengerTypeCode Example: "ADT" - `NetFareInfo.NetFareBreakdownConstruction` (array) - `NetFareInfo.NetFareBreakdownConstruction.value` (string) - `NetFareInfo.NetFareBreakdownConstruction.fareType` (string) Assigned Type: c-1100:StringTiny - `NetFareInfo.NetFareBreakdownConstruction.rateOfExchange` (number) The rate of exchange applied to the fare breakdown - `NetFareInfo.TicketBaseAudit` (object) Returned only in the Price APIs. GDS only; not supported for NDC. The base amount of a ticket price or net price that is filed in local currency. Returned when the origin currency is not the same as the PCC currency to show the currency in which the base fare has been filed. When used for NetBaseAmount: Net ticket data (NTD) is returned in the AirPrice, AirReservation, Exchange Search, and Reservation Retrieve responses for any GDS fare that has a private fare component (fareType=AgencyPrivateFare). When NTD is returned, TermsAndConditionsFuill includes FareGuaranteePolicy to return the fare calculation indicator for the fare. When NTD is returned, PriceBreakdown may include NetBaseAmount. - `NetFareInfo.TicketBasePassenger` (object) The monetary value - `NetFareInfo.TicketBasePassenger.value` (number) - `NetFareInfo.TicketBasePassenger.currencyCode` (string) Assigned Type: c-1100:CurrencyCode - `NetFareInfo.TicketBasePassenger.codeAuthority` (string, required) Assigned Type: c-1100:CodeContext - `NetFareInfo.TicketBasePassenger.decimalPlace` (integer, required) Assigned Type: c-1100:CurrencyMinorUnit - `NetFareInfo.TicketBasePassenger.decimalAuthority` (string) Assigned Type: c-1100:CodeContext - `NetFareInfo.TicketBasePassenger.bTInd` (boolean) If true, this is a bulk ticket fare - `NetFareInfo.TicketBasePassenger.iTInd` (boolean) If true, this is an inclusive tour fare - `TravelerIdentifierRef` (object) Identifier references as object both within a message payload or an object held in cache that may be used for subsequent workflows. Returned for NDC in the Price response if age was sent for this traveler in the previous workflow requests. - `TravelerIdentifierRef.name` (string) Traveler identifier - `TravelerIdentifierRef.passengerTypeCode` (string) Passenger Type code Example: "ADT" - `TravelerIdentifierRef.ages` (array) The ages of the travelers associated to a particular ptc. For NDC, this value will be returned in PriceBreakdownAir if sent as part of the PassengerCriteria in the Air Search request. Example: [15] - `TravelerIdentifierRef.passengerCriteriaRef` (string) Allows the user to associate passenger criteria information. Example: "passengerCriteria_1" - `TravelerIdentifierRef.value` (string) - `TravelerIdentifierRef.id` (string) A locally referenced ID - `TravelerIdentifierRef.description` (string) Descriptive text used to identify the contents of a target object - `TravelerIdentifierRef.uris` (array) Uniform Resource Identifier Example: ["google.com"] - `TravelerIdentifierRef.age` (integer) Replaced with ages array. The age of the traveler. Example: 11 - `NetBaseAmount` (object) Returned only in the Price APIs. GDS only; not supported for NDC. The base amount of a ticket price or net price that is filed in local currency. Returned when the origin currency is not the same as the PCC currency to show the currency in which the base fare has been filed. When used for NetBaseAmount: Net ticket data (NTD) is returned in the AirPrice, AirReservation, Exchange Search, and Reservation Retrieve responses for any GDS fare that has a private fare component (fareType=AgencyPrivateFare). When NTD is returned, TermsAndConditionsFuill includes FareGuaranteePolicy to return the fare calculation indicator for the fare. When NTD is returned, PriceBreakdown may include NetBaseAmount. - `FareCalculation` (string) GDS only; not supported for NDC. For each PTC, when available, FareCalculation returns the fare calculation ladder for all public and private fare types filed by an agency or an airline. Example: "LON BA SYD R564.00YEE1Y BA LON R564.00YEE1Y NUC1128.00END ROE0.787855" - `Surcharges` (object) In AirSearch workflow this applies to GDS only. Not supported for NDC, which does not return surcharges. Returned if surcharges apply to this offer. For GDS only, for a multi-city offer with stopovers (see multi-city offers with stopovers for details), surcharges and commission amounts are for the entire journey. For all other offers, the surcharges and commission amounts are for each leg (origin and destination pair). A multi-city offer can be identified by the jc in its CombinabilityCode: jc1, jc2. Surcharges can be omitted from the Search response with excludeSurchargesInd. - `Surcharge` (array, required) - `Surcharge.value` (number) Surcharge amount Example: 12 - `Surcharge.currencyCode` (string) ISO 4217 currency code for the surcharge. Example: "USD" - `Surcharge.surchargeCode` (string) Surcharge code Example: "ADDITIONAL COSTS" - `Surcharge.reportingAuthority` (string) Not used. Surcharge reporting authority Example: "Federal register" - `Surcharge.purpose` (string) Surcharge purpose. For Air workflows possible values include Weekend Surcharge, Stopover Charge, Multiple Stopover Charges, Other (default value that covers all other surcharges such as fuel surcharges). Example: "Weekend Surcharge" - `Surcharge.description` (string) Description of the surcharge. Example: "Rollaway Surcharge" - `Surcharge.surchargeApplication` (string) Application values (such as the application of a fee) like per person or per room. Enum: same as `Surcharge.surchargeApplication` (7 values) - `Surcharge.surchargeFrequency` (string) The frequency of a fee such as per night or per stay. Enum: same as `Surcharge.surchargeFrequency` (6 values) - `Surcharge.codeAuthority` (string) Not used. Currency code authority. Example: "ISO 4217" - `Surcharge.decimalPlace` (integer) Decimal place for the currency unit. Example: 4 - `Surcharge.decimalAuthority` (string) Not used. Currency code decimal authority. Example: "ISO 4217" - `Surcharges.@type` (string, required) Discriminator class is SurchargesDetail Example: "SurchargesDetail" - `Surcharges.TotalSurcharges` (number) A monetary amount, up to 4 decimal places. Example: 211.11 - `Surcharges.approximateInd` (boolean) If true, the surcharge amounts are approximate. - `TravelerRefs` (array) Returned only in Reservation Retrieve to identify the traveler associated with this instance of PriceBreakdown in case of multiple offers on the booking. Example: ["[\"traveler_1\",\"traveler2\"]"] - `PaidTaxes` (object) Summary Taxes object - `Tax` (array) - `Tax.value` (number) Amount of the tax. Returned as 0 if a tax was marked as exempt with TaxExemption. Example: 12.2 - `Tax.currencyCode` (string) A ISO 4217 currency code associated to the value. Example: "USD" - `Tax.taxCode` (string) "Code for the tax. For Hotels this is the OTA code." Example: "XF2" - `Tax.reportingAuthority` (string) Identifies the reporting authority such as airport code for XF taxes Example: "JFK1" - `Tax.purpose` (string) Supplier returned description of tax. Example: "Fuel surcharge" - `Tax.description` (string) "Short summary of the tax. In Air workflows this is returned only for NDC. Note that descriptions are not returned for tax codes YQ and YR, which are fees charged by airlines and not government-imposed taxes. For Hotels this is the OTA tax description." Example: "Lodging tax" - `Tax.includedInBase` (string) Yes , No , Unknown Enum: same as `instantPurchase` in "AdvanceReservationRequired" (3 values) - `Tax.codeAuthority` (string) Not used. Currency Code Authority Example: "ISO" - `Tax.decimalPlace` (integer) Permitted number of decimals. Associated to the currency value. Example: 2 - `Tax.decimalAuthority` (string) Not used. Currency decimal authority Example: "ISO" - `Tax.exemptInd` (boolean) GDS only; not supported for NDC. Returned if a tax was marked exempt in a prior request with the TaxExemption pricing modifer. If true, this tax is exempt" Example: true - `Tax.nonRefundableInd` (boolean) If true, the tax is non refundable. This indicator is only supported for exchange search and exchange price quote transactions. Example: true - `Tax.excludedFromTotalPriceInd` (boolean) Returned in Hotel APIs when a tax is not included in the TotalPrice. Default behavior is for taxes to be included in TotalPrice. Example: true - `TaxPercent` (object) Returned when the tax is expressed as a percentage of the amount. - `TaxPercent.value` (number) The tax percentage amount. Example: 5.5 - `TaxPercent.taxCode` (string) Any code for the tax. Example: "971 - IRS Notice" - `TaxPercent.reportingAuthority` (string) Tax reporting authority Example: "Georgia Department of Revenue" - `TaxPercent.purpose` (string) Purpose of tax Example: "statutory tax" - `TaxPercent.description` (string) Description Example: "1.5% of SGST" - `TaxPercent.includedInBase` (string) Yes , No , Unknown Enum: same as `instantPurchase` in "AdvanceReservationRequired" (3 values) - `PaidTaxes.@type` (string, required) Discriminator classes PaidTaxes or PaidTaxesDetail Example: "PaidTaxesDetail" - `PaidTaxes.TotalTaxes` (number) A monetary amount, up to 4 decimal places. Decimal place needs to be included. Example: 220.12 - `RequestedPricingModifiers` (array) - `RequestedPricingModifiers.@type` (string, required) Discriminator. Example: "RequestedPricingModifiers" - `RequestedPricingModifiers.PassengerCriteria` (object) Defines the passenger criteria. Send one PassengerCriteria for each passenger type code (PTC). Search supports up to 9 total passengers. A maximum of 6 PTCs are supported for GDS. NDC does not have a PTC limitation. AirPrice supports up to nine total passengers across all PTCs. - `TravelerIdentifierRef` (object, required) Identifier references as object both within a message payload or an object held in cache that may be used for subsequent workflows. Returned for NDC in the Price response if age was sent for this traveler in the previous workflow requests. - `RequestedPricingModifiers.PassengerCriteria.@type` (string, required) Discriminator. No child classes. Example: "PassengerCriteria" - `RequestedPricingModifiers.PassengerCriteria.number` (integer, required) The amount of passengers associated with this passenger type code. Default is 1. Example: 1 - `RequestedPricingModifiers.PassengerCriteria.age` (integer) The age of the passenger. Notes on PTC and age: - Travelport recommends sending age only with PTCs that require age for pricing. - If the age is sent in the request, for NDC only, the age is returned in the pricing response. - For child passengers, Travelport recommends sending the age of the child in the age attribute plus the PTC CNN. Travelport recommends against sending CNN without age, or the CHD PTC. Not all fares cannot be quoted for CHD. - The age for CNN is generally between 2 and 11 inclusive, with ADT fares returned for ages 12 and up; however, this can vary by airline and country. - The age for INF must be either 0 or 1. - During booking, date of birth is required for all child and infant PTCs (Add Traveler payload in Traveler/birthDate). Example: 26 - `RequestedPricingModifiers.PassengerCriteria.passengerTypeCode` (string) The passenger type code (PTC) for the passengers on the itinerary. Required field for Air Search and Flight specific search. Common PTCs are: - ADT: adult - CHD: child of unknown age - For child passengers, Travelport recommends sending the age of the child in the age attribute plus the PTC CNN. Travelport recommends against sending CNN without age, or the CHD PTC. Many fares cannot be quoted for CHD. - CNN: child when age is known - The age for CNN is generally between 2 and 11 inclusive, with ADT fares returned for ages 12 and up; however, this can vary by airline and country. - INF: infant without a seat - INS: infant with a seat - UNN: unaccompanied child. See API guides to download a full list of PTCs. NDC carriers BA, SQ, AV, AA, and AF/KLM offer teen/young adult tax exemptions from the UK Air Passenger Duty (GB tax). Send PTC with the value YTH and send the passengers age per below. The PTC may be returned as ADT, or Cxx in which xx is the age, but the tax exemption is applied in the pricing on these NDC carriers. For marine fares, send the PTC value SEA. You must also send OSI remarks at Add Traveler with the vessel name and location. Marine fares are private fares for travelers going to or from a vessel. NDC only; not supported for GDS. When running a multiple passenger search for NDC on Qantas, Qantas supports only these PTCs: ADT, CHD, CNN, INF. Sending any other PTC may result in an error at ticketing. Any traveler sent without a PTC value is defaulted to ADT. PTC can be sent or omitted for ADT passenger. AirReservation defaults the PTC to ADT and returns it in the Reservation Retrieve. Example: "ADT" - `RequestedPricingModifiers.PassengerCriteria.birthDate` (string) The date of birth of the passenger. May be used in age validation for fares with age restrictions. Example: "2020-01-16" - `RequestedPricingModifiers.PassengerCriteria.id` (string) Unique id to support referencing of this specific passenger criteria. Example: "passengercriteria_001" - `RequestedPricingModifiers.PassengerCriteria.CustomerLoyalty` (array) NDC only; not supported for GDS. Optional object for sending customer loyalty information, such as for a frequent flyer program. If CustomerLoyalty is sent in the Search request, it must also be sent in the Air Price request and the Add Traveler request. As some carriers validate frequent traveler data through the workflow, failing to send the same CustomerLoyalty details, even if invalid, may cause a booking failure. If an invalid number is sent, the response returns a warning message that the FQTV is invalid, and the invalid number is cached to prevent a potential booking failure. - `RequestedPricingModifiers.PassengerCriteria.TravelerGeographicLocation` (object) For AirSearch: supported/validated only for NDC to support local citizen fares. For AirPrice and AirReservation: GDS only; not supported for NDC. Optional object for requesting local citizen/local resident fares for Spain and associated islands. You must also send a PTC relevant to the local resident fares; e.g., ADR for adult resident, CHR for child resident. Any discount applied through TravelerGeographicLocation applies to all travelers, not only to the traveler in this instance of PassengerCriteria. If the discount must apply only to an individual traveler, that traveler requires a separate search and book workflow. - `RequestedPricingModifiers.PassengerCriteria.specifiedPassengerTypeCodeOnlyInd` (boolean) GDS only; not supported for NDC. - If true: returns only offers for the specified PTC. If no fares are available for the specified PTC, returns an error message that there is no valid fare. - If false (default behavior): If no fares are available for the specified PTC, returns fares for the default ADT (adult) PTC instead. Example: true - `RequestedPricingModifiers.PricingModifiersAir` (object) A selection of Pricing Modifiers that can be used to influence the Price of an Offer. - For the AirPrice reference payload request, if any price modifiers were included in the preceding Search request and no price modifiers are sent in the AirPrice request, the cached price modifiers sent at Search are sent with the AirPrice request. If any price modifiers are sent in the AirPrice reference payload request, all cached Search modifiers are discarded and only the modifiers sent in that AirPrice request are used. - For the Add Offer request, you may optionally store fares with one or more pricing modifiers. If a pricing modifier is not added, the auto stored fare is added to the reservation. There is no change in the AirReservation response when pricing modifiers are requested. AirReservation applies modifiers from Add Offer and earlier steps as follows: - Modifiers sent in the Add Offer request (supported for both full and reference payload). - If no modifiers are sent in Add Offer, any pricing modifiers sent in AirPrice are applied. - If no modifiers were sent in AirPrice, or if AirPrice was not sent, any pricing modifiers sent in Search are applied. GDS only; pricing modifiers not supported for NDC. If the requested modifier does not have any fares associated with it, the workbench commit fails and returns the error message 'No Fare Found'. Pricing happens at commit, not at Add Offer. - `Brand` (object) Information on airline Brand offerings. If brand attributes were not excluded with inhibitBrandContentInd=true (GDS only), then brand attributes are returned and consolidated in ReferenceList/ReferenceListBrand. In this case Brand does not return the name or Identifier objects but instead returns only BrandRef, which matches to the brand identifier (e.g., b1) in ReferenceListBrand. - `RequestedPricingModifiers.PricingModifiersAir.@type` (string, required) Discriminator. Child classes PricingModifiersAir and PricingModifersAirDetail Example: "PricingModifiersAir" - `RequestedPricingModifiers.PricingModifiersAir.currencyCode` (string) In an API request, send the currency type to return if you want to override the default currency specified with your PCC. Example: "GBP" - `RequestedPricingModifiers.PricingModifiersAir.FareSelection` (object) Requests the return of fare types including private fares (negotiated), public fares (published), or net fares (consolidator fares, or any negotiated wholesale price that is further marked up for sale to customers). May be used to request fares with specific restrictions, change, or refund options. - `RequestedPricingModifiers.PricingModifiersAir.OrganizationInformation` (object) Use to send account codes for negotiated fares or to send optional India GST SSR Remarks in GSTRegistrationNumber. For NDC supports corporate loyalty program and GST Information. This information is returned in TermsAndConditions." - `RequestedPricingModifiers.PricingModifiersAir.TaxExemption` (object) GDS only, not supported for NDC. Use to mark some or all taxes as exempt. Specify all taxes, only specific tax codes, or all taxes in specific countries. Must include either allTaxesExemptInd OR both countries and taxCodes. TaxExemption supports up to nine values for countries, taxCodes, or both combined. The response returns any exempt taxes with exemptInd=true and value=0. - `RequestedPricingModifiers.PricingModifiersAir.PromotionalCode` (array) - `RequestedPricingModifiers.PricingModifiersAir.SellCity` (string) GDS only, not supported for NDC. The IATA location code for a city. Overrides the sell city of the requester to specify an alternate sale location and return fares based on that location. The response returns pricing in the local currency for the specified sell city instead of the PCC's default currency. Example: "NYC" - `RequestedPricingModifiers.PricingModifiersAir.TicketCity` (string) GDS only, not supported for NDC. The IATA location code for a city. Overrides the ticketing city of the requester to specify an alternate ticket location and return fares based on that location; the response returns pricing in the local currency for the specified ticket city instead of the PCC's default currency. Example: "NYC" - `RequestedPricingModifiers.PricingModifiersAir.PricingPCC` (string) GDS only, not supported for NDC. Use to send a faring PCC for which a selective access or code group agreement exists between that PCC and the PCC associated with your account. The following combinations of PricingPCC and FareSelection/fareType=PrivateFaresOnly return results as follows: - PricingPCC sent and PrivateFaresOnly not requested: If a selective access or group agreement exists, both public and any available private fares are returned for the requesting and providing PCC. - If no selective access or group agreement exists, only public fares are returned. - PricingPCC sent and PrivateFaresOnly is requested: If a selective access or group agreement exists that allows private fare access, only available private fares are returned for the requesting and providing PCC. - If no agreement exists, or if an agreement exists but does not allow private fares access, an error is returned. Example: "0Bx3" - `RequestedPricingModifiers.PricingModifiersAir.FareBasisCodeOverride` (array) - `RequestedPricingModifiers.PricingModifiersAir.MultiPricingAgency` (array) The customer can send up to 3 Pseudo City Codes (PCCs) in PricingModifiersAir, MultiPricingAgency. If a customer sends more than 3 PCCs in MultiPricingAgency, only the first 3 are validated. If a customer sends both PricingPCC and MultiPricingAgency with PCCs, the PCC in PricingPCC is ignored. Example: ["[\"0XS4\",\"0YBZ\",\"J80K\"]"] - `RequestedPricingModifiers.PricingModifiersAir.TicketingPCC` (string) GDS only, not supported for NDC. In an API request, overrides the ticketing PCC associated with your account to specify an alternate PCC and return fares based on that PCC. Example: "0XS4" - `RequestedPricingModifiers.PricingModifiersAir.CalculatedFareAdjustment` (object) Used in Exchange Search to modify the Price of the Fare. Discriminator classes CalculatedFareAdjustmentDiscount or CalculatedFareAdjustmentIncrease - `RequestedPricingModifiers.PricingModifiersAir.ManualFareAdjustment` (array) Send to manually adjust the base fare amount on all fares for a specific PTC. - `RequestedPricingModifiers.PricingModifiersAir.BrandPreference` (array) - `RequestedPricingModifiers.PricingModifiersAir.includeSplitPaymentInd` (boolean) Requests request split ticketing, which returns outbound and inbound one-way fares in addition to round trip options in the Search API response. This may result in lower fares than the same or similar round-trip itinerary. If true, requests split ticketing. If false or omitted split ticketing options are not returned. Default is false. GDS only, not supported for NDC. When split ticketing is requested, the Search response returns offers in the following order: Outbound one-way offers, Inbound one-way offers, Round trip offers. The response identifies all one-way outbound and inbound offers with CombinabilityCode j0. CombinabilityCode values for round trip offers start at j1 and increment by one for each offer. Only the following are in scope for split ticketing: Search (not supported for Next Leg Search or Flight Specific Search), Round-trip journey-based offerings ( isJourney header not sent or sent as true, or CustomResponseModifiersAir/SearchRepresentation not sent or sent with value Journey ) Upsells. Split ticketing is not supported for round-trip leg-based searches, virtual interlining, or NDC. Split ticketing is available only for customers specifically provisioned for split ticketing. Split ticketing returns one-way outbound and one-way inbound fares in addition to round-trip offers. Split ticket offers are identified with CombinabilityCode j0. If your account is not configured for split ticketing, sending includeSplitPaymentInd returns a response without split ticket offers and a warning message. GDS only, not supported for NDC. In Air Price, For split ticketing, the request must send offers that are identified in the Search response with CombinabilityCode j0, which identifies those offers as one-way outbound and one-way inbound split ticketing offers. A combination of j0 and any non-j0 value offer returns an error message that split pricing is not supported - `RequestedPricingModifiers.PricingModifiersAir.returnMostRestrictiveBrandInd` (boolean) In Search API, when there are different brands on a connecting flight, return information for either the most restrictive brand or the brand on the most significant segment on the itinerary. If true, return the offer brand of the most restrictive brand. If false or omitted, return the offer brand of the most significant segment of the itinerary. GDS only, not supported for NDC. - `RequestedPricingModifiers.PricingModifiersAir.splitPaymentOfferings` (number) Number between 0 and 99. Send with includeSplitPaymentInd to configure the percentage of round trip offers to return in a split ticketing response. By default, Search divides the split ticketing response into 34% round-trip offerings and the remainder as split ticketing offers, which are combined outbound and inbound one-way fares. To change this percentage, send SplitPaymentOfferings with the percentage value of round trip offers to return. Example: 25 - `RequestedPricingModifiers.CabinPreference` (object) Requests a fare based on the cabin class. Only one cabin preferenceType (Permitted, Preferred, PreferredWithUpgrade) is allowed per request, but there is no limit to the number of cabins that can be sent. Any CabinPreference in the initial Search request is applied to any subsequent Next Leg Search and reference Flight Specific Search requests. In AirPrice and AirReservation only one cabin preference type is allowed per request, but there is no limit to the number of cabins that can be sent. If CabinPreference was sent in the Search request, it is cached and sent with the AirPrice reference payload request. If you send CabinPreference in the AirPrice request, all cached modifiers are discarded and only the modifiers sent in the AirPrice request are used. Can be combined with lowFareFinderInd=true to return lowest fare in the requested cabin or cabins. When using CabinPreference and lowFareFinderInd, if both CabinPreference and a class of service are sent, class of service is ignored. If CabinPreference is sent without a class of service, the response returns the lowest fare in the cabin requested. If that cabin is not available, the response may upgrade or downgrade to a different cabin. If a different cabin than requested is returned, the response returns the message that the cabin class may differ from the class requested. If lowFareFinderInd=false and CabinPreference are sent in the request, AirPrice ignores the preferred cabin and returns a message that the preferred cabin was ignored. If CabinPreference is set to All, no cabin preference is applied." - `RequestedPricingModifiers.CabinPreference.@type` (string, required) Discriminator. No child classes exist Example: "CabinPreference" - `RequestedPricingModifiers.CabinPreference.preferenceType` (string) Type of cabin preference. Sending a mix of preferenceType values is not supported. For example, you cannot send an instance of CabinPreference with a preferenceType of Permitted and another instance with preferenceType of Prohibited. In this case the results default to the Preferred preference. Note that if lowFareFinderInd is sent with true and CabinPreference is sent, the only supported value for CabinPreference/type is Permitted. Enum: same as `RequestedPricingModifiers.CabinPreference.preferenceType` in "PriceBreakdownAir" (4 values) - `RequestedPricingModifiers.CabinPreference.cabins` (array) A space-delimited list of cabins. Enum: same as `PassengerFlight.FlightProduct.cabin` in "ProductAir" (5 values) - `RequestedPricingModifiers.CabinPreference.legSequence` (array) Limits preference to the specified leg referenced in SearchCriteriaFlight. You can apply the preference to only some legs of the itinerary, or different preferences to different legs. To apply preference to the entire itinerary, do not send legSequence. GDS only, not supported for NDC. Not supported at Price or Book. Example: [1,2] - `RequestedPricingModifiers.FlightType` (object) The type of flight connection - `RequestedPricingModifiers.FlightType.@type` (string, required) Discriminator. No child classes. Example: "FlightType" - `RequestedPricingModifiers.FlightType.connectionType` (string) Limits the connection type returned. Each value returns the specified type and all higher types. For example, StopDirect could return both flights that stop without a change of planes (StopDirect) and non-stop direct flights (NonStopDirect). SingleConnection or DoubleConnection will not exclude StopDirect flights from the journey. For example, SingleConnection could return an itinerary with two flight numbers, and either of these flights could have intermediate stops. Enum: same as `RequestedPricingModifiers.FlightType.connectionType` in "PriceBreakdownAir" (5 values) - `RequestedPricingModifiers.FlightType.excludeInterlineConnectionsInd` (boolean) Excludes interline connectionsClosed from results. If true, does not return offers with interline connections. If false or omitted, may return interline connections in results. Default is false. GDS only, not supported for NDC. When a product contains multiple interline air segments, brand details return only the brand of the significant carrier, not the validating/plating carrier brand information. The IATA rules for determining the significant carrier on an itinerary are based on the areas in which the transportation takes place. Example: true - `RequestedPricingModifiers.CustomResponseModifiersAir` (object) Contains additional modifiers to customize the result set. Includes optional indicators for returning or excluding specified response content. Values sent at Search can carry forward into the Next Leg Search request and are not re-sent. - `RequestedPricingModifiers.CustomResponseModifiersAir.@type` (string, required) discriminator Example: "CustomResponseModifiersAir" - `RequestedPricingModifiers.CustomResponseModifiersAir.BrandAttributeInclusion` (array) Supported in AirSearch and AirPrice. Returns only information about the brand attributes specified and does not return any other brand attributes. - `RequestedPricingModifiers.CustomResponseModifiersAir.SearchRepresentation` (string) Specifies either a journey or leg-based response. Journey returns offers for all legs of the itinerary. Journey is the default. Leg returns offers for only the first leg of the itinerary. Must be followed with a Next Leg Search to select an offer for the first leg and return offers on the subsequent leg to combine with it.Customize search result set as leg or journey based. Next Leg Search requests, and Flight Specific Search requests for less than the full itinerary, are supported only after a leg-based Search, not a journey-based Search. If these requests follow a journey-based Search request, an error message is returned. Enum: same as `RequestedPricingModifiers.CustomResponseModifiersAir.SearchRepresentation` in "PriceBreakdownAir" (3 values) - `RequestedPricingModifiers.CustomResponseModifiersAir.excludePenaltiesInd` (boolean) GDS only; not supported for NDC. Indicator to omit change and cancel penalties. - If true: omits all penalty information from the response. - If false (default behavior): returns any change and penalty details provided by carrier for each offer in TermsAndConditionsFullAir/Penalties. If sent in Search but not in AirPrice, the value sent in Search is cached and applied to the AirPrice results. However, you can override the value sent in Search by sending excludePenaltiesInd in the AirPrice request with the opposite value. For example, if the Search request sends excludePenaltiesInd=true and the AirPrice request sends excludePenaltiesInd=false, the Search response does not return penalties and the AirPrice response does return penalties. Example: true - `RequestedPricingModifiers.CustomResponseModifiersAir.excludeBaggageFeesInd` (boolean) GDS only; not supported for NDC. Indicator to exclude baggage details. - If true: excludes baggage fees, carry on fees, and embargo information from the response. Baggage quantity or weight is returned instead. - If false (default behavior): baggage details returned in response. Default is false. Example: true - `RequestedPricingModifiers.CustomResponseModifiersAir.includeFareCalculationInd` (boolean) GDS only; not supported for NDC or in the Flight Specific Search full payload request. Indicator to request the return of the fare calculation ladder. - If true: returns the fare calculation ladder in BestCombinablePrice.PriceBreakdownAir.FareCalculation. - If false (default behavior): fare calculation ladder is not returned. Example: true - `RequestedPricingModifiers.CustomResponseModifiersAir.excludeSurchargesInd` (boolean) GDS only; not supported for NDC. Indicator to exclude a surcharge breakdown. - If true: excludes a surcharge breakdown from the response. Baggage quantity or kilos is returned instead. - If false (default behavior): surcharge breakdown returned in response. Example: true - `RequestedPricingModifiers.CustomResponseModifiersAir.excludeUnbundledFaresInd` (boolean) GDS only, not supported for NDC. Sets whether to return unbundled fares. Supported in AirSearch and AirPrice. - If true: does not return unbundled fares. - If false (default behavior): returns unbundled and bundled fares as available. Example: true - `RequestedPricingModifiers.CustomResponseModifiersAir.includeCO2EmissionsDataInd` (boolean) Indicator to return CO2 emission data in the Search and Next Leg Search responses. - If true: returns CO2 emission data. - If false (default behavior): CO2 emission data not returned. Example: true - `RequestedPricingModifiers.CustomResponseModifiersAir.includeFlightAmenitiesInd` (boolean) Indicator to return flight amenities from ATPCO RouteHappy data. - If true: includes amenities in the response if available. - If false: Does not return ATPCO RouteHappy amenities. Example: true - `RequestedPricingModifiers.CustomResponseModifiersAir.includeUniversalProductAttributesInd` (boolean) Indicator to return universal product attributes (UPAs), which include images, icons, and URLs as provided by ATPCO. Must also send includeFlightAmenitiesInd=true. - If true: returns universal product attributes if available. - If false (default behavior): Universal product attributes not returned. UPAs are not returned for direct flights with intermediate stops, non-flight segments such as trains, or for Premium Business class. Example: true - `RequestedPricingModifiers.CustomResponseModifiersAir.includeBundledAncillariesInd` (boolean) NDC only. If true: the search and price response will include bundled air and ancillary offerings/offers. Search and Price response will contain both ProductAir and ProductAncillary plus a new child class of PriceBreakdown: PriceBreakdownAncillaryAir to define the ancillary inclusion and pricing. Example: true - `RequestedPricingModifiers.CustomResponseModifiersAir.includeFullPenaltyDisclosureInd` (boolean) If true, penalty information sourced from ATPCO Cat 31 and 33 will be disclosed. Penalties may be exposed at fare component level and include time windows. - `RequestedPricingModifiers.PricingModifiersAirChange` (object) Pricing Modifiers that can be used to influence the Price of an Exchanged Offer - `RequestedPricingModifiers.PricingModifiersAirChange.@type` (string) Example: "PricingModifiersAirChange" - `RequestedPricingModifiers.PricingModifiersAirChange.currencyCode` (string) ISO 4217 currency code Example: "USD" - `RequestedPricingModifiers.PricingModifiersAirChange.FareSelection` (object) Requests the return of fare types including private fares (negotiated), public fares (published), or net fares (consolidator fares, or any negotiated wholesale price that is further marked up for sale to customers). May be used to request fares with specific restrictions, change, or refund options. - `RequestedPricingModifiers.PricingModifiersAirChange.OrganizationInformation` (object) Use to send account codes for negotiated fares or to send optional India GST SSR Remarks in GSTRegistrationNumber. For NDC supports corporate loyalty program and GST Information. This information is returned in TermsAndConditions." - `RequestedPricingModifiers.PricingModifiersAirChange.WaiverCode` (object) A code assigned by an airline to support waiver of fees or ticket value as a result of disruption to the passenger. - `RequestedPricingModifiers.PricingModifiersAirChange.TaxExemption` (object) GDS only, not supported for NDC. Use to mark some or all taxes as exempt. Specify all taxes, only specific tax codes, or all taxes in specific countries. Must include either allTaxesExemptInd OR both countries and taxCodes. TaxExemption supports up to nine values for countries, taxCodes, or both combined. The response returns any exempt taxes with exemptInd=true and value=0. - `RequestedPricingModifiers.PricingModifiersAirChange.PromotionalCode` (object) NDC only. Not supported for GDS. Any NDC airline designated promotional code. - `RequestedPricingModifiers.PricingModifiersAirChange.SellCity` (string) Overrides the sell city of the requestor Example: "MEX" - `RequestedPricingModifiers.PricingModifiersAirChange.TicketCity` (string) Overrides the ticket city of the requestor Example: "MEX" - `RequestedPricingModifiers.PricingModifiersAirChange.PricingPCC` (string) Overrides the pricing PCC of the requestor Example: "0XS4" - `RequestedPricingModifiers.PricingModifiersAirChange.TicketingPCC` (string) Overrides the ticketing PCC of the requestor Example: "0XCD" - `RequestedPricingModifiers.PricingModifiersAirChange.CalculatedFareAdjustment` (object) Used in Exchange Search to modify the Price of the Fare. Discriminator classes CalculatedFareAdjustmentDiscount or CalculatedFareAdjustmentIncrease - `RequestedPricingModifiers.PricingModifiersAirChange.BrandPreference` (array) - `RequestedPricingModifiers.PricingModifiersAirChange.keepToBrandInd` (boolean) If true, the offerings returned will be of the same brand as the original Offer Example: true - `RequestedPricingModifiers.PricingModifiersAirChange.returnMostRestrictiveBrandInd` (boolean) if true, the most restrictive brand will be returned in the response when there are different brands present in the Offering Example: true - `RequestedPricingModifiers.PricingModifiersAirChange.doNotNetInd` (boolean) If true, this exchange will not net any residual/refundable amounts against due amounts. - `RequestedPricingModifiers.lowFareFinderInd` (boolean) Provides pricing flexibility around class of service. If not sent, the response returns fares only in the requested class of service. If true, returns the lowest fares available in any class of service available, which may not be the same as the requested class. Note that if lowFareFinderInd is sent with true and CabinPreference is sent, the only supported value for CabinPreference/type is Permitted. When lowFareFindInd=true and brand attributes are not disabled (inhibitBrandContentInd), AirPrice uses only the brand tier (and any other pricing modifiers) to find the lowest fare within a brand tier regardless of class of service. GDS only; not supported for NDC. Example: true - `RequestedPricingModifiers.keepToBrandInd` (boolean) If true, the original brand will be maintained during the exchange process. Example: true - `RequestedPricingModifiers.lowFareFindAndRebookInd` (boolean) If true, the original flights in the reservation will be rebooked or replaced with the new exchanged flights. - `PassengerCriteriaRefs` (array) NDC only; not supported for GDS. Returned for NDC if a traveler identifier was sent for this traveler in the previous workflow requests. Example: ["passengerCriteria_1"] - `FlightPassCredits` (integer) The number of flight pass credits consumed for this pricebreakdown. Example: 1 - PriceBreakdownAncillary: - `inclusiveOfTaxInd` (boolean) If true, this ancillary is sold inclusive of tax. Example: true - `quantity` (integer) The quantity of ancillary items included in this PriceBreakdown. Example: 1 - `Description` (object) A description of the ancillary with description codes. - `Description.value` (string) The text description of the ancillary. Example: "Vegetarian Meal" - `Description.code` (string) The ATPCO group code. Example: "BG" - `Description.subCode` (string) The ATPCO RFISC subcode. Example: "0D4" - `Description.subGroup` (string) The ATPCO sub group code. Example: "SP" - `Description.codeContext` (string) The code context value. Example: "ATPCO" - `Description.ssrCode` (string) The four character AIRIMP SSR code for this ancillary. Example: "VGML" - `Description.issuanceReasonCode` (string) The airline provided reason for issuance code. Example: "C" - `Description.geographicSpecification` (string) How the ancillary is applied across the itinerary. Enum: same as `Ancillary.Description.geographicSpecification` in "ProductAncillary" (3 values) - `ProductRef` (string) The product ref this PriceBreakdown applies to. If no productRef exists then the PriceBreakdown applies to all Products within the Offer. Example: "p_1" - `Discount` (object) NDC only; not supported for GDS. Returned for a fare discounted from the published price, such as a promotional discount. Not returned for privately negotiated discounts such as private fares. - `Discount.value` (number) The amount value of the discount Example: 20.22 - `Discount.description` (string) The text description for the discount. Example: "Spring discount on group bookings" - `Discount.currencyCode` (string, required) Currency code discount is returned in. Example: "USD" - `Discount.codeAuthority` (string, required) Not used. Currency code Authority. Example: "ISO" - `Discount.decimalPlace` (integer, required) Number of decimal places in the currency the discount is returned in. Example: 2 - `Discount.decimalAuthority` (string) Not used. Decimal Authority. Example: "ISO" - `TravelerIdentifierRef` (object) Identifier references as object both within a message payload or an object held in cache that may be used for subsequent workflows. Returned for NDC in the Price response if age was sent for this traveler in the previous workflow requests. - `TravelerIdentifierRef.name` (string) Traveler identifier - `TravelerIdentifierRef.passengerTypeCode` (string) Passenger Type code Example: "ADT" - `TravelerIdentifierRef.ages` (array) The ages of the travelers associated to a particular ptc. For NDC, this value will be returned in PriceBreakdownAir if sent as part of the PassengerCriteria in the Air Search request. Example: [15] - `TravelerIdentifierRef.passengerCriteriaRef` (string) Allows the user to associate passenger criteria information. Example: "passengerCriteria_1" - `TravelerIdentifierRef.value` (string) - `TravelerIdentifierRef.id` (string) A locally referenced ID - `TravelerIdentifierRef.description` (string) Descriptive text used to identify the contents of a target object - `TravelerIdentifierRef.uris` (array) Uniform Resource Identifier Example: ["google.com"] - `TravelerIdentifierRef.age` (integer) Replaced with ages array. The age of the traveler. Example: 11 - `AncillaryPriceApplicationCode` (object) Determines how an ancillary price has been built. - `AncillaryPriceApplicationCode.value` (string) Example: "3" - `AncillaryPriceApplicationCode.application` (string) Associated text. Example: "PerItem" - PriceBreakdownHospitality: - `roomPricingType` (string) A string provided by the hotel to describe how a service is priced, such as per night or per stay. Enum: same as `roomPricingType` in "PriceBreakdownHospitality" (5 values) - `Description` (string) Example: "Advance Purchase-Ro-Free WiFi" - `NightlyRate` (array) - `NightlyRate.@type` (string) - `NightlyRate.startDate` (string, required) Start date for the nightly rate in YYYY-MM-DD format. - `NightlyRate.nights` (integer) Number of nights the nightly rate is valid. - `NightlyRate.Amount` (object, required) Amount represents the cost applied - `AverageNightlyRate` (array) The average nightly rate for a given offer. - `AverageNightlyRate.value` (number) The amount of a given currency. Example: 124.56 - `AverageNightlyRate.code` (string) An ISO 4217 alpha character code (3 characters) that specifies a money unit. Example: "USD" - `AverageNightlyRate.minorUnit` (integer) Minor units are a mechanism for expressing the relationship between a major currency unit and its corresponding minor currency unit. It is the smallest unit of a given currency. For example; the smallest denomination in USD is the cent, which is 1/100 of a USD, and the minor unit value is 2. Not all currencies have a minor unit. Example: 2 - `AverageNightlyRate.currencySource` (string) The system requesting or returning the currency code specified in the attribute Enum: same as `MinimumAdcolAmount.currencySource` in "ChangePermitted" (3 values) - `AverageNightlyRate.approximateInd` (boolean) "If true, the currency amount has been converted from the original amount. For Air Exchange Eligibility, returned only if a currency is converted. If returned, the value is always true, indicating that the fee is approximate because of currency conversion. For Hotel Availability and Rules, true indicates this is a calculated value; false indicates this is the value returned by the property." Example: true - `AmenitySurcharges` (object) Amenity Surcharges information. - `AmenitySurcharges.@type` (string, required) Discriminator classes AmenitySurcharges or AmenitySurchargesDetail Example: "AmenitySurchargesDetail" - `AmenitySurcharges.TotalSurcharges` (number) A monetary amount, up to 4 decimal places. Decimal place needs to be included. Example: 211.11 - `AmenitySurcharges.approximateInd` (boolean) if true, the surcharge amounts are approximate - `AmenitySurcharges.Surcharge` (array, required) - `AmenitySurcharges.Surcharge.value` (number) Surcharge amount Example: 12 - `AmenitySurcharges.Surcharge.currencyCode` (string) ISO 4217 currency code for the surcharge. Example: "USD" - `AmenitySurcharges.Surcharge.surchargeCode` (string) Surcharge code Example: "ADDITIONAL COSTS" - `AmenitySurcharges.Surcharge.reportingAuthority` (string) Not used. Surcharge reporting authority Example: "Federal register" - `AmenitySurcharges.Surcharge.purpose` (string) Surcharge purpose. For Air workflows possible values include Weekend Surcharge, Stopover Charge, Multiple Stopover Charges, Other (default value that covers all other surcharges such as fuel surcharges). Example: "Weekend Surcharge" - `AmenitySurcharges.Surcharge.description` (string) Description of the surcharge. Example: "Rollaway Surcharge" - `AmenitySurcharges.Surcharge.surchargeApplication` (string) Application values (such as the application of a fee) like per person or per room. Enum: same as `Surcharge.surchargeApplication` (7 values) - `AmenitySurcharges.Surcharge.surchargeFrequency` (string) The frequency of a fee such as per night or per stay. Enum: same as `Surcharge.surchargeFrequency` (6 values) - `AmenitySurcharges.Surcharge.codeAuthority` (string) Not used. Currency code authority. Example: "ISO 4217" - `AmenitySurcharges.Surcharge.decimalPlace` (integer) Decimal place for the currency unit. Example: 4 - `AmenitySurcharges.Surcharge.decimalAuthority` (string) Not used. Currency code decimal authority. Example: "ISO 4217" - `priceChangesDuringStayInd` (boolean) "If true, indicates the price changes at least once during requested dates. If roomPricingType = Per night, multiple instances of priceChangesDuringStayInd are returned." - `shortRateDescription` (string) A normalized rate description for comparing rates across multiple aggregators. Example: "Flexible Rate" - PriceBreakdownVehiclePrice: - `VehiclePrice` (object, required) Rate summary for rental of the vehicle. - `VehiclePrice.@type` (string, required) Example: "VehiclePrice" - `VehiclePrice.id` (string) Internal ID - `VehiclePrice.rateSource` (string) Assigned Type: c-1100:StringTiny - `VehiclePrice.rateGuaranteedInd` (boolean) Assigned Type: c-1100:OptionalIndicator - `VehiclePrice.ratePeriod` (string) The time period for a rate such as daily, weekly, monthly Enum: same as `VehiclePrice.ratePeriod` in "PriceBreakdownVehiclePrice" (15 values) - `VehiclePrice.RateDistance` (object) Rate for the period defined by the attributes - `VehiclePrice.RateDistance.value` (number) - `VehiclePrice.RateDistance.unlimitedDistanceInd` (boolean) if true unlimited miles is included with the rental - `VehiclePrice.RateDistance.requestedCodeAppliedInd` (boolean) if true, the requested code has been applied - `VehiclePrice.RateDistance.allowance` (integer) The distance allowance permitted with this rate. Use in combination with distanceUnits and ratePeriod - `VehiclePrice.RateDistance.distanceUnits` (string) For Hotels: Optional object to request either miles or kilometers for the search radius from the specified location. If unitOfDistance is not specified, the search defaults to miles for properties in the United States, Myanmar, and Liberia. The search defaults to kilometers in all other countries. Enum: same as `Vehicle.VehicleDateLocation.RentalPickup.GeoLocation.altitudeUnitOfDistance` in "ProductVehicle" (2 values) - `VehiclePrice.RateDistance.ratePeriod` (string) The time period for a rate such as daily, weekly, monthly Enum: same as `VehiclePrice.ratePeriod` in "PriceBreakdownVehiclePrice" (15 values) - `VehiclePrice.RateDescription` (array) - `sequence` (integer) The order of the text block, if there are more than one block. Example: 2 - `description` (string) Text block detail description Example: "description" - `Image` (object) Each instance is one image and its accompanying details, including a link to the image. Key value pairs; not all may be returned. - `Image.value` (string) URL of the image - `Image.dimensionCategory` (string) Deprecated and replaced by imageSize - `Image.width` (integer) Image width Example: 42 - `Image.height` (integer) Image height Example: 43 - `Image.caption` (string) Image caption Example: "Ticket" - `Image.pictureCategory` (integer) deprecated and replaced by pictureOf Example: 5 - `Image.imageSize` (string) A size for the image to return, allowing you to set image quality. Hospitality APIs no longer support thumbnail. Enum: same as `Vehicle.Image.imageSize` in "ProductVehicle" (5 values) - `Image.pictureOf` (string) The image category Enum: same as `Vehicle.Image.pictureOf` in "ProductVehicle" (26 values) - `URL` (string) A URL for this block - `DateCreateModify` (object, required) Time stamp of the creation. - `DateCreateModify.value` (string) Example: "2026-03-04T11:22:00Z" - `DateCreateModify.creatorID` (string) ID of creator. Software system identifier or an employee id Example: "c1234563" - `DateCreateModify.lastModify` (string) Time stamp of last modification. Example: "2026-03-04T11:24:00Z" - `DateCreateModify.lastModifierID` (string) Identifies the last software system or person to modify a record Example: "m346789" - `DateCreateModify.purge` (string) Date an item will be purged from a system of record Example: "2026-03-03" - `VehiclePrice.RateDescription.@type` (string, required) Discriminator classes TextBlock or TextBlockDetail Example: "TextBlockDetail" - `VehiclePrice.RateDescription.title` (string) "The title of the rule or information. For TermsAndConditionsFullHospitality, may include any of the following Rule Types; Promotional Data, Rate Description, Room Rate Data, Rate Text, Guarantee, Cancellation, Deposit, Check in/out, Room detail, Extra charges, Packages, Property, Location, Miscellaneous, Rate Amount, Alternate Rate Amount, Rate Comment, FAX, Phone, Special Information, Information, Room Hold Expiration Time. Not every property returns all of these types. Some properties do not return any title. Only English is supported for these values." Example: "Baggage Details" - `VehiclePrice.RateDescription.id` (string) Internally referenced id Example: "2" - `VehiclePrice.RateDescription.TextFormatted` (array, required) - `VehiclePrice.RateAvailability` (string) Options are available to sell, need to call, or closed Enum: same as `VehiclePrice.RateAvailability` in "PriceBreakdownVehiclePrice" (3 values) - `VehiclePrice.SupplierRate` (object, required) Estimated total amount - Monetary amounts expressed in another currency. - `VehiclePrice.SupplierRate.@type` (string, required) Example: "SupplierRate" - `VehiclePrice.SupplierRate.BaseRate` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.SupplierRate.BaseRate.value` (number) The amount of a given currency. Example: 124.56 - `VehiclePrice.SupplierRate.BaseRate.code` (string) An ISO 4217 alpha character code (3 characters) that specifies a money unit. Example: "USD" - `VehiclePrice.SupplierRate.BaseRate.minorUnit` (integer) Minor units are a mechanism for expressing the relationship between a major currency unit and its corresponding minor currency unit. It is the smallest unit of a given currency. For example; the smallest denomination in USD is the cent, which is 1/100 of a USD, and the minor unit value is 2. Not all currencies have a minor unit. Example: 2 - `VehiclePrice.SupplierRate.BaseRate.currencySource` (string) The system requesting or returning the currency code specified in the attribute Enum: same as `MinimumAdcolAmount.currencySource` in "ChangePermitted" (3 values) - `VehiclePrice.SupplierRate.BaseRate.approximateInd` (boolean) "If true, the currency amount has been converted from the original amount. For Air Exchange Eligibility, returned only if a currency is converted. If returned, the value is always true, indicating that the fee is approximate because of currency conversion. For Hotel Availability and Rules, true indicates this is a calculated value; false indicates this is the value returned by the property." Example: true - `VehiclePrice.SupplierRate.RateForPeriod` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.SupplierRate.DropOffCharge` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.SupplierRate.ExtraMileageCharge` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.SupplierRate.EstimatedTotalAmount` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.ApproximateRate` (object) Estimated total amount - Monetary amounts expressed in another currency. - `VehiclePrice.ApproximateRate.@type` (string, required) Example: "ApproximateRate" - `VehiclePrice.ApproximateRate.BaseRate` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.ApproximateRate.RateForPeriod` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.ApproximateRate.DropOffCharge` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.ApproximateRate.ExtraMileageCharge` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.ApproximateRate.EstimatedTotalAmount` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.CustomerLoyalty` (object) Specifies the ID for the membership program. Object for sending customer loyalty information, such as for a frequent flyer program. For Hotel send the loyalty card number in the value field, followed by programID with the hotel chain code, and supplierType: Hotel. For Air send the loyalty card number in the value field, followed by airline code in "supplier". For cross accrual use the "shareWithSupplier" field to submit to partner airlines. - `VehiclePrice.CustomerLoyalty.value` (string, required) Number on loyalty card. Example: "132456" - `VehiclePrice.CustomerLoyalty.id` (string) Optional Customer Loyalty Id. Not saved Example: "Loyalty_1" - `VehiclePrice.CustomerLoyalty.priority` (integer) Optional Numeric Priority Code Example: 2 - `VehiclePrice.CustomerLoyalty.programId` (string) "Specifies an identifier to indicate the company owner of the loyalty program. Typically two characters. For frequent guest number, the hotel supplier or brand code. For frequent flyer number, the air supplier code of the loyalty program." Example: "HY" - `VehiclePrice.CustomerLoyalty.programName` (string) Supplier's loyalty program name. Example: "Frontier-EarlyReturns" - `VehiclePrice.CustomerLoyalty.supplierType` (string) The type of supplier of a loyalty program. Uses 'hotel' for frequent guest number or 'air' for frequent flyer number. Example: "Hotel" - `VehiclePrice.CustomerLoyalty.supplier` (string) Supplier of a loyalty program (typically 2 characters representing the hotel, brand, or airline). Example: "UA" - `VehiclePrice.CustomerLoyalty.tier` (string) Customer Loyalty tier Example: "Silver" - `VehiclePrice.CustomerLoyalty.shareWithSupplier` (array) The list of suppliers that the CustomerLoyalty number is shared. Used for cross accrual. Example: ["LH"] - `VehiclePrice.CustomerLoyalty.cardHolderName` (string) Customer loyalty member name; up to 128 characters are supported. In Air Search, for discounted offers to be returned, the name must be sent as LAST FIRST; e.g.,if SMITH is the last name and JORDAN the first name, send as SMITH JORDAN Example: "John Smith" - `VehiclePrice.CustomerLoyalty.validatedInd` (boolean) Customer loyalty number has been validated by the supplier Example: true - `VehiclePrice.CustomerLoyalty.prefix` (string) The cardholder name prefix title like Mr, Mrs, Dr Example: "Dr" - `VehiclePrice.CustomerLoyalty.given` (string) The First Name of the Cardholder Example: "John" - `VehiclePrice.CustomerLoyalty.middle` (string) Middle Name of the Cardholder Example: "Wilkinson" - `VehiclePrice.CustomerLoyalty.surname` (string) Last Name of the Cardholder Example: "Smith" - `VehiclePrice.RateQualifier` (string) A closed enumeration of possible rate qualifiers for vehicle rental Enum: same as `VehiclePrice.RateQualifier` in "PriceBreakdownVehiclePrice" (5 values) - `rateGuaranteedInd` (boolean) - PriceBreakdownVehicleDeposit: - `totalPayableNowInd` (boolean) If True the Amount is the total amount payable now - `totalPayableLaterInd` (boolean) If True the Amount is the total amount payable later - PriceBreakdownVehicleCharges: - `VehicleCharges` (object) - `VehicleCharges.@type` (string, required) Example: "VehicleCharges" - `VehicleCharges.description` (string) Assigned Type: c-1100:String - `VehicleCharges.VehicleChargePurposeCode` (object) Any code used to specify an item, for example a type of traveler, service code, room amenity, etc. - `VehicleCharges.VehicleChargePurposeCode.value` (string) Example: "INS" - `VehicleCharges.VehicleChargePurposeCode.codeContext` (string) Code Context Example: "ACRISS" - `VehicleCharges.ratePeriod` (string) The time period for a rate such as daily, weekly, monthly Enum: same as `VehiclePrice.ratePeriod` in "PriceBreakdownVehiclePrice" (15 values) - `VehicleCharges.rateChargeInfo` (string) Assigned Type: c-1100:String - `VehicleCharges.RateCategory` (string) For Hotel Search, request a rate category by sending up to 8 OTA rate categories to search for. If the supplier has rates available for the requested category, the response contains those rates and indicates them as such. Some properties do not return these rates unless explicitly requested. For a Hotel Rules request, this value can be found, if returned, in the Availability response's ProductRateCodeInfo/RateCodeInfo/rateCategory. Enum: same as `VehicleCharges.RateCategory` in "PriceBreakdownVehicleCharges" (32 values) - `VehicleCharges.VehicleCoverageTypeCode` (object) The OTA code defined for the Vehicle Coverage Type - `VehicleCharges.VehicleCoverageTypeCode.value` (string) Example: "INS" - `VehicleCharges.VehicleCoverageTypeCode.codeContext` (string) Code Context Example: "ACRISS" - `VehicleCharges.Calculation` (array) - `VehicleCharges.Calculation.@type` (string, required) Example: "Calculation" - `VehicleCharges.Calculation.UnitAmount` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehicleCharges.Calculation.UnitName` (string) The time period for a rate such as daily, weekly, monthly Enum: same as `VehiclePrice.ratePeriod` in "PriceBreakdownVehiclePrice" (15 values) - `VehicleCharges.Calculation.Quantity` (integer) The quantity used in the calculation of the vehicle charge e.g 2 x $500 per week - `VehicleCharges.Calculation.MaxQuantity` (integer) The maximum quantity allowed for a charge e.g Baby seat charged at $10 per day for a maximum of 10 days - `VehicleCharges.Calculation.TotalAmount` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehicleCharges.Calculation.Percent` (number) Used when the charge is based on a percentage of a TotalAmount - `VehicleCharges.Calculation.Applicability` (object) Textual information. - `VehicleCharges.taxInclusiveInd` (boolean) - `VehicleCharges.guaranteedInd` (boolean) - `VehicleCharges.payNowInd` (boolean) If true the vehicle charge must be paid now and is included in the totalPrice calculation - `VehicleCharges.includedInEstimatedTotalInd` (boolean) - `VehicleCharges.includedInBaseRateInd` (boolean) If true the Vehicle Charge has been included in the base rate of the Vehicle price - `ResidualPrice.VendorCurrencyTotal` (object) No longer used. Previously used to expose the local vendor currency when it is different to the purchased currency - `AdditionalCollectionPrice` (object) The Additional Collection amount for this transaction. - `PriceBreakdown` (array) — one of (discriminator: @type): - PriceBreakdownAir: - `quantity` (integer) Quantity of passengers in that PTC. Example: 2 - `requestedPassengerType` (string) The PTC to which the PriceBreakdown applies. Example: "CHD" - `FiledAmount` (object) Returned only in the Price APIs. GDS only; not supported for NDC. The base amount of a ticket price or net price that is filed in local currency. Returned when the origin currency is not the same as the PCC currency to show the currency in which the base fare has been filed. When used for NetBaseAmount: Net ticket data (NTD) is returned in the AirPrice, AirReservation, Exchange Search, and Reservation Retrieve responses for any GDS fare that has a private fare component (fareType=AgencyPrivateFare). When NTD is returned, TermsAndConditionsFuill includes FareGuaranteePolicy to return the fare calculation indicator for the fare. When NTD is returned, PriceBreakdown may include NetBaseAmount. - `FiledAmount.value` (number) Filed amount value Example: 43.3422 - `FiledAmount.currencyCode` (string) Code for the currency in which the base fare was filed. Example: "USD" - `FiledAmount.codeAuthority` (string) Filed amount currency code authority Example: "Australian Dollar" - `FiledAmount.decimalPlace` (integer, required) Number of decimal places in the currency in ISO 4217 standard format. Example: 3 - `FiledAmount.decimalAuthority` (string) ISO 4217 standard decimal authority Example: "ISO 4217" - `Discount` (object) NDC only; not supported for GDS. Returned for a fare discounted from the published price, such as a promotional discount. Not returned for privately negotiated discounts such as private fares. - `Discount.value` (number) The amount value of the discount Example: 20.22 - `Discount.description` (string) The text description for the discount. Example: "Spring discount on group bookings" - `Discount.currencyCode` (string, required) Currency code discount is returned in. Example: "USD" - `Discount.codeAuthority` (string, required) Not used. Currency code Authority. Example: "ISO" - `Discount.decimalPlace` (integer, required) Number of decimal places in the currency the discount is returned in. Example: 2 - `Discount.decimalAuthority` (string) Not used. Decimal Authority. Example: "ISO" - `NetFareInfo` (object) Detailed information on the net fare used. - `NetFareInfo.@type` (string, required) Example: "NetFareInfo" - `NetFareInfo.passengerTypeCode` (string) PassengerTypeCode Example: "ADT" - `NetFareInfo.NetFareBreakdownConstruction` (array) - `NetFareInfo.NetFareBreakdownConstruction.value` (string) - `NetFareInfo.NetFareBreakdownConstruction.fareType` (string) Assigned Type: c-1100:StringTiny - `NetFareInfo.NetFareBreakdownConstruction.rateOfExchange` (number) The rate of exchange applied to the fare breakdown - `NetFareInfo.TicketBaseAudit` (object) Returned only in the Price APIs. GDS only; not supported for NDC. The base amount of a ticket price or net price that is filed in local currency. Returned when the origin currency is not the same as the PCC currency to show the currency in which the base fare has been filed. When used for NetBaseAmount: Net ticket data (NTD) is returned in the AirPrice, AirReservation, Exchange Search, and Reservation Retrieve responses for any GDS fare that has a private fare component (fareType=AgencyPrivateFare). When NTD is returned, TermsAndConditionsFuill includes FareGuaranteePolicy to return the fare calculation indicator for the fare. When NTD is returned, PriceBreakdown may include NetBaseAmount. - `NetFareInfo.TicketBasePassenger` (object) The monetary value - `NetFareInfo.TicketBasePassenger.value` (number) - `NetFareInfo.TicketBasePassenger.currencyCode` (string) Assigned Type: c-1100:CurrencyCode - `NetFareInfo.TicketBasePassenger.codeAuthority` (string, required) Assigned Type: c-1100:CodeContext - `NetFareInfo.TicketBasePassenger.decimalPlace` (integer, required) Assigned Type: c-1100:CurrencyMinorUnit - `NetFareInfo.TicketBasePassenger.decimalAuthority` (string) Assigned Type: c-1100:CodeContext - `NetFareInfo.TicketBasePassenger.bTInd` (boolean) If true, this is a bulk ticket fare - `NetFareInfo.TicketBasePassenger.iTInd` (boolean) If true, this is an inclusive tour fare - `TravelerIdentifierRef` (object) Identifier references as object both within a message payload or an object held in cache that may be used for subsequent workflows. Returned for NDC in the Price response if age was sent for this traveler in the previous workflow requests. - `TravelerIdentifierRef.name` (string) Traveler identifier - `TravelerIdentifierRef.passengerTypeCode` (string) Passenger Type code Example: "ADT" - `TravelerIdentifierRef.ages` (array) The ages of the travelers associated to a particular ptc. For NDC, this value will be returned in PriceBreakdownAir if sent as part of the PassengerCriteria in the Air Search request. Example: [15] - `TravelerIdentifierRef.passengerCriteriaRef` (string) Allows the user to associate passenger criteria information. Example: "passengerCriteria_1" - `TravelerIdentifierRef.value` (string) - `TravelerIdentifierRef.id` (string) A locally referenced ID - `TravelerIdentifierRef.description` (string) Descriptive text used to identify the contents of a target object - `TravelerIdentifierRef.uris` (array) Uniform Resource Identifier Example: ["google.com"] - `TravelerIdentifierRef.age` (integer) Replaced with ages array. The age of the traveler. Example: 11 - `NetBaseAmount` (object) Returned only in the Price APIs. GDS only; not supported for NDC. The base amount of a ticket price or net price that is filed in local currency. Returned when the origin currency is not the same as the PCC currency to show the currency in which the base fare has been filed. When used for NetBaseAmount: Net ticket data (NTD) is returned in the AirPrice, AirReservation, Exchange Search, and Reservation Retrieve responses for any GDS fare that has a private fare component (fareType=AgencyPrivateFare). When NTD is returned, TermsAndConditionsFuill includes FareGuaranteePolicy to return the fare calculation indicator for the fare. When NTD is returned, PriceBreakdown may include NetBaseAmount. - `FareCalculation` (string) GDS only; not supported for NDC. For each PTC, when available, FareCalculation returns the fare calculation ladder for all public and private fare types filed by an agency or an airline. Example: "LON BA SYD R564.00YEE1Y BA LON R564.00YEE1Y NUC1128.00END ROE0.787855" - `Surcharges` (object) In AirSearch workflow this applies to GDS only. Not supported for NDC, which does not return surcharges. Returned if surcharges apply to this offer. For GDS only, for a multi-city offer with stopovers (see multi-city offers with stopovers for details), surcharges and commission amounts are for the entire journey. For all other offers, the surcharges and commission amounts are for each leg (origin and destination pair). A multi-city offer can be identified by the jc in its CombinabilityCode: jc1, jc2. Surcharges can be omitted from the Search response with excludeSurchargesInd. - `Surcharge` (array, required) - `Surcharge.value` (number) Surcharge amount Example: 12 - `Surcharge.currencyCode` (string) ISO 4217 currency code for the surcharge. Example: "USD" - `Surcharge.surchargeCode` (string) Surcharge code Example: "ADDITIONAL COSTS" - `Surcharge.reportingAuthority` (string) Not used. Surcharge reporting authority Example: "Federal register" - `Surcharge.purpose` (string) Surcharge purpose. For Air workflows possible values include Weekend Surcharge, Stopover Charge, Multiple Stopover Charges, Other (default value that covers all other surcharges such as fuel surcharges). Example: "Weekend Surcharge" - `Surcharge.description` (string) Description of the surcharge. Example: "Rollaway Surcharge" - `Surcharge.surchargeApplication` (string) Application values (such as the application of a fee) like per person or per room. Enum: same as `Surcharge.surchargeApplication` (7 values) - `Surcharge.surchargeFrequency` (string) The frequency of a fee such as per night or per stay. Enum: same as `Surcharge.surchargeFrequency` (6 values) - `Surcharge.codeAuthority` (string) Not used. Currency code authority. Example: "ISO 4217" - `Surcharge.decimalPlace` (integer) Decimal place for the currency unit. Example: 4 - `Surcharge.decimalAuthority` (string) Not used. Currency code decimal authority. Example: "ISO 4217" - `Surcharges.@type` (string, required) Discriminator class is SurchargesDetail Example: "SurchargesDetail" - `Surcharges.TotalSurcharges` (number) A monetary amount, up to 4 decimal places. Example: 211.11 - `Surcharges.approximateInd` (boolean) If true, the surcharge amounts are approximate. - `TravelerRefs` (array) Returned only in Reservation Retrieve to identify the traveler associated with this instance of PriceBreakdown in case of multiple offers on the booking. Example: ["[\"traveler_1\",\"traveler2\"]"] - `PaidTaxes` (object) Summary Taxes object - `Tax` (array) - `Tax.value` (number) Amount of the tax. Returned as 0 if a tax was marked as exempt with TaxExemption. Example: 12.2 - `Tax.currencyCode` (string) A ISO 4217 currency code associated to the value. Example: "USD" - `Tax.taxCode` (string) "Code for the tax. For Hotels this is the OTA code." Example: "XF2" - `Tax.reportingAuthority` (string) Identifies the reporting authority such as airport code for XF taxes Example: "JFK1" - `Tax.purpose` (string) Supplier returned description of tax. Example: "Fuel surcharge" - `Tax.description` (string) "Short summary of the tax. In Air workflows this is returned only for NDC. Note that descriptions are not returned for tax codes YQ and YR, which are fees charged by airlines and not government-imposed taxes. For Hotels this is the OTA tax description." Example: "Lodging tax" - `Tax.includedInBase` (string) Yes , No , Unknown Enum: same as `instantPurchase` in "AdvanceReservationRequired" (3 values) - `Tax.codeAuthority` (string) Not used. Currency Code Authority Example: "ISO" - `Tax.decimalPlace` (integer) Permitted number of decimals. Associated to the currency value. Example: 2 - `Tax.decimalAuthority` (string) Not used. Currency decimal authority Example: "ISO" - `Tax.exemptInd` (boolean) GDS only; not supported for NDC. Returned if a tax was marked exempt in a prior request with the TaxExemption pricing modifer. If true, this tax is exempt" Example: true - `Tax.nonRefundableInd` (boolean) If true, the tax is non refundable. This indicator is only supported for exchange search and exchange price quote transactions. Example: true - `Tax.excludedFromTotalPriceInd` (boolean) Returned in Hotel APIs when a tax is not included in the TotalPrice. Default behavior is for taxes to be included in TotalPrice. Example: true - `TaxPercent` (object) Returned when the tax is expressed as a percentage of the amount. - `TaxPercent.value` (number) The tax percentage amount. Example: 5.5 - `TaxPercent.taxCode` (string) Any code for the tax. Example: "971 - IRS Notice" - `TaxPercent.reportingAuthority` (string) Tax reporting authority Example: "Georgia Department of Revenue" - `TaxPercent.purpose` (string) Purpose of tax Example: "statutory tax" - `TaxPercent.description` (string) Description Example: "1.5% of SGST" - `TaxPercent.includedInBase` (string) Yes , No , Unknown Enum: same as `instantPurchase` in "AdvanceReservationRequired" (3 values) - `PaidTaxes.@type` (string, required) Discriminator classes PaidTaxes or PaidTaxesDetail Example: "PaidTaxesDetail" - `PaidTaxes.TotalTaxes` (number) A monetary amount, up to 4 decimal places. Decimal place needs to be included. Example: 220.12 - `RequestedPricingModifiers` (array) - `RequestedPricingModifiers.@type` (string, required) Discriminator. Example: "RequestedPricingModifiers" - `RequestedPricingModifiers.PassengerCriteria` (object) Defines the passenger criteria. Send one PassengerCriteria for each passenger type code (PTC). Search supports up to 9 total passengers. A maximum of 6 PTCs are supported for GDS. NDC does not have a PTC limitation. AirPrice supports up to nine total passengers across all PTCs. - `TravelerIdentifierRef` (object, required) Identifier references as object both within a message payload or an object held in cache that may be used for subsequent workflows. Returned for NDC in the Price response if age was sent for this traveler in the previous workflow requests. - `RequestedPricingModifiers.PassengerCriteria.@type` (string, required) Discriminator. No child classes. Example: "PassengerCriteria" - `RequestedPricingModifiers.PassengerCriteria.number` (integer, required) The amount of passengers associated with this passenger type code. Default is 1. Example: 1 - `RequestedPricingModifiers.PassengerCriteria.age` (integer) The age of the passenger. Notes on PTC and age: - Travelport recommends sending age only with PTCs that require age for pricing. - If the age is sent in the request, for NDC only, the age is returned in the pricing response. - For child passengers, Travelport recommends sending the age of the child in the age attribute plus the PTC CNN. Travelport recommends against sending CNN without age, or the CHD PTC. Not all fares cannot be quoted for CHD. - The age for CNN is generally between 2 and 11 inclusive, with ADT fares returned for ages 12 and up; however, this can vary by airline and country. - The age for INF must be either 0 or 1. - During booking, date of birth is required for all child and infant PTCs (Add Traveler payload in Traveler/birthDate). Example: 26 - `RequestedPricingModifiers.PassengerCriteria.passengerTypeCode` (string) The passenger type code (PTC) for the passengers on the itinerary. Required field for Air Search and Flight specific search. Common PTCs are: - ADT: adult - CHD: child of unknown age - For child passengers, Travelport recommends sending the age of the child in the age attribute plus the PTC CNN. Travelport recommends against sending CNN without age, or the CHD PTC. Many fares cannot be quoted for CHD. - CNN: child when age is known - The age for CNN is generally between 2 and 11 inclusive, with ADT fares returned for ages 12 and up; however, this can vary by airline and country. - INF: infant without a seat - INS: infant with a seat - UNN: unaccompanied child. See API guides to download a full list of PTCs. NDC carriers BA, SQ, AV, AA, and AF/KLM offer teen/young adult tax exemptions from the UK Air Passenger Duty (GB tax). Send PTC with the value YTH and send the passengers age per below. The PTC may be returned as ADT, or Cxx in which xx is the age, but the tax exemption is applied in the pricing on these NDC carriers. For marine fares, send the PTC value SEA. You must also send OSI remarks at Add Traveler with the vessel name and location. Marine fares are private fares for travelers going to or from a vessel. NDC only; not supported for GDS. When running a multiple passenger search for NDC on Qantas, Qantas supports only these PTCs: ADT, CHD, CNN, INF. Sending any other PTC may result in an error at ticketing. Any traveler sent without a PTC value is defaulted to ADT. PTC can be sent or omitted for ADT passenger. AirReservation defaults the PTC to ADT and returns it in the Reservation Retrieve. Example: "ADT" - `RequestedPricingModifiers.PassengerCriteria.birthDate` (string) The date of birth of the passenger. May be used in age validation for fares with age restrictions. Example: "2020-01-16" - `RequestedPricingModifiers.PassengerCriteria.id` (string) Unique id to support referencing of this specific passenger criteria. Example: "passengercriteria_001" - `RequestedPricingModifiers.PassengerCriteria.CustomerLoyalty` (array) NDC only; not supported for GDS. Optional object for sending customer loyalty information, such as for a frequent flyer program. If CustomerLoyalty is sent in the Search request, it must also be sent in the Air Price request and the Add Traveler request. As some carriers validate frequent traveler data through the workflow, failing to send the same CustomerLoyalty details, even if invalid, may cause a booking failure. If an invalid number is sent, the response returns a warning message that the FQTV is invalid, and the invalid number is cached to prevent a potential booking failure. - `RequestedPricingModifiers.PassengerCriteria.TravelerGeographicLocation` (object) For AirSearch: supported/validated only for NDC to support local citizen fares. For AirPrice and AirReservation: GDS only; not supported for NDC. Optional object for requesting local citizen/local resident fares for Spain and associated islands. You must also send a PTC relevant to the local resident fares; e.g., ADR for adult resident, CHR for child resident. Any discount applied through TravelerGeographicLocation applies to all travelers, not only to the traveler in this instance of PassengerCriteria. If the discount must apply only to an individual traveler, that traveler requires a separate search and book workflow. - `RequestedPricingModifiers.PassengerCriteria.specifiedPassengerTypeCodeOnlyInd` (boolean) GDS only; not supported for NDC. - If true: returns only offers for the specified PTC. If no fares are available for the specified PTC, returns an error message that there is no valid fare. - If false (default behavior): If no fares are available for the specified PTC, returns fares for the default ADT (adult) PTC instead. Example: true - `RequestedPricingModifiers.PricingModifiersAir` (object) A selection of Pricing Modifiers that can be used to influence the Price of an Offer. - For the AirPrice reference payload request, if any price modifiers were included in the preceding Search request and no price modifiers are sent in the AirPrice request, the cached price modifiers sent at Search are sent with the AirPrice request. If any price modifiers are sent in the AirPrice reference payload request, all cached Search modifiers are discarded and only the modifiers sent in that AirPrice request are used. - For the Add Offer request, you may optionally store fares with one or more pricing modifiers. If a pricing modifier is not added, the auto stored fare is added to the reservation. There is no change in the AirReservation response when pricing modifiers are requested. AirReservation applies modifiers from Add Offer and earlier steps as follows: - Modifiers sent in the Add Offer request (supported for both full and reference payload). - If no modifiers are sent in Add Offer, any pricing modifiers sent in AirPrice are applied. - If no modifiers were sent in AirPrice, or if AirPrice was not sent, any pricing modifiers sent in Search are applied. GDS only; pricing modifiers not supported for NDC. If the requested modifier does not have any fares associated with it, the workbench commit fails and returns the error message 'No Fare Found'. Pricing happens at commit, not at Add Offer. - `Brand` (object) Information on airline Brand offerings. If brand attributes were not excluded with inhibitBrandContentInd=true (GDS only), then brand attributes are returned and consolidated in ReferenceList/ReferenceListBrand. In this case Brand does not return the name or Identifier objects but instead returns only BrandRef, which matches to the brand identifier (e.g., b1) in ReferenceListBrand. - `RequestedPricingModifiers.PricingModifiersAir.@type` (string, required) Discriminator. Child classes PricingModifiersAir and PricingModifersAirDetail Example: "PricingModifiersAir" - `RequestedPricingModifiers.PricingModifiersAir.currencyCode` (string) In an API request, send the currency type to return if you want to override the default currency specified with your PCC. Example: "GBP" - `RequestedPricingModifiers.PricingModifiersAir.FareSelection` (object) Requests the return of fare types including private fares (negotiated), public fares (published), or net fares (consolidator fares, or any negotiated wholesale price that is further marked up for sale to customers). May be used to request fares with specific restrictions, change, or refund options. - `RequestedPricingModifiers.PricingModifiersAir.OrganizationInformation` (object) Use to send account codes for negotiated fares or to send optional India GST SSR Remarks in GSTRegistrationNumber. For NDC supports corporate loyalty program and GST Information. This information is returned in TermsAndConditions." - `RequestedPricingModifiers.PricingModifiersAir.TaxExemption` (object) GDS only, not supported for NDC. Use to mark some or all taxes as exempt. Specify all taxes, only specific tax codes, or all taxes in specific countries. Must include either allTaxesExemptInd OR both countries and taxCodes. TaxExemption supports up to nine values for countries, taxCodes, or both combined. The response returns any exempt taxes with exemptInd=true and value=0. - `RequestedPricingModifiers.PricingModifiersAir.PromotionalCode` (array) - `RequestedPricingModifiers.PricingModifiersAir.SellCity` (string) GDS only, not supported for NDC. The IATA location code for a city. Overrides the sell city of the requester to specify an alternate sale location and return fares based on that location. The response returns pricing in the local currency for the specified sell city instead of the PCC's default currency. Example: "NYC" - `RequestedPricingModifiers.PricingModifiersAir.TicketCity` (string) GDS only, not supported for NDC. The IATA location code for a city. Overrides the ticketing city of the requester to specify an alternate ticket location and return fares based on that location; the response returns pricing in the local currency for the specified ticket city instead of the PCC's default currency. Example: "NYC" - `RequestedPricingModifiers.PricingModifiersAir.PricingPCC` (string) GDS only, not supported for NDC. Use to send a faring PCC for which a selective access or code group agreement exists between that PCC and the PCC associated with your account. The following combinations of PricingPCC and FareSelection/fareType=PrivateFaresOnly return results as follows: - PricingPCC sent and PrivateFaresOnly not requested: If a selective access or group agreement exists, both public and any available private fares are returned for the requesting and providing PCC. - If no selective access or group agreement exists, only public fares are returned. - PricingPCC sent and PrivateFaresOnly is requested: If a selective access or group agreement exists that allows private fare access, only available private fares are returned for the requesting and providing PCC. - If no agreement exists, or if an agreement exists but does not allow private fares access, an error is returned. Example: "0Bx3" - `RequestedPricingModifiers.PricingModifiersAir.FareBasisCodeOverride` (array) - `RequestedPricingModifiers.PricingModifiersAir.MultiPricingAgency` (array) The customer can send up to 3 Pseudo City Codes (PCCs) in PricingModifiersAir, MultiPricingAgency. If a customer sends more than 3 PCCs in MultiPricingAgency, only the first 3 are validated. If a customer sends both PricingPCC and MultiPricingAgency with PCCs, the PCC in PricingPCC is ignored. Example: ["[\"0XS4\",\"0YBZ\",\"J80K\"]"] - `RequestedPricingModifiers.PricingModifiersAir.TicketingPCC` (string) GDS only, not supported for NDC. In an API request, overrides the ticketing PCC associated with your account to specify an alternate PCC and return fares based on that PCC. Example: "0XS4" - `RequestedPricingModifiers.PricingModifiersAir.CalculatedFareAdjustment` (object) Used in Exchange Search to modify the Price of the Fare. Discriminator classes CalculatedFareAdjustmentDiscount or CalculatedFareAdjustmentIncrease - `RequestedPricingModifiers.PricingModifiersAir.ManualFareAdjustment` (array) Send to manually adjust the base fare amount on all fares for a specific PTC. - `RequestedPricingModifiers.PricingModifiersAir.BrandPreference` (array) - `RequestedPricingModifiers.PricingModifiersAir.includeSplitPaymentInd` (boolean) Requests request split ticketing, which returns outbound and inbound one-way fares in addition to round trip options in the Search API response. This may result in lower fares than the same or similar round-trip itinerary. If true, requests split ticketing. If false or omitted split ticketing options are not returned. Default is false. GDS only, not supported for NDC. When split ticketing is requested, the Search response returns offers in the following order: Outbound one-way offers, Inbound one-way offers, Round trip offers. The response identifies all one-way outbound and inbound offers with CombinabilityCode j0. CombinabilityCode values for round trip offers start at j1 and increment by one for each offer. Only the following are in scope for split ticketing: Search (not supported for Next Leg Search or Flight Specific Search), Round-trip journey-based offerings ( isJourney header not sent or sent as true, or CustomResponseModifiersAir/SearchRepresentation not sent or sent with value Journey ) Upsells. Split ticketing is not supported for round-trip leg-based searches, virtual interlining, or NDC. Split ticketing is available only for customers specifically provisioned for split ticketing. Split ticketing returns one-way outbound and one-way inbound fares in addition to round-trip offers. Split ticket offers are identified with CombinabilityCode j0. If your account is not configured for split ticketing, sending includeSplitPaymentInd returns a response without split ticket offers and a warning message. GDS only, not supported for NDC. In Air Price, For split ticketing, the request must send offers that are identified in the Search response with CombinabilityCode j0, which identifies those offers as one-way outbound and one-way inbound split ticketing offers. A combination of j0 and any non-j0 value offer returns an error message that split pricing is not supported - `RequestedPricingModifiers.PricingModifiersAir.returnMostRestrictiveBrandInd` (boolean) In Search API, when there are different brands on a connecting flight, return information for either the most restrictive brand or the brand on the most significant segment on the itinerary. If true, return the offer brand of the most restrictive brand. If false or omitted, return the offer brand of the most significant segment of the itinerary. GDS only, not supported for NDC. - `RequestedPricingModifiers.PricingModifiersAir.splitPaymentOfferings` (number) Number between 0 and 99. Send with includeSplitPaymentInd to configure the percentage of round trip offers to return in a split ticketing response. By default, Search divides the split ticketing response into 34% round-trip offerings and the remainder as split ticketing offers, which are combined outbound and inbound one-way fares. To change this percentage, send SplitPaymentOfferings with the percentage value of round trip offers to return. Example: 25 - `RequestedPricingModifiers.CabinPreference` (object) Requests a fare based on the cabin class. Only one cabin preferenceType (Permitted, Preferred, PreferredWithUpgrade) is allowed per request, but there is no limit to the number of cabins that can be sent. Any CabinPreference in the initial Search request is applied to any subsequent Next Leg Search and reference Flight Specific Search requests. In AirPrice and AirReservation only one cabin preference type is allowed per request, but there is no limit to the number of cabins that can be sent. If CabinPreference was sent in the Search request, it is cached and sent with the AirPrice reference payload request. If you send CabinPreference in the AirPrice request, all cached modifiers are discarded and only the modifiers sent in the AirPrice request are used. Can be combined with lowFareFinderInd=true to return lowest fare in the requested cabin or cabins. When using CabinPreference and lowFareFinderInd, if both CabinPreference and a class of service are sent, class of service is ignored. If CabinPreference is sent without a class of service, the response returns the lowest fare in the cabin requested. If that cabin is not available, the response may upgrade or downgrade to a different cabin. If a different cabin than requested is returned, the response returns the message that the cabin class may differ from the class requested. If lowFareFinderInd=false and CabinPreference are sent in the request, AirPrice ignores the preferred cabin and returns a message that the preferred cabin was ignored. If CabinPreference is set to All, no cabin preference is applied." - `RequestedPricingModifiers.CabinPreference.@type` (string, required) Discriminator. No child classes exist Example: "CabinPreference" - `RequestedPricingModifiers.CabinPreference.preferenceType` (string) Type of cabin preference. Sending a mix of preferenceType values is not supported. For example, you cannot send an instance of CabinPreference with a preferenceType of Permitted and another instance with preferenceType of Prohibited. In this case the results default to the Preferred preference. Note that if lowFareFinderInd is sent with true and CabinPreference is sent, the only supported value for CabinPreference/type is Permitted. Enum: same as `RequestedPricingModifiers.CabinPreference.preferenceType` in "PriceBreakdownAir" (4 values) - `RequestedPricingModifiers.CabinPreference.cabins` (array) A space-delimited list of cabins. Enum: same as `PassengerFlight.FlightProduct.cabin` in "ProductAir" (5 values) - `RequestedPricingModifiers.CabinPreference.legSequence` (array) Limits preference to the specified leg referenced in SearchCriteriaFlight. You can apply the preference to only some legs of the itinerary, or different preferences to different legs. To apply preference to the entire itinerary, do not send legSequence. GDS only, not supported for NDC. Not supported at Price or Book. Example: [1,2] - `RequestedPricingModifiers.FlightType` (object) The type of flight connection - `RequestedPricingModifiers.FlightType.@type` (string, required) Discriminator. No child classes. Example: "FlightType" - `RequestedPricingModifiers.FlightType.connectionType` (string) Limits the connection type returned. Each value returns the specified type and all higher types. For example, StopDirect could return both flights that stop without a change of planes (StopDirect) and non-stop direct flights (NonStopDirect). SingleConnection or DoubleConnection will not exclude StopDirect flights from the journey. For example, SingleConnection could return an itinerary with two flight numbers, and either of these flights could have intermediate stops. Enum: same as `RequestedPricingModifiers.FlightType.connectionType` in "PriceBreakdownAir" (5 values) - `RequestedPricingModifiers.FlightType.excludeInterlineConnectionsInd` (boolean) Excludes interline connectionsClosed from results. If true, does not return offers with interline connections. If false or omitted, may return interline connections in results. Default is false. GDS only, not supported for NDC. When a product contains multiple interline air segments, brand details return only the brand of the significant carrier, not the validating/plating carrier brand information. The IATA rules for determining the significant carrier on an itinerary are based on the areas in which the transportation takes place. Example: true - `RequestedPricingModifiers.CustomResponseModifiersAir` (object) Contains additional modifiers to customize the result set. Includes optional indicators for returning or excluding specified response content. Values sent at Search can carry forward into the Next Leg Search request and are not re-sent. - `RequestedPricingModifiers.CustomResponseModifiersAir.@type` (string, required) discriminator Example: "CustomResponseModifiersAir" - `RequestedPricingModifiers.CustomResponseModifiersAir.BrandAttributeInclusion` (array) Supported in AirSearch and AirPrice. Returns only information about the brand attributes specified and does not return any other brand attributes. - `RequestedPricingModifiers.CustomResponseModifiersAir.SearchRepresentation` (string) Specifies either a journey or leg-based response. Journey returns offers for all legs of the itinerary. Journey is the default. Leg returns offers for only the first leg of the itinerary. Must be followed with a Next Leg Search to select an offer for the first leg and return offers on the subsequent leg to combine with it.Customize search result set as leg or journey based. Next Leg Search requests, and Flight Specific Search requests for less than the full itinerary, are supported only after a leg-based Search, not a journey-based Search. If these requests follow a journey-based Search request, an error message is returned. Enum: same as `RequestedPricingModifiers.CustomResponseModifiersAir.SearchRepresentation` in "PriceBreakdownAir" (3 values) - `RequestedPricingModifiers.CustomResponseModifiersAir.excludePenaltiesInd` (boolean) GDS only; not supported for NDC. Indicator to omit change and cancel penalties. - If true: omits all penalty information from the response. - If false (default behavior): returns any change and penalty details provided by carrier for each offer in TermsAndConditionsFullAir/Penalties. If sent in Search but not in AirPrice, the value sent in Search is cached and applied to the AirPrice results. However, you can override the value sent in Search by sending excludePenaltiesInd in the AirPrice request with the opposite value. For example, if the Search request sends excludePenaltiesInd=true and the AirPrice request sends excludePenaltiesInd=false, the Search response does not return penalties and the AirPrice response does return penalties. Example: true - `RequestedPricingModifiers.CustomResponseModifiersAir.excludeBaggageFeesInd` (boolean) GDS only; not supported for NDC. Indicator to exclude baggage details. - If true: excludes baggage fees, carry on fees, and embargo information from the response. Baggage quantity or weight is returned instead. - If false (default behavior): baggage details returned in response. Default is false. Example: true - `RequestedPricingModifiers.CustomResponseModifiersAir.includeFareCalculationInd` (boolean) GDS only; not supported for NDC or in the Flight Specific Search full payload request. Indicator to request the return of the fare calculation ladder. - If true: returns the fare calculation ladder in BestCombinablePrice.PriceBreakdownAir.FareCalculation. - If false (default behavior): fare calculation ladder is not returned. Example: true - `RequestedPricingModifiers.CustomResponseModifiersAir.excludeSurchargesInd` (boolean) GDS only; not supported for NDC. Indicator to exclude a surcharge breakdown. - If true: excludes a surcharge breakdown from the response. Baggage quantity or kilos is returned instead. - If false (default behavior): surcharge breakdown returned in response. Example: true - `RequestedPricingModifiers.CustomResponseModifiersAir.excludeUnbundledFaresInd` (boolean) GDS only, not supported for NDC. Sets whether to return unbundled fares. Supported in AirSearch and AirPrice. - If true: does not return unbundled fares. - If false (default behavior): returns unbundled and bundled fares as available. Example: true - `RequestedPricingModifiers.CustomResponseModifiersAir.includeCO2EmissionsDataInd` (boolean) Indicator to return CO2 emission data in the Search and Next Leg Search responses. - If true: returns CO2 emission data. - If false (default behavior): CO2 emission data not returned. Example: true - `RequestedPricingModifiers.CustomResponseModifiersAir.includeFlightAmenitiesInd` (boolean) Indicator to return flight amenities from ATPCO RouteHappy data. - If true: includes amenities in the response if available. - If false: Does not return ATPCO RouteHappy amenities. Example: true - `RequestedPricingModifiers.CustomResponseModifiersAir.includeUniversalProductAttributesInd` (boolean) Indicator to return universal product attributes (UPAs), which include images, icons, and URLs as provided by ATPCO. Must also send includeFlightAmenitiesInd=true. - If true: returns universal product attributes if available. - If false (default behavior): Universal product attributes not returned. UPAs are not returned for direct flights with intermediate stops, non-flight segments such as trains, or for Premium Business class. Example: true - `RequestedPricingModifiers.CustomResponseModifiersAir.includeBundledAncillariesInd` (boolean) NDC only. If true: the search and price response will include bundled air and ancillary offerings/offers. Search and Price response will contain both ProductAir and ProductAncillary plus a new child class of PriceBreakdown: PriceBreakdownAncillaryAir to define the ancillary inclusion and pricing. Example: true - `RequestedPricingModifiers.CustomResponseModifiersAir.includeFullPenaltyDisclosureInd` (boolean) If true, penalty information sourced from ATPCO Cat 31 and 33 will be disclosed. Penalties may be exposed at fare component level and include time windows. - `RequestedPricingModifiers.PricingModifiersAirChange` (object) Pricing Modifiers that can be used to influence the Price of an Exchanged Offer - `RequestedPricingModifiers.PricingModifiersAirChange.@type` (string) Example: "PricingModifiersAirChange" - `RequestedPricingModifiers.PricingModifiersAirChange.currencyCode` (string) ISO 4217 currency code Example: "USD" - `RequestedPricingModifiers.PricingModifiersAirChange.FareSelection` (object) Requests the return of fare types including private fares (negotiated), public fares (published), or net fares (consolidator fares, or any negotiated wholesale price that is further marked up for sale to customers). May be used to request fares with specific restrictions, change, or refund options. - `RequestedPricingModifiers.PricingModifiersAirChange.OrganizationInformation` (object) Use to send account codes for negotiated fares or to send optional India GST SSR Remarks in GSTRegistrationNumber. For NDC supports corporate loyalty program and GST Information. This information is returned in TermsAndConditions." - `RequestedPricingModifiers.PricingModifiersAirChange.WaiverCode` (object) A code assigned by an airline to support waiver of fees or ticket value as a result of disruption to the passenger. - `RequestedPricingModifiers.PricingModifiersAirChange.TaxExemption` (object) GDS only, not supported for NDC. Use to mark some or all taxes as exempt. Specify all taxes, only specific tax codes, or all taxes in specific countries. Must include either allTaxesExemptInd OR both countries and taxCodes. TaxExemption supports up to nine values for countries, taxCodes, or both combined. The response returns any exempt taxes with exemptInd=true and value=0. - `RequestedPricingModifiers.PricingModifiersAirChange.PromotionalCode` (object) NDC only. Not supported for GDS. Any NDC airline designated promotional code. - `RequestedPricingModifiers.PricingModifiersAirChange.SellCity` (string) Overrides the sell city of the requestor Example: "MEX" - `RequestedPricingModifiers.PricingModifiersAirChange.TicketCity` (string) Overrides the ticket city of the requestor Example: "MEX" - `RequestedPricingModifiers.PricingModifiersAirChange.PricingPCC` (string) Overrides the pricing PCC of the requestor Example: "0XS4" - `RequestedPricingModifiers.PricingModifiersAirChange.TicketingPCC` (string) Overrides the ticketing PCC of the requestor Example: "0XCD" - `RequestedPricingModifiers.PricingModifiersAirChange.CalculatedFareAdjustment` (object) Used in Exchange Search to modify the Price of the Fare. Discriminator classes CalculatedFareAdjustmentDiscount or CalculatedFareAdjustmentIncrease - `RequestedPricingModifiers.PricingModifiersAirChange.BrandPreference` (array) - `RequestedPricingModifiers.PricingModifiersAirChange.keepToBrandInd` (boolean) If true, the offerings returned will be of the same brand as the original Offer Example: true - `RequestedPricingModifiers.PricingModifiersAirChange.returnMostRestrictiveBrandInd` (boolean) if true, the most restrictive brand will be returned in the response when there are different brands present in the Offering Example: true - `RequestedPricingModifiers.PricingModifiersAirChange.doNotNetInd` (boolean) If true, this exchange will not net any residual/refundable amounts against due amounts. - `RequestedPricingModifiers.lowFareFinderInd` (boolean) Provides pricing flexibility around class of service. If not sent, the response returns fares only in the requested class of service. If true, returns the lowest fares available in any class of service available, which may not be the same as the requested class. Note that if lowFareFinderInd is sent with true and CabinPreference is sent, the only supported value for CabinPreference/type is Permitted. When lowFareFindInd=true and brand attributes are not disabled (inhibitBrandContentInd), AirPrice uses only the brand tier (and any other pricing modifiers) to find the lowest fare within a brand tier regardless of class of service. GDS only; not supported for NDC. Example: true - `RequestedPricingModifiers.keepToBrandInd` (boolean) If true, the original brand will be maintained during the exchange process. Example: true - `RequestedPricingModifiers.lowFareFindAndRebookInd` (boolean) If true, the original flights in the reservation will be rebooked or replaced with the new exchanged flights. - `PassengerCriteriaRefs` (array) NDC only; not supported for GDS. Returned for NDC if a traveler identifier was sent for this traveler in the previous workflow requests. Example: ["passengerCriteria_1"] - `FlightPassCredits` (integer) The number of flight pass credits consumed for this pricebreakdown. Example: 1 - PriceBreakdownAncillary: - `inclusiveOfTaxInd` (boolean) If true, this ancillary is sold inclusive of tax. Example: true - `quantity` (integer) The quantity of ancillary items included in this PriceBreakdown. Example: 1 - `Description` (object) A description of the ancillary with description codes. - `Description.value` (string) The text description of the ancillary. Example: "Vegetarian Meal" - `Description.code` (string) The ATPCO group code. Example: "BG" - `Description.subCode` (string) The ATPCO RFISC subcode. Example: "0D4" - `Description.subGroup` (string) The ATPCO sub group code. Example: "SP" - `Description.codeContext` (string) The code context value. Example: "ATPCO" - `Description.ssrCode` (string) The four character AIRIMP SSR code for this ancillary. Example: "VGML" - `Description.issuanceReasonCode` (string) The airline provided reason for issuance code. Example: "C" - `Description.geographicSpecification` (string) How the ancillary is applied across the itinerary. Enum: same as `Ancillary.Description.geographicSpecification` in "ProductAncillary" (3 values) - `ProductRef` (string) The product ref this PriceBreakdown applies to. If no productRef exists then the PriceBreakdown applies to all Products within the Offer. Example: "p_1" - `Discount` (object) NDC only; not supported for GDS. Returned for a fare discounted from the published price, such as a promotional discount. Not returned for privately negotiated discounts such as private fares. - `Discount.value` (number) The amount value of the discount Example: 20.22 - `Discount.description` (string) The text description for the discount. Example: "Spring discount on group bookings" - `Discount.currencyCode` (string, required) Currency code discount is returned in. Example: "USD" - `Discount.codeAuthority` (string, required) Not used. Currency code Authority. Example: "ISO" - `Discount.decimalPlace` (integer, required) Number of decimal places in the currency the discount is returned in. Example: 2 - `Discount.decimalAuthority` (string) Not used. Decimal Authority. Example: "ISO" - `TravelerIdentifierRef` (object) Identifier references as object both within a message payload or an object held in cache that may be used for subsequent workflows. Returned for NDC in the Price response if age was sent for this traveler in the previous workflow requests. - `TravelerIdentifierRef.name` (string) Traveler identifier - `TravelerIdentifierRef.passengerTypeCode` (string) Passenger Type code Example: "ADT" - `TravelerIdentifierRef.ages` (array) The ages of the travelers associated to a particular ptc. For NDC, this value will be returned in PriceBreakdownAir if sent as part of the PassengerCriteria in the Air Search request. Example: [15] - `TravelerIdentifierRef.passengerCriteriaRef` (string) Allows the user to associate passenger criteria information. Example: "passengerCriteria_1" - `TravelerIdentifierRef.value` (string) - `TravelerIdentifierRef.id` (string) A locally referenced ID - `TravelerIdentifierRef.description` (string) Descriptive text used to identify the contents of a target object - `TravelerIdentifierRef.uris` (array) Uniform Resource Identifier Example: ["google.com"] - `TravelerIdentifierRef.age` (integer) Replaced with ages array. The age of the traveler. Example: 11 - `AncillaryPriceApplicationCode` (object) Determines how an ancillary price has been built. - `AncillaryPriceApplicationCode.value` (string) Example: "3" - `AncillaryPriceApplicationCode.application` (string) Associated text. Example: "PerItem" - PriceBreakdownHospitality: - `roomPricingType` (string) A string provided by the hotel to describe how a service is priced, such as per night or per stay. Enum: same as `roomPricingType` in "PriceBreakdownHospitality" (5 values) - `Description` (string) Example: "Advance Purchase-Ro-Free WiFi" - `NightlyRate` (array) - `NightlyRate.@type` (string) - `NightlyRate.startDate` (string, required) Start date for the nightly rate in YYYY-MM-DD format. - `NightlyRate.nights` (integer) Number of nights the nightly rate is valid. - `NightlyRate.Amount` (object, required) Amount represents the cost applied - `AverageNightlyRate` (array) The average nightly rate for a given offer. - `AverageNightlyRate.value` (number) The amount of a given currency. Example: 124.56 - `AverageNightlyRate.code` (string) An ISO 4217 alpha character code (3 characters) that specifies a money unit. Example: "USD" - `AverageNightlyRate.minorUnit` (integer) Minor units are a mechanism for expressing the relationship between a major currency unit and its corresponding minor currency unit. It is the smallest unit of a given currency. For example; the smallest denomination in USD is the cent, which is 1/100 of a USD, and the minor unit value is 2. Not all currencies have a minor unit. Example: 2 - `AverageNightlyRate.currencySource` (string) The system requesting or returning the currency code specified in the attribute Enum: same as `MinimumAdcolAmount.currencySource` in "ChangePermitted" (3 values) - `AverageNightlyRate.approximateInd` (boolean) "If true, the currency amount has been converted from the original amount. For Air Exchange Eligibility, returned only if a currency is converted. If returned, the value is always true, indicating that the fee is approximate because of currency conversion. For Hotel Availability and Rules, true indicates this is a calculated value; false indicates this is the value returned by the property." Example: true - `AmenitySurcharges` (object) Amenity Surcharges information. - `AmenitySurcharges.@type` (string, required) Discriminator classes AmenitySurcharges or AmenitySurchargesDetail Example: "AmenitySurchargesDetail" - `AmenitySurcharges.TotalSurcharges` (number) A monetary amount, up to 4 decimal places. Decimal place needs to be included. Example: 211.11 - `AmenitySurcharges.approximateInd` (boolean) if true, the surcharge amounts are approximate - `AmenitySurcharges.Surcharge` (array, required) - `AmenitySurcharges.Surcharge.value` (number) Surcharge amount Example: 12 - `AmenitySurcharges.Surcharge.currencyCode` (string) ISO 4217 currency code for the surcharge. Example: "USD" - `AmenitySurcharges.Surcharge.surchargeCode` (string) Surcharge code Example: "ADDITIONAL COSTS" - `AmenitySurcharges.Surcharge.reportingAuthority` (string) Not used. Surcharge reporting authority Example: "Federal register" - `AmenitySurcharges.Surcharge.purpose` (string) Surcharge purpose. For Air workflows possible values include Weekend Surcharge, Stopover Charge, Multiple Stopover Charges, Other (default value that covers all other surcharges such as fuel surcharges). Example: "Weekend Surcharge" - `AmenitySurcharges.Surcharge.description` (string) Description of the surcharge. Example: "Rollaway Surcharge" - `AmenitySurcharges.Surcharge.surchargeApplication` (string) Application values (such as the application of a fee) like per person or per room. Enum: same as `Surcharge.surchargeApplication` (7 values) - `AmenitySurcharges.Surcharge.surchargeFrequency` (string) The frequency of a fee such as per night or per stay. Enum: same as `Surcharge.surchargeFrequency` (6 values) - `AmenitySurcharges.Surcharge.codeAuthority` (string) Not used. Currency code authority. Example: "ISO 4217" - `AmenitySurcharges.Surcharge.decimalPlace` (integer) Decimal place for the currency unit. Example: 4 - `AmenitySurcharges.Surcharge.decimalAuthority` (string) Not used. Currency code decimal authority. Example: "ISO 4217" - `priceChangesDuringStayInd` (boolean) "If true, indicates the price changes at least once during requested dates. If roomPricingType = Per night, multiple instances of priceChangesDuringStayInd are returned." - `shortRateDescription` (string) A normalized rate description for comparing rates across multiple aggregators. Example: "Flexible Rate" - PriceBreakdownVehiclePrice: - `VehiclePrice` (object, required) Rate summary for rental of the vehicle. - `VehiclePrice.@type` (string, required) Example: "VehiclePrice" - `VehiclePrice.id` (string) Internal ID - `VehiclePrice.rateSource` (string) Assigned Type: c-1100:StringTiny - `VehiclePrice.rateGuaranteedInd` (boolean) Assigned Type: c-1100:OptionalIndicator - `VehiclePrice.ratePeriod` (string) The time period for a rate such as daily, weekly, monthly Enum: same as `VehiclePrice.ratePeriod` in "PriceBreakdownVehiclePrice" (15 values) - `VehiclePrice.RateDistance` (object) Rate for the period defined by the attributes - `VehiclePrice.RateDistance.value` (number) - `VehiclePrice.RateDistance.unlimitedDistanceInd` (boolean) if true unlimited miles is included with the rental - `VehiclePrice.RateDistance.requestedCodeAppliedInd` (boolean) if true, the requested code has been applied - `VehiclePrice.RateDistance.allowance` (integer) The distance allowance permitted with this rate. Use in combination with distanceUnits and ratePeriod - `VehiclePrice.RateDistance.distanceUnits` (string) For Hotels: Optional object to request either miles or kilometers for the search radius from the specified location. If unitOfDistance is not specified, the search defaults to miles for properties in the United States, Myanmar, and Liberia. The search defaults to kilometers in all other countries. Enum: same as `Vehicle.VehicleDateLocation.RentalPickup.GeoLocation.altitudeUnitOfDistance` in "ProductVehicle" (2 values) - `VehiclePrice.RateDistance.ratePeriod` (string) The time period for a rate such as daily, weekly, monthly Enum: same as `VehiclePrice.ratePeriod` in "PriceBreakdownVehiclePrice" (15 values) - `VehiclePrice.RateDescription` (array) - `sequence` (integer) The order of the text block, if there are more than one block. Example: 2 - `description` (string) Text block detail description Example: "description" - `Image` (object) Each instance is one image and its accompanying details, including a link to the image. Key value pairs; not all may be returned. - `Image.value` (string) URL of the image - `Image.dimensionCategory` (string) Deprecated and replaced by imageSize - `Image.width` (integer) Image width Example: 42 - `Image.height` (integer) Image height Example: 43 - `Image.caption` (string) Image caption Example: "Ticket" - `Image.pictureCategory` (integer) deprecated and replaced by pictureOf Example: 5 - `Image.imageSize` (string) A size for the image to return, allowing you to set image quality. Hospitality APIs no longer support thumbnail. Enum: same as `Vehicle.Image.imageSize` in "ProductVehicle" (5 values) - `Image.pictureOf` (string) The image category Enum: same as `Vehicle.Image.pictureOf` in "ProductVehicle" (26 values) - `URL` (string) A URL for this block - `DateCreateModify` (object, required) Time stamp of the creation. - `DateCreateModify.value` (string) Example: "2026-03-04T11:22:00Z" - `DateCreateModify.creatorID` (string) ID of creator. Software system identifier or an employee id Example: "c1234563" - `DateCreateModify.lastModify` (string) Time stamp of last modification. Example: "2026-03-04T11:24:00Z" - `DateCreateModify.lastModifierID` (string) Identifies the last software system or person to modify a record Example: "m346789" - `DateCreateModify.purge` (string) Date an item will be purged from a system of record Example: "2026-03-03" - `VehiclePrice.RateDescription.@type` (string, required) Discriminator classes TextBlock or TextBlockDetail Example: "TextBlockDetail" - `VehiclePrice.RateDescription.title` (string) "The title of the rule or information. For TermsAndConditionsFullHospitality, may include any of the following Rule Types; Promotional Data, Rate Description, Room Rate Data, Rate Text, Guarantee, Cancellation, Deposit, Check in/out, Room detail, Extra charges, Packages, Property, Location, Miscellaneous, Rate Amount, Alternate Rate Amount, Rate Comment, FAX, Phone, Special Information, Information, Room Hold Expiration Time. Not every property returns all of these types. Some properties do not return any title. Only English is supported for these values." Example: "Baggage Details" - `VehiclePrice.RateDescription.id` (string) Internally referenced id Example: "2" - `VehiclePrice.RateDescription.TextFormatted` (array, required) - `VehiclePrice.RateAvailability` (string) Options are available to sell, need to call, or closed Enum: same as `VehiclePrice.RateAvailability` in "PriceBreakdownVehiclePrice" (3 values) - `VehiclePrice.SupplierRate` (object, required) Estimated total amount - Monetary amounts expressed in another currency. - `VehiclePrice.SupplierRate.@type` (string, required) Example: "SupplierRate" - `VehiclePrice.SupplierRate.BaseRate` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.SupplierRate.BaseRate.value` (number) The amount of a given currency. Example: 124.56 - `VehiclePrice.SupplierRate.BaseRate.code` (string) An ISO 4217 alpha character code (3 characters) that specifies a money unit. Example: "USD" - `VehiclePrice.SupplierRate.BaseRate.minorUnit` (integer) Minor units are a mechanism for expressing the relationship between a major currency unit and its corresponding minor currency unit. It is the smallest unit of a given currency. For example; the smallest denomination in USD is the cent, which is 1/100 of a USD, and the minor unit value is 2. Not all currencies have a minor unit. Example: 2 - `VehiclePrice.SupplierRate.BaseRate.currencySource` (string) The system requesting or returning the currency code specified in the attribute Enum: same as `MinimumAdcolAmount.currencySource` in "ChangePermitted" (3 values) - `VehiclePrice.SupplierRate.BaseRate.approximateInd` (boolean) "If true, the currency amount has been converted from the original amount. For Air Exchange Eligibility, returned only if a currency is converted. If returned, the value is always true, indicating that the fee is approximate because of currency conversion. For Hotel Availability and Rules, true indicates this is a calculated value; false indicates this is the value returned by the property." Example: true - `VehiclePrice.SupplierRate.RateForPeriod` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.SupplierRate.DropOffCharge` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.SupplierRate.ExtraMileageCharge` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.SupplierRate.EstimatedTotalAmount` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.ApproximateRate` (object) Estimated total amount - Monetary amounts expressed in another currency. - `VehiclePrice.ApproximateRate.@type` (string, required) Example: "ApproximateRate" - `VehiclePrice.ApproximateRate.BaseRate` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.ApproximateRate.RateForPeriod` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.ApproximateRate.DropOffCharge` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.ApproximateRate.ExtraMileageCharge` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.ApproximateRate.EstimatedTotalAmount` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.CustomerLoyalty` (object) Specifies the ID for the membership program. Object for sending customer loyalty information, such as for a frequent flyer program. For Hotel send the loyalty card number in the value field, followed by programID with the hotel chain code, and supplierType: Hotel. For Air send the loyalty card number in the value field, followed by airline code in "supplier". For cross accrual use the "shareWithSupplier" field to submit to partner airlines. - `VehiclePrice.CustomerLoyalty.value` (string, required) Number on loyalty card. Example: "132456" - `VehiclePrice.CustomerLoyalty.id` (string) Optional Customer Loyalty Id. Not saved Example: "Loyalty_1" - `VehiclePrice.CustomerLoyalty.priority` (integer) Optional Numeric Priority Code Example: 2 - `VehiclePrice.CustomerLoyalty.programId` (string) "Specifies an identifier to indicate the company owner of the loyalty program. Typically two characters. For frequent guest number, the hotel supplier or brand code. For frequent flyer number, the air supplier code of the loyalty program." Example: "HY" - `VehiclePrice.CustomerLoyalty.programName` (string) Supplier's loyalty program name. Example: "Frontier-EarlyReturns" - `VehiclePrice.CustomerLoyalty.supplierType` (string) The type of supplier of a loyalty program. Uses 'hotel' for frequent guest number or 'air' for frequent flyer number. Example: "Hotel" - `VehiclePrice.CustomerLoyalty.supplier` (string) Supplier of a loyalty program (typically 2 characters representing the hotel, brand, or airline). Example: "UA" - `VehiclePrice.CustomerLoyalty.tier` (string) Customer Loyalty tier Example: "Silver" - `VehiclePrice.CustomerLoyalty.shareWithSupplier` (array) The list of suppliers that the CustomerLoyalty number is shared. Used for cross accrual. Example: ["LH"] - `VehiclePrice.CustomerLoyalty.cardHolderName` (string) Customer loyalty member name; up to 128 characters are supported. In Air Search, for discounted offers to be returned, the name must be sent as LAST FIRST; e.g.,if SMITH is the last name and JORDAN the first name, send as SMITH JORDAN Example: "John Smith" - `VehiclePrice.CustomerLoyalty.validatedInd` (boolean) Customer loyalty number has been validated by the supplier Example: true - `VehiclePrice.CustomerLoyalty.prefix` (string) The cardholder name prefix title like Mr, Mrs, Dr Example: "Dr" - `VehiclePrice.CustomerLoyalty.given` (string) The First Name of the Cardholder Example: "John" - `VehiclePrice.CustomerLoyalty.middle` (string) Middle Name of the Cardholder Example: "Wilkinson" - `VehiclePrice.CustomerLoyalty.surname` (string) Last Name of the Cardholder Example: "Smith" - `VehiclePrice.RateQualifier` (string) A closed enumeration of possible rate qualifiers for vehicle rental Enum: same as `VehiclePrice.RateQualifier` in "PriceBreakdownVehiclePrice" (5 values) - `rateGuaranteedInd` (boolean) - PriceBreakdownVehicleDeposit: - `totalPayableNowInd` (boolean) If True the Amount is the total amount payable now - `totalPayableLaterInd` (boolean) If True the Amount is the total amount payable later - PriceBreakdownVehicleCharges: - `VehicleCharges` (object) - `VehicleCharges.@type` (string, required) Example: "VehicleCharges" - `VehicleCharges.description` (string) Assigned Type: c-1100:String - `VehicleCharges.VehicleChargePurposeCode` (object) Any code used to specify an item, for example a type of traveler, service code, room amenity, etc. - `VehicleCharges.VehicleChargePurposeCode.value` (string) Example: "INS" - `VehicleCharges.VehicleChargePurposeCode.codeContext` (string) Code Context Example: "ACRISS" - `VehicleCharges.ratePeriod` (string) The time period for a rate such as daily, weekly, monthly Enum: same as `VehiclePrice.ratePeriod` in "PriceBreakdownVehiclePrice" (15 values) - `VehicleCharges.rateChargeInfo` (string) Assigned Type: c-1100:String - `VehicleCharges.RateCategory` (string) For Hotel Search, request a rate category by sending up to 8 OTA rate categories to search for. If the supplier has rates available for the requested category, the response contains those rates and indicates them as such. Some properties do not return these rates unless explicitly requested. For a Hotel Rules request, this value can be found, if returned, in the Availability response's ProductRateCodeInfo/RateCodeInfo/rateCategory. Enum: same as `VehicleCharges.RateCategory` in "PriceBreakdownVehicleCharges" (32 values) - `VehicleCharges.VehicleCoverageTypeCode` (object) The OTA code defined for the Vehicle Coverage Type - `VehicleCharges.VehicleCoverageTypeCode.value` (string) Example: "INS" - `VehicleCharges.VehicleCoverageTypeCode.codeContext` (string) Code Context Example: "ACRISS" - `VehicleCharges.Calculation` (array) - `VehicleCharges.Calculation.@type` (string, required) Example: "Calculation" - `VehicleCharges.Calculation.UnitAmount` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehicleCharges.Calculation.UnitName` (string) The time period for a rate such as daily, weekly, monthly Enum: same as `VehiclePrice.ratePeriod` in "PriceBreakdownVehiclePrice" (15 values) - `VehicleCharges.Calculation.Quantity` (integer) The quantity used in the calculation of the vehicle charge e.g 2 x $500 per week - `VehicleCharges.Calculation.MaxQuantity` (integer) The maximum quantity allowed for a charge e.g Baby seat charged at $10 per day for a maximum of 10 days - `VehicleCharges.Calculation.TotalAmount` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehicleCharges.Calculation.Percent` (number) Used when the charge is based on a percentage of a TotalAmount - `VehicleCharges.Calculation.Applicability` (object) Textual information. - `VehicleCharges.taxInclusiveInd` (boolean) - `VehicleCharges.guaranteedInd` (boolean) - `VehicleCharges.payNowInd` (boolean) If true the vehicle charge must be paid now and is included in the totalPrice calculation - `VehicleCharges.includedInEstimatedTotalInd` (boolean) - `VehicleCharges.includedInBaseRateInd` (boolean) If true the Vehicle Charge has been included in the base rate of the Vehicle price - `AdditionalCollectionPrice.@type` (string, required) Example: "AdditionalCollectionPrice" - `AdditionalCollectionPrice.id` (string) Internally referenced id Example: "adcolPrice_1" - `AdditionalCollectionPrice.CurrencyCode` (object) Currency codes are the three-letter alphabetic codes that represent the various currencies used throughout the world. Unless changed in the request, the currency is the default associated with your provisioned PCC from Travelport. For Hotel: SourceCurrency is based on the location of the hotel and used for all rates in the response. TargetCurrency is the currency code sent in the request in requestedCurrency. - `AdditionalCollectionPrice.Base` (number) The total amount not including taxes and/or fees - `AdditionalCollectionPrice.TotalTaxes` (number) The total of the taxes included in the total price - `AdditionalCollectionPrice.TotalFees` (number) The total of the fees included in the total price - `AdditionalCollectionPrice.TotalPrice` (number) The total price of the product in the currency indicated - `AdditionalCollectionPrice.VendorCurrencyTotal` (object) No longer used. Previously used to expose the local vendor currency when it is different to the purchased currency - OfferUpsell: - `OfferUpsellInd` (string) If true, the OfferUpsell contains ancillary offerings offered in connection with the ParentOffer Example: "true" - `Offer.@type` (string, required) Discriminator - Air Price child classes OfferID, Offer, and OfferUpsell. - Reservation and ReservationWorkbench child classes OfferID, Offer, OfferModify, and OfferUpsell. - Hotel Rules child classes OfferID and Offer. Example: "Offer" - `Offer.id` (string) Offer identifier sent in the reference payload request to book that offer. Not returned in the full payload response; this is the only difference in the two responses. Example: "offer_1" - `Offer.offerRef` (string) Used to reference another instance of this object in the same message Example: "offer_1" - `Offer.Identifier` (object) A globally unique identifier key often used to reference a given option (such as Pricing, Booking, Rules, or additional workflows) or to retrieve information (such as Hotel pagination). - `Offer.ContentSource` (string) Indicates the owner the offer or document. Enum: same as `Offer.ContentSource` in "ReferenceListOffer" (4 values) - `Offer.parentOfferRef` (string) A reference to the Offer this offer is sold in conjunction with Example: "offer_1" - `Offer.offerModifyRef` (string) Reference to the new Offer created as a result of this Offer being subject to a schedule change. - `Offer.Product` (array, required) Lists the flight or flights for one leg of the itinerary. Repeats for additional leg or legs. - `Quantity` (integer) "The quantity of the product. For Hotel Create Reservation (Full Payload) request, the number of rooms requested; 1-9 inclusive supported. If not provided, default is 1. For Hotel responses, the number of rooms currently available matching this rate. In Air Search quantity represents the number of seats available for that Product. If the Product has connecting flights, Quantity returns the lowest number available. For example, if the first flight has 9 seats in Y class and the connecting flight has 4 seats in Y class, Quantity returns a value of 4." Example: 2 - `Offer.Product.@type` (string, required) Discriminator. - Air Search child classes are ProductAir and ProductAncillary. - Exchange Search child class is ProductAir. - Ancillary Search child class is ProductAncillary. - Seat Map child class is ProductSeatAvailability. - Air Price child classes are ProductAir and ProductAncillary. - Hotel Availability child classes are ProductHospitality and ProductHospitalityOffer. - Hotel Rules and HotelReservation child classes are ProductHospitality. - All Vehicle APIs child classes are ProductVehicle and ProductAncillaryVehicle. - Reservation and Reservation Workbench child classes are ProductAir, ProductAncillary, ProductHospitality, ProductVehicle, and ProductAncillaryVehicle. Example: "ProductAir" - `Offer.Product.id` (string) Local id within a given message to support referencing this object. Example: "product_1" - `Offer.Product.productRef` (string) Reference id that corresponds to the product 'id' in ReferenceListProduct.Product. To find flight details for a product, use the ProductRef id to identify the product in ReferenceListProduct.Product, and use the Flight id's (e.g., s3, s4) to match to flight information in ReferenceListFlight.Flight. Example: "product_1" - `Offer.Product.Identifier` (object) A globally unique identifier key often used to reference a given option (such as Pricing, Booking, Rules, or additional workflows) or to retrieve information (such as Hotel pagination). - `Offer.Price` (object, required) Price includes a summary of the Base, Taxes, and Fees applicable to the offer in the currency indicated. The amounts in Base, TotalTaxes, TotalFees, and TotalPrice are inclusive of all travelers across all PTCs. The amounts in PriceBreakdown apply to one traveler with the PTC returned in that instance. - `FlightPassCredits` (integer) The total number of flight pass credits consumed for this offer. Example: 2 - `PriceBreakdown` (array) — one of (discriminator: @type): - PriceBreakdownAir: - `quantity` (integer) Quantity of passengers in that PTC. Example: 2 - `requestedPassengerType` (string) The PTC to which the PriceBreakdown applies. Example: "CHD" - `FiledAmount` (object) Returned only in the Price APIs. GDS only; not supported for NDC. The base amount of a ticket price or net price that is filed in local currency. Returned when the origin currency is not the same as the PCC currency to show the currency in which the base fare has been filed. When used for NetBaseAmount: Net ticket data (NTD) is returned in the AirPrice, AirReservation, Exchange Search, and Reservation Retrieve responses for any GDS fare that has a private fare component (fareType=AgencyPrivateFare). When NTD is returned, TermsAndConditionsFuill includes FareGuaranteePolicy to return the fare calculation indicator for the fare. When NTD is returned, PriceBreakdown may include NetBaseAmount. - `FiledAmount.value` (number) Filed amount value Example: 43.3422 - `FiledAmount.currencyCode` (string) Code for the currency in which the base fare was filed. Example: "USD" - `FiledAmount.codeAuthority` (string) Filed amount currency code authority Example: "Australian Dollar" - `FiledAmount.decimalPlace` (integer, required) Number of decimal places in the currency in ISO 4217 standard format. Example: 3 - `FiledAmount.decimalAuthority` (string) ISO 4217 standard decimal authority Example: "ISO 4217" - `Discount` (object) NDC only; not supported for GDS. Returned for a fare discounted from the published price, such as a promotional discount. Not returned for privately negotiated discounts such as private fares. - `Discount.value` (number) The amount value of the discount Example: 20.22 - `Discount.description` (string) The text description for the discount. Example: "Spring discount on group bookings" - `Discount.currencyCode` (string, required) Currency code discount is returned in. Example: "USD" - `Discount.codeAuthority` (string, required) Not used. Currency code Authority. Example: "ISO" - `Discount.decimalPlace` (integer, required) Number of decimal places in the currency the discount is returned in. Example: 2 - `Discount.decimalAuthority` (string) Not used. Decimal Authority. Example: "ISO" - `NetFareInfo` (object) Detailed information on the net fare used. - `NetFareInfo.@type` (string, required) Example: "NetFareInfo" - `NetFareInfo.passengerTypeCode` (string) PassengerTypeCode Example: "ADT" - `NetFareInfo.NetFareBreakdownConstruction` (array) - `NetFareInfo.TicketBaseAudit` (object) Returned only in the Price APIs. GDS only; not supported for NDC. The base amount of a ticket price or net price that is filed in local currency. Returned when the origin currency is not the same as the PCC currency to show the currency in which the base fare has been filed. When used for NetBaseAmount: Net ticket data (NTD) is returned in the AirPrice, AirReservation, Exchange Search, and Reservation Retrieve responses for any GDS fare that has a private fare component (fareType=AgencyPrivateFare). When NTD is returned, TermsAndConditionsFuill includes FareGuaranteePolicy to return the fare calculation indicator for the fare. When NTD is returned, PriceBreakdown may include NetBaseAmount. - `NetFareInfo.TicketBasePassenger` (object) The monetary value - `NetFareInfo.TicketBasePassenger.value` (number) - `NetFareInfo.TicketBasePassenger.currencyCode` (string) Assigned Type: c-1100:CurrencyCode - `NetFareInfo.TicketBasePassenger.codeAuthority` (string, required) Assigned Type: c-1100:CodeContext - `NetFareInfo.TicketBasePassenger.decimalPlace` (integer, required) Assigned Type: c-1100:CurrencyMinorUnit - `NetFareInfo.TicketBasePassenger.decimalAuthority` (string) Assigned Type: c-1100:CodeContext - `NetFareInfo.TicketBasePassenger.bTInd` (boolean) If true, this is a bulk ticket fare - `NetFareInfo.TicketBasePassenger.iTInd` (boolean) If true, this is an inclusive tour fare - `TravelerIdentifierRef` (object) Identifier references as object both within a message payload or an object held in cache that may be used for subsequent workflows. Returned for NDC in the Price response if age was sent for this traveler in the previous workflow requests. - `TravelerIdentifierRef.name` (string) Traveler identifier - `TravelerIdentifierRef.passengerTypeCode` (string) Passenger Type code Example: "ADT" - `TravelerIdentifierRef.ages` (array) The ages of the travelers associated to a particular ptc. For NDC, this value will be returned in PriceBreakdownAir if sent as part of the PassengerCriteria in the Air Search request. Example: [15] - `TravelerIdentifierRef.passengerCriteriaRef` (string) Allows the user to associate passenger criteria information. Example: "passengerCriteria_1" - `TravelerIdentifierRef.value` (string) - `TravelerIdentifierRef.id` (string) A locally referenced ID - `TravelerIdentifierRef.description` (string) Descriptive text used to identify the contents of a target object - `TravelerIdentifierRef.uris` (array) Uniform Resource Identifier Example: ["google.com"] - `TravelerIdentifierRef.age` (integer) Replaced with ages array. The age of the traveler. Example: 11 - `NetBaseAmount` (object) Returned only in the Price APIs. GDS only; not supported for NDC. The base amount of a ticket price or net price that is filed in local currency. Returned when the origin currency is not the same as the PCC currency to show the currency in which the base fare has been filed. When used for NetBaseAmount: Net ticket data (NTD) is returned in the AirPrice, AirReservation, Exchange Search, and Reservation Retrieve responses for any GDS fare that has a private fare component (fareType=AgencyPrivateFare). When NTD is returned, TermsAndConditionsFuill includes FareGuaranteePolicy to return the fare calculation indicator for the fare. When NTD is returned, PriceBreakdown may include NetBaseAmount. - `FareCalculation` (string) GDS only; not supported for NDC. For each PTC, when available, FareCalculation returns the fare calculation ladder for all public and private fare types filed by an agency or an airline. Example: "LON BA SYD R564.00YEE1Y BA LON R564.00YEE1Y NUC1128.00END ROE0.787855" - `Surcharges` (object) In AirSearch workflow this applies to GDS only. Not supported for NDC, which does not return surcharges. Returned if surcharges apply to this offer. For GDS only, for a multi-city offer with stopovers (see multi-city offers with stopovers for details), surcharges and commission amounts are for the entire journey. For all other offers, the surcharges and commission amounts are for each leg (origin and destination pair). A multi-city offer can be identified by the jc in its CombinabilityCode: jc1, jc2. Surcharges can be omitted from the Search response with excludeSurchargesInd. - `Surcharge` (array, required) - `Surcharges.@type` (string, required) Discriminator class is SurchargesDetail Example: "SurchargesDetail" - `Surcharges.TotalSurcharges` (number) A monetary amount, up to 4 decimal places. Example: 211.11 - `Surcharges.approximateInd` (boolean) If true, the surcharge amounts are approximate. - `TravelerRefs` (array) Returned only in Reservation Retrieve to identify the traveler associated with this instance of PriceBreakdown in case of multiple offers on the booking. Example: ["[\"traveler_1\",\"traveler2\"]"] - `PaidTaxes` (object) Summary Taxes object - `Tax` (array) - `TaxPercent` (object) Returned when the tax is expressed as a percentage of the amount. - `TaxPercent.value` (number) The tax percentage amount. Example: 5.5 - `TaxPercent.taxCode` (string) Any code for the tax. Example: "971 - IRS Notice" - `TaxPercent.reportingAuthority` (string) Tax reporting authority Example: "Georgia Department of Revenue" - `TaxPercent.purpose` (string) Purpose of tax Example: "statutory tax" - `TaxPercent.description` (string) Description Example: "1.5% of SGST" - `TaxPercent.includedInBase` (string) Yes , No , Unknown Enum: same as `instantPurchase` in "AdvanceReservationRequired" (3 values) - `PaidTaxes.@type` (string, required) Discriminator classes PaidTaxes or PaidTaxesDetail Example: "PaidTaxesDetail" - `PaidTaxes.TotalTaxes` (number) A monetary amount, up to 4 decimal places. Decimal place needs to be included. Example: 220.12 - `RequestedPricingModifiers` (array) - `RequestedPricingModifiers.@type` (string, required) Discriminator. Example: "RequestedPricingModifiers" - `RequestedPricingModifiers.PassengerCriteria` (object) Defines the passenger criteria. Send one PassengerCriteria for each passenger type code (PTC). Search supports up to 9 total passengers. A maximum of 6 PTCs are supported for GDS. NDC does not have a PTC limitation. AirPrice supports up to nine total passengers across all PTCs. - `RequestedPricingModifiers.PricingModifiersAir` (object) A selection of Pricing Modifiers that can be used to influence the Price of an Offer. - For the AirPrice reference payload request, if any price modifiers were included in the preceding Search request and no price modifiers are sent in the AirPrice request, the cached price modifiers sent at Search are sent with the AirPrice request. If any price modifiers are sent in the AirPrice reference payload request, all cached Search modifiers are discarded and only the modifiers sent in that AirPrice request are used. - For the Add Offer request, you may optionally store fares with one or more pricing modifiers. If a pricing modifier is not added, the auto stored fare is added to the reservation. There is no change in the AirReservation response when pricing modifiers are requested. AirReservation applies modifiers from Add Offer and earlier steps as follows: - Modifiers sent in the Add Offer request (supported for both full and reference payload). - If no modifiers are sent in Add Offer, any pricing modifiers sent in AirPrice are applied. - If no modifiers were sent in AirPrice, or if AirPrice was not sent, any pricing modifiers sent in Search are applied. GDS only; pricing modifiers not supported for NDC. If the requested modifier does not have any fares associated with it, the workbench commit fails and returns the error message 'No Fare Found'. Pricing happens at commit, not at Add Offer. - `RequestedPricingModifiers.CabinPreference` (object) Requests a fare based on the cabin class. Only one cabin preferenceType (Permitted, Preferred, PreferredWithUpgrade) is allowed per request, but there is no limit to the number of cabins that can be sent. Any CabinPreference in the initial Search request is applied to any subsequent Next Leg Search and reference Flight Specific Search requests. In AirPrice and AirReservation only one cabin preference type is allowed per request, but there is no limit to the number of cabins that can be sent. If CabinPreference was sent in the Search request, it is cached and sent with the AirPrice reference payload request. If you send CabinPreference in the AirPrice request, all cached modifiers are discarded and only the modifiers sent in the AirPrice request are used. Can be combined with lowFareFinderInd=true to return lowest fare in the requested cabin or cabins. When using CabinPreference and lowFareFinderInd, if both CabinPreference and a class of service are sent, class of service is ignored. If CabinPreference is sent without a class of service, the response returns the lowest fare in the cabin requested. If that cabin is not available, the response may upgrade or downgrade to a different cabin. If a different cabin than requested is returned, the response returns the message that the cabin class may differ from the class requested. If lowFareFinderInd=false and CabinPreference are sent in the request, AirPrice ignores the preferred cabin and returns a message that the preferred cabin was ignored. If CabinPreference is set to All, no cabin preference is applied." - `RequestedPricingModifiers.FlightType` (object) The type of flight connection - `RequestedPricingModifiers.CustomResponseModifiersAir` (object) Contains additional modifiers to customize the result set. Includes optional indicators for returning or excluding specified response content. Values sent at Search can carry forward into the Next Leg Search request and are not re-sent. - `RequestedPricingModifiers.PricingModifiersAirChange` (object) Pricing Modifiers that can be used to influence the Price of an Exchanged Offer - `RequestedPricingModifiers.lowFareFinderInd` (boolean) Provides pricing flexibility around class of service. If not sent, the response returns fares only in the requested class of service. If true, returns the lowest fares available in any class of service available, which may not be the same as the requested class. Note that if lowFareFinderInd is sent with true and CabinPreference is sent, the only supported value for CabinPreference/type is Permitted. When lowFareFindInd=true and brand attributes are not disabled (inhibitBrandContentInd), AirPrice uses only the brand tier (and any other pricing modifiers) to find the lowest fare within a brand tier regardless of class of service. GDS only; not supported for NDC. Example: true - `RequestedPricingModifiers.keepToBrandInd` (boolean) If true, the original brand will be maintained during the exchange process. Example: true - `RequestedPricingModifiers.lowFareFindAndRebookInd` (boolean) If true, the original flights in the reservation will be rebooked or replaced with the new exchanged flights. - `PassengerCriteriaRefs` (array) NDC only; not supported for GDS. Returned for NDC if a traveler identifier was sent for this traveler in the previous workflow requests. Example: ["passengerCriteria_1"] - `FlightPassCredits` (integer) The number of flight pass credits consumed for this pricebreakdown. Example: 1 - PriceBreakdownAncillary: - `inclusiveOfTaxInd` (boolean) If true, this ancillary is sold inclusive of tax. Example: true - `quantity` (integer) The quantity of ancillary items included in this PriceBreakdown. Example: 1 - `Description` (object) A description of the ancillary with description codes. - `Description.value` (string) The text description of the ancillary. Example: "Vegetarian Meal" - `Description.code` (string) The ATPCO group code. Example: "BG" - `Description.subCode` (string) The ATPCO RFISC subcode. Example: "0D4" - `Description.subGroup` (string) The ATPCO sub group code. Example: "SP" - `Description.codeContext` (string) The code context value. Example: "ATPCO" - `Description.ssrCode` (string) The four character AIRIMP SSR code for this ancillary. Example: "VGML" - `Description.issuanceReasonCode` (string) The airline provided reason for issuance code. Example: "C" - `Description.geographicSpecification` (string) How the ancillary is applied across the itinerary. Enum: same as `Ancillary.Description.geographicSpecification` in "ProductAncillary" (3 values) - `ProductRef` (string) The product ref this PriceBreakdown applies to. If no productRef exists then the PriceBreakdown applies to all Products within the Offer. Example: "p_1" - `Discount` (object) NDC only; not supported for GDS. Returned for a fare discounted from the published price, such as a promotional discount. Not returned for privately negotiated discounts such as private fares. - `Discount.value` (number) The amount value of the discount Example: 20.22 - `Discount.description` (string) The text description for the discount. Example: "Spring discount on group bookings" - `Discount.currencyCode` (string, required) Currency code discount is returned in. Example: "USD" - `Discount.codeAuthority` (string, required) Not used. Currency code Authority. Example: "ISO" - `Discount.decimalPlace` (integer, required) Number of decimal places in the currency the discount is returned in. Example: 2 - `Discount.decimalAuthority` (string) Not used. Decimal Authority. Example: "ISO" - `TravelerIdentifierRef` (object) Identifier references as object both within a message payload or an object held in cache that may be used for subsequent workflows. Returned for NDC in the Price response if age was sent for this traveler in the previous workflow requests. - `TravelerIdentifierRef.name` (string) Traveler identifier - `TravelerIdentifierRef.passengerTypeCode` (string) Passenger Type code Example: "ADT" - `TravelerIdentifierRef.ages` (array) The ages of the travelers associated to a particular ptc. For NDC, this value will be returned in PriceBreakdownAir if sent as part of the PassengerCriteria in the Air Search request. Example: [15] - `TravelerIdentifierRef.passengerCriteriaRef` (string) Allows the user to associate passenger criteria information. Example: "passengerCriteria_1" - `TravelerIdentifierRef.value` (string) - `TravelerIdentifierRef.id` (string) A locally referenced ID - `TravelerIdentifierRef.description` (string) Descriptive text used to identify the contents of a target object - `TravelerIdentifierRef.uris` (array) Uniform Resource Identifier Example: ["google.com"] - `TravelerIdentifierRef.age` (integer) Replaced with ages array. The age of the traveler. Example: 11 - `AncillaryPriceApplicationCode` (object) Determines how an ancillary price has been built. - `AncillaryPriceApplicationCode.value` (string) Example: "3" - `AncillaryPriceApplicationCode.application` (string) Associated text. Example: "PerItem" - PriceBreakdownHospitality: - `roomPricingType` (string) A string provided by the hotel to describe how a service is priced, such as per night or per stay. Enum: same as `roomPricingType` in "PriceBreakdownHospitality" (5 values) - `Description` (string) Example: "Advance Purchase-Ro-Free WiFi" - `NightlyRate` (array) - `NightlyRate.@type` (string) - `NightlyRate.startDate` (string, required) Start date for the nightly rate in YYYY-MM-DD format. - `NightlyRate.nights` (integer) Number of nights the nightly rate is valid. - `NightlyRate.Amount` (object, required) Amount represents the cost applied - `AverageNightlyRate` (array) The average nightly rate for a given offer. - `AverageNightlyRate.value` (number) The amount of a given currency. Example: 124.56 - `AverageNightlyRate.code` (string) An ISO 4217 alpha character code (3 characters) that specifies a money unit. Example: "USD" - `AverageNightlyRate.minorUnit` (integer) Minor units are a mechanism for expressing the relationship between a major currency unit and its corresponding minor currency unit. It is the smallest unit of a given currency. For example; the smallest denomination in USD is the cent, which is 1/100 of a USD, and the minor unit value is 2. Not all currencies have a minor unit. Example: 2 - `AverageNightlyRate.currencySource` (string) The system requesting or returning the currency code specified in the attribute Enum: same as `MinimumAdcolAmount.currencySource` in "ChangePermitted" (3 values) - `AverageNightlyRate.approximateInd` (boolean) "If true, the currency amount has been converted from the original amount. For Air Exchange Eligibility, returned only if a currency is converted. If returned, the value is always true, indicating that the fee is approximate because of currency conversion. For Hotel Availability and Rules, true indicates this is a calculated value; false indicates this is the value returned by the property." Example: true - `AmenitySurcharges` (object) Amenity Surcharges information. - `AmenitySurcharges.@type` (string, required) Discriminator classes AmenitySurcharges or AmenitySurchargesDetail Example: "AmenitySurchargesDetail" - `AmenitySurcharges.TotalSurcharges` (number) A monetary amount, up to 4 decimal places. Decimal place needs to be included. Example: 211.11 - `AmenitySurcharges.approximateInd` (boolean) if true, the surcharge amounts are approximate - `AmenitySurcharges.Surcharge` (array, required) - `priceChangesDuringStayInd` (boolean) "If true, indicates the price changes at least once during requested dates. If roomPricingType = Per night, multiple instances of priceChangesDuringStayInd are returned." - `shortRateDescription` (string) A normalized rate description for comparing rates across multiple aggregators. Example: "Flexible Rate" - PriceBreakdownVehiclePrice: - `VehiclePrice` (object, required) Rate summary for rental of the vehicle. - `VehiclePrice.@type` (string, required) Example: "VehiclePrice" - `VehiclePrice.id` (string) Internal ID - `VehiclePrice.rateSource` (string) Assigned Type: c-1100:StringTiny - `VehiclePrice.rateGuaranteedInd` (boolean) Assigned Type: c-1100:OptionalIndicator - `VehiclePrice.ratePeriod` (string) The time period for a rate such as daily, weekly, monthly Enum: same as `VehiclePrice.ratePeriod` in "PriceBreakdownVehiclePrice" (15 values) - `VehiclePrice.RateDistance` (object) Rate for the period defined by the attributes - `VehiclePrice.RateDistance.value` (number) - `VehiclePrice.RateDistance.unlimitedDistanceInd` (boolean) if true unlimited miles is included with the rental - `VehiclePrice.RateDistance.requestedCodeAppliedInd` (boolean) if true, the requested code has been applied - `VehiclePrice.RateDistance.allowance` (integer) The distance allowance permitted with this rate. Use in combination with distanceUnits and ratePeriod - `VehiclePrice.RateDistance.distanceUnits` (string) For Hotels: Optional object to request either miles or kilometers for the search radius from the specified location. If unitOfDistance is not specified, the search defaults to miles for properties in the United States, Myanmar, and Liberia. The search defaults to kilometers in all other countries. Enum: same as `Vehicle.VehicleDateLocation.RentalPickup.GeoLocation.altitudeUnitOfDistance` in "ProductVehicle" (2 values) - `VehiclePrice.RateDistance.ratePeriod` (string) The time period for a rate such as daily, weekly, monthly Enum: same as `VehiclePrice.ratePeriod` in "PriceBreakdownVehiclePrice" (15 values) - `VehiclePrice.RateDescription` (array) - `sequence` (integer) The order of the text block, if there are more than one block. Example: 2 - `description` (string) Text block detail description Example: "description" - `Image` (object) Each instance is one image and its accompanying details, including a link to the image. Key value pairs; not all may be returned. - `URL` (string) A URL for this block - `DateCreateModify` (object, required) Time stamp of the creation. - `VehiclePrice.RateAvailability` (string) Options are available to sell, need to call, or closed Enum: same as `VehiclePrice.RateAvailability` in "PriceBreakdownVehiclePrice" (3 values) - `VehiclePrice.SupplierRate` (object, required) Estimated total amount - Monetary amounts expressed in another currency. - `VehiclePrice.SupplierRate.@type` (string, required) Example: "SupplierRate" - `VehiclePrice.SupplierRate.BaseRate` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.SupplierRate.RateForPeriod` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.SupplierRate.DropOffCharge` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.SupplierRate.ExtraMileageCharge` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.SupplierRate.EstimatedTotalAmount` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.ApproximateRate` (object) Estimated total amount - Monetary amounts expressed in another currency. - `VehiclePrice.ApproximateRate.@type` (string, required) Example: "ApproximateRate" - `VehiclePrice.ApproximateRate.BaseRate` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.ApproximateRate.RateForPeriod` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.ApproximateRate.DropOffCharge` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.ApproximateRate.ExtraMileageCharge` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.ApproximateRate.EstimatedTotalAmount` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.CustomerLoyalty` (object) Specifies the ID for the membership program. Object for sending customer loyalty information, such as for a frequent flyer program. For Hotel send the loyalty card number in the value field, followed by programID with the hotel chain code, and supplierType: Hotel. For Air send the loyalty card number in the value field, followed by airline code in "supplier". For cross accrual use the "shareWithSupplier" field to submit to partner airlines. - `VehiclePrice.CustomerLoyalty.value` (string, required) Number on loyalty card. Example: "132456" - `VehiclePrice.CustomerLoyalty.id` (string) Optional Customer Loyalty Id. Not saved Example: "Loyalty_1" - `VehiclePrice.CustomerLoyalty.priority` (integer) Optional Numeric Priority Code Example: 2 - `VehiclePrice.CustomerLoyalty.programId` (string) "Specifies an identifier to indicate the company owner of the loyalty program. Typically two characters. For frequent guest number, the hotel supplier or brand code. For frequent flyer number, the air supplier code of the loyalty program." Example: "HY" - `VehiclePrice.CustomerLoyalty.programName` (string) Supplier's loyalty program name. Example: "Frontier-EarlyReturns" - `VehiclePrice.CustomerLoyalty.supplierType` (string) The type of supplier of a loyalty program. Uses 'hotel' for frequent guest number or 'air' for frequent flyer number. Example: "Hotel" - `VehiclePrice.CustomerLoyalty.supplier` (string) Supplier of a loyalty program (typically 2 characters representing the hotel, brand, or airline). Example: "UA" - `VehiclePrice.CustomerLoyalty.tier` (string) Customer Loyalty tier Example: "Silver" - `VehiclePrice.CustomerLoyalty.shareWithSupplier` (array) The list of suppliers that the CustomerLoyalty number is shared. Used for cross accrual. Example: ["LH"] - `VehiclePrice.CustomerLoyalty.cardHolderName` (string) Customer loyalty member name; up to 128 characters are supported. In Air Search, for discounted offers to be returned, the name must be sent as LAST FIRST; e.g.,if SMITH is the last name and JORDAN the first name, send as SMITH JORDAN Example: "John Smith" - `VehiclePrice.CustomerLoyalty.validatedInd` (boolean) Customer loyalty number has been validated by the supplier Example: true - `VehiclePrice.CustomerLoyalty.prefix` (string) The cardholder name prefix title like Mr, Mrs, Dr Example: "Dr" - `VehiclePrice.CustomerLoyalty.given` (string) The First Name of the Cardholder Example: "John" - `VehiclePrice.CustomerLoyalty.middle` (string) Middle Name of the Cardholder Example: "Wilkinson" - `VehiclePrice.CustomerLoyalty.surname` (string) Last Name of the Cardholder Example: "Smith" - `VehiclePrice.RateQualifier` (string) A closed enumeration of possible rate qualifiers for vehicle rental Enum: same as `VehiclePrice.RateQualifier` in "PriceBreakdownVehiclePrice" (5 values) - `rateGuaranteedInd` (boolean) - PriceBreakdownVehicleDeposit: - `totalPayableNowInd` (boolean) If True the Amount is the total amount payable now - `totalPayableLaterInd` (boolean) If True the Amount is the total amount payable later - PriceBreakdownVehicleCharges: - `VehicleCharges` (object) - `VehicleCharges.@type` (string, required) Example: "VehicleCharges" - `VehicleCharges.description` (string) Assigned Type: c-1100:String - `VehicleCharges.VehicleChargePurposeCode` (object) Any code used to specify an item, for example a type of traveler, service code, room amenity, etc. - `VehicleCharges.VehicleChargePurposeCode.value` (string) Example: "INS" - `VehicleCharges.VehicleChargePurposeCode.codeContext` (string) Code Context Example: "ACRISS" - `VehicleCharges.ratePeriod` (string) The time period for a rate such as daily, weekly, monthly Enum: same as `VehiclePrice.ratePeriod` in "PriceBreakdownVehiclePrice" (15 values) - `VehicleCharges.rateChargeInfo` (string) Assigned Type: c-1100:String - `VehicleCharges.RateCategory` (string) For Hotel Search, request a rate category by sending up to 8 OTA rate categories to search for. If the supplier has rates available for the requested category, the response contains those rates and indicates them as such. Some properties do not return these rates unless explicitly requested. For a Hotel Rules request, this value can be found, if returned, in the Availability response's ProductRateCodeInfo/RateCodeInfo/rateCategory. Enum: same as `VehicleCharges.RateCategory` in "PriceBreakdownVehicleCharges" (32 values) - `VehicleCharges.VehicleCoverageTypeCode` (object) The OTA code defined for the Vehicle Coverage Type - `VehicleCharges.VehicleCoverageTypeCode.value` (string) Example: "INS" - `VehicleCharges.VehicleCoverageTypeCode.codeContext` (string) Code Context Example: "ACRISS" - `VehicleCharges.Calculation` (array) - `VehicleCharges.taxInclusiveInd` (boolean) - `VehicleCharges.guaranteedInd` (boolean) - `VehicleCharges.payNowInd` (boolean) If true the vehicle charge must be paid now and is included in the totalPrice calculation - `VehicleCharges.includedInEstimatedTotalInd` (boolean) - `VehicleCharges.includedInBaseRateInd` (boolean) If true the Vehicle Charge has been included in the base rate of the Vehicle price - `PriceBreakdown.@type` (string, required) Discriminator - Air Search and Air Price APIs child classes are PriceBreakdownAir and PriceBreakdownAncillary. - Search Ancillaries and Seat Availabilities child classes are PriceBreakdown, PriceBreakdownAncillary, and PriceBreakdownAncillaryAir. - All Hotel API child classes are PriceBreakdownHospitality. - Vehicle API child classes are PriceBreakdownVehicleCharges, PriceBreakdownVehicleDeposit, PriceBreakdownVehiclePrice, and PriceBreakdownAncillaryVehicle. - Reservation and Reservation Workbench APIs are PriceBreakdownAir, PriceBreakdownAncillary, PriceBreakdownHospitality, PriceBreakdownVehicleCharges, PriceBreakdownVehicleDeposit, PriceBreakdownVehiclePrice, and PriceBreakdownAncillaryVehicle. Example: "PriceBreakdownAir" - `PriceBreakdown.Amount` (object) Amount represents the cost applied - `PriceBreakdown.Amount.@type` (string) - `PriceBreakdown.Amount.currencySource` (string) The system requesting or returning the currency code specified in the attribute Enum: same as `MinimumAdcolAmount.currencySource` in "ChangePermitted" (3 values) - `PriceBreakdown.Amount.CurrencyCode` (object) Currency codes are the three-letter alphabetic codes that represent the various currencies used throughout the world. Unless changed in the request, the currency is the default associated with your provisioned PCC from Travelport. For Hotel: SourceCurrency is based on the location of the hotel and used for all rates in the response. TargetCurrency is the currency code sent in the request in requestedCurrency. - `PriceBreakdown.Amount.Base` (number) The base price prior to all applicable taxes or fees of a product, such as the amount for a room or fare for a flight (one passenger). Example: 120.2 - `PriceBreakdown.Amount.Taxes` (object) Summary of all individual taxes. Child class TaxesDetail provides the breakdown of individual taxes. - `PriceBreakdown.Amount.Fees` (object) Includes TotalFees object to return the sum total of any fees. May include array of Fee objects to break down individual fees. Child class FeesDetail may also include a breakdown of the individual fees. - `PriceBreakdown.Amount.Total` (number) "Specifies the total price including base + taxes + fees. In PriceBreakdownHospitality, this total is for a given group of nights. In PriceBreakdownAir this is the total of base cost and all fees and taxes for one passenger of this PTC type." Example: 230.13 - `PriceBreakdown.Amount.approximateInd` (boolean) if true this amount has been converted from the original amount Example: true - `PriceBreakdown.Commission` (object) — one of (discriminator: @type): GDS only; not supported for NDC. Commission information. Any commission filed by an airline in a CAT35 fare is returned in PriceBreakdownAir/Commission. The amount is either a percent of the fare component (@type CommissionPercent and the Percent object) or an amount (@type CommissionAmount and the Amount object)." - CommissionAmount: - `Amount` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - CommissionPercent: - `Percent` (number) Percent amount of commission Example: 20 - `PriceBreakdown.Commission.@type` (string, required) Discriminator. Child classes CommissionAmount or CommissionPercent Example: "CommissionAmount" - `PriceBreakdown.Commission.application` (string) Type of commission Enum: same as `PriceBreakdown.Commission.application` (6 values) - `Offer.Price.@type` (string, required) Discriminator classes Price or PriceDetail Example: "PriceDetail" - `Offer.Price.id` (string) Internally referenced id Example: "2" - `Offer.Price.CurrencyCode` (object) Currency codes are the three-letter alphabetic codes that represent the various currencies used throughout the world. Unless changed in the request, the currency is the default associated with your provisioned PCC from Travelport. For Hotel: SourceCurrency is based on the location of the hotel and used for all rates in the response. TargetCurrency is the currency code sent in the request in requestedCurrency. - `Offer.Price.CurrencyCode.value` (string) An ISO 4217 currency code. Example: "USD" - `Offer.Price.CurrencyCode.codeAuthority` (string) Currency code authority Example: "ISO 4217" - `Offer.Price.CurrencyCode.decimalPlace` (integer) Number of decimal places for the currency. Example: 4 - `Offer.Price.CurrencyCode.decimalAuthority` (string) Currency code decimal authority Example: "ISO 4217" - `Offer.Price.Base` (number) "Base price before taxes and fees. For Hotel, may not be returned by all suppliers." Example: 20.2 - `Offer.Price.TotalTaxes` (number) "Total taxes applied to the base price. For Hotel, may not be returned by all suppliers." Example: 34.4 - `Offer.Price.TotalFees` (number) Total fees included in Total Price. Example: 201 - `Offer.Price.TotalPrice` (number) Total price of this offer including the base price and all taxes and fees. Example: 34 - `Offer.Price.VendorCurrencyTotal` (object) No longer used. Previously used to expose the local vendor currency when it is different to the purchased currency - `Offer.Price.VendorCurrencyTotal.@type` (string) - `Offer.Price.VendorCurrencyTotal.currencySource` (string) The system requesting or returning the currency code specified in the attribute Enum: same as `MinimumAdcolAmount.currencySource` in "ChangePermitted" (3 values) - `Offer.Price.VendorCurrencyTotal.CurrencyCode` (object) Currency codes are the three-letter alphabetic codes that represent the various currencies used throughout the world. Unless changed in the request, the currency is the default associated with your provisioned PCC from Travelport. For Hotel: SourceCurrency is based on the location of the hotel and used for all rates in the response. TargetCurrency is the currency code sent in the request in requestedCurrency. - `Offer.Price.VendorCurrencyTotal.Base` (number) The price prior to all applicable taxes of a product such as the rate for a room or fare for a flight. Example: 120.2 - `Offer.Price.VendorCurrencyTotal.Taxes` (object) Summary of all individual taxes. Child class TaxesDetail provides the breakdown of individual taxes. - `Tax` (array) - `TaxPercent` (object) Returned when the tax is expressed as a percentage of the amount. - `TaxPercent.value` (number) The tax percentage amount. Example: 5.5 - `TaxPercent.taxCode` (string) Any code for the tax. Example: "971 - IRS Notice" - `TaxPercent.reportingAuthority` (string) Tax reporting authority Example: "Georgia Department of Revenue" - `TaxPercent.purpose` (string) Purpose of tax Example: "statutory tax" - `TaxPercent.description` (string) Description Example: "1.5% of SGST" - `TaxPercent.includedInBase` (string) Yes , No , Unknown Enum: same as `instantPurchase` in "AdvanceReservationRequired" (3 values) - `Offer.Price.VendorCurrencyTotal.Taxes.@type` (string, required) Discriminator class is TaxesDetail Example: "TaxesDetail" - `Offer.Price.VendorCurrencyTotal.Taxes.TotalTaxes` (number) A monetary amount, representing the total of all taxes included in this offer. Supports up to 4 decimal places; decimal place must be included. Example: 330.1 - `Offer.Price.VendorCurrencyTotal.Taxes.TaxInfo` (array) Returned for TripChange APIS only. - `Offer.Price.VendorCurrencyTotal.Fees` (object) Includes TotalFees object to return the sum total of any fees. May include array of Fee objects to break down individual fees. Child class FeesDetail may also include a breakdown of the individual fees. - `Fee` (array) Array of individual fees. - `Offer.Price.VendorCurrencyTotal.Fees.@type` (string, required) Discriminator. Child class FeesDetail Example: "FeesDetail" - `Offer.Price.VendorCurrencyTotal.Fees.TotalFees` (number) Total fees included in the TotalPrice. Supports up to 4 decimal places; decimal place needs to be included. Example: 111.11 - `Offer.Price.VendorCurrencyTotal.Fees.TotalAdditionalFeesPayableLocally` (number) Fees due separately at the property. Expected to be paid in local currency. These fees are not included in the Offer TotalPrice. Example: 2.1 - `Offer.Price.VendorCurrencyTotal.Total` (number) Specifies the total price including base + taxes + fees Example: 30.13 - `Offer.Price.VendorCurrencyTotal.approximateInd` (boolean) True if this amount has been converted from the original amount Example: true - `Offer.TermsAndConditionsFull` (array) — one of (discriminator: @type): - TermsAndConditionsFull: - `ExpiryDate` (string) The date and time in UTC the offer will no longer be valid. Example: "2022-08-07T12:12:00Z" - `CustomerLoyalty` (array) - `CustomerLoyalty.value` (string, required) Number on loyalty card. Example: "132456" - `CustomerLoyalty.id` (string) Optional Customer Loyalty Id. Not saved Example: "Loyalty_1" - `CustomerLoyalty.priority` (integer) Optional Numeric Priority Code Example: 2 - `CustomerLoyalty.programId` (string) "Specifies an identifier to indicate the company owner of the loyalty program. Typically two characters. For frequent guest number, the hotel supplier or brand code. For frequent flyer number, the air supplier code of the loyalty program." Example: "HY" - `CustomerLoyalty.programName` (string) Supplier's loyalty program name. Example: "Frontier-EarlyReturns" - `CustomerLoyalty.supplierType` (string) The type of supplier of a loyalty program. Uses 'hotel' for frequent guest number or 'air' for frequent flyer number. Example: "Hotel" - `CustomerLoyalty.supplier` (string) Supplier of a loyalty program (typically 2 characters representing the hotel, brand, or airline). Example: "UA" - `CustomerLoyalty.tier` (string) Customer Loyalty tier Example: "Silver" - `CustomerLoyalty.shareWithSupplier` (array) The list of suppliers that the CustomerLoyalty number is shared. Used for cross accrual. Example: ["LH"] - `CustomerLoyalty.cardHolderName` (string) Customer loyalty member name; up to 128 characters are supported. In Air Search, for discounted offers to be returned, the name must be sent as LAST FIRST; e.g.,if SMITH is the last name and JORDAN the first name, send as SMITH JORDAN Example: "John Smith" - `CustomerLoyalty.validatedInd` (boolean) Customer loyalty number has been validated by the supplier Example: true - `CustomerLoyalty.prefix` (string) The cardholder name prefix title like Mr, Mrs, Dr Example: "Dr" - `CustomerLoyalty.given` (string) The First Name of the Cardholder Example: "John" - `CustomerLoyalty.middle` (string) Middle Name of the Cardholder Example: "Wilkinson" - `CustomerLoyalty.surname` (string) Last Name of the Cardholder Example: "Smith" - `TextBlock` (array) A list of free text terms and conditions. - `sequence` (integer) The order of the text block, if there are more than one block. Example: 2 - `description` (string) Text block detail description Example: "description" - `Image` (object) Each instance is one image and its accompanying details, including a link to the image. Key value pairs; not all may be returned. - `Image.value` (string) URL of the image - `Image.dimensionCategory` (string) Deprecated and replaced by imageSize - `Image.width` (integer) Image width Example: 42 - `Image.height` (integer) Image height Example: 43 - `Image.caption` (string) Image caption Example: "Ticket" - `Image.pictureCategory` (integer) deprecated and replaced by pictureOf Example: 5 - `Image.imageSize` (string) A size for the image to return, allowing you to set image quality. Hospitality APIs no longer support thumbnail. Enum: same as `Vehicle.Image.imageSize` in "ProductVehicle" (5 values) - `Image.pictureOf` (string) The image category Enum: same as `Vehicle.Image.pictureOf` in "ProductVehicle" (26 values) - `URL` (string) A URL for this block - `DateCreateModify` (object, required) Time stamp of the creation. - `DateCreateModify.value` (string) Example: "2026-03-04T11:22:00Z" - `DateCreateModify.creatorID` (string) ID of creator. Software system identifier or an employee id Example: "c1234563" - `DateCreateModify.lastModify` (string) Time stamp of last modification. Example: "2026-03-04T11:24:00Z" - `DateCreateModify.lastModifierID` (string) Identifies the last software system or person to modify a record Example: "m346789" - `DateCreateModify.purge` (string) Date an item will be purged from a system of record Example: "2026-03-03" - `TextBlock.@type` (string, required) Discriminator classes TextBlock or TextBlockDetail Example: "TextBlockDetail" - `TextBlock.title` (string) "The title of the rule or information. For TermsAndConditionsFullHospitality, may include any of the following Rule Types; Promotional Data, Rate Description, Room Rate Data, Rate Text, Guarantee, Cancellation, Deposit, Check in/out, Room detail, Extra charges, Packages, Property, Location, Miscellaneous, Rate Amount, Alternate Rate Amount, Rate Comment, FAX, Phone, Special Information, Information, Room Hold Expiration Time. Not every property returns all of these types. Some properties do not return any title. Only English is supported for these values." Example: "Baggage Details" - `TextBlock.id` (string) Internally referenced id Example: "2" - `TextBlock.TextFormatted` (array, required) - TermsAndConditionsFullSummary: - `ExpiryDate` (string) The data and time the offer will expire Example: "2022-08-07T12:12:00Z" - `CustomerLoyalty` (array) - `CustomerLoyalty.value` (string, required) Number on loyalty card. Example: "132456" - `CustomerLoyalty.id` (string) Optional Customer Loyalty Id. Not saved Example: "Loyalty_1" - `CustomerLoyalty.priority` (integer) Optional Numeric Priority Code Example: 2 - `CustomerLoyalty.programId` (string) "Specifies an identifier to indicate the company owner of the loyalty program. Typically two characters. For frequent guest number, the hotel supplier or brand code. For frequent flyer number, the air supplier code of the loyalty program." Example: "HY" - `CustomerLoyalty.programName` (string) Supplier's loyalty program name. Example: "Frontier-EarlyReturns" - `CustomerLoyalty.supplierType` (string) The type of supplier of a loyalty program. Uses 'hotel' for frequent guest number or 'air' for frequent flyer number. Example: "Hotel" - `CustomerLoyalty.supplier` (string) Supplier of a loyalty program (typically 2 characters representing the hotel, brand, or airline). Example: "UA" - `CustomerLoyalty.tier` (string) Customer Loyalty tier Example: "Silver" - `CustomerLoyalty.shareWithSupplier` (array) The list of suppliers that the CustomerLoyalty number is shared. Used for cross accrual. Example: ["LH"] - `CustomerLoyalty.cardHolderName` (string) Customer loyalty member name; up to 128 characters are supported. In Air Search, for discounted offers to be returned, the name must be sent as LAST FIRST; e.g.,if SMITH is the last name and JORDAN the first name, send as SMITH JORDAN Example: "John Smith" - `CustomerLoyalty.validatedInd` (boolean) Customer loyalty number has been validated by the supplier Example: true - `CustomerLoyalty.prefix` (string) The cardholder name prefix title like Mr, Mrs, Dr Example: "Dr" - `CustomerLoyalty.given` (string) The First Name of the Cardholder Example: "John" - `CustomerLoyalty.middle` (string) Middle Name of the Cardholder Example: "Wilkinson" - `CustomerLoyalty.surname` (string) Last Name of the Cardholder Example: "Smith" - `TextBlock` (array) - `sequence` (integer) The order of the text block, if there are more than one block. Example: 2 - `description` (string) Text block detail description Example: "description" - `Image` (object) Each instance is one image and its accompanying details, including a link to the image. Key value pairs; not all may be returned. - `Image.value` (string) URL of the image - `Image.dimensionCategory` (string) Deprecated and replaced by imageSize - `Image.width` (integer) Image width Example: 42 - `Image.height` (integer) Image height Example: 43 - `Image.caption` (string) Image caption Example: "Ticket" - `Image.pictureCategory` (integer) deprecated and replaced by pictureOf Example: 5 - `Image.imageSize` (string) A size for the image to return, allowing you to set image quality. Hospitality APIs no longer support thumbnail. Enum: same as `Vehicle.Image.imageSize` in "ProductVehicle" (5 values) - `Image.pictureOf` (string) The image category Enum: same as `Vehicle.Image.pictureOf` in "ProductVehicle" (26 values) - `URL` (string) A URL for this block - `DateCreateModify` (object, required) Time stamp of the creation. - `DateCreateModify.value` (string) Example: "2026-03-04T11:22:00Z" - `DateCreateModify.creatorID` (string) ID of creator. Software system identifier or an employee id Example: "c1234563" - `DateCreateModify.lastModify` (string) Time stamp of last modification. Example: "2026-03-04T11:24:00Z" - `DateCreateModify.lastModifierID` (string) Identifies the last software system or person to modify a record Example: "m346789" - `DateCreateModify.purge` (string) Date an item will be purged from a system of record Example: "2026-03-03" - `TextBlock.@type` (string, required) Discriminator classes TextBlock or TextBlockDetail Example: "TextBlockDetail" - `TextBlock.title` (string) "The title of the rule or information. For TermsAndConditionsFullHospitality, may include any of the following Rule Types; Promotional Data, Rate Description, Room Rate Data, Rate Text, Guarantee, Cancellation, Deposit, Check in/out, Room detail, Extra charges, Packages, Property, Location, Miscellaneous, Rate Amount, Alternate Rate Amount, Rate Comment, FAX, Phone, Special Information, Information, Room Hold Expiration Time. Not every property returns all of these types. Some properties do not return any title. Only English is supported for these values." Example: "Baggage Details" - `TextBlock.id` (string) Internally referenced id Example: "2" - `TextBlock.TextFormatted` (array, required) - `Offer.TermsAndConditionsFull.@type` (string, required) Discriminator - Air Price child classes are TermsAndConditionsFullAir and TermsAndConditionsFullAncillary. - Hotel Rules and Reservation class is TermsAndConditionsFullHospitality. - Vehicle Rules and Reservation class is TermsAndConditionsFullVehicle. - Reservation and Reservation Workbench APIs child classes are TermsAndConditionsFullAir, TermsAndConditionsFullAncillary, TermsAndConditionsFullHospitality, TermsAndConditionsFullVehicle, TermsAndConditionsFullVehicle, and TermsAndConditionsFullScheduleChange. Example: "TermsAndConditionsFullAir" - `Offer.TermsAndConditionsFull.id` (string) Local identifier within a given message for this object. Example: "TC_1" - `Offer.TermsAndConditionsFull.termsAndConditionsRef` (string) Used to reference another instance of this object in the same message. Example: "TC_1" - `Offer.TermsAndConditionsFull.Identifier` (object) A globally unique identifier key often used to reference a given option (such as Pricing, Booking, Rules, or additional workflows) or to retrieve information (such as Hotel pagination). - `Offer.passiveOfferInd` (boolean) Indicates aggregator segment built into PNR. Always send with true when using in a request. If returned true in a response, the Offer is passive for booking purposes. Example: true - `Offer.scheduleChangeInd` (boolean) If true, this Offer is subject to a schedule change. - ReferenceListBrand: - `Brand` (array) Each instance provides details for one BrandRef id. - `Brand.@type` (string, required) Discriminator. Child classes BrandID and Brand. BrandCompleteInfo is no longer in use. Example: "BrandID" - `Brand.id` (string) Local id within a given message to support referencing this object. Example: "brand_001" - `Brand.BrandRef` (string) Reference id that corresponds to the brand 'id' in ReferenceListBrand.Brand. Example: "brandRef_001" - `Brand.Identifier` (object) A globally unique identifier key often used to reference a given option (such as Pricing, Booking, Rules, or additional workflows) or to retrieve information (such as Hotel pagination). - `Brand.name` (string, required) Brand name from the supplier. Example: "Main Cabin Extra" - `Brand.tier` (integer) The brand tier. Not returned for NDC. Example: 2 - `Brand.shelfNumbers` (array) ATPCO shelf number. If the carrier has provided it for this brand, the shelf number is the number for a grouping of comparable brands that share similar ticket and flight attributes. Example: [1,4,5] - `Brand.code` (string) The ATPCO Brand Code. Example: "REFMAIN" - `Brand.BrandAttribute` (array) A list of enumerated features that are included, chargeable, or not offered for this brand. Contains one or more instances of the two paired key value pairs classification and inclusion. The return of brand attributes can be disabled in the AirPrice Reference Payload request. - `Brand.BrandAttribute.@type` (string, required) Discriminator. No child classes. Example: "BrandAttribute" - `Brand.BrandAttribute.classification` (string, required) The Travelport classification used for a category of ancillaries. Additional items can be sent in AdditionalClassification Enum: same as `BrandAttribute.classification` (11 values) - `Brand.BrandAttribute.inclusion` (string, required) The indicator as to how the brand and the product are associated. Enum: same as `BrandAttribute.inclusion` (3 values) - `Brand.BrandAttribute.ImageURL` (array) URL for an image for the brand, when available. Example: ["http:/imageurl.com"] - `Brand.BrandAttribute.matchedAttributeInd` (boolean) Returned only if true for any attribute requested in ProductInclusionPreference.Classification. Example: true - `Brand.BrandAttribute.groupCode` (string) Carrier group code. Returned if filed by the carrier. Example: "BG" - `Brand.BrandAttribute.subGroupCode` (string) Carrier sub group code. Returned if filed by the carrier. Example: "CY" - `Brand.BrandAttribute.subCode` (string) Carrier sub code. Returned if filed by the carrier. Example: "08A" - `Brand.AdditionalBrandAttribute` (array) Array of non-enumerated features that are included, chargeable, or not offered for this brand. Contains one or more instances of the two paired key value pairs classification and inclusion. - `Brand.AdditionalBrandAttribute.@type` (string, required) Discriminator. No child classes. Example: "AdditionalBrandAttribute" - `Brand.AdditionalBrandAttribute.Classification` (string, required) The Travelport classification used for categories of ancillaries. Supported attributes currently include ChauffeurTransfer, ExtraLegroom, InFlightEntertainment, LoungeAccess, PriorityBaggage, PriorityBoarding, PriorityCheckIn, PrioritySecurity, PriorityServices,MileageAccrual, Upgrades, USB. Example: "ChauffeurTransfer" - `Brand.AdditionalBrandAttribute.Inclusion` (string, required) The indicator as to how the brand and the product are associated. Enum: same as `BrandAttribute.inclusion` (3 values) - `Brand.AdditionalBrandAttribute.ImageURL` (array) URL for an image for the brand, when available. Example: ["https:/travelport/image/profile/firstviewimage"] - `Brand.AdditionalBrandAttribute.matchedAttributeInd` (boolean) Returned only if true for any attribute requested in ProductInclusionPreference.Classification. Example: true - `Brand.AdditionalBrandAttribute.groupCode` (string) Carrier group code. Returned if filed by the carrier. Example: "BG" - `Brand.AdditionalBrandAttribute.subGroupCode` (string) Carrier sub group code. Returned if filed by the carrier. Example: "CY" - `Brand.AdditionalBrandAttribute.subCode` (string) Carrier sub code. Returned if filed by the carrier. Example: "08A" - `Brand.ImageURL` (array) Example: ["http:/imageurl.com"] - ReferenceListTermsAndConditions: - `TermsAndConditions` (array) — one of (discriminator: @type): - TermsAndConditionsAir: - `BaggageAllowance` (array) - `url` (string) Link to additional baggage policy information. Example: "https://airline/baggage" - `BaggageAllowance.@type` (string, required) Discriminator. Child class BaggageAllowanceDetail Example: "BaggageAllowanceDetail" - `BaggageAllowance.passengerTypeCodes` (array) All PTCs to which this allowance applies. Example: ["ADT"] - `BaggageAllowance.baggageType` (string) Identifies the type of baggage. Enum: same as `BaggageAllowance.baggageType` in "TermsAndConditionsAir" (5 values) - `BaggageAllowance.validatingAirlineCode` (string) The validating baggage airline code Example: "BA" - `BaggageAllowance.ProductRef` (array) The Product id/s to which this baggage allowance applies. Example: ["p1","p2"] - `BaggageAllowance.BaggageItem` (array) - `BaggageAllowance.BaggageItem.@type` (string) Example: "BaggageItem" - `BaggageAllowance.BaggageItem.quantity` (integer) The number of baggage items allowed. May be free or at a charge. Not returned for baggage allowances by weight. Example: 2 - `BaggageAllowance.BaggageItem.includedInOfferPrice` (string) Yes , No , Unknown Enum: same as `instantPurchase` in "AdvanceReservationRequired" (3 values) - `BaggageAllowance.BaggageItem.Measurement` (array) Measurement details for BaggageItem as available and applicable. Baggage measurements are not always returned. - measurementType: Type of measurement specified, such as weight, height, width, etc. - unit: Unit in which measurement is specified, such as Kilograms, Inches, Centimeters, etc. - value: The number of units allowed for this measurement type. NDC returns quantity and Measurement info for FirstCheckedBag, SecondCheckedBag, AdditionalBags, and CarryOn when returned by the NDC carrier. NDC returns measurements in structured format in the Search response when the NDC carrier returns them this way. Otherwise, the measurements are returned in Text. For GDS, baggage measurements are returned in Text. - `BaggageAllowance.BaggageItem.BaggageFee` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `BaggageAllowance.BaggageItem.BaggageFee.value` (number) The amount of a given currency. Example: 124.56 - `BaggageAllowance.BaggageItem.BaggageFee.code` (string) An ISO 4217 alpha character code (3 characters) that specifies a money unit. Example: "USD" - `BaggageAllowance.BaggageItem.BaggageFee.minorUnit` (integer) Minor units are a mechanism for expressing the relationship between a major currency unit and its corresponding minor currency unit. It is the smallest unit of a given currency. For example; the smallest denomination in USD is the cent, which is 1/100 of a USD, and the minor unit value is 2. Not all currencies have a minor unit. Example: 2 - `BaggageAllowance.BaggageItem.BaggageFee.currencySource` (string) The system requesting or returning the currency code specified in the attribute Enum: same as `MinimumAdcolAmount.currencySource` in "ChangePermitted" (3 values) - `BaggageAllowance.BaggageItem.BaggageFee.approximateInd` (boolean) "If true, the currency amount has been converted from the original amount. For Air Exchange Eligibility, returned only if a currency is converted. If returned, the value is always true, indicating that the fee is approximate because of currency conversion. For Hotel Availability and Rules, true indicates this is a calculated value; false indicates this is the value returned by the property." Example: true - `BaggageAllowance.BaggageItem.Text` (string) Any free text provided by carrier for baggage terms. May provide measurements for the allowed baggage dimension. When the baggage allowance is based on pieces, Text returns 0P, 1P, 2P, or 3P, defined as follows, for FirstCheckedBag, SecondCheckedBag, AdditionalBags, and/or CarryOn. - 0P: No free bags. - 1P: The FirstCheckedBag is free; the SecondCheckedBag has a fee. - 2P: Both the FirstCheckedBag and SecondCheckedBag are free. - 3P: Both the FirstCheckedBag and SecondCheckedBag are free, plus an additional checked bag (AdditionalBags) is free." Example: "UPTO15LB/7KG AND UPTO45LI/115LCM" - `BaggageAllowance.BaggageItem.soldByPieceInd` (boolean) Returned only if true. Indicates baggage allowance is by piece, such as one, two, or three pieces. Weight restrictions may also apply. - `BaggageAllowance.BaggageItem.soldByWeightInd` (boolean) Returned only if true. Indicates the baggage is allowed by weight, either kilograms or pounds, such as 50 pounds or 35 kilograms. Number of item restrictions may also apply. - `BaggageAllowance.SegmentSequenceList` (array) Segment/s on which this baggage allowance applies. Segment sequence is only to be used when the baggage allowance differs between segments within a product. If so, then the ProducRef must be specified. Example: [12,45,3,2] - `BaggageAllowance.Text` (array) Example: ["Blue baggage allowed","Purple baggage allowed"] - `FareRuleIdentifierRef` (object) Identifier references as object both within a message payload or an object held in cache that may be used for subsequent workflows. FareRuleIdentifierRef is deprecated and not in use. Use Fare Rule end points directly for detailed fare rules. - `FareRuleIdentifierRef.value` (string) - `FareRuleIdentifierRef.id` (string) A locally referenced ID - `FareRuleIdentifierRef.description` (string) Descriptive text used to identify the contents of a target object - `FareRuleIdentifierRef.uris` (array) Uniform Resource Identifier Example: ["google.com"] - `OrganizationInformation` (object) Use to send account codes for negotiated fares or to send optional India GST SSR Remarks in GSTRegistrationNumber. For NDC supports corporate loyalty program and GST Information. This information is returned in TermsAndConditions." - `OrganizationInformation.@type` (string, required) Discriminator. No child classes Example: "OrganizationInformation" - `OrganizationInformation.OrganizationIdentifier` (array) Array of account codes to return negotiated fares. The response returns an instance of TermsAndConditions/OrganizationInformation/OrganizationIdentifier for each account code sent. When FareSelection/fareType=PrivateFaresOnly and an account code is sent in OrganizationIdentifier, AirPrice ignores the account code. Instead, AirPrice returns any private fares available for that market and a booking code for your PCC. This prevents the return of an error message when no specific fare has been filed for that account code. - `OrganizationInformation.OrganizationIdentifier.value` (string) The value of the code to apply. Example: "JBD123456" - `OrganizationInformation.OrganizationIdentifier.supplier` (string) The IATA code for the airline on which the code is applicable. Example: "AA" - `OrganizationInformation.OrganizationIdentifier.organizationCodeType` (string) Sends a description for the OrganizationIdentifer value. For AirPrice, always send with a value of Account. Enum: same as `OrganizationInformation.OrganizationIdentifier.organizationCodeType` in "TermsAndConditionsAir" (4 values) - `OrganizationInformation.OrganizationIdentifier.segmentSequenceList` (array) Returned in response when the code is applicable to a specified segment sequence Example: [1,2,3] - `OrganizationInformation.OrganizationIdentifier.productRef` (array) Returned in response when the code is applicable to a specified product Example: ["product_1"] - `OrganizationInformation.OrganizationIdentifier.accountCodeFaresOnlyInd` (boolean) GDS only; not supported for NDC. Not supported in Standalone Price. Indicator to limit the fares returned to only fares filed for the specified account code. - If true: Limits the fares returned to only fares filed for that account code; must send with one or more account codes in OrganizationIdentifier/value. If sending multiple account codes, send each instance with accountCodeFaresOnlyInd set to true. - If false (default behavior): does not limit fares returned to any account code sent. If an account code is sent without accountCodeFaresOnlyInd=true, the response includes any fares filed for that account code plus fares that are not specific to the account code. If accountCodeFaresOnlyInd=true and no account code is sent, the indicator is ignored and the response returns all fares and a warning message that the request must include an account code. Note the following when also requesting private fares only: - FareSelection/fareType=PrivateFaresOnly and account code: Private fares are returned. - FareSelection/fareType=PrivateFaresOnly, accountCodeFaresOnlyInd=true, and account code: Any private fares specific to that account code are returned if available. If no private fares exist for that account code, an error message is returned. Note the following when also requesting net fares: - FareSelection/fareType=NetFaresOnly and account code: Net fares are returned. - FareSelection/fareType=NetFaresOnly, accountCodeFaresOnlyInd=true, and account code: Any net fares specific to that account code are returned if available. If no net fares exist for that account code, an error message is returned. Example: true - `OrganizationInformation.GSTRegistrationNumber` (array) Send to add India GST (Goods and Services Tax) Special Service Requests. In this case country should be IND. Supported during book 'Add Offer' workflow. See the [India GST SSRs](https://developer.travelport.com/docs/flights/guides/booking-and-reservations/remarks-and-service-requests#india-gst-ssr) in the Remarks & Service Requests Guide for important details. - `OrganizationInformation.GSTRegistrationNumber.value` (string, required) The GST registered number for the business. Example: "07AAGFF2194N1Z1" - `OrganizationInformation.GSTRegistrationNumber.telephone` (string, required) Business telephone number Example: "222-222-222" - `OrganizationInformation.GSTRegistrationNumber.address` (string, required) Business address Example: "1122 sample trail, CO, USA, 21232" - `OrganizationInformation.GSTRegistrationNumber.country` (string, required) IATA country code of the business. Example: "IND" - `OrganizationInformation.GSTRegistrationNumber.companyName` (string, required) Business name Example: "Adecco" - `OrganizationInformation.GSTRegistrationNumber.email` (string, required) Business E-Mail address Example: "sample@adecco.com" - `ValidatingAirline` (array) Each instance lists the carrier on which the ticket is issued. - `ValidatingAirline.@type` (string) Example: "ValidatingAirline" - `ValidatingAirline.SegmentSequenceList` (array) The segmentSequenceList the validatingCarrier applies to Example: [2,4,6,8,10] - `ValidatingAirline.ValidatingAirline` (string, required) Represents the airline responsible for ticketing\/fulfillment of this Offer Example: "QA" - `ValidatingAirline.ProductRef` (array) The productRef the validatingCarrier applies to Example: ["product1","product2","product3"] - `TicketingAgency` (array) If TicketingPCC was sent in the request to override the default ticketing agency, TicketingAgency returns the PCC of the overriding agency. If no override request was made, TicketingAgency returns the default PCC. GDS only; not supported for NDC. - `TicketingAgency.@type` (string) Example: "TicketingAgency" - `TicketingAgency.Code` (string, required) PCC of the overriding or default ticket agency. Example: "A561510" - `TicketingAgency.ProductRef` (array) Product references to which this ticketing agency PCC applies. If empty applies to all products within the offer. Example: ["p1","p2","p3"] - `TicketingAgency.SegmentSequenceList` (array) SegmentSequenceList the TicketingAgency applies to. If empty applies to all segments within the product. Example: [31,28,43,42,51,26] - `PaymentTimeLimit` (string) The local (per the point of sale) date and time by which the offer must be ticketed. Returned for GDS offers and some NDC airlines. Example: "2022-08-07T12:12:00Z" - `PromotionalCode` (object) NDC only. Not supported for GDS. Any NDC airline designated promotional code. - `PromotionalCode.value` (string) The promotional code to apply Example: "CDFRT" - `PromotionalCode.supplierCode` (string, required) The IATA code for the airline on which the promotional code is applicable. Example: "AA" - `Penalties` (array) Air Search returns change and cancel penalties for this set of terms and conditions. For GDS, Penalties are currently returned as the most restrictive CAT16 penalty details; NDC penalty rules are not necessarily filed in a specific category (CAT). Returned by default. Not returned if the optional indicator excludePenaltiesInd=true (GDS only), which omits penalty information from the response. Includes the PassengerTypeCodes object and either or both the Change and Cancel objects. Not all NDC carriers return penalty details. Some NDC carriers may not return Penalty/amount when a change is permitted, which means there is no charge for the change. - `Penalties.@type` (string, required) Discriminator. No child classes. Example: "Penalties" - `Penalties.Change` (array) — one of (discriminator: @type): Details about maximum or minimum change fees charged for changes to this itinerary. Returned in Penalties object with type ChangePermitted if a change is permitted after booking. - ChangeIndeterminate: - `IndeterminateInd` (string) Structured fare rules could not be determined for this category. Example: "true" - ChangePermitted: - `penaltyTypes` (array, required) Enum: same as `penaltyTypes` in "ChangePermitted" (8 values) - `PenaltyAppliesTo` (string) Returned in Change and Cancel objects to specify what the change or cancel penalty applies to. Enum: same as `PenaltyAppliesTo` in "ChangePermitted" (5 values) - `Penalty` (array) — one of (discriminator: @type): - PenaltyAmount: - `Amount` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - PenaltyPercent: - `Percent` (number) Percent of the fare charges for the penalty Example: 20 - `Penalty.@type` (string, required) Discriminator. Child classes PenaltyAmount or PenaltyPercent Example: "PenaltyAmount" - `Penalty.application` (string) Type of commission Enum: same as `PriceBreakdown.Commission.application` (6 values) - `higherPenatltyAppliesInd` (boolean) If true, when an amount and a percent are specified in the Penalty then the higher of these apply Example: true - `MinimumAdcolAmount` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `ChangeMethod` (string) Ticket must be reissued, revalidated or both Enum: same as `ChangeMethod` in "ChangePermitted" (3 values) - `ResidualValuePenalty` (string) List of Residual Value Penalty types. Enum: same as `ResidualValuePenalty` in "ChangePermitted" (4 values) - `PeriodBeforeDeparture` (object) The first occurrence (if day of week) or the unit of time - `PeriodBeforeDeparture.value` (integer) Example: 1 - `PeriodBeforeDeparture.period` (string) Defines the Units that can be applied to Stay restrictions. Enum: same as `PeriodBeforeDeparture.period` in "ChangePermitted" (11 values) - `PenaltyException` (object) The first occurrence (if day of week) or the unit of time - `PenaltyException.value` (integer) Example: 1 - `PenaltyException.period` (string) Defines the Units that can be applied to Stay restrictions. Enum: same as `PeriodBeforeDeparture.period` in "ChangePermitted" (11 values) - `PenaltyException.appliesAfterReservationInd` (boolean) If true, exception applies after reservation has been made - `PenaltyException.appliesAfterTicketingInd` (boolean) If true, exception applies after ticketing - ChangeNotPermitted: - `NotPermittedInd` (string) Changes are not permitted Example: "true" - `penaltyTypes` (array) Enum: same as `penaltyTypes` in "ChangePermitted" (8 values) - `PeriodBeforeDeparture` (object) The first occurrence (if day of week) or the unit of time - `PeriodBeforeDeparture.value` (integer) Example: 1 - `PeriodBeforeDeparture.period` (string) Defines the Units that can be applied to Stay restrictions. Enum: same as `PeriodBeforeDeparture.period` in "ChangePermitted" (11 values) - `taxesNonRefundableInd` (boolean) if true, for non-refundable fares taxes are also non-refundable. Example: true - `Penalties.Change.@type` (string, required) Discriminator. Child classes ChangePermitted, ChangeNotPermitted, and ChangeIndeterminate. Example: "ChangePermitted" - `Penalties.Change.ProductRefs` (array) List of product reference ids to which these penalties apply, if applicable only to specific products. Example: ["p1","p2"] - `Penalties.Change.SegmentSequence` (array) List of segment sequence numbers to which these penalties apply, if applicable only to specific segments. Example: [1] - `Penalties.Cancel` (array) — one of (discriminator: @type): Returned in Penalties object with type CancelPermitted if a cancellation is permitted after booking. - CancelIndeterminate: - `IndeterminateInd` (string) structured fare rules could not be determined for this category Example: "true" - CancelPermitted: - `penaltyTypes` (array, required) Enum: same as `penaltyTypes` in "ChangePermitted" (8 values) - `PenaltyAppliesTo` (string) Returned in Change and Cancel objects to specify what the change or cancel penalty applies to. Enum: same as `PenaltyAppliesTo` in "ChangePermitted" (5 values) - `Penalty` (array) — one of (discriminator: @type): - PenaltyAmount: - `Amount` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - PenaltyPercent: - `Percent` (number) Percent of the fare charges for the penalty Example: 20 - `Penalty.@type` (string, required) Discriminator. Child classes PenaltyAmount or PenaltyPercent Example: "PenaltyAmount" - `Penalty.application` (string) Type of commission Enum: same as `PriceBreakdown.Commission.application` (6 values) - `higherPenatltyAppliesInd` (boolean) If true, when an amount and a percent are specified in the Penalty then the higher of these apply Example: true - `MinimumAdcolAmount` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `ChangeMethod` (string) Ticket must be reissued, revalidated or both Enum: same as `ChangeMethod` in "ChangePermitted" (3 values) - `ResidualValuePenalty` (string) List of Residual Value Penalty types. Enum: same as `ResidualValuePenalty` in "ChangePermitted" (4 values) - `PeriodBeforeDeparture` (object) The first occurrence (if day of week) or the unit of time - `PeriodBeforeDeparture.value` (integer) Example: 1 - `PeriodBeforeDeparture.period` (string) Defines the Units that can be applied to Stay restrictions. Enum: same as `PeriodBeforeDeparture.period` in "ChangePermitted" (11 values) - `PenaltyException` (object) The first occurrence (if day of week) or the unit of time - `PenaltyException.value` (integer) Example: 1 - `PenaltyException.period` (string) Defines the Units that can be applied to Stay restrictions. Enum: same as `PeriodBeforeDeparture.period` in "ChangePermitted" (11 values) - `PenaltyException.appliesAfterReservationInd` (boolean) If true, exception applies after reservation has been made - `PenaltyException.appliesAfterTicketingInd` (boolean) If true, exception applies after ticketing - CancelNotPermitted: - `NotPermittedInd` (string) Cancel is not permitted Example: "true" - `penaltyTypes` (array) Enum: same as `penaltyTypes` in "ChangePermitted" (8 values) - `PeriodBeforeDeparture` (object) The first occurrence (if day of week) or the unit of time - `PeriodBeforeDeparture.value` (integer) Example: 1 - `PeriodBeforeDeparture.period` (string) Defines the Units that can be applied to Stay restrictions. Enum: same as `PeriodBeforeDeparture.period` in "ChangePermitted" (11 values) - `taxesNonRefundableInd` (boolean) if true, for non-refundable fares taxes are also non-refundable Example: true - `Penalties.Cancel.@type` (string, required) discriminator Example: "CancelPermitted" - `Penalties.Cancel.ProductRefs` (array) The product ids this cancel information applies to. Example: ["p1","p2"] - `Penalties.Cancel.SegmentSequence` (array) The list of any segment sequence numbers this cancelation information applies to. Example: [1] - `Penalties.Waiver` (array) Enum: same as `StructuredFareRules.Penalties.Waiver` in "FareRuleStructured" (6 values) - `Penalties.PenaltySourceCode` (object) The source of the penalty applied. - `Penalties.PenaltySourceCode.value` (string) Example: "Properties of the penalty" - `Penalties.PenaltySourceCode.codeContext` (string) Penalty source code context Example: "Context of the penalty source" - `Penalties.PassengerTypeCodes` (array) The passenger type codes that the penalties apply to. Example: ["ADT","CHD"] - `Penalties.involuntaryInd` (boolean) Penalties apply for involuntary changes initiated by the airline. Example: true - `Penalties.applyLeastRestrictiveInd` (boolean) If true, the least restrictive of the rule hierarchy is applied. Example: true - `Penalties.ruleNumber` (string) The rule number associated to this fare rule info. Example: "D38" - `Penalties.tariffNumber` (string) The tariff number associated to this fare rule info. Example: "01634" - `FareGuaranteePolicy` (array) - `FareGuaranteePolicy.@type` (string, required) discriminator Example: "FareGuaranteePolicy" - `FareGuaranteePolicy.passengerTypeCodes` (array) The list of passenger type codes Example: ["ADT","CHD"] - `FareGuaranteePolicy.EligibleforADMReview` (string, required) Yes , No , Unknown Enum: same as `instantPurchase` in "AdvanceReservationRequired" (3 values) - `FareGuaranteePolicy.Code` (object) Any code used to specify an item, for example a type of traveler, service code, room amenity, etc. - `FareGuaranteePolicy.Code.value` (string) Example: "INS" - `FareGuaranteePolicy.Code.codeContext` (string) Code Context Example: "ACRISS" - `PricingAgency` (array) - `PricingAgency.@type` (string) Discriminator. No child classes. Example: "PricingAgency" - `PricingAgency.ProductRef` (array) Product references to which this pricing agency PCC applies. If empty applies to all products within the offer. Example: ["p1"] - `PricingAgency.Code` (string, required) PCC of the overriding or default pricing agency. Example: "0XS4" - `PricingAgency.SegmentSequenceList` (array) SegmentSequence references to which this pricing agency PCC applies. If empty applies to all segments within the products. Example: [2,4,6,8,10] - `FlightPass` (array) - `FlightPass.@type` (string, required) Discriminator. No child classes Example: "FlightPass" - `FlightPass.accountNumber` (string, required) The flight pass account number Example: "0140851633093" - `FlightPass.supplier` (string, required) The flight pass supplier code Example: "AC" - `FlightPass.Description` (array) Example: ["FlightPass"] - `FlightPass.TravelerIdentifierRef` (array) In Search, use the passengerCriteriaRef to reference the owner of the flightpass. This is a mandatory field for Search API. - `FlightPass.TravelerIdentifierRef.name` (string) Traveler identifier - `FlightPass.TravelerIdentifierRef.passengerTypeCode` (string) Passenger Type code Example: "ADT" - `FlightPass.TravelerIdentifierRef.ages` (array) The ages of the travelers associated to a particular ptc. For NDC, this value will be returned in PriceBreakdownAir if sent as part of the PassengerCriteria in the Air Search request. Example: [15] - `FlightPass.TravelerIdentifierRef.passengerCriteriaRef` (string) Allows the user to associate passenger criteria information. Example: "passengerCriteria_1" - `FlightPass.TravelerIdentifierRef.value` (string) - `FlightPass.TravelerIdentifierRef.id` (string) A locally referenced ID - `FlightPass.TravelerIdentifierRef.description` (string) Descriptive text used to identify the contents of a target object - `FlightPass.TravelerIdentifierRef.uris` (array) Uniform Resource Identifier Example: ["google.com"] - `FlightPass.TravelerIdentifierRef.age` (integer) Replaced with ages array. The age of the traveler. Example: 11 - `instantPurchaseInd` (boolean) If true the Offer/Offering must be paid for at the same time as creating the Reservation. Example: true - `secureFlightPassengerDataRequiredInd` (boolean) Returned only when true to indicate the airline requires additional passenger data for one or more travelers to complete the reservation per Secure Flight Passenger Data requirements. Example: true - `TourCodes` (array) GDS only; not supported for NDC. Any tour code applicable to this fare, per PTC. Includes TravelerIdentifierRef and TourCode objects.A tour code is a carrier specified and agreed code for a negotiated fare. It is used by the BSP or ARC data processing center to perform a series of calculations that may be based on the itinerary, agency code, dates, and other transaction attributes. The tour code can help identify airline-specific incentive payments such as commissions for fares that offer the most revenue. - `TourCodes.@type` (string) Discriminator. No child classes. Example: "TourCodes" - `TourCodes.TravelerIdentifierRef` (array) Reference the traveler if the tour code is traveler specific. Leave blank to apply to all travelers. - `TourCodes.TourCode` (object, required) Tour code - `TourCodes.TourCode.value` (string) The actual value of the tour code. - `TourCodes.TourCode.tourCodeType` (string) List of tour code types. Enum: same as `TourCodes.TourCode.tourCodeType` in "TermsAndConditionsAir" (2 values) - `DocumentValidDateRange` (object) The valid date range to be applied to the document. - `DocumentValidDateRange.@type` (string) Example: "DocumentValidDateRange" - `DocumentValidDateRange.ProductRef` (string) The product this document date range applies to. If blank, applies to all products. Example: "product_1" - `DocumentValidDateRange.SegmentSequenceList` (array) The segmentSequence within the product the action is being requested for. Used when multiple flights exist within a product. Only one product may be selected with this option. - `DocumentValidDateRange.ValidDateRange` (object) Specifies the begin and end date of an event, such as check-in and check-out dates. - `DocumentValidDateRange.ValidDateRange.start` (string, required) Specifies the start date for an event, such as a booking or check-in date in YYYY-MM-DD format. Example: "2026-03-03" - `DocumentValidDateRange.ValidDateRange.end` (string, required) Specifies the end date an event, such as a booking or check-out date in YYYY-MM-DD format. Example: "2026-03-03" - `flightPassInd` (boolean) If true, this offer is made in conjunction with a flight pass account. - `Restriction` (array) Not supported in Search response. - `Restriction.value` (string) Example: "No late arrivals" - `Restriction.segmentSequenceList` (array) Segment sequence list Example: [2,4,6,8,10] - `Restriction.productRef` (array) The productRef which the restriction applies to Example: ["p1","p2","p3","p4"] - `BaggageRecheck` (array) Not implemented. - `BaggageRecheck.@type` (string) Example: "BaggageRecheck" - `BaggageRecheck.At` (string, required) The city where the baggage recheck is required Example: "MEX" - `BaggageRecheck.ArrivalFlight` (object, required) Flight common schema. Used across Air workflow. One instance for each flight in the FlightSegment. A direct flight option has one Flight object while connecting flights have a Flight object for each flight on the leg. - `distance` (integer) Distance covered by the flight. Example: 6574 - `stops` (integer) Number of stops Example: 2 - `duration` (string) Elapsed flight time. Represented in hours (H) and minutes (M) OR the format PT{x}H{x}M, in which P is the duration designator, T is the time designator, {x}H is the number of hours for the connection, and {x}H is the number of minutes for the connection. Example: "PT1H40M" - `carrier` (string, required) The airline code. Example: "BA" - `number` (string, required) The marketing carrier flight number. Example: "98" - `operatingCarrier` (string) The operating airline code. Shown in codeshare situations when the operating carrier is different to the marketing carrier. Example: "BA" - `operatingCarrierName` (string) The operating carrier name Example: "Liberty Aerospace" - `operatingCarrierNumber` (string) Operating airline flight number. If there is no operating carrier number, then CO2 emission estimates for operating carriers is not supported. GDS only; not returned for NDC. Returned only in Search response. Example: "091" - `equipment` (string) Equipment model. Note that TRN, TRS, and BUS equipment codes indicate ground transportation. Example: "777" - `Departure` (object, required) Departure details for a given leg. - `terminal` (string) Departure terminal, returned when available. Example: "Terminal 1" - `country` (string) Country of to departure or arrival Example: "US" - `Departure.@type` (string, required) Discriminator classes Departure or DepartureDetail Example: "DepartureDetail" - `Departure.location` (string, required) IATA code for departure airport or city for this leg of the itinerary. Example: "AMS" - `Departure.date` (string, required) Departure date in YYYY-MM-DD format. Example: "0011-10-17" - `Departure.time` (string, required) Departure date in HH:mm:ss (24-hour format). Example: "04:45:00" - `Arrival` (object, required) - `terminal` (string) Arrival terminal, returned when available. Example: "Terminal 1" - `country` (string) Country of to departure or arrival Example: "US" - `Arrival.@type` (string, required) Discriminator classes Arrival or ArrivalDetail Example: "ArrivalDetail" - `Arrival.location` (string, required) IATA code for arrival airport or city for this leg of the itinerary. Example: "MAD" - `Arrival.date` (string, required) Arrival date in YYYY-MM-DD format. Example: "0011-10-17" - `Arrival.time` (string) Arrival date in HH:mm:ss (24-hour format). Example: "04:45:00" - `IntermediateStop` (array) - `IntermediateStop.value` (string) The IATA airport code for the airport where the intermediate stop occurs. - `IntermediateStop.arrivalFlightDuration` (string) Duration in hours and minutes of the flight arriving at the intermediate stop. ISO 8601 format Example: "PT2H35M" - `IntermediateStop.departureFlightDuration` (string) Duration in hours and minutes of the flight departing the intermediate stop. ISO 8601 format Example: "PT1H35M" - `IntermediateStop.duration` (string) Duration in hours and minutes between the arrival and departure at the intermediate stop. ISO 8601 format Example: "PT1H35M" - `IntermediateStop.equipment` (string) Equipment model, if there is a change of equipment during the stop. Example: "777" - `IntermediateStop.arrivalDate` (string) The local date the aircraft arrives at the intermediate stop Example: "2026-04-30" - `IntermediateStop.departureDate` (string) The local date the aircraft departs from the intermediate stop Example: "2026-04-30" - `IntermediateStop.arrivalTime` (string) The local time the aircraft arrives at the intermediate stop Example: "68400" - `IntermediateStop.departurelTime` (string) The local time the aircraft departs from the intermediate stop Example: "72000" - `IntermediateStop.arrivalTerminal` (string) Arrival terminal of the intermediate stop airport Example: "Terminal2" - `IntermediateStop.departureTerminal` (string) Departure terminal of the intermediate stop airport Example: "Terminal4" - `subjectToGovernmentApprovalInd` (boolean) If true, the airline has filed in its schedule that availability for a specific flight is subject to government approval. GDS only, not supported for NDC. Returned only in the Air Search API response. Example: true - `BaggageRecheck.DepartureFlight` (object, required) Flight common schema. Used across Air workflow. One instance for each flight in the FlightSegment. A direct flight option has one Flight object while connecting flights have a Flight object for each flight on the leg. - `distance` (integer) Distance covered by the flight. Example: 6574 - `stops` (integer) Number of stops Example: 2 - `duration` (string) Elapsed flight time. Represented in hours (H) and minutes (M) OR the format PT{x}H{x}M, in which P is the duration designator, T is the time designator, {x}H is the number of hours for the connection, and {x}H is the number of minutes for the connection. Example: "PT1H40M" - `carrier` (string, required) The airline code. Example: "BA" - `number` (string, required) The marketing carrier flight number. Example: "98" - `operatingCarrier` (string) The operating airline code. Shown in codeshare situations when the operating carrier is different to the marketing carrier. Example: "BA" - `operatingCarrierName` (string) The operating carrier name Example: "Liberty Aerospace" - `operatingCarrierNumber` (string) Operating airline flight number. If there is no operating carrier number, then CO2 emission estimates for operating carriers is not supported. GDS only; not returned for NDC. Returned only in Search response. Example: "091" - `equipment` (string) Equipment model. Note that TRN, TRS, and BUS equipment codes indicate ground transportation. Example: "777" - `Departure` (object, required) Departure details for a given leg. - `terminal` (string) Departure terminal, returned when available. Example: "Terminal 1" - `country` (string) Country of to departure or arrival Example: "US" - `Departure.@type` (string, required) Discriminator classes Departure or DepartureDetail Example: "DepartureDetail" - `Departure.location` (string, required) IATA code for departure airport or city for this leg of the itinerary. Example: "AMS" - `Departure.date` (string, required) Departure date in YYYY-MM-DD format. Example: "0011-10-17" - `Departure.time` (string, required) Departure date in HH:mm:ss (24-hour format). Example: "04:45:00" - `Arrival` (object, required) - `terminal` (string) Arrival terminal, returned when available. Example: "Terminal 1" - `country` (string) Country of to departure or arrival Example: "US" - `Arrival.@type` (string, required) Discriminator classes Arrival or ArrivalDetail Example: "ArrivalDetail" - `Arrival.location` (string, required) IATA code for arrival airport or city for this leg of the itinerary. Example: "MAD" - `Arrival.date` (string, required) Arrival date in YYYY-MM-DD format. Example: "0011-10-17" - `Arrival.time` (string) Arrival date in HH:mm:ss (24-hour format). Example: "04:45:00" - `IntermediateStop` (array) - `IntermediateStop.value` (string) The IATA airport code for the airport where the intermediate stop occurs. - `IntermediateStop.arrivalFlightDuration` (string) Duration in hours and minutes of the flight arriving at the intermediate stop. ISO 8601 format Example: "PT2H35M" - `IntermediateStop.departureFlightDuration` (string) Duration in hours and minutes of the flight departing the intermediate stop. ISO 8601 format Example: "PT1H35M" - `IntermediateStop.duration` (string) Duration in hours and minutes between the arrival and departure at the intermediate stop. ISO 8601 format Example: "PT1H35M" - `IntermediateStop.equipment` (string) Equipment model, if there is a change of equipment during the stop. Example: "777" - `IntermediateStop.arrivalDate` (string) The local date the aircraft arrives at the intermediate stop Example: "2026-04-30" - `IntermediateStop.departureDate` (string) The local date the aircraft departs from the intermediate stop Example: "2026-04-30" - `IntermediateStop.arrivalTime` (string) The local time the aircraft arrives at the intermediate stop Example: "68400" - `IntermediateStop.departurelTime` (string) The local time the aircraft departs from the intermediate stop Example: "72000" - `IntermediateStop.arrivalTerminal` (string) Arrival terminal of the intermediate stop airport Example: "Terminal2" - `IntermediateStop.departureTerminal` (string) Departure terminal of the intermediate stop airport Example: "Terminal4" - `subjectToGovernmentApprovalInd` (boolean) If true, the airline has filed in its schedule that availability for a specific flight is subject to government approval. GDS only, not supported for NDC. Returned only in the Air Search API response. Example: true - TermsAndConditionsAncillary: - `ApplicationLimit` (object) Exposes any limitation on the amount of ancillaries available for purchase. Example, start 1 end 3 ApplicableLevel Passenger would mean a minumum of 1 and maximum of 3 ancillary items may be purchased. - `ApplicationLimit.value` (string) The application of the ancillary Enum: same as `ApplicationLimit.value` in "TermsAndConditionsAncillary" (6 values) - `ApplicationLimit.start` (string) The start value Example: "45" - `ApplicationLimit.end` (string) The end value Example: "67" - `Refundability` (object) Describes the refundability of an Offer - `Refundability.value` (string) Describes the refundability of an Offer Enum: same as `Refundability.value` in "TermsAndConditionsAncillary" (3 values) - `validatingAirline` (string) Represents the airline responsible for ticketing/fulfillment of this Offer. Example: "AA" - `fulfillmentType` (string) The EMD fulfillment types Enum: same as `fulfillmentType` in "TermsAndConditionsAncillary" (4 values) - `associatedItem` (string) The EMD Association types Enum: same as `associatedItem` in "TermsAndConditionsAncillary" (2 values) - `unsellableInd` (boolean) If true, this ancillary product can not be sold through Travelport systems. - `instantPurchaseInd` (boolean) If true, the Offer/Offering must be paid for at the same time as creating the Reservation. - TermsAndConditionsScheduleChange: - `ScheduleChangeOptions` (array) - `ScheduleChangeOptions.@type` (string, required) Example: "ScheduleChangeOptions" - `ScheduleChangeOptions.options` (array) List of available options. Enum: same as `ScheduleChangeOptions.options` in "TermsAndConditionsScheduleChange" (3 values) - `ScheduleChangeOptions.waiverCodeRequiredInd` (boolean) If true, a waiver code is required in subsequent reshop or refund transactions. Example: true - `ScheduleChangeOptions.reissueRequiredInd` (boolean) If true, the schedule change requires the original document to be reissued. Example: true - `ScheduleChangeOptions.documentsRevalidatedInd` (boolean) If true, the original documents associated to the Offer have already been revalidated with the new flight details. Example: true - `TermsAndConditions.@type` (string, required) Discriminator. - Air Search child classes are TermsAndConditionsAir and TermsAndConditionsAncillary. - Exchange Search child class is TermsAndConditionsAirChange. - Search Ancillaries and Seat Availabilities child classes are TermsAndConditions, TermsAndConditionsAncillary, and TermsAndConditionsAncillaryAir. - Hotel Availability child class is TermsAndConditionsHospitality. Example: "TermsAndConditionsAir" - `TermsAndConditions.id` (string) Local id within a given message to support referencing this object. For Air Search APIs, matches to the reference value in ProductBrandOffering/TermsAndConditions/termsAndConditionsRef in instances of ProductBrandOptions. Example: "TC_1" - `TermsAndConditions.termsAndConditionsRef` (string) Reference id that corresponds to the TermsAndConditions 'id' in ReferenceListTermsAndConditions.TermsAndConditions. Example: "TC_1" - `TermsAndConditions.Identifier` (object) A globally unique identifier key often used to reference a given option (such as Pricing, Booking, Rules, or additional workflows) or to retrieve information (such as Hotel pagination). - `TermsAndConditions.ExpiryDate` (string) The date and time in UTC the offer will expire. Not returned in GDS Search. NDC generally allows 20 to 30 minutes to create a booking (the offer time limit). That time limit varies by airline and is returned here in the Search response. Example: "2022-08-07T12:12:00Z" - `TermsAndConditions.CustomerLoyalty` (array) - `TermsAndConditions.CustomerLoyalty.value` (string, required) Number on loyalty card. Example: "132456" - `TermsAndConditions.CustomerLoyalty.id` (string) Optional Customer Loyalty Id. Not saved Example: "Loyalty_1" - `TermsAndConditions.CustomerLoyalty.priority` (integer) Optional Numeric Priority Code Example: 2 - `TermsAndConditions.CustomerLoyalty.programId` (string) "Specifies an identifier to indicate the company owner of the loyalty program. Typically two characters. For frequent guest number, the hotel supplier or brand code. For frequent flyer number, the air supplier code of the loyalty program." Example: "HY" - `TermsAndConditions.CustomerLoyalty.programName` (string) Supplier's loyalty program name. Example: "Frontier-EarlyReturns" - `TermsAndConditions.CustomerLoyalty.supplierType` (string) The type of supplier of a loyalty program. Uses 'hotel' for frequent guest number or 'air' for frequent flyer number. Example: "Hotel" - `TermsAndConditions.CustomerLoyalty.supplier` (string) Supplier of a loyalty program (typically 2 characters representing the hotel, brand, or airline). Example: "UA" - `TermsAndConditions.CustomerLoyalty.tier` (string) Customer Loyalty tier Example: "Silver" - `TermsAndConditions.CustomerLoyalty.shareWithSupplier` (array) The list of suppliers that the CustomerLoyalty number is shared. Used for cross accrual. Example: ["LH"] - `TermsAndConditions.CustomerLoyalty.cardHolderName` (string) Customer loyalty member name; up to 128 characters are supported. In Air Search, for discounted offers to be returned, the name must be sent as LAST FIRST; e.g.,if SMITH is the last name and JORDAN the first name, send as SMITH JORDAN Example: "John Smith" - `TermsAndConditions.CustomerLoyalty.validatedInd` (boolean) Customer loyalty number has been validated by the supplier Example: true - `TermsAndConditions.CustomerLoyalty.prefix` (string) The cardholder name prefix title like Mr, Mrs, Dr Example: "Dr" - `TermsAndConditions.CustomerLoyalty.given` (string) The First Name of the Cardholder Example: "John" - `TermsAndConditions.CustomerLoyalty.middle` (string) Middle Name of the Cardholder Example: "Wilkinson" - `TermsAndConditions.CustomerLoyalty.surname` (string) Last Name of the Cardholder Example: "Smith" - ReferenceListExchangedPrice: - `Price` (array, required) - `FlightPassCredits` (integer) The total number of flight pass credits consumed for this offer. Example: 2 - `PriceBreakdown` (array) — one of (discriminator: @type): - PriceBreakdownAir: - `quantity` (integer) Quantity of passengers in that PTC. Example: 2 - `requestedPassengerType` (string) The PTC to which the PriceBreakdown applies. Example: "CHD" - `FiledAmount` (object) Returned only in the Price APIs. GDS only; not supported for NDC. The base amount of a ticket price or net price that is filed in local currency. Returned when the origin currency is not the same as the PCC currency to show the currency in which the base fare has been filed. When used for NetBaseAmount: Net ticket data (NTD) is returned in the AirPrice, AirReservation, Exchange Search, and Reservation Retrieve responses for any GDS fare that has a private fare component (fareType=AgencyPrivateFare). When NTD is returned, TermsAndConditionsFuill includes FareGuaranteePolicy to return the fare calculation indicator for the fare. When NTD is returned, PriceBreakdown may include NetBaseAmount. - `FiledAmount.value` (number) Filed amount value Example: 43.3422 - `FiledAmount.currencyCode` (string) Code for the currency in which the base fare was filed. Example: "USD" - `FiledAmount.codeAuthority` (string) Filed amount currency code authority Example: "Australian Dollar" - `FiledAmount.decimalPlace` (integer, required) Number of decimal places in the currency in ISO 4217 standard format. Example: 3 - `FiledAmount.decimalAuthority` (string) ISO 4217 standard decimal authority Example: "ISO 4217" - `Discount` (object) NDC only; not supported for GDS. Returned for a fare discounted from the published price, such as a promotional discount. Not returned for privately negotiated discounts such as private fares. - `Discount.value` (number) The amount value of the discount Example: 20.22 - `Discount.description` (string) The text description for the discount. Example: "Spring discount on group bookings" - `Discount.currencyCode` (string, required) Currency code discount is returned in. Example: "USD" - `Discount.codeAuthority` (string, required) Not used. Currency code Authority. Example: "ISO" - `Discount.decimalPlace` (integer, required) Number of decimal places in the currency the discount is returned in. Example: 2 - `Discount.decimalAuthority` (string) Not used. Decimal Authority. Example: "ISO" - `NetFareInfo` (object) Detailed information on the net fare used. - `NetFareInfo.@type` (string, required) Example: "NetFareInfo" - `NetFareInfo.passengerTypeCode` (string) PassengerTypeCode Example: "ADT" - `NetFareInfo.NetFareBreakdownConstruction` (array) - `NetFareInfo.NetFareBreakdownConstruction.value` (string) - `NetFareInfo.NetFareBreakdownConstruction.fareType` (string) Assigned Type: c-1100:StringTiny - `NetFareInfo.NetFareBreakdownConstruction.rateOfExchange` (number) The rate of exchange applied to the fare breakdown - `NetFareInfo.TicketBaseAudit` (object) Returned only in the Price APIs. GDS only; not supported for NDC. The base amount of a ticket price or net price that is filed in local currency. Returned when the origin currency is not the same as the PCC currency to show the currency in which the base fare has been filed. When used for NetBaseAmount: Net ticket data (NTD) is returned in the AirPrice, AirReservation, Exchange Search, and Reservation Retrieve responses for any GDS fare that has a private fare component (fareType=AgencyPrivateFare). When NTD is returned, TermsAndConditionsFuill includes FareGuaranteePolicy to return the fare calculation indicator for the fare. When NTD is returned, PriceBreakdown may include NetBaseAmount. - `NetFareInfo.TicketBasePassenger` (object) The monetary value - `NetFareInfo.TicketBasePassenger.value` (number) - `NetFareInfo.TicketBasePassenger.currencyCode` (string) Assigned Type: c-1100:CurrencyCode - `NetFareInfo.TicketBasePassenger.codeAuthority` (string, required) Assigned Type: c-1100:CodeContext - `NetFareInfo.TicketBasePassenger.decimalPlace` (integer, required) Assigned Type: c-1100:CurrencyMinorUnit - `NetFareInfo.TicketBasePassenger.decimalAuthority` (string) Assigned Type: c-1100:CodeContext - `NetFareInfo.TicketBasePassenger.bTInd` (boolean) If true, this is a bulk ticket fare - `NetFareInfo.TicketBasePassenger.iTInd` (boolean) If true, this is an inclusive tour fare - `TravelerIdentifierRef` (object) Identifier references as object both within a message payload or an object held in cache that may be used for subsequent workflows. Returned for NDC in the Price response if age was sent for this traveler in the previous workflow requests. - `TravelerIdentifierRef.name` (string) Traveler identifier - `TravelerIdentifierRef.passengerTypeCode` (string) Passenger Type code Example: "ADT" - `TravelerIdentifierRef.ages` (array) The ages of the travelers associated to a particular ptc. For NDC, this value will be returned in PriceBreakdownAir if sent as part of the PassengerCriteria in the Air Search request. Example: [15] - `TravelerIdentifierRef.passengerCriteriaRef` (string) Allows the user to associate passenger criteria information. Example: "passengerCriteria_1" - `TravelerIdentifierRef.value` (string) - `TravelerIdentifierRef.id` (string) A locally referenced ID - `TravelerIdentifierRef.description` (string) Descriptive text used to identify the contents of a target object - `TravelerIdentifierRef.uris` (array) Uniform Resource Identifier Example: ["google.com"] - `TravelerIdentifierRef.age` (integer) Replaced with ages array. The age of the traveler. Example: 11 - `NetBaseAmount` (object) Returned only in the Price APIs. GDS only; not supported for NDC. The base amount of a ticket price or net price that is filed in local currency. Returned when the origin currency is not the same as the PCC currency to show the currency in which the base fare has been filed. When used for NetBaseAmount: Net ticket data (NTD) is returned in the AirPrice, AirReservation, Exchange Search, and Reservation Retrieve responses for any GDS fare that has a private fare component (fareType=AgencyPrivateFare). When NTD is returned, TermsAndConditionsFuill includes FareGuaranteePolicy to return the fare calculation indicator for the fare. When NTD is returned, PriceBreakdown may include NetBaseAmount. - `FareCalculation` (string) GDS only; not supported for NDC. For each PTC, when available, FareCalculation returns the fare calculation ladder for all public and private fare types filed by an agency or an airline. Example: "LON BA SYD R564.00YEE1Y BA LON R564.00YEE1Y NUC1128.00END ROE0.787855" - `Surcharges` (object) In AirSearch workflow this applies to GDS only. Not supported for NDC, which does not return surcharges. Returned if surcharges apply to this offer. For GDS only, for a multi-city offer with stopovers (see multi-city offers with stopovers for details), surcharges and commission amounts are for the entire journey. For all other offers, the surcharges and commission amounts are for each leg (origin and destination pair). A multi-city offer can be identified by the jc in its CombinabilityCode: jc1, jc2. Surcharges can be omitted from the Search response with excludeSurchargesInd. - `Surcharge` (array, required) - `Surcharge.value` (number) Surcharge amount Example: 12 - `Surcharge.currencyCode` (string) ISO 4217 currency code for the surcharge. Example: "USD" - `Surcharge.surchargeCode` (string) Surcharge code Example: "ADDITIONAL COSTS" - `Surcharge.reportingAuthority` (string) Not used. Surcharge reporting authority Example: "Federal register" - `Surcharge.purpose` (string) Surcharge purpose. For Air workflows possible values include Weekend Surcharge, Stopover Charge, Multiple Stopover Charges, Other (default value that covers all other surcharges such as fuel surcharges). Example: "Weekend Surcharge" - `Surcharge.description` (string) Description of the surcharge. Example: "Rollaway Surcharge" - `Surcharge.surchargeApplication` (string) Application values (such as the application of a fee) like per person or per room. Enum: same as `Surcharge.surchargeApplication` (7 values) - `Surcharge.surchargeFrequency` (string) The frequency of a fee such as per night or per stay. Enum: same as `Surcharge.surchargeFrequency` (6 values) - `Surcharge.codeAuthority` (string) Not used. Currency code authority. Example: "ISO 4217" - `Surcharge.decimalPlace` (integer) Decimal place for the currency unit. Example: 4 - `Surcharge.decimalAuthority` (string) Not used. Currency code decimal authority. Example: "ISO 4217" - `Surcharges.@type` (string, required) Discriminator class is SurchargesDetail Example: "SurchargesDetail" - `Surcharges.TotalSurcharges` (number) A monetary amount, up to 4 decimal places. Example: 211.11 - `Surcharges.approximateInd` (boolean) If true, the surcharge amounts are approximate. - `TravelerRefs` (array) Returned only in Reservation Retrieve to identify the traveler associated with this instance of PriceBreakdown in case of multiple offers on the booking. Example: ["[\"traveler_1\",\"traveler2\"]"] - `PaidTaxes` (object) Summary Taxes object - `Tax` (array) - `Tax.value` (number) Amount of the tax. Returned as 0 if a tax was marked as exempt with TaxExemption. Example: 12.2 - `Tax.currencyCode` (string) A ISO 4217 currency code associated to the value. Example: "USD" - `Tax.taxCode` (string) "Code for the tax. For Hotels this is the OTA code." Example: "XF2" - `Tax.reportingAuthority` (string) Identifies the reporting authority such as airport code for XF taxes Example: "JFK1" - `Tax.purpose` (string) Supplier returned description of tax. Example: "Fuel surcharge" - `Tax.description` (string) "Short summary of the tax. In Air workflows this is returned only for NDC. Note that descriptions are not returned for tax codes YQ and YR, which are fees charged by airlines and not government-imposed taxes. For Hotels this is the OTA tax description." Example: "Lodging tax" - `Tax.includedInBase` (string) Yes , No , Unknown Enum: same as `instantPurchase` in "AdvanceReservationRequired" (3 values) - `Tax.codeAuthority` (string) Not used. Currency Code Authority Example: "ISO" - `Tax.decimalPlace` (integer) Permitted number of decimals. Associated to the currency value. Example: 2 - `Tax.decimalAuthority` (string) Not used. Currency decimal authority Example: "ISO" - `Tax.exemptInd` (boolean) GDS only; not supported for NDC. Returned if a tax was marked exempt in a prior request with the TaxExemption pricing modifer. If true, this tax is exempt" Example: true - `Tax.nonRefundableInd` (boolean) If true, the tax is non refundable. This indicator is only supported for exchange search and exchange price quote transactions. Example: true - `Tax.excludedFromTotalPriceInd` (boolean) Returned in Hotel APIs when a tax is not included in the TotalPrice. Default behavior is for taxes to be included in TotalPrice. Example: true - `TaxPercent` (object) Returned when the tax is expressed as a percentage of the amount. - `TaxPercent.value` (number) The tax percentage amount. Example: 5.5 - `TaxPercent.taxCode` (string) Any code for the tax. Example: "971 - IRS Notice" - `TaxPercent.reportingAuthority` (string) Tax reporting authority Example: "Georgia Department of Revenue" - `TaxPercent.purpose` (string) Purpose of tax Example: "statutory tax" - `TaxPercent.description` (string) Description Example: "1.5% of SGST" - `TaxPercent.includedInBase` (string) Yes , No , Unknown Enum: same as `instantPurchase` in "AdvanceReservationRequired" (3 values) - `PaidTaxes.@type` (string, required) Discriminator classes PaidTaxes or PaidTaxesDetail Example: "PaidTaxesDetail" - `PaidTaxes.TotalTaxes` (number) A monetary amount, up to 4 decimal places. Decimal place needs to be included. Example: 220.12 - `RequestedPricingModifiers` (array) - `RequestedPricingModifiers.@type` (string, required) Discriminator. Example: "RequestedPricingModifiers" - `RequestedPricingModifiers.PassengerCriteria` (object) Defines the passenger criteria. Send one PassengerCriteria for each passenger type code (PTC). Search supports up to 9 total passengers. A maximum of 6 PTCs are supported for GDS. NDC does not have a PTC limitation. AirPrice supports up to nine total passengers across all PTCs. - `TravelerIdentifierRef` (object, required) Identifier references as object both within a message payload or an object held in cache that may be used for subsequent workflows. Returned for NDC in the Price response if age was sent for this traveler in the previous workflow requests. - `RequestedPricingModifiers.PassengerCriteria.@type` (string, required) Discriminator. No child classes. Example: "PassengerCriteria" - `RequestedPricingModifiers.PassengerCriteria.number` (integer, required) The amount of passengers associated with this passenger type code. Default is 1. Example: 1 - `RequestedPricingModifiers.PassengerCriteria.age` (integer) The age of the passenger. Notes on PTC and age: - Travelport recommends sending age only with PTCs that require age for pricing. - If the age is sent in the request, for NDC only, the age is returned in the pricing response. - For child passengers, Travelport recommends sending the age of the child in the age attribute plus the PTC CNN. Travelport recommends against sending CNN without age, or the CHD PTC. Not all fares cannot be quoted for CHD. - The age for CNN is generally between 2 and 11 inclusive, with ADT fares returned for ages 12 and up; however, this can vary by airline and country. - The age for INF must be either 0 or 1. - During booking, date of birth is required for all child and infant PTCs (Add Traveler payload in Traveler/birthDate). Example: 26 - `RequestedPricingModifiers.PassengerCriteria.passengerTypeCode` (string) The passenger type code (PTC) for the passengers on the itinerary. Required field for Air Search and Flight specific search. Common PTCs are: - ADT: adult - CHD: child of unknown age - For child passengers, Travelport recommends sending the age of the child in the age attribute plus the PTC CNN. Travelport recommends against sending CNN without age, or the CHD PTC. Many fares cannot be quoted for CHD. - CNN: child when age is known - The age for CNN is generally between 2 and 11 inclusive, with ADT fares returned for ages 12 and up; however, this can vary by airline and country. - INF: infant without a seat - INS: infant with a seat - UNN: unaccompanied child. See API guides to download a full list of PTCs. NDC carriers BA, SQ, AV, AA, and AF/KLM offer teen/young adult tax exemptions from the UK Air Passenger Duty (GB tax). Send PTC with the value YTH and send the passengers age per below. The PTC may be returned as ADT, or Cxx in which xx is the age, but the tax exemption is applied in the pricing on these NDC carriers. For marine fares, send the PTC value SEA. You must also send OSI remarks at Add Traveler with the vessel name and location. Marine fares are private fares for travelers going to or from a vessel. NDC only; not supported for GDS. When running a multiple passenger search for NDC on Qantas, Qantas supports only these PTCs: ADT, CHD, CNN, INF. Sending any other PTC may result in an error at ticketing. Any traveler sent without a PTC value is defaulted to ADT. PTC can be sent or omitted for ADT passenger. AirReservation defaults the PTC to ADT and returns it in the Reservation Retrieve. Example: "ADT" - `RequestedPricingModifiers.PassengerCriteria.birthDate` (string) The date of birth of the passenger. May be used in age validation for fares with age restrictions. Example: "2020-01-16" - `RequestedPricingModifiers.PassengerCriteria.id` (string) Unique id to support referencing of this specific passenger criteria. Example: "passengercriteria_001" - `RequestedPricingModifiers.PassengerCriteria.CustomerLoyalty` (array) NDC only; not supported for GDS. Optional object for sending customer loyalty information, such as for a frequent flyer program. If CustomerLoyalty is sent in the Search request, it must also be sent in the Air Price request and the Add Traveler request. As some carriers validate frequent traveler data through the workflow, failing to send the same CustomerLoyalty details, even if invalid, may cause a booking failure. If an invalid number is sent, the response returns a warning message that the FQTV is invalid, and the invalid number is cached to prevent a potential booking failure. - `RequestedPricingModifiers.PassengerCriteria.TravelerGeographicLocation` (object) For AirSearch: supported/validated only for NDC to support local citizen fares. For AirPrice and AirReservation: GDS only; not supported for NDC. Optional object for requesting local citizen/local resident fares for Spain and associated islands. You must also send a PTC relevant to the local resident fares; e.g., ADR for adult resident, CHR for child resident. Any discount applied through TravelerGeographicLocation applies to all travelers, not only to the traveler in this instance of PassengerCriteria. If the discount must apply only to an individual traveler, that traveler requires a separate search and book workflow. - `RequestedPricingModifiers.PassengerCriteria.TravelerGeographicLocation.value` (string) IATA code for the city, country, or state/province relevant to the local citizen//local resident fare. Example: "PMI" - `RequestedPricingModifiers.PassengerCriteria.TravelerGeographicLocation.travelerGeographicLocationType` (string) The type of location where the fare is valid. Enum: same as `RequestedPricingModifiers.PassengerCriteria.TravelerGeographicLocation.travelerGeographicLocationType` in "PriceBreakdownAir" (3 values) - `RequestedPricingModifiers.PassengerCriteria.TravelerGeographicLocation.residentGeographicCode` (string) Resident code for Spanish residency fares for NDC. Any discount will apply to all travelers, not only to the traveler in this instance of PassengerCriteria. Supported/validated only for NDC to support local citizen fares. - `RequestedPricingModifiers.PassengerCriteria.TravelerGeographicLocation.generalLargeFamilyResidentDiscountInd` (boolean) Send only if true and request qualifies for general large family resident discount, defined as general large families (up to three children) from Spain, from the EU/EEA, or of any other nationality whose residency in Spain is recognized and who are in possession of a large-family certificate issued by the autonomous community in which they live. Supported/validated only for NDC to support local citizen fares. Example: true - `RequestedPricingModifiers.PassengerCriteria.TravelerGeographicLocation.specialLargeFamilyResidentDiscountInd` (boolean) Send only if true and request qualifies for special large family resident discount, defined as special large families (four or more children) from Spain, from the EU/EEA, or of any other nationality whose residency in Spain is recognized and who are in possession of a large-family certificate issued by the autonomous community in which they live. Supported/validated only for NDC to support local citizen fares. Example: true - `RequestedPricingModifiers.PassengerCriteria.specifiedPassengerTypeCodeOnlyInd` (boolean) GDS only; not supported for NDC. - If true: returns only offers for the specified PTC. If no fares are available for the specified PTC, returns an error message that there is no valid fare. - If false (default behavior): If no fares are available for the specified PTC, returns fares for the default ADT (adult) PTC instead. Example: true - `RequestedPricingModifiers.PricingModifiersAir` (object) A selection of Pricing Modifiers that can be used to influence the Price of an Offer. - For the AirPrice reference payload request, if any price modifiers were included in the preceding Search request and no price modifiers are sent in the AirPrice request, the cached price modifiers sent at Search are sent with the AirPrice request. If any price modifiers are sent in the AirPrice reference payload request, all cached Search modifiers are discarded and only the modifiers sent in that AirPrice request are used. - For the Add Offer request, you may optionally store fares with one or more pricing modifiers. If a pricing modifier is not added, the auto stored fare is added to the reservation. There is no change in the AirReservation response when pricing modifiers are requested. AirReservation applies modifiers from Add Offer and earlier steps as follows: - Modifiers sent in the Add Offer request (supported for both full and reference payload). - If no modifiers are sent in Add Offer, any pricing modifiers sent in AirPrice are applied. - If no modifiers were sent in AirPrice, or if AirPrice was not sent, any pricing modifiers sent in Search are applied. GDS only; pricing modifiers not supported for NDC. If the requested modifier does not have any fares associated with it, the workbench commit fails and returns the error message 'No Fare Found'. Pricing happens at commit, not at Add Offer. - `Brand` (object) Information on airline Brand offerings. If brand attributes were not excluded with inhibitBrandContentInd=true (GDS only), then brand attributes are returned and consolidated in ReferenceList/ReferenceListBrand. In this case Brand does not return the name or Identifier objects but instead returns only BrandRef, which matches to the brand identifier (e.g., b1) in ReferenceListBrand. - `Brand.@type` (string, required) Discriminator. Child classes BrandID and Brand. BrandCompleteInfo is no longer in use. Example: "BrandID" - `Brand.id` (string) Local id within a given message to support referencing this object. Example: "brand_001" - `Brand.BrandRef` (string) Reference id that corresponds to the brand 'id' in ReferenceListBrand.Brand. Example: "brandRef_001" - `Brand.Identifier` (object) A globally unique identifier key often used to reference a given option (such as Pricing, Booking, Rules, or additional workflows) or to retrieve information (such as Hotel pagination). - `Brand.name` (string, required) Brand name from the supplier. Example: "Main Cabin Extra" - `Brand.tier` (integer) The brand tier. Not returned for NDC. Example: 2 - `Brand.shelfNumbers` (array) ATPCO shelf number. If the carrier has provided it for this brand, the shelf number is the number for a grouping of comparable brands that share similar ticket and flight attributes. Example: [1,4,5] - `Brand.code` (string) The ATPCO Brand Code. Example: "REFMAIN" - `Brand.BrandAttribute` (array) A list of enumerated features that are included, chargeable, or not offered for this brand. Contains one or more instances of the two paired key value pairs classification and inclusion. The return of brand attributes can be disabled in the AirPrice Reference Payload request. - `Brand.AdditionalBrandAttribute` (array) Array of non-enumerated features that are included, chargeable, or not offered for this brand. Contains one or more instances of the two paired key value pairs classification and inclusion. - `Brand.ImageURL` (array) Example: ["http:/imageurl.com"] - `RequestedPricingModifiers.PricingModifiersAir.@type` (string, required) Discriminator. Child classes PricingModifiersAir and PricingModifersAirDetail Example: "PricingModifiersAir" - `RequestedPricingModifiers.PricingModifiersAir.currencyCode` (string) In an API request, send the currency type to return if you want to override the default currency specified with your PCC. Example: "GBP" - `RequestedPricingModifiers.PricingModifiersAir.FareSelection` (object) Requests the return of fare types including private fares (negotiated), public fares (published), or net fares (consolidator fares, or any negotiated wholesale price that is further marked up for sale to customers). May be used to request fares with specific restrictions, change, or refund options. - `validatingCarrier` (string) IATA code for a carrier to override any default validating carrier (the airline designator that the ticket is issued against). If the validating carrier code is not supported for an itinerary, the response returns the error Ticketing Agreement does not exist. If an invalid validating carrier code is sent in the request, the response returns the error Unknown Carrier. Example: "KA" - `prohibitMinStayFaresInd` (boolean) If true, returns only fares that do not require a minimum stay. False allows minimum stay fares. Default is false. Example: true - `prohibitMaxStayFaresInd` (boolean) If true, returns only fares that do not require a maximum stay. False allows maximum stay fares. Default is false. Example: true - `refundableOnlyInd` (boolean) If true, returns only fares that are fully refundable. Default is false. Example: true - `prohibitAdvancePurchaseFaresInd` (boolean) If true, returns only fares that do not require advance purchase. False allows fares with advance purchase restrictions. Default is false. Example: true - `prohibitUnbundledFaresInd` (boolean) Example: true - `prohibitRefundableFaresInd` (boolean) This field is deprecated. Use RefundOptions for refundability options Example: true - `RequestedPricingModifiers.PricingModifiersAir.FareSelection.@type` (string, required) Discriminator. Child class FareSelectionDetail. Example: "FareSelection" - `RequestedPricingModifiers.PricingModifiersAir.FareSelection.fareType` (string) Defines the type of fares to return (only public fares, only private fares, only agency private fares, etc.). These can be combined. The response identifies the type of fare returned for each Product in PassengerFlight/FlightProduct @fareType. Possible values in the response are AirlinePrivateFare, AgencyPrivateFare, NetFare, or PublicFare. Enum: same as `RequestedPricingModifiers.PricingModifiersAir.FareSelection.fareType` in "PriceBreakdownAir" (7 values) - `RequestedPricingModifiers.PricingModifiersAir.FareSelection.RefundOptions` (object) Supports requesting only fares that meet certain refund criteria. GDS only; not supported for NDC. Search supports sending up to 12 refundability options. The following combinations are mutually exclusive; if sent, Search ignores them and returns a warning message: NonRefundable cannot also be sent with PartialRefund. Refundable cannot also be sent with ChangeOptions/changeTypes=PenaltyToChange - `RequestedPricingModifiers.PricingModifiersAir.FareSelection.ChangeOptions` (object) Supports requesting only fares that meet certain change criteria. GDS only; not supported for NDC. Search supports sending up to 12 changeability options. ChangeOptions.changeTypes=PenaltyToChange cannot be sent with RefundOptions.Refundable. If sent, Search ignores them and returns a warning message - `RequestedPricingModifiers.PricingModifiersAir.FareSelection.FareQualiferString` (array) Request specific private leisure fares. Supported values vary by NDC carrier. For detailed NDC support by carrier, see the Knowledge Base article NDC capabilities by airline through JSON API in the guide section. This value is returned in FlightProduct.FareQualifierString if supplied by the airline. (Note the misspelling in request parameter) Example: ["Tour"] - `RequestedPricingModifiers.PricingModifiersAir.FareSelection.FareQualifier` (array) - `RequestedPricingModifiers.PricingModifiersAir.OrganizationInformation` (object) Use to send account codes for negotiated fares or to send optional India GST SSR Remarks in GSTRegistrationNumber. For NDC supports corporate loyalty program and GST Information. This information is returned in TermsAndConditions." - `RequestedPricingModifiers.PricingModifiersAir.OrganizationInformation.@type` (string, required) Discriminator. No child classes Example: "OrganizationInformation" - `RequestedPricingModifiers.PricingModifiersAir.OrganizationInformation.OrganizationIdentifier` (array) Array of account codes to return negotiated fares. The response returns an instance of TermsAndConditions/OrganizationInformation/OrganizationIdentifier for each account code sent. When FareSelection/fareType=PrivateFaresOnly and an account code is sent in OrganizationIdentifier, AirPrice ignores the account code. Instead, AirPrice returns any private fares available for that market and a booking code for your PCC. This prevents the return of an error message when no specific fare has been filed for that account code. - `RequestedPricingModifiers.PricingModifiersAir.OrganizationInformation.GSTRegistrationNumber` (array) Send to add India GST (Goods and Services Tax) Special Service Requests. In this case country should be IND. Supported during book 'Add Offer' workflow. See the [India GST SSRs](https://developer.travelport.com/docs/flights/guides/booking-and-reservations/remarks-and-service-requests#india-gst-ssr) in the Remarks & Service Requests Guide for important details. - `RequestedPricingModifiers.PricingModifiersAir.TaxExemption` (object) GDS only, not supported for NDC. Use to mark some or all taxes as exempt. Specify all taxes, only specific tax codes, or all taxes in specific countries. Must include either allTaxesExemptInd OR both countries and taxCodes. TaxExemption supports up to nine values for countries, taxCodes, or both combined. The response returns any exempt taxes with exemptInd=true and value=0. - `RequestedPricingModifiers.PricingModifiersAir.TaxExemption.@type` (string) Discriminator. No child classes. Example: "TaxExemption" - `RequestedPricingModifiers.PricingModifiersAir.TaxExemption.countries` (array) One or more ISO codes for the countries in which the paired taxCodes sent are tax exempt. Must also send taxCodes object. Example: ["GB","MX"] - `RequestedPricingModifiers.PricingModifiersAir.TaxExemption.taxCodes` (array) One or more two-letter alphanumeric tax codes to mark as exempt in the paired country. Must also send countries object. Example: ["US"] - `RequestedPricingModifiers.PricingModifiersAir.TaxExemption.allTaxesExemptInd` (boolean) Use to set all taxes as exempt. - If true: marks all taxes on the itinerary as tax exempt. - Do not send if false. Instead, use countries and taxCodes to specify which taxes to exempt. Example: true - `RequestedPricingModifiers.PricingModifiersAir.PromotionalCode` (array) - `RequestedPricingModifiers.PricingModifiersAir.SellCity` (string) GDS only, not supported for NDC. The IATA location code for a city. Overrides the sell city of the requester to specify an alternate sale location and return fares based on that location. The response returns pricing in the local currency for the specified sell city instead of the PCC's default currency. Example: "NYC" - `RequestedPricingModifiers.PricingModifiersAir.TicketCity` (string) GDS only, not supported for NDC. The IATA location code for a city. Overrides the ticketing city of the requester to specify an alternate ticket location and return fares based on that location; the response returns pricing in the local currency for the specified ticket city instead of the PCC's default currency. Example: "NYC" - `RequestedPricingModifiers.PricingModifiersAir.PricingPCC` (string) GDS only, not supported for NDC. Use to send a faring PCC for which a selective access or code group agreement exists between that PCC and the PCC associated with your account. The following combinations of PricingPCC and FareSelection/fareType=PrivateFaresOnly return results as follows: - PricingPCC sent and PrivateFaresOnly not requested: If a selective access or group agreement exists, both public and any available private fares are returned for the requesting and providing PCC. - If no selective access or group agreement exists, only public fares are returned. - PricingPCC sent and PrivateFaresOnly is requested: If a selective access or group agreement exists that allows private fare access, only available private fares are returned for the requesting and providing PCC. - If no agreement exists, or if an agreement exists but does not allow private fares access, an error is returned. Example: "0Bx3" - `RequestedPricingModifiers.PricingModifiersAir.FareBasisCodeOverride` (array) - `RequestedPricingModifiers.PricingModifiersAir.MultiPricingAgency` (array) The customer can send up to 3 Pseudo City Codes (PCCs) in PricingModifiersAir, MultiPricingAgency. If a customer sends more than 3 PCCs in MultiPricingAgency, only the first 3 are validated. If a customer sends both PricingPCC and MultiPricingAgency with PCCs, the PCC in PricingPCC is ignored. Example: ["[\"0XS4\",\"0YBZ\",\"J80K\"]"] - `RequestedPricingModifiers.PricingModifiersAir.TicketingPCC` (string) GDS only, not supported for NDC. In an API request, overrides the ticketing PCC associated with your account to specify an alternate PCC and return fares based on that PCC. Example: "0XS4" - `RequestedPricingModifiers.PricingModifiersAir.CalculatedFareAdjustment` (object) — one of (discriminator: @type): Used in Exchange Search to modify the Price of the Fare. Discriminator classes CalculatedFareAdjustmentDiscount or CalculatedFareAdjustmentIncrease - CalculatedFareAdjustmentDiscount: - `AmountPercent` (object) Parent object when amount is applied as an Amount or a Percent. - CalculatedFareAdjustmentIncrease: - `AmountPercent` (object, required) Parent object when amount is applied as an Amount or a Percent. - `RequestedPricingModifiers.PricingModifiersAir.CalculatedFareAdjustment.@type` (string, required) Example: "CalculatedFareAdjustmentDiscount" - `RequestedPricingModifiers.PricingModifiersAir.ManualFareAdjustment` (array) — one of (discriminator: @type): Send to manually adjust the base fare amount on all fares for a specific PTC. - ManualFareAdjustmentIncrease: - `AmountPercent` (object, required) Parent object when amount is applied as an Amount or a Percent. - ManualFareAdjustmentDiscount: - `AmountPercent` (object, required) Parent object when amount is applied as an Amount or a Percent. - `RequestedPricingModifiers.PricingModifiersAir.BrandPreference` (array) - `RequestedPricingModifiers.PricingModifiersAir.includeSplitPaymentInd` (boolean) Requests request split ticketing, which returns outbound and inbound one-way fares in addition to round trip options in the Search API response. This may result in lower fares than the same or similar round-trip itinerary. If true, requests split ticketing. If false or omitted split ticketing options are not returned. Default is false. GDS only, not supported for NDC. When split ticketing is requested, the Search response returns offers in the following order: Outbound one-way offers, Inbound one-way offers, Round trip offers. The response identifies all one-way outbound and inbound offers with CombinabilityCode j0. CombinabilityCode values for round trip offers start at j1 and increment by one for each offer. Only the following are in scope for split ticketing: Search (not supported for Next Leg Search or Flight Specific Search), Round-trip journey-based offerings ( isJourney header not sent or sent as true, or CustomResponseModifiersAir/SearchRepresentation not sent or sent with value Journey ) Upsells. Split ticketing is not supported for round-trip leg-based searches, virtual interlining, or NDC. Split ticketing is available only for customers specifically provisioned for split ticketing. Split ticketing returns one-way outbound and one-way inbound fares in addition to round-trip offers. Split ticket offers are identified with CombinabilityCode j0. If your account is not configured for split ticketing, sending includeSplitPaymentInd returns a response without split ticket offers and a warning message. GDS only, not supported for NDC. In Air Price, For split ticketing, the request must send offers that are identified in the Search response with CombinabilityCode j0, which identifies those offers as one-way outbound and one-way inbound split ticketing offers. A combination of j0 and any non-j0 value offer returns an error message that split pricing is not supported - `RequestedPricingModifiers.PricingModifiersAir.returnMostRestrictiveBrandInd` (boolean) In Search API, when there are different brands on a connecting flight, return information for either the most restrictive brand or the brand on the most significant segment on the itinerary. If true, return the offer brand of the most restrictive brand. If false or omitted, return the offer brand of the most significant segment of the itinerary. GDS only, not supported for NDC. - `RequestedPricingModifiers.PricingModifiersAir.splitPaymentOfferings` (number) Number between 0 and 99. Send with includeSplitPaymentInd to configure the percentage of round trip offers to return in a split ticketing response. By default, Search divides the split ticketing response into 34% round-trip offerings and the remainder as split ticketing offers, which are combined outbound and inbound one-way fares. To change this percentage, send SplitPaymentOfferings with the percentage value of round trip offers to return. Example: 25 - `RequestedPricingModifiers.CabinPreference` (object) Requests a fare based on the cabin class. Only one cabin preferenceType (Permitted, Preferred, PreferredWithUpgrade) is allowed per request, but there is no limit to the number of cabins that can be sent. Any CabinPreference in the initial Search request is applied to any subsequent Next Leg Search and reference Flight Specific Search requests. In AirPrice and AirReservation only one cabin preference type is allowed per request, but there is no limit to the number of cabins that can be sent. If CabinPreference was sent in the Search request, it is cached and sent with the AirPrice reference payload request. If you send CabinPreference in the AirPrice request, all cached modifiers are discarded and only the modifiers sent in the AirPrice request are used. Can be combined with lowFareFinderInd=true to return lowest fare in the requested cabin or cabins. When using CabinPreference and lowFareFinderInd, if both CabinPreference and a class of service are sent, class of service is ignored. If CabinPreference is sent without a class of service, the response returns the lowest fare in the cabin requested. If that cabin is not available, the response may upgrade or downgrade to a different cabin. If a different cabin than requested is returned, the response returns the message that the cabin class may differ from the class requested. If lowFareFinderInd=false and CabinPreference are sent in the request, AirPrice ignores the preferred cabin and returns a message that the preferred cabin was ignored. If CabinPreference is set to All, no cabin preference is applied." - `RequestedPricingModifiers.CabinPreference.@type` (string, required) Discriminator. No child classes exist Example: "CabinPreference" - `RequestedPricingModifiers.CabinPreference.preferenceType` (string) Type of cabin preference. Sending a mix of preferenceType values is not supported. For example, you cannot send an instance of CabinPreference with a preferenceType of Permitted and another instance with preferenceType of Prohibited. In this case the results default to the Preferred preference. Note that if lowFareFinderInd is sent with true and CabinPreference is sent, the only supported value for CabinPreference/type is Permitted. Enum: same as `RequestedPricingModifiers.CabinPreference.preferenceType` in "PriceBreakdownAir" (4 values) - `RequestedPricingModifiers.CabinPreference.cabins` (array) A space-delimited list of cabins. Enum: same as `PassengerFlight.FlightProduct.cabin` in "ProductAir" (5 values) - `RequestedPricingModifiers.CabinPreference.legSequence` (array) Limits preference to the specified leg referenced in SearchCriteriaFlight. You can apply the preference to only some legs of the itinerary, or different preferences to different legs. To apply preference to the entire itinerary, do not send legSequence. GDS only, not supported for NDC. Not supported at Price or Book. Example: [1,2] - `RequestedPricingModifiers.FlightType` (object) The type of flight connection - `RequestedPricingModifiers.FlightType.@type` (string, required) Discriminator. No child classes. Example: "FlightType" - `RequestedPricingModifiers.FlightType.connectionType` (string) Limits the connection type returned. Each value returns the specified type and all higher types. For example, StopDirect could return both flights that stop without a change of planes (StopDirect) and non-stop direct flights (NonStopDirect). SingleConnection or DoubleConnection will not exclude StopDirect flights from the journey. For example, SingleConnection could return an itinerary with two flight numbers, and either of these flights could have intermediate stops. Enum: same as `RequestedPricingModifiers.FlightType.connectionType` in "PriceBreakdownAir" (5 values) - `RequestedPricingModifiers.FlightType.excludeInterlineConnectionsInd` (boolean) Excludes interline connectionsClosed from results. If true, does not return offers with interline connections. If false or omitted, may return interline connections in results. Default is false. GDS only, not supported for NDC. When a product contains multiple interline air segments, brand details return only the brand of the significant carrier, not the validating/plating carrier brand information. The IATA rules for determining the significant carrier on an itinerary are based on the areas in which the transportation takes place. Example: true - `RequestedPricingModifiers.CustomResponseModifiersAir` (object) Contains additional modifiers to customize the result set. Includes optional indicators for returning or excluding specified response content. Values sent at Search can carry forward into the Next Leg Search request and are not re-sent. - `RequestedPricingModifiers.CustomResponseModifiersAir.@type` (string, required) discriminator Example: "CustomResponseModifiersAir" - `RequestedPricingModifiers.CustomResponseModifiersAir.BrandAttributeInclusion` (array) Supported in AirSearch and AirPrice. Returns only information about the brand attributes specified and does not return any other brand attributes. - `RequestedPricingModifiers.CustomResponseModifiersAir.SearchRepresentation` (string) Specifies either a journey or leg-based response. Journey returns offers for all legs of the itinerary. Journey is the default. Leg returns offers for only the first leg of the itinerary. Must be followed with a Next Leg Search to select an offer for the first leg and return offers on the subsequent leg to combine with it.Customize search result set as leg or journey based. Next Leg Search requests, and Flight Specific Search requests for less than the full itinerary, are supported only after a leg-based Search, not a journey-based Search. If these requests follow a journey-based Search request, an error message is returned. Enum: same as `RequestedPricingModifiers.CustomResponseModifiersAir.SearchRepresentation` in "PriceBreakdownAir" (3 values) - `RequestedPricingModifiers.CustomResponseModifiersAir.excludePenaltiesInd` (boolean) GDS only; not supported for NDC. Indicator to omit change and cancel penalties. - If true: omits all penalty information from the response. - If false (default behavior): returns any change and penalty details provided by carrier for each offer in TermsAndConditionsFullAir/Penalties. If sent in Search but not in AirPrice, the value sent in Search is cached and applied to the AirPrice results. However, you can override the value sent in Search by sending excludePenaltiesInd in the AirPrice request with the opposite value. For example, if the Search request sends excludePenaltiesInd=true and the AirPrice request sends excludePenaltiesInd=false, the Search response does not return penalties and the AirPrice response does return penalties. Example: true - `RequestedPricingModifiers.CustomResponseModifiersAir.excludeBaggageFeesInd` (boolean) GDS only; not supported for NDC. Indicator to exclude baggage details. - If true: excludes baggage fees, carry on fees, and embargo information from the response. Baggage quantity or weight is returned instead. - If false (default behavior): baggage details returned in response. Default is false. Example: true - `RequestedPricingModifiers.CustomResponseModifiersAir.includeFareCalculationInd` (boolean) GDS only; not supported for NDC or in the Flight Specific Search full payload request. Indicator to request the return of the fare calculation ladder. - If true: returns the fare calculation ladder in BestCombinablePrice.PriceBreakdownAir.FareCalculation. - If false (default behavior): fare calculation ladder is not returned. Example: true - `RequestedPricingModifiers.CustomResponseModifiersAir.excludeSurchargesInd` (boolean) GDS only; not supported for NDC. Indicator to exclude a surcharge breakdown. - If true: excludes a surcharge breakdown from the response. Baggage quantity or kilos is returned instead. - If false (default behavior): surcharge breakdown returned in response. Example: true - `RequestedPricingModifiers.CustomResponseModifiersAir.excludeUnbundledFaresInd` (boolean) GDS only, not supported for NDC. Sets whether to return unbundled fares. Supported in AirSearch and AirPrice. - If true: does not return unbundled fares. - If false (default behavior): returns unbundled and bundled fares as available. Example: true - `RequestedPricingModifiers.CustomResponseModifiersAir.includeCO2EmissionsDataInd` (boolean) Indicator to return CO2 emission data in the Search and Next Leg Search responses. - If true: returns CO2 emission data. - If false (default behavior): CO2 emission data not returned. Example: true - `RequestedPricingModifiers.CustomResponseModifiersAir.includeFlightAmenitiesInd` (boolean) Indicator to return flight amenities from ATPCO RouteHappy data. - If true: includes amenities in the response if available. - If false: Does not return ATPCO RouteHappy amenities. Example: true - `RequestedPricingModifiers.CustomResponseModifiersAir.includeUniversalProductAttributesInd` (boolean) Indicator to return universal product attributes (UPAs), which include images, icons, and URLs as provided by ATPCO. Must also send includeFlightAmenitiesInd=true. - If true: returns universal product attributes if available. - If false (default behavior): Universal product attributes not returned. UPAs are not returned for direct flights with intermediate stops, non-flight segments such as trains, or for Premium Business class. Example: true - `RequestedPricingModifiers.CustomResponseModifiersAir.includeBundledAncillariesInd` (boolean) NDC only. If true: the search and price response will include bundled air and ancillary offerings/offers. Search and Price response will contain both ProductAir and ProductAncillary plus a new child class of PriceBreakdown: PriceBreakdownAncillaryAir to define the ancillary inclusion and pricing. Example: true - `RequestedPricingModifiers.CustomResponseModifiersAir.includeFullPenaltyDisclosureInd` (boolean) If true, penalty information sourced from ATPCO Cat 31 and 33 will be disclosed. Penalties may be exposed at fare component level and include time windows. - `RequestedPricingModifiers.PricingModifiersAirChange` (object) Pricing Modifiers that can be used to influence the Price of an Exchanged Offer - `RequestedPricingModifiers.PricingModifiersAirChange.@type` (string) Example: "PricingModifiersAirChange" - `RequestedPricingModifiers.PricingModifiersAirChange.currencyCode` (string) ISO 4217 currency code Example: "USD" - `RequestedPricingModifiers.PricingModifiersAirChange.FareSelection` (object) Requests the return of fare types including private fares (negotiated), public fares (published), or net fares (consolidator fares, or any negotiated wholesale price that is further marked up for sale to customers). May be used to request fares with specific restrictions, change, or refund options. - `validatingCarrier` (string) IATA code for a carrier to override any default validating carrier (the airline designator that the ticket is issued against). If the validating carrier code is not supported for an itinerary, the response returns the error Ticketing Agreement does not exist. If an invalid validating carrier code is sent in the request, the response returns the error Unknown Carrier. Example: "KA" - `prohibitMinStayFaresInd` (boolean) If true, returns only fares that do not require a minimum stay. False allows minimum stay fares. Default is false. Example: true - `prohibitMaxStayFaresInd` (boolean) If true, returns only fares that do not require a maximum stay. False allows maximum stay fares. Default is false. Example: true - `refundableOnlyInd` (boolean) If true, returns only fares that are fully refundable. Default is false. Example: true - `prohibitAdvancePurchaseFaresInd` (boolean) If true, returns only fares that do not require advance purchase. False allows fares with advance purchase restrictions. Default is false. Example: true - `prohibitUnbundledFaresInd` (boolean) Example: true - `prohibitRefundableFaresInd` (boolean) This field is deprecated. Use RefundOptions for refundability options Example: true - `RequestedPricingModifiers.PricingModifiersAirChange.OrganizationInformation` (object) Use to send account codes for negotiated fares or to send optional India GST SSR Remarks in GSTRegistrationNumber. For NDC supports corporate loyalty program and GST Information. This information is returned in TermsAndConditions." - `RequestedPricingModifiers.PricingModifiersAirChange.WaiverCode` (object) A code assigned by an airline to support waiver of fees or ticket value as a result of disruption to the passenger. - `RequestedPricingModifiers.PricingModifiersAirChange.WaiverCode.value` (string) - `RequestedPricingModifiers.PricingModifiersAirChange.WaiverCode.reasonCode` (integer) A code assigned to identify the reason for disruption Example: 2 - `RequestedPricingModifiers.PricingModifiersAirChange.WaiverCode.waiverType` (string) List of waiver types. Enum: same as `RequestedPricingModifiers.PricingModifiersAirChange.WaiverCode.waiverType` in "PriceBreakdownAir" (5 values) - `RequestedPricingModifiers.PricingModifiersAirChange.TaxExemption` (object) GDS only, not supported for NDC. Use to mark some or all taxes as exempt. Specify all taxes, only specific tax codes, or all taxes in specific countries. Must include either allTaxesExemptInd OR both countries and taxCodes. TaxExemption supports up to nine values for countries, taxCodes, or both combined. The response returns any exempt taxes with exemptInd=true and value=0. - `RequestedPricingModifiers.PricingModifiersAirChange.PromotionalCode` (object) NDC only. Not supported for GDS. Any NDC airline designated promotional code. - `RequestedPricingModifiers.PricingModifiersAirChange.PromotionalCode.value` (string) The promotional code to apply Example: "CDFRT" - `RequestedPricingModifiers.PricingModifiersAirChange.PromotionalCode.supplierCode` (string, required) The IATA code for the airline on which the promotional code is applicable. Example: "AA" - `RequestedPricingModifiers.PricingModifiersAirChange.SellCity` (string) Overrides the sell city of the requestor Example: "MEX" - `RequestedPricingModifiers.PricingModifiersAirChange.TicketCity` (string) Overrides the ticket city of the requestor Example: "MEX" - `RequestedPricingModifiers.PricingModifiersAirChange.PricingPCC` (string) Overrides the pricing PCC of the requestor Example: "0XS4" - `RequestedPricingModifiers.PricingModifiersAirChange.TicketingPCC` (string) Overrides the ticketing PCC of the requestor Example: "0XCD" - `RequestedPricingModifiers.PricingModifiersAirChange.CalculatedFareAdjustment` (object) — one of (discriminator: @type): Used in Exchange Search to modify the Price of the Fare. Discriminator classes CalculatedFareAdjustmentDiscount or CalculatedFareAdjustmentIncrease - CalculatedFareAdjustmentDiscount: - `AmountPercent` (object) Parent object when amount is applied as an Amount or a Percent. - CalculatedFareAdjustmentIncrease: - `AmountPercent` (object, required) Parent object when amount is applied as an Amount or a Percent. - `RequestedPricingModifiers.PricingModifiersAirChange.BrandPreference` (array) - `RequestedPricingModifiers.PricingModifiersAirChange.keepToBrandInd` (boolean) If true, the offerings returned will be of the same brand as the original Offer Example: true - `RequestedPricingModifiers.PricingModifiersAirChange.returnMostRestrictiveBrandInd` (boolean) if true, the most restrictive brand will be returned in the response when there are different brands present in the Offering Example: true - `RequestedPricingModifiers.PricingModifiersAirChange.doNotNetInd` (boolean) If true, this exchange will not net any residual/refundable amounts against due amounts. - `RequestedPricingModifiers.lowFareFinderInd` (boolean) Provides pricing flexibility around class of service. If not sent, the response returns fares only in the requested class of service. If true, returns the lowest fares available in any class of service available, which may not be the same as the requested class. Note that if lowFareFinderInd is sent with true and CabinPreference is sent, the only supported value for CabinPreference/type is Permitted. When lowFareFindInd=true and brand attributes are not disabled (inhibitBrandContentInd), AirPrice uses only the brand tier (and any other pricing modifiers) to find the lowest fare within a brand tier regardless of class of service. GDS only; not supported for NDC. Example: true - `RequestedPricingModifiers.keepToBrandInd` (boolean) If true, the original brand will be maintained during the exchange process. Example: true - `RequestedPricingModifiers.lowFareFindAndRebookInd` (boolean) If true, the original flights in the reservation will be rebooked or replaced with the new exchanged flights. - `PassengerCriteriaRefs` (array) NDC only; not supported for GDS. Returned for NDC if a traveler identifier was sent for this traveler in the previous workflow requests. Example: ["passengerCriteria_1"] - `FlightPassCredits` (integer) The number of flight pass credits consumed for this pricebreakdown. Example: 1 - PriceBreakdownAncillary: - `inclusiveOfTaxInd` (boolean) If true, this ancillary is sold inclusive of tax. Example: true - `quantity` (integer) The quantity of ancillary items included in this PriceBreakdown. Example: 1 - `Description` (object) A description of the ancillary with description codes. - `Description.value` (string) The text description of the ancillary. Example: "Vegetarian Meal" - `Description.code` (string) The ATPCO group code. Example: "BG" - `Description.subCode` (string) The ATPCO RFISC subcode. Example: "0D4" - `Description.subGroup` (string) The ATPCO sub group code. Example: "SP" - `Description.codeContext` (string) The code context value. Example: "ATPCO" - `Description.ssrCode` (string) The four character AIRIMP SSR code for this ancillary. Example: "VGML" - `Description.issuanceReasonCode` (string) The airline provided reason for issuance code. Example: "C" - `Description.geographicSpecification` (string) How the ancillary is applied across the itinerary. Enum: same as `Ancillary.Description.geographicSpecification` in "ProductAncillary" (3 values) - `ProductRef` (string) The product ref this PriceBreakdown applies to. If no productRef exists then the PriceBreakdown applies to all Products within the Offer. Example: "p_1" - `Discount` (object) NDC only; not supported for GDS. Returned for a fare discounted from the published price, such as a promotional discount. Not returned for privately negotiated discounts such as private fares. - `Discount.value` (number) The amount value of the discount Example: 20.22 - `Discount.description` (string) The text description for the discount. Example: "Spring discount on group bookings" - `Discount.currencyCode` (string, required) Currency code discount is returned in. Example: "USD" - `Discount.codeAuthority` (string, required) Not used. Currency code Authority. Example: "ISO" - `Discount.decimalPlace` (integer, required) Number of decimal places in the currency the discount is returned in. Example: 2 - `Discount.decimalAuthority` (string) Not used. Decimal Authority. Example: "ISO" - `TravelerIdentifierRef` (object) Identifier references as object both within a message payload or an object held in cache that may be used for subsequent workflows. Returned for NDC in the Price response if age was sent for this traveler in the previous workflow requests. - `TravelerIdentifierRef.name` (string) Traveler identifier - `TravelerIdentifierRef.passengerTypeCode` (string) Passenger Type code Example: "ADT" - `TravelerIdentifierRef.ages` (array) The ages of the travelers associated to a particular ptc. For NDC, this value will be returned in PriceBreakdownAir if sent as part of the PassengerCriteria in the Air Search request. Example: [15] - `TravelerIdentifierRef.passengerCriteriaRef` (string) Allows the user to associate passenger criteria information. Example: "passengerCriteria_1" - `TravelerIdentifierRef.value` (string) - `TravelerIdentifierRef.id` (string) A locally referenced ID - `TravelerIdentifierRef.description` (string) Descriptive text used to identify the contents of a target object - `TravelerIdentifierRef.uris` (array) Uniform Resource Identifier Example: ["google.com"] - `TravelerIdentifierRef.age` (integer) Replaced with ages array. The age of the traveler. Example: 11 - `AncillaryPriceApplicationCode` (object) Determines how an ancillary price has been built. - `AncillaryPriceApplicationCode.value` (string) Example: "3" - `AncillaryPriceApplicationCode.application` (string) Associated text. Example: "PerItem" - PriceBreakdownHospitality: - `roomPricingType` (string) A string provided by the hotel to describe how a service is priced, such as per night or per stay. Enum: same as `roomPricingType` in "PriceBreakdownHospitality" (5 values) - `Description` (string) Example: "Advance Purchase-Ro-Free WiFi" - `NightlyRate` (array) - `NightlyRate.@type` (string) - `NightlyRate.startDate` (string, required) Start date for the nightly rate in YYYY-MM-DD format. - `NightlyRate.nights` (integer) Number of nights the nightly rate is valid. - `NightlyRate.Amount` (object, required) Amount represents the cost applied - `AverageNightlyRate` (array) The average nightly rate for a given offer. - `AverageNightlyRate.value` (number) The amount of a given currency. Example: 124.56 - `AverageNightlyRate.code` (string) An ISO 4217 alpha character code (3 characters) that specifies a money unit. Example: "USD" - `AverageNightlyRate.minorUnit` (integer) Minor units are a mechanism for expressing the relationship between a major currency unit and its corresponding minor currency unit. It is the smallest unit of a given currency. For example; the smallest denomination in USD is the cent, which is 1/100 of a USD, and the minor unit value is 2. Not all currencies have a minor unit. Example: 2 - `AverageNightlyRate.currencySource` (string) The system requesting or returning the currency code specified in the attribute Enum: same as `MinimumAdcolAmount.currencySource` in "ChangePermitted" (3 values) - `AverageNightlyRate.approximateInd` (boolean) "If true, the currency amount has been converted from the original amount. For Air Exchange Eligibility, returned only if a currency is converted. If returned, the value is always true, indicating that the fee is approximate because of currency conversion. For Hotel Availability and Rules, true indicates this is a calculated value; false indicates this is the value returned by the property." Example: true - `AmenitySurcharges` (object) Amenity Surcharges information. - `AmenitySurcharges.@type` (string, required) Discriminator classes AmenitySurcharges or AmenitySurchargesDetail Example: "AmenitySurchargesDetail" - `AmenitySurcharges.TotalSurcharges` (number) A monetary amount, up to 4 decimal places. Decimal place needs to be included. Example: 211.11 - `AmenitySurcharges.approximateInd` (boolean) if true, the surcharge amounts are approximate - `AmenitySurcharges.Surcharge` (array, required) - `AmenitySurcharges.Surcharge.value` (number) Surcharge amount Example: 12 - `AmenitySurcharges.Surcharge.currencyCode` (string) ISO 4217 currency code for the surcharge. Example: "USD" - `AmenitySurcharges.Surcharge.surchargeCode` (string) Surcharge code Example: "ADDITIONAL COSTS" - `AmenitySurcharges.Surcharge.reportingAuthority` (string) Not used. Surcharge reporting authority Example: "Federal register" - `AmenitySurcharges.Surcharge.purpose` (string) Surcharge purpose. For Air workflows possible values include Weekend Surcharge, Stopover Charge, Multiple Stopover Charges, Other (default value that covers all other surcharges such as fuel surcharges). Example: "Weekend Surcharge" - `AmenitySurcharges.Surcharge.description` (string) Description of the surcharge. Example: "Rollaway Surcharge" - `AmenitySurcharges.Surcharge.surchargeApplication` (string) Application values (such as the application of a fee) like per person or per room. Enum: same as `Surcharge.surchargeApplication` (7 values) - `AmenitySurcharges.Surcharge.surchargeFrequency` (string) The frequency of a fee such as per night or per stay. Enum: same as `Surcharge.surchargeFrequency` (6 values) - `AmenitySurcharges.Surcharge.codeAuthority` (string) Not used. Currency code authority. Example: "ISO 4217" - `AmenitySurcharges.Surcharge.decimalPlace` (integer) Decimal place for the currency unit. Example: 4 - `AmenitySurcharges.Surcharge.decimalAuthority` (string) Not used. Currency code decimal authority. Example: "ISO 4217" - `priceChangesDuringStayInd` (boolean) "If true, indicates the price changes at least once during requested dates. If roomPricingType = Per night, multiple instances of priceChangesDuringStayInd are returned." - `shortRateDescription` (string) A normalized rate description for comparing rates across multiple aggregators. Example: "Flexible Rate" - PriceBreakdownVehiclePrice: - `VehiclePrice` (object, required) Rate summary for rental of the vehicle. - `VehiclePrice.@type` (string, required) Example: "VehiclePrice" - `VehiclePrice.id` (string) Internal ID - `VehiclePrice.rateSource` (string) Assigned Type: c-1100:StringTiny - `VehiclePrice.rateGuaranteedInd` (boolean) Assigned Type: c-1100:OptionalIndicator - `VehiclePrice.ratePeriod` (string) The time period for a rate such as daily, weekly, monthly Enum: same as `VehiclePrice.ratePeriod` in "PriceBreakdownVehiclePrice" (15 values) - `VehiclePrice.RateDistance` (object) Rate for the period defined by the attributes - `VehiclePrice.RateDistance.value` (number) - `VehiclePrice.RateDistance.unlimitedDistanceInd` (boolean) if true unlimited miles is included with the rental - `VehiclePrice.RateDistance.requestedCodeAppliedInd` (boolean) if true, the requested code has been applied - `VehiclePrice.RateDistance.allowance` (integer) The distance allowance permitted with this rate. Use in combination with distanceUnits and ratePeriod - `VehiclePrice.RateDistance.distanceUnits` (string) For Hotels: Optional object to request either miles or kilometers for the search radius from the specified location. If unitOfDistance is not specified, the search defaults to miles for properties in the United States, Myanmar, and Liberia. The search defaults to kilometers in all other countries. Enum: same as `Vehicle.VehicleDateLocation.RentalPickup.GeoLocation.altitudeUnitOfDistance` in "ProductVehicle" (2 values) - `VehiclePrice.RateDistance.ratePeriod` (string) The time period for a rate such as daily, weekly, monthly Enum: same as `VehiclePrice.ratePeriod` in "PriceBreakdownVehiclePrice" (15 values) - `VehiclePrice.RateDescription` (array) - `sequence` (integer) The order of the text block, if there are more than one block. Example: 2 - `description` (string) Text block detail description Example: "description" - `Image` (object) Each instance is one image and its accompanying details, including a link to the image. Key value pairs; not all may be returned. - `Image.value` (string) URL of the image - `Image.dimensionCategory` (string) Deprecated and replaced by imageSize - `Image.width` (integer) Image width Example: 42 - `Image.height` (integer) Image height Example: 43 - `Image.caption` (string) Image caption Example: "Ticket" - `Image.pictureCategory` (integer) deprecated and replaced by pictureOf Example: 5 - `Image.imageSize` (string) A size for the image to return, allowing you to set image quality. Hospitality APIs no longer support thumbnail. Enum: same as `Vehicle.Image.imageSize` in "ProductVehicle" (5 values) - `Image.pictureOf` (string) The image category Enum: same as `Vehicle.Image.pictureOf` in "ProductVehicle" (26 values) - `URL` (string) A URL for this block - `DateCreateModify` (object, required) Time stamp of the creation. - `DateCreateModify.value` (string) Example: "2026-03-04T11:22:00Z" - `DateCreateModify.creatorID` (string) ID of creator. Software system identifier or an employee id Example: "c1234563" - `DateCreateModify.lastModify` (string) Time stamp of last modification. Example: "2026-03-04T11:24:00Z" - `DateCreateModify.lastModifierID` (string) Identifies the last software system or person to modify a record Example: "m346789" - `DateCreateModify.purge` (string) Date an item will be purged from a system of record Example: "2026-03-03" - `VehiclePrice.RateDescription.@type` (string, required) Discriminator classes TextBlock or TextBlockDetail Example: "TextBlockDetail" - `VehiclePrice.RateDescription.title` (string) "The title of the rule or information. For TermsAndConditionsFullHospitality, may include any of the following Rule Types; Promotional Data, Rate Description, Room Rate Data, Rate Text, Guarantee, Cancellation, Deposit, Check in/out, Room detail, Extra charges, Packages, Property, Location, Miscellaneous, Rate Amount, Alternate Rate Amount, Rate Comment, FAX, Phone, Special Information, Information, Room Hold Expiration Time. Not every property returns all of these types. Some properties do not return any title. Only English is supported for these values." Example: "Baggage Details" - `VehiclePrice.RateDescription.id` (string) Internally referenced id Example: "2" - `VehiclePrice.RateDescription.TextFormatted` (array, required) - `VehiclePrice.RateAvailability` (string) Options are available to sell, need to call, or closed Enum: same as `VehiclePrice.RateAvailability` in "PriceBreakdownVehiclePrice" (3 values) - `VehiclePrice.SupplierRate` (object, required) Estimated total amount - Monetary amounts expressed in another currency. - `VehiclePrice.SupplierRate.@type` (string, required) Example: "SupplierRate" - `VehiclePrice.SupplierRate.BaseRate` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.SupplierRate.BaseRate.value` (number) The amount of a given currency. Example: 124.56 - `VehiclePrice.SupplierRate.BaseRate.code` (string) An ISO 4217 alpha character code (3 characters) that specifies a money unit. Example: "USD" - `VehiclePrice.SupplierRate.BaseRate.minorUnit` (integer) Minor units are a mechanism for expressing the relationship between a major currency unit and its corresponding minor currency unit. It is the smallest unit of a given currency. For example; the smallest denomination in USD is the cent, which is 1/100 of a USD, and the minor unit value is 2. Not all currencies have a minor unit. Example: 2 - `VehiclePrice.SupplierRate.BaseRate.currencySource` (string) The system requesting or returning the currency code specified in the attribute Enum: same as `MinimumAdcolAmount.currencySource` in "ChangePermitted" (3 values) - `VehiclePrice.SupplierRate.BaseRate.approximateInd` (boolean) "If true, the currency amount has been converted from the original amount. For Air Exchange Eligibility, returned only if a currency is converted. If returned, the value is always true, indicating that the fee is approximate because of currency conversion. For Hotel Availability and Rules, true indicates this is a calculated value; false indicates this is the value returned by the property." Example: true - `VehiclePrice.SupplierRate.RateForPeriod` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.SupplierRate.DropOffCharge` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.SupplierRate.ExtraMileageCharge` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.SupplierRate.EstimatedTotalAmount` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.ApproximateRate` (object) Estimated total amount - Monetary amounts expressed in another currency. - `VehiclePrice.ApproximateRate.@type` (string, required) Example: "ApproximateRate" - `VehiclePrice.ApproximateRate.BaseRate` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.ApproximateRate.RateForPeriod` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.ApproximateRate.DropOffCharge` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.ApproximateRate.ExtraMileageCharge` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.ApproximateRate.EstimatedTotalAmount` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehiclePrice.CustomerLoyalty` (object) Specifies the ID for the membership program. Object for sending customer loyalty information, such as for a frequent flyer program. For Hotel send the loyalty card number in the value field, followed by programID with the hotel chain code, and supplierType: Hotel. For Air send the loyalty card number in the value field, followed by airline code in "supplier". For cross accrual use the "shareWithSupplier" field to submit to partner airlines. - `VehiclePrice.CustomerLoyalty.value` (string, required) Number on loyalty card. Example: "132456" - `VehiclePrice.CustomerLoyalty.id` (string) Optional Customer Loyalty Id. Not saved Example: "Loyalty_1" - `VehiclePrice.CustomerLoyalty.priority` (integer) Optional Numeric Priority Code Example: 2 - `VehiclePrice.CustomerLoyalty.programId` (string) "Specifies an identifier to indicate the company owner of the loyalty program. Typically two characters. For frequent guest number, the hotel supplier or brand code. For frequent flyer number, the air supplier code of the loyalty program." Example: "HY" - `VehiclePrice.CustomerLoyalty.programName` (string) Supplier's loyalty program name. Example: "Frontier-EarlyReturns" - `VehiclePrice.CustomerLoyalty.supplierType` (string) The type of supplier of a loyalty program. Uses 'hotel' for frequent guest number or 'air' for frequent flyer number. Example: "Hotel" - `VehiclePrice.CustomerLoyalty.supplier` (string) Supplier of a loyalty program (typically 2 characters representing the hotel, brand, or airline). Example: "UA" - `VehiclePrice.CustomerLoyalty.tier` (string) Customer Loyalty tier Example: "Silver" - `VehiclePrice.CustomerLoyalty.shareWithSupplier` (array) The list of suppliers that the CustomerLoyalty number is shared. Used for cross accrual. Example: ["LH"] - `VehiclePrice.CustomerLoyalty.cardHolderName` (string) Customer loyalty member name; up to 128 characters are supported. In Air Search, for discounted offers to be returned, the name must be sent as LAST FIRST; e.g.,if SMITH is the last name and JORDAN the first name, send as SMITH JORDAN Example: "John Smith" - `VehiclePrice.CustomerLoyalty.validatedInd` (boolean) Customer loyalty number has been validated by the supplier Example: true - `VehiclePrice.CustomerLoyalty.prefix` (string) The cardholder name prefix title like Mr, Mrs, Dr Example: "Dr" - `VehiclePrice.CustomerLoyalty.given` (string) The First Name of the Cardholder Example: "John" - `VehiclePrice.CustomerLoyalty.middle` (string) Middle Name of the Cardholder Example: "Wilkinson" - `VehiclePrice.CustomerLoyalty.surname` (string) Last Name of the Cardholder Example: "Smith" - `VehiclePrice.RateQualifier` (string) A closed enumeration of possible rate qualifiers for vehicle rental Enum: same as `VehiclePrice.RateQualifier` in "PriceBreakdownVehiclePrice" (5 values) - `rateGuaranteedInd` (boolean) - PriceBreakdownVehicleDeposit: - `totalPayableNowInd` (boolean) If True the Amount is the total amount payable now - `totalPayableLaterInd` (boolean) If True the Amount is the total amount payable later - PriceBreakdownVehicleCharges: - `VehicleCharges` (object) - `VehicleCharges.@type` (string, required) Example: "VehicleCharges" - `VehicleCharges.description` (string) Assigned Type: c-1100:String - `VehicleCharges.VehicleChargePurposeCode` (object) Any code used to specify an item, for example a type of traveler, service code, room amenity, etc. - `VehicleCharges.VehicleChargePurposeCode.value` (string) Example: "INS" - `VehicleCharges.VehicleChargePurposeCode.codeContext` (string) Code Context Example: "ACRISS" - `VehicleCharges.ratePeriod` (string) The time period for a rate such as daily, weekly, monthly Enum: same as `VehiclePrice.ratePeriod` in "PriceBreakdownVehiclePrice" (15 values) - `VehicleCharges.rateChargeInfo` (string) Assigned Type: c-1100:String - `VehicleCharges.RateCategory` (string) For Hotel Search, request a rate category by sending up to 8 OTA rate categories to search for. If the supplier has rates available for the requested category, the response contains those rates and indicates them as such. Some properties do not return these rates unless explicitly requested. For a Hotel Rules request, this value can be found, if returned, in the Availability response's ProductRateCodeInfo/RateCodeInfo/rateCategory. Enum: same as `VehicleCharges.RateCategory` in "PriceBreakdownVehicleCharges" (32 values) - `VehicleCharges.VehicleCoverageTypeCode` (object) The OTA code defined for the Vehicle Coverage Type - `VehicleCharges.VehicleCoverageTypeCode.value` (string) Example: "INS" - `VehicleCharges.VehicleCoverageTypeCode.codeContext` (string) Code Context Example: "ACRISS" - `VehicleCharges.Calculation` (array) - `VehicleCharges.Calculation.@type` (string, required) Example: "Calculation" - `VehicleCharges.Calculation.UnitAmount` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehicleCharges.Calculation.UnitAmount.value` (number) The amount of a given currency. Example: 124.56 - `VehicleCharges.Calculation.UnitAmount.code` (string) An ISO 4217 alpha character code (3 characters) that specifies a money unit. Example: "USD" - `VehicleCharges.Calculation.UnitAmount.minorUnit` (integer) Minor units are a mechanism for expressing the relationship between a major currency unit and its corresponding minor currency unit. It is the smallest unit of a given currency. For example; the smallest denomination in USD is the cent, which is 1/100 of a USD, and the minor unit value is 2. Not all currencies have a minor unit. Example: 2 - `VehicleCharges.Calculation.UnitAmount.currencySource` (string) The system requesting or returning the currency code specified in the attribute Enum: same as `MinimumAdcolAmount.currencySource` in "ChangePermitted" (3 values) - `VehicleCharges.Calculation.UnitAmount.approximateInd` (boolean) "If true, the currency amount has been converted from the original amount. For Air Exchange Eligibility, returned only if a currency is converted. If returned, the value is always true, indicating that the fee is approximate because of currency conversion. For Hotel Availability and Rules, true indicates this is a calculated value; false indicates this is the value returned by the property." Example: true - `VehicleCharges.Calculation.UnitName` (string) The time period for a rate such as daily, weekly, monthly Enum: same as `VehiclePrice.ratePeriod` in "PriceBreakdownVehiclePrice" (15 values) - `VehicleCharges.Calculation.Quantity` (integer) The quantity used in the calculation of the vehicle charge e.g 2 x $500 per week - `VehicleCharges.Calculation.MaxQuantity` (integer) The maximum quantity allowed for a charge e.g Baby seat charged at $10 per day for a maximum of 10 days - `VehicleCharges.Calculation.TotalAmount` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `VehicleCharges.Calculation.Percent` (number) Used when the charge is based on a percentage of a TotalAmount - `VehicleCharges.Calculation.Applicability` (object) Textual information. - `VehicleCharges.Calculation.Applicability.value` (string) Actual text. May be restricted by character limits based on the type of comment (e.g. Notepad remarks limited to 87 characters). Example: "Additional comments" - `VehicleCharges.Calculation.Applicability.id` (string) Local identifier within a given message for this object. Example: "comment_1" - `VehicleCharges.Calculation.Applicability.name` (string) Title of comment or type of remark. Example: "Comment name" - `VehicleCharges.Calculation.Applicability.language` (string) Language code using ISO-639 standard Example: "EN" - `VehicleCharges.taxInclusiveInd` (boolean) - `VehicleCharges.guaranteedInd` (boolean) - `VehicleCharges.payNowInd` (boolean) If true the vehicle charge must be paid now and is included in the totalPrice calculation - `VehicleCharges.includedInEstimatedTotalInd` (boolean) - `VehicleCharges.includedInBaseRateInd` (boolean) If true the Vehicle Charge has been included in the base rate of the Vehicle price - `PriceBreakdown.@type` (string, required) Discriminator - Air Search and Air Price APIs child classes are PriceBreakdownAir and PriceBreakdownAncillary. - Search Ancillaries and Seat Availabilities child classes are PriceBreakdown, PriceBreakdownAncillary, and PriceBreakdownAncillaryAir. - All Hotel API child classes are PriceBreakdownHospitality. - Vehicle API child classes are PriceBreakdownVehicleCharges, PriceBreakdownVehicleDeposit, PriceBreakdownVehiclePrice, and PriceBreakdownAncillaryVehicle. - Reservation and Reservation Workbench APIs are PriceBreakdownAir, PriceBreakdownAncillary, PriceBreakdownHospitality, PriceBreakdownVehicleCharges, PriceBreakdownVehicleDeposit, PriceBreakdownVehiclePrice, and PriceBreakdownAncillaryVehicle. Example: "PriceBreakdownAir" - `PriceBreakdown.Amount` (object) Amount represents the cost applied - `PriceBreakdown.Amount.@type` (string) - `PriceBreakdown.Amount.currencySource` (string) The system requesting or returning the currency code specified in the attribute Enum: same as `MinimumAdcolAmount.currencySource` in "ChangePermitted" (3 values) - `PriceBreakdown.Amount.CurrencyCode` (object) Currency codes are the three-letter alphabetic codes that represent the various currencies used throughout the world. Unless changed in the request, the currency is the default associated with your provisioned PCC from Travelport. For Hotel: SourceCurrency is based on the location of the hotel and used for all rates in the response. TargetCurrency is the currency code sent in the request in requestedCurrency. - `PriceBreakdown.Amount.Base` (number) The base price prior to all applicable taxes or fees of a product, such as the amount for a room or fare for a flight (one passenger). Example: 120.2 - `PriceBreakdown.Amount.Taxes` (object) Summary of all individual taxes. Child class TaxesDetail provides the breakdown of individual taxes. - `Tax` (array) - `TaxPercent` (object) Returned when the tax is expressed as a percentage of the amount. - `TaxPercent.value` (number) The tax percentage amount. Example: 5.5 - `TaxPercent.taxCode` (string) Any code for the tax. Example: "971 - IRS Notice" - `TaxPercent.reportingAuthority` (string) Tax reporting authority Example: "Georgia Department of Revenue" - `TaxPercent.purpose` (string) Purpose of tax Example: "statutory tax" - `TaxPercent.description` (string) Description Example: "1.5% of SGST" - `TaxPercent.includedInBase` (string) Yes , No , Unknown Enum: same as `instantPurchase` in "AdvanceReservationRequired" (3 values) - `PriceBreakdown.Amount.Fees` (object) Includes TotalFees object to return the sum total of any fees. May include array of Fee objects to break down individual fees. Child class FeesDetail may also include a breakdown of the individual fees. - `Fee` (array) Array of individual fees. - `PriceBreakdown.Amount.Total` (number) "Specifies the total price including base + taxes + fees. In PriceBreakdownHospitality, this total is for a given group of nights. In PriceBreakdownAir this is the total of base cost and all fees and taxes for one passenger of this PTC type." Example: 230.13 - `PriceBreakdown.Amount.approximateInd` (boolean) if true this amount has been converted from the original amount Example: true - `PriceBreakdown.Commission` (object) — one of (discriminator: @type): GDS only; not supported for NDC. Commission information. Any commission filed by an airline in a CAT35 fare is returned in PriceBreakdownAir/Commission. The amount is either a percent of the fare component (@type CommissionPercent and the Percent object) or an amount (@type CommissionAmount and the Amount object)." - CommissionAmount: - `Amount` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `Amount.value` (number) The amount of a given currency. Example: 124.56 - `Amount.code` (string) An ISO 4217 alpha character code (3 characters) that specifies a money unit. Example: "USD" - `Amount.minorUnit` (integer) Minor units are a mechanism for expressing the relationship between a major currency unit and its corresponding minor currency unit. It is the smallest unit of a given currency. For example; the smallest denomination in USD is the cent, which is 1/100 of a USD, and the minor unit value is 2. Not all currencies have a minor unit. Example: 2 - `Amount.currencySource` (string) The system requesting or returning the currency code specified in the attribute Enum: same as `MinimumAdcolAmount.currencySource` in "ChangePermitted" (3 values) - `Amount.approximateInd` (boolean) "If true, the currency amount has been converted from the original amount. For Air Exchange Eligibility, returned only if a currency is converted. If returned, the value is always true, indicating that the fee is approximate because of currency conversion. For Hotel Availability and Rules, true indicates this is a calculated value; false indicates this is the value returned by the property." Example: true - CommissionPercent: - `Percent` (number) Percent amount of commission Example: 20 - `PriceBreakdown.Commission.@type` (string, required) Discriminator. Child classes CommissionAmount or CommissionPercent Example: "CommissionAmount" - `PriceBreakdown.Commission.application` (string) Type of commission Enum: same as `PriceBreakdown.Commission.application` (6 values) - `Price.@type` (string, required) Discriminator classes Price or PriceDetail Example: "PriceDetail" - `Price.id` (string) Internally referenced id Example: "2" - `Price.CurrencyCode` (object) Currency codes are the three-letter alphabetic codes that represent the various currencies used throughout the world. Unless changed in the request, the currency is the default associated with your provisioned PCC from Travelport. For Hotel: SourceCurrency is based on the location of the hotel and used for all rates in the response. TargetCurrency is the currency code sent in the request in requestedCurrency. - `Price.CurrencyCode.value` (string) An ISO 4217 currency code. Example: "USD" - `Price.CurrencyCode.codeAuthority` (string) Currency code authority Example: "ISO 4217" - `Price.CurrencyCode.decimalPlace` (integer) Number of decimal places for the currency. Example: 4 - `Price.CurrencyCode.decimalAuthority` (string) Currency code decimal authority Example: "ISO 4217" - `Price.Base` (number) "Base price before taxes and fees. For Hotel, may not be returned by all suppliers." Example: 20.2 - `Price.TotalTaxes` (number) "Total taxes applied to the base price. For Hotel, may not be returned by all suppliers." Example: 34.4 - `Price.TotalFees` (number) Total fees included in Total Price. Example: 201 - `Price.TotalPrice` (number) Total price of this offer including the base price and all taxes and fees. Example: 34 - `Price.VendorCurrencyTotal` (object) No longer used. Previously used to expose the local vendor currency when it is different to the purchased currency - `Price.VendorCurrencyTotal.@type` (string) - `Price.VendorCurrencyTotal.currencySource` (string) The system requesting or returning the currency code specified in the attribute Enum: same as `MinimumAdcolAmount.currencySource` in "ChangePermitted" (3 values) - `Price.VendorCurrencyTotal.CurrencyCode` (object) Currency codes are the three-letter alphabetic codes that represent the various currencies used throughout the world. Unless changed in the request, the currency is the default associated with your provisioned PCC from Travelport. For Hotel: SourceCurrency is based on the location of the hotel and used for all rates in the response. TargetCurrency is the currency code sent in the request in requestedCurrency. - `Price.VendorCurrencyTotal.Base` (number) The price prior to all applicable taxes of a product such as the rate for a room or fare for a flight. Example: 120.2 - `Price.VendorCurrencyTotal.Taxes` (object) Summary of all individual taxes. Child class TaxesDetail provides the breakdown of individual taxes. - `Tax` (array) - `Tax.value` (number) Amount of the tax. Returned as 0 if a tax was marked as exempt with TaxExemption. Example: 12.2 - `Tax.currencyCode` (string) A ISO 4217 currency code associated to the value. Example: "USD" - `Tax.taxCode` (string) "Code for the tax. For Hotels this is the OTA code." Example: "XF2" - `Tax.reportingAuthority` (string) Identifies the reporting authority such as airport code for XF taxes Example: "JFK1" - `Tax.purpose` (string) Supplier returned description of tax. Example: "Fuel surcharge" - `Tax.description` (string) "Short summary of the tax. In Air workflows this is returned only for NDC. Note that descriptions are not returned for tax codes YQ and YR, which are fees charged by airlines and not government-imposed taxes. For Hotels this is the OTA tax description." Example: "Lodging tax" - `Tax.includedInBase` (string) Yes , No , Unknown Enum: same as `instantPurchase` in "AdvanceReservationRequired" (3 values) - `Tax.codeAuthority` (string) Not used. Currency Code Authority Example: "ISO" - `Tax.decimalPlace` (integer) Permitted number of decimals. Associated to the currency value. Example: 2 - `Tax.decimalAuthority` (string) Not used. Currency decimal authority Example: "ISO" - `Tax.exemptInd` (boolean) GDS only; not supported for NDC. Returned if a tax was marked exempt in a prior request with the TaxExemption pricing modifer. If true, this tax is exempt" Example: true - `Tax.nonRefundableInd` (boolean) If true, the tax is non refundable. This indicator is only supported for exchange search and exchange price quote transactions. Example: true - `Tax.excludedFromTotalPriceInd` (boolean) Returned in Hotel APIs when a tax is not included in the TotalPrice. Default behavior is for taxes to be included in TotalPrice. Example: true - `TaxPercent` (object) Returned when the tax is expressed as a percentage of the amount. - `TaxPercent.value` (number) The tax percentage amount. Example: 5.5 - `TaxPercent.taxCode` (string) Any code for the tax. Example: "971 - IRS Notice" - `TaxPercent.reportingAuthority` (string) Tax reporting authority Example: "Georgia Department of Revenue" - `TaxPercent.purpose` (string) Purpose of tax Example: "statutory tax" - `TaxPercent.description` (string) Description Example: "1.5% of SGST" - `TaxPercent.includedInBase` (string) Yes , No , Unknown Enum: same as `instantPurchase` in "AdvanceReservationRequired" (3 values) - `Price.VendorCurrencyTotal.Taxes.@type` (string, required) Discriminator class is TaxesDetail Example: "TaxesDetail" - `Price.VendorCurrencyTotal.Taxes.TotalTaxes` (number) A monetary amount, representing the total of all taxes included in this offer. Supports up to 4 decimal places; decimal place must be included. Example: 330.1 - `Price.VendorCurrencyTotal.Taxes.TaxInfo` (array) Returned for TripChange APIS only. - `Price.VendorCurrencyTotal.Taxes.TaxInfo.@type` (string) Example: "TaxInfo" - `Price.VendorCurrencyTotal.Taxes.TaxInfo.TaxCode` (string, required) The tax code Example: "XF" - `Price.VendorCurrencyTotal.Taxes.TaxInfo.CurrencyCode` (object) Currency codes are the three-letter alphabetic codes that represent the various currencies used throughout the world. Unless changed in the request, the currency is the default associated with your provisioned PCC from Travelport. For Hotel: SourceCurrency is based on the location of the hotel and used for all rates in the response. TargetCurrency is the currency code sent in the request in requestedCurrency. - `Price.VendorCurrencyTotal.Taxes.TaxInfo.Amount` (number, required) The amount of the tax applied - `Price.VendorCurrencyTotal.Taxes.TaxInfo.TaxBreakdown` (array, required) The breakdown of the tax for this tax code - `Price.VendorCurrencyTotal.Fees` (object) Includes TotalFees object to return the sum total of any fees. May include array of Fee objects to break down individual fees. Child class FeesDetail may also include a breakdown of the individual fees. - `Fee` (array) Array of individual fees. - `Fee.@type` (string) - `Fee.feeCode` (string) For Hotel, the Hotel provider's explanation of the fee; can be returned either as a code or as text. For Air, the code for the fee, such as 'OB' for OB fees." Example: "1011" - `Fee.reportingAuthority` (string) Not used. Identifies the reporting authority. Example: "OPRA" - `Fee.purpose` (string) Not used. Fee purpose Example: "Service charge" - `Fee.description` (string) Any description or text explanation of the charge. Example: "Resort Fee" - `Fee.feeApplication` (string) Application values (such as the application of a fee) like per person or per room. Enum: same as `Surcharge.surchargeApplication` (7 values) - `Fee.feeFrequency` (string) The frequency of a fee such as per night or per stay. Enum: same as `Surcharge.surchargeFrequency` (6 values) - `Fee.FeeAmountOrPercent` (object, required) Defines whether the fee is charged as an amount or percentage. - `Fee.Tax` (array) - `Fee.includedinBaseInd` (boolean) If true, indicates the fee is included in Base Price. - `Fee.includedInTotalPriceInd` (boolean) If true, indicates the fee is included in Total Price. Default behavior is for fees not to be included in TotalPrice. - `Fee.collectionMethod` (string) List of change fee method Enum: same as `Fee.collectionMethod` (4 values) - `Price.VendorCurrencyTotal.Fees.@type` (string, required) Discriminator. Child class FeesDetail Example: "FeesDetail" - `Price.VendorCurrencyTotal.Fees.TotalFees` (number) Total fees included in the TotalPrice. Supports up to 4 decimal places; decimal place needs to be included. Example: 111.11 - `Price.VendorCurrencyTotal.Fees.TotalAdditionalFeesPayableLocally` (number) Fees due separately at the property. Expected to be paid in local currency. These fees are not included in the Offer TotalPrice. Example: 2.1 - `Price.VendorCurrencyTotal.Total` (number) Specifies the total price including base + taxes + fees Example: 30.13 - `Price.VendorCurrencyTotal.approximateInd` (boolean) True if this amount has been converted from the original amount Example: true - `ErrorResponse.CurrencyRateConversion` (array) - `ErrorResponse.CurrencyRateConversion.@type` (string) - `ErrorResponse.CurrencyRateConversion.SourceCurrency` (object, required) Currency codes are the three-letter alphabetic codes that represent the various currencies used throughout the world. Unless changed in the request, the currency is the default associated with your provisioned PCC from Travelport. For Hotel: SourceCurrency is based on the location of the hotel and used for all rates in the response. TargetCurrency is the currency code sent in the request in requestedCurrency. - `ErrorResponse.CurrencyRateConversion.SourceCurrency.value` (string) An ISO 4217 currency code. Example: "USD" - `ErrorResponse.CurrencyRateConversion.SourceCurrency.codeAuthority` (string) Currency code authority Example: "ISO 4217" - `ErrorResponse.CurrencyRateConversion.SourceCurrency.decimalPlace` (integer) Number of decimal places for the currency. Example: 4 - `ErrorResponse.CurrencyRateConversion.SourceCurrency.decimalAuthority` (string) Currency code decimal authority Example: "ISO 4217" - `ErrorResponse.CurrencyRateConversion.TargetCurrency` (object, required) Currency codes are the three-letter alphabetic codes that represent the various currencies used throughout the world. Unless changed in the request, the currency is the default associated with your provisioned PCC from Travelport. For Hotel: SourceCurrency is based on the location of the hotel and used for all rates in the response. TargetCurrency is the currency code sent in the request in requestedCurrency. - `ErrorResponse.CurrencyRateConversion.ConversionRate` (object, required) Conversion rate of SourceCurrency value to TargetCurrency value. This value can be used to calculate, independently of the API, conversion for the rates in the response. The response does not convert any amounts. - `ErrorResponse.CurrencyRateConversion.ConversionRate.value` (number) - `ErrorResponse.CurrencyRateConversion.ConversionRate.rateAuthority` (string) Contextual rate authority Example: "ISO 4217" - `ErrorResponse.CurrencyRateConversion.ConversionRate.rateAsOf` (string) Rate as of Example: "2026-08-07T12:12:00Z" - `ErrorResponse.Pagination` (object) Pagination object used when result sets span across a number of pages. - `ErrorResponse.Pagination.@type` (string, required) Example: "Pagination" - `ErrorResponse.Pagination.page` (integer, required) The current page number of the full result set Example: 1 - `ErrorResponse.Pagination.pageSize` (integer, required) The total number of items on this page Example: 20 - `ErrorResponse.Pagination.totalPages` (integer, required) The total number of pages in this result set Example: 5 - `ErrorResponse.Pagination.totalItems` (integer, required) The total number of pages in this result set Example: 100