# Flight Specific Search The Flight Specific Search API Reference Payload request returns additional upsells, up to 99, for any product/s returned by Search or Next Leg Search. The reference payload sends an identifier referencing a previous response and the offer and product identifiers. To use the Flight Specific Search reference payload request, your initial Search request must send offersPerPage to invoke caching if that Search was journey-based (leg-based search results are always cached). The full payload request does not reference a previous Search response (GDS only, not supported for NDC). Any CabinPreference in the initial Search request is applied to any subsequent Next Leg Search and reference Flight Specific Search requests. The Flight Specific Search response uses the same structure and returns the same objects as the Search response. The difference is that one instance of CatalogProductOffering (id o1) is returned for each offer sent in the request and one instance of ReferenceListProduct/Product is returned for each product sent in the request. When sending a Premium Flex request, use the endpoint catalog/search/catalogproductofferings/buildpremiumflexoptions. Endpoint: POST /air/catalog/search/catalogproductofferings/buildoptions Version: 11.36.0 Security: bearerAuth ## Security: - `bearerAuth` (unknown) http bearer JWT ## Header parameters: - `TraceId` (string) Identifier used to correlate Air API invocations across a multi-call business flows. - `XAUTH_TRAVELPORT_ACCESSGROUP` (string) Identifies the Travelport access group with which the caller is associated - `travelportPlusSessionIdentifier` (string) travelportPlusSessionIdentifier used to maintain an established agency session - `TVP-PCC-Core` (string) Allows user to pass PCC instead of Access Group ID ## Request body: - `application/json` (unknown) Flight Specific Search request payload. ## Request fields (application/json): - `@type` (string, required) Discriminator. No child classes Example: CatalogProductOfferingsQueryBuildOptions - `BuildOptions` (object, required) Used for a Flight Specific Search request. Selects the specific flights and the maximum number of upsells to return. - `BuildOptions.@type` (string, required) Discriminator. - Reference Payload Flight Specific Search child class is BuildOptionsFromCatalogProductOptions - Full Payload Flight Specific Search child class is BuildOptionsFromProducts Enum: "BuildOptionsFromProducts", "BuildOptionsFromCatalogProductOptions" - `BuildOptions.maxNumberOfUpsellsToReturn` (integer) Number of upsells to return. Valid values are 0 to 99 inclusive. If the carrier has filed fewer upsells, all filed upsells are returned. Example: 2 - `BuildOptions.PaymentCriteria` (object) Optional object to send the BIN/INN (IssuerIdentificationNumber) of the credit card to be used for payment; sending the BIN returns OB fees in the response Required when using Air Canada flight pass. - `BuildOptions.PaymentCriteria.@type` (string, required) discriminator Example: PaymentCriteria - `BuildOptions.PaymentCriteria.IssuerIdentificationNumber` (string) Required if PaymentCriteria sent; 6 to 16 characters inclusive are accepted. The BIN/IssuerIdentificationNumber (IIN) of the credit card to be used for payment and returning OB fees. OB fees are ticketing and form of payment (FOP) charges, including credit card fees. Returned in an instance of Price/PriceBreakdown/Fees/Fee with a feeCode of OB. For NDC carrier BA, you must send the complete 16-digit credit card number to return the surcharge amount. Example: 123456 - `BuildOptions.PaymentCriteria.PaymentCardCode` (string) A two character code for a credit card Example: VI - `BuildOptions.PaymentCriteria.DocumentNumber` (array) - `BuildOptions.PaymentCriteria.DocumentNumber.value` (string) Example: 1259900123456 - `BuildOptions.PaymentCriteria.DocumentNumber.documentIssuer` (string) Document issuer Example: BA - `BuildOptions.PaymentCriteria.DocumentNumber.documentType` (string) Document type like EMD, MCO Enum: "EMD", "MCO", "Ticket", "TASF", "Invoice" - `BuildOptions.PaymentCriteria.DocumentNumber.travelerIdentifierRef` (string) traveler identifier reference Example: traveler_1 - `BuildOptions.PaymentCriteria.DocumentNumber.name` (string) The name of the Traveler being referenced. Example: SMITH/JMR - `BuildOptions.PaymentCriteria.DocumentNumber.passengerTypeCode` (string) The passenger type code of the Traveler being referenced. Example: ADT - `BuildOptions.PaymentCriteria.DocumentNumber.id` (string) A locally referenced ID Example: id_1 - `BuildOptions.PaymentCriteria.DocumentNumber.description` (string) Descriptive text used to identify the contents of a target object Example: Descriptive text. - `BuildOptions.PaymentCriteria.DocumentNumber.uris` (array) The URI used to GET the target object in another domain. Example: ["www.travelport.com/uri"] - `BuildOptions.PaymentCriteria.FlightPass` (array) In Search API, for NDC flight pass bookings this is a required field and must reference the owner in PassengerCriteria. Only one permitted per Search request. Required when using a flight pass to pay for an Air Canada NDC booking. Only one instance allowed. Refer to the [Air Canada Flight Pass](https://developer.travelport.com/docs/flights/ndc/ndc-guide-for-air-canada-flight-pass) section of the NDC Guide for more information - `BuildOptions.PaymentCriteria.FlightPass.@type` (string, required) Discriminator. No child classes Example: FlightPass - `BuildOptions.PaymentCriteria.FlightPass.accountNumber` (string, required) The flight pass account number. Example: 0140851633093 - `BuildOptions.PaymentCriteria.FlightPass.supplier` (string, required) The flight pass supplier code. AC is the only value accepted at this time. Example: AC - `BuildOptions.PaymentCriteria.FlightPass.Description` (array) - `BuildOptions.PaymentCriteria.FlightPass.TravelerIdentifierRef` (array) In Search, use the passengerCriteriaRef to reference the owner of the flightpass. This is a mandatory field for Search API. - `BuildOptions.PaymentCriteria.FlightPass.TravelerIdentifierRef.value` (string) Example: traveler_001 - `BuildOptions.PaymentCriteria.FlightPass.TravelerIdentifierRef.id` (string) A locally referenced ID Example: id_001 - `BuildOptions.PaymentCriteria.FlightPass.TravelerIdentifierRef.description` (string) Descriptive text used to identify the contents of a target object Example: Descriptive Text - `BuildOptions.PaymentCriteria.FlightPass.TravelerIdentifierRef.uris` (array) Uniform Resource Identifier Example: ["www.travelport.com/uri"] - `BuildOptions.PaymentCriteria.agencyAccountInd` (boolean) If true, payment will be made by agency account Example: true - `BuildOptions.PaymentCriteria.bspInd` (boolean) If true, payment will be made by BSP Example: true - `BuildOptions.PaymentCriteria.cashInd` (boolean) If true, payment will be made by cash Example: true - `BuildOptions.PaymentCriteria.invoiceInd` (boolean) If true, payment will be made by invoice Example: true - `BuildOptions.FareRuleType` (string) Use not recommended; request fare rules using the Fare Rules API request instead. Returns fare rules in the offer response. Structured rules limit the rules returned to one or more of these categories: advance reservation/ticketing requirements, minimum/maximum stay, stopovers, penalties, voluntary exchanges and refunds. GDS supports all categories; NDC supports only penalties. See the [Fare Rules Guide](https://developer.travelport.com/docs/flights/guides/fare-rules-guide) for details. Note that even if fare rules are not requested, for GDS only, change and cancel penalties are returned unless suppressed by sending CustomResponseModifiersAir/excludePenaltiesInd set to true. Not supported in BuildOptions (Flight Specific Search). Enum: "Structured", "ShortText", "LongText" - `BuildOptions.FareRuleCategory` (array) Not supported for flight specific search - `BuildOptions.BrandOptions` (string) Send with the value returnAllBrands to return all brands in a fare family regardless of the brand of the anchoring flight chosen from the initial Search response. GDS only; not supported for NDC. Not supported in the Flight Specific Search full payload request. Enum: "keepToBrand", "returnAllBrands" - `BuildOptions.returnBrandedFaresInd` (boolean) Not supported in flight specific search - `BuildOptions.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. - `BuildOptions.CustomResponseModifiersAir.@type` (string, required) discriminator Example: CustomResponseModifiersAir - `BuildOptions.CustomResponseModifiersAir.BrandAttributeInclusion` (array) Supported in AirSearch and AirPrice. Returns only information about the brand attributes specified and does not return any other brand attributes. - `BuildOptions.CustomResponseModifiersAir.BrandAttributeInclusion.@type` (string) Example: BrandAttributeInclusion - `BuildOptions.CustomResponseModifiersAir.BrandAttributeInclusion.legSequence` (array) Leg sequence not supported for BrandAttributeInclusion. Example: [1,2] - `BuildOptions.CustomResponseModifiersAir.BrandAttributeInclusion.Classification` (array) Send one or more of the supported values to return information about only the specified attributes. Fares may include other attributes but information about them is not returned. - `BuildOptions.CustomResponseModifiersAir.BrandAttributeInclusion.AdditionalClassification` (array) Send one or more of the additional supported values to return information about only the specified additional attributes. Supported values: - ChauffeurTransfer - ExtraLegroom - InFlightEntertainment - LoungeAccess - PriorityBaggage - PriorityBoarding - PriorityCheckIn - PrioritySecurity - PriorityServices - MileageAccrual - Upgrades - USB - `BuildOptions.CustomResponseModifiersAir.SearchRepresentation` (string) Specifies either a journey or leg-based response.This setting does not affect one-way itineraries, which have one leg and are always journey-based. - 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" - `BuildOptions.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 - `BuildOptions.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 - `BuildOptions.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 - `BuildOptions.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 - `BuildOptions.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 - `BuildOptions.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 - `BuildOptions.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 - `BuildOptions.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 - `BuildOptions.CustomResponseModifiersAir.includeBundledAncillariesInd` (boolean) NDC only; not supported for GDS. If true: request NDC offers that include an ancillary service bundled with the cost of the air fare. This could be a discounted paid seat or any other ancillary service offered by the carrier. Search and Price responses will contain both ProductAir and ProductAncillary plus a new child class of PriceBreakdown, PriceBreakdownAncillaryAir, to define the ancillary inclusion and pricing. Example: true - `BuildOptions.CustomResponseModifiersAir.includeFullPenaltyDisclosureInd` (boolean) GDS only. For NDC, change and cancel penalties are returned by the NDC carrier. Indicator to return ATPCO Cat31 and Cat33 penalties in the response in TermsAndConditions/Penalties in Change and Cancel. - If true: returns penalty information sourced from ATPCO Cat 31 and 33. Penalties may be exposed at fare component level and include time windows. - If false (default behavior): Cat 31 and 33 penalties are not returned. The most restrictive Cat 16 penalties are returned. When specified in the Search request, this indicator is applied to Reference Payload Flight Specific Search as well. - `BuildOptions.BuildFromProductsRequest` (object, required) GDS only. Not supported for NDC. Full payload itinerary request used in multiple work flows. Flight Specific Search, Full payload Price, Full payload Book. - `BuildOptions.BuildFromProductsRequest.@type` (string, required) Discriminator. - Next Leg Search and AirPrice child classes BuildFromProductsRequestAir, BuildFromProductsRequestAirSearch, and BuildFromProductsRequestOfferConstruction - To price all PTCs and segments send with @type BuildFromProductsRequestAir. - To price a specific PTC and/or air segment, send with @type BuildFromProductsRequestOfferConstruction - TripChange child class is BuildFromProductsRequestAirChange Enum: "BuildFromProductsRequestAirChange", "BuildFromProductsRequestAir" - `BuildOptions.BuildFromProductsRequest.PricingModifiersAirChange` (object) Optional modifiers related to pricing, such as brands, taxes, and account codes. May include OrganizationInformation (account codes), FareSelection (fare types), CalculatedFareAdjustment (increase/decrease fare modifiers) or BrandPreference (brand tiers). - `BuildOptions.BuildFromProductsRequest.PricingModifiersAirChange.@type` (string) Example: PricingModifiersAirChange - `BuildOptions.BuildFromProductsRequest.PricingModifiersAirChange.currencyCode` (string) ISO 4217 currency code Example: USD - `BuildOptions.BuildFromProductsRequest.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. - `BuildOptions.BuildFromProductsRequest.PricingModifiersAirChange.FareSelection.@type` (string, required) Discriminator. Child class FareSelectionDetail. Enum: "FareSelectionDetail" - `BuildOptions.BuildFromProductsRequest.PricingModifiersAirChange.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" - `BuildOptions.BuildFromProductsRequest.PricingModifiersAirChange.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 - `BuildOptions.BuildFromProductsRequest.PricingModifiersAirChange.FareSelection.RefundOptions.@type` (string, required) Discriminator. No child classes. Example: RefundOptions - `BuildOptions.BuildFromProductsRequest.PricingModifiersAirChange.FareSelection.RefundOptions.refundTypes` (array, required) - `BuildOptions.BuildFromProductsRequest.PricingModifiersAirChange.FareSelection.RefundOptions.RefundPenaltyRange` (object) Not currently supported. User can express a minimum and maximum Refund penalty range that will be included in the result set. - `BuildOptions.BuildFromProductsRequest.PricingModifiersAirChange.FareSelection.RefundOptions.RefundPenaltyRange.@type` (string) Example: RefundPenaltyRange - `BuildOptions.BuildFromProductsRequest.PricingModifiersAirChange.FareSelection.RefundOptions.RefundPenaltyRange.Minimum` (object) Parent object when amount is applied as an Amount or a Percent. - `BuildOptions.BuildFromProductsRequest.PricingModifiersAirChange.FareSelection.RefundOptions.RefundPenaltyRange.Minimum.@type` (string, required) Discriminator classes AmountPercentAmount or AmountPercentPercent Enum: "AmountPercentAmount", "AmountPercentPercent" - `BuildOptions.BuildFromProductsRequest.PricingModifiersAirChange.FareSelection.RefundOptions.RefundPenaltyRange.Minimum.application` (string) Type of commission Enum: "Full", "Partial", "Non-paying", "No-show", "Adjustment", "Commissionable" - `BuildOptions.BuildFromProductsRequest.PricingModifiersAirChange.FareSelection.RefundOptions.RefundPenaltyRange.Minimum.Amount` (object) A monetary amount, up to 4 decimal places. Decimal place must be included. - `BuildOptions.BuildFromProductsRequest.PricingModifiersAirChange.FareSelection.RefundOptions.RefundPenaltyRange.Minimum.Percent` (number) Percent amount of commission Example: 20 - `BuildOptions.BuildFromProductsRequest.PricingModifiersAirChange.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 - `BuildOptions.BuildFromProductsRequest.PricingModifiersAirChange.FareSelection.ChangeOptions.@type` (string) Discriminator. No child classes. Example: ChangeOptions - `BuildOptions.BuildFromProductsRequest.PricingModifiersAirChange.FareSelection.ChangeOptions.changeTypes` (array, required) - `BuildOptions.BuildFromProductsRequest.PricingModifiersAirChange.FareSelection.ChangeOptions.ChangePenaltyRange` (object) Not currently supported. User can express a minimum and maximum Change penalty range that will be included in the result set - `BuildOptions.BuildFromProductsRequest.PricingModifiersAirChange.FareSelection.ChangeOptions.ChangePenaltyRange.@type` (string) Example: ChangePenaltyRange - `BuildOptions.BuildFromProductsRequest.PricingModifiersAirChange.FareSelection.FareQualifier` (array) - `BuildOptions.BuildFromProductsRequest.PricingModifiersAirChange.FareSelection.FareQualifier.value` (string) Deprecated - do not use. Replaced by FareQualiferString Enum: "Consolidator", "Government", "Marine", "Military", "Reward", "StandBy", "Staff", "Student", "Tour", "Youth", "VistFriendsAndRelatives" - `BuildOptions.BuildFromProductsRequest.PricingModifiersAirChange.FareSelection.FareQualiferString` (array) Request specific private leisure fares. Supported values vary by NDC carrier. For detailed NDC support by carrier, see [NDC Carrier Support](https://developer.travelport.com/docs/flights/ndc/ndc-guide#ndc-carrier-support) in the developer documentation. This value is returned in FlightProduct.FareQualifierString if supplied by the airline. (Note the misspelling in request parameter)" Example: ["Tour"] - `BuildOptions.BuildFromProductsRequest.PricingModifiersAirChange.FareSelection.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 - `BuildOptions.BuildFromProductsRequest.PricingModifiersAirChange.FareSelection.prohibitMinStayFaresInd` (boolean) - If true: returns only fares that do not require a minimum stay. - If false (default behavior): allows minimum stay fares. Example: true - `BuildOptions.BuildFromProductsRequest.PricingModifiersAirChange.FareSelection.prohibitMaxStayFaresInd` (boolean) - If true: returns only fares that do not require a maximum stay. - If false (default behavior): allows maximum stay fares. Example: true - `BuildOptions.BuildFromProductsRequest.PricingModifiersAirChange.FareSelection.refundableOnlyInd` (boolean) - If true: returns only fares that are fully refundable. - If false (default behavior): allows fares that are not fully refundable Example: true - `BuildOptions.BuildFromProductsRequest.PricingModifiersAirChange.FareSelection.prohibitAdvancePurchaseFaresInd` (boolean) - If true, returns only fares that do not require advance purchase. - If false (default behavior): allows fares with advance purchase restrictions. Example: true - `BuildOptions.BuildFromProductsRequest.PricingModifiersAirChange.FareSelection.prohibitUnbundledFaresInd` (boolean) Supported for GDS Exchanges. - If true, prevents unbundled fares. - If false (default behavior): does not prevent unbundled fares. Example: true - `BuildOptions.BuildFromProductsRequest.PricingModifiersAirChange.FareSelection.prohibitRefundableFaresInd` (boolean) This field is deprecated. Use RefundOptions for refundability options Example: true - `BuildOptions.BuildFromProductsRequest.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. - `BuildOptions.BuildFromProductsRequest.PricingModifiersAirChange.OrganizationInformation.@type` (string, required) Discriminator. No child classes Example: OrganizationInformation - `BuildOptions.BuildFromProductsRequest.PricingModifiersAirChange.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. - `BuildOptions.BuildFromProductsRequest.PricingModifiersAirChange.OrganizationInformation.OrganizationIdentifier.value` (string) The value of the code to apply. Note for AirSearch account codes: - For GDS, up to 15 account codes are supported. Account codes are alphanumeric and must start with an alphabetic character. - When one account code is sent, it is applied to the entire journey. - An account code can be sent for each SearchCriteriaFlight. When multiple account codes are sent, the first account code is applied to the first SearchCriteriaFlight, the second account code is applied to the second SearchCriteriaFlight, etc. - For NDC, one account code per carrier is supported Example: JBD123456 - `BuildOptions.BuildFromProductsRequest.PricingModifiersAirChange.OrganizationInformation.OrganizationIdentifier.supplier` (string) The IATA code for the airline on which the code is applicable. Example: AA - `BuildOptions.BuildFromProductsRequest.PricingModifiersAirChange.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" - `BuildOptions.BuildFromProductsRequest.PricingModifiersAirChange.OrganizationInformation.OrganizationIdentifier.segmentSequenceList` (array) Returned in response when the code is applicable to a specified segment sequence Example: [1,2,3] - `BuildOptions.BuildFromProductsRequest.PricingModifiersAirChange.OrganizationInformation.OrganizationIdentifier.productRef` (array) Returned in response when the code is applicable to a specified product Example: ["product_1"] - `BuildOptions.BuildFromProductsRequest.PricingModifiersAirChange.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 - `BuildOptions.BuildFromProductsRequest.PricingModifiersAirChange.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. - `BuildOptions.BuildFromProductsRequest.PricingModifiersAirChange.OrganizationInformation.GSTRegistrationNumber.value` (string, required) The GST registered number for the business. Example: 07AAGFF2194N1Z1 - `BuildOptions.BuildFromProductsRequest.PricingModifiersAirChange.OrganizationInformation.GSTRegistrationNumber.telephone` (string, required) Business telephone number Example: 222-222-222 - `BuildOptions.BuildFromProductsRequest.PricingModifiersAirChange.OrganizationInformation.GSTRegistrationNumber.address` (string, required) Business address Example: 1122 sample trail, CO, USA, 21232 - `BuildOptions.BuildFromProductsRequest.PricingModifiersAirChange.OrganizationInformation.GSTRegistrationNumber.country` (string, required) IATA country code of the business. Example: IND - `BuildOptions.BuildFromProductsRequest.PricingModifiersAirChange.OrganizationInformation.GSTRegistrationNumber.companyName` (string, required) Business name Example: Adecco - `BuildOptions.BuildFromProductsRequest.PricingModifiersAirChange.OrganizationInformation.GSTRegistrationNumber.email` (string, required) Business E-Mail address Example: sample@adecco.com - `BuildOptions.BuildFromProductsRequest.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. Waiver code can be passed during the refund by document process (BuildFromOfferList). Select the type of fee that is to be waivered in the waiver type field. Also passed as a FormOfPayment. - `BuildOptions.BuildFromProductsRequest.PricingModifiersAirChange.WaiverCode.value` (string) - `BuildOptions.BuildFromProductsRequest.PricingModifiersAirChange.WaiverCode.reasonCode` (integer) A code assigned to identify the reason for disruption Example: 2 - `BuildOptions.BuildFromProductsRequest.PricingModifiersAirChange.WaiverCode.waiverType` (string) List of waiver types. Enum: "ChangePenalty", "PriceDifference", "ChangePenaltyAndPriceDifference", "RefundPenalty", "NameChangePenalty" - `BuildOptions.BuildFromProductsRequest.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. For AirChange: specify up to five taxes to exempt during exchange search. - `BuildOptions.BuildFromProductsRequest.PricingModifiersAirChange.TaxExemption.@type` (string) Discriminator. No child classes. Example: TaxExemption - `BuildOptions.BuildFromProductsRequest.PricingModifiersAirChange.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"] - `BuildOptions.BuildFromProductsRequest.PricingModifiersAirChange.TaxExemption.taxCodes` (array) One or more two-letter alphanumeric tax codes to mark as exempt in the paired country. Must also send countries object. For AirChange: send up to five tax codes to exempt. Exempted taxes are returned in the response as PriceBreakdown/Taxes/Tax/exemptInd=true. Example: ["US"] - `BuildOptions.BuildFromProductsRequest.PricingModifiersAirChange.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 - `BuildOptions.BuildFromProductsRequest.PricingModifiersAirChange.PromotionalCode` (object) NDC only. Not supported for GDS. Any NDC airline designated promotional code. - `BuildOptions.BuildFromProductsRequest.PricingModifiersAirChange.PromotionalCode.value` (string) The promotional code to apply Example: CDFRT - `BuildOptions.BuildFromProductsRequest.PricingModifiersAirChange.PromotionalCode.supplierCode` (string, required) The IATA code for the airline on which the promotional code is applicable. Example: AA - `BuildOptions.BuildFromProductsRequest.PricingModifiersAirChange.SellCity` (string) Overrides the sell city of the requestor Example: MEX - `BuildOptions.BuildFromProductsRequest.PricingModifiersAirChange.TicketCity` (string) Overrides the ticket city of the requestor Example: MEX - `BuildOptions.BuildFromProductsRequest.PricingModifiersAirChange.PricingPCC` (string) Overrides the pricing PCC of the requestor Example: XS4 - `BuildOptions.BuildFromProductsRequest.PricingModifiersAirChange.TicketingPCC` (string) Overrides the ticketing PCC of the requestor Example: XCD - `BuildOptions.BuildFromProductsRequest.PricingModifiersAirChange.CalculatedFareAdjustment` (object) Used in Exchange Search to modify the Price of the Fare. Discriminator classes CalculatedFareAdjustmentDiscount or CalculatedFareAdjustmentIncrease - `BuildOptions.BuildFromProductsRequest.PricingModifiersAirChange.CalculatedFareAdjustment.@type` (string, required) Enum: "CalculatedFareAdjustmentDiscount", "CalculatedFareAdjustmentIncrease" - `BuildOptions.BuildFromProductsRequest.PricingModifiersAirChange.BrandPreference` (array) - `BuildOptions.BuildFromProductsRequest.PricingModifiersAirChange.BrandPreference.@type` (string, required) Discriminator. No child classes exist Example: BrandPreference - `BuildOptions.BuildFromProductsRequest.PricingModifiersAirChange.BrandPreference.brandTier` (integer) The brand tier Example: 1 - `BuildOptions.BuildFromProductsRequest.PricingModifiersAirChange.BrandPreference.legSequence` (array) Correlates with legSequence in SearchCriteriaFlight Example: [1,2] - `BuildOptions.BuildFromProductsRequest.PricingModifiersAirChange.keepToBrandInd` (boolean) If true, the offerings returned will be of the same brand as the original Offer Example: true - `BuildOptions.BuildFromProductsRequest.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 - `BuildOptions.BuildFromProductsRequest.PricingModifiersAirChange.doNotNetInd` (boolean) If true, this exchange will not net any residual/refundable amounts against due amounts. Example: true - `BuildOptions.BuildFromProductsRequest.ProductCriteriaAir` (array, required) - `BuildOptions.BuildFromProductsRequest.ProductCriteriaAir.@type` (string) Discriminator. No child classes. Example: ProductCriteriaAir - `BuildOptions.BuildFromProductsRequest.ProductCriteriaAir.sequence` (integer, required) Optional sequence of this block of product criteria Example: 1 - `BuildOptions.BuildFromProductsRequest.ProductCriteriaAir.SponsoredFlightAttributes` (object) Coming soon. Contains marketing information for Sponsored Flight Options. - `BuildOptions.BuildFromProductsRequest.ProductCriteriaAir.SponsoredFlightAttributes.@type` (string, required) Discriminator. No child classes. Example: SponsoredFlightAttributes - `BuildOptions.BuildFromProductsRequest.ProductCriteriaAir.SponsoredFlightAttributes.positionNumber` (integer) The display position number of the sponsored option Example: 1 - `BuildOptions.BuildFromProductsRequest.ProductCriteriaAir.SponsoredFlightAttributes.adID` (string) The advertisement ID Example: F123 - `BuildOptions.BuildFromProductsRequest.ProductCriteriaAir.SponsoredFlightAttributes.trackingID` (string) Unique tracking ID for sponsored flights campaign required in end to end workflow. Example: 490516f5-d33c-4190-9ffe-619748d7ed24 - `BuildOptions.BuildFromProductsRequest.ProductCriteriaAir.SponsoredFlightAttributes.sponsoredFlightInd` (boolean) If true, this option is a sponsored flight option. Example: true - `BuildOptions.BuildFromProductsRequest.ProductCriteriaAir.SpecificFlightCriteria` (array, required) An array of flight criteria. - `BuildOptions.BuildFromProductsRequest.ProductCriteriaAir.SpecificFlightCriteria.@type` (string) Discriminator. No child classes. Example: SpecificFlightCriteria - `BuildOptions.BuildFromProductsRequest.ProductCriteriaAir.SpecificFlightCriteria.carrier` (string, required) IATA code for the airline carrier for this flight. Example: BA - `BuildOptions.BuildFromProductsRequest.ProductCriteriaAir.SpecificFlightCriteria.flightNumber` (string, required) Flight number assigned by the airline. Example: 980 - `BuildOptions.BuildFromProductsRequest.ProductCriteriaAir.SpecificFlightCriteria.departureDate` (string, required) The local departure date of the flight in YYYY-MM-DD format. Example: 2025-10-25 - `BuildOptions.BuildFromProductsRequest.ProductCriteriaAir.SpecificFlightCriteria.departureTime` (string) The local departure time of the flight in HH:MM:SS (24-hour) format. Example: 68400 - `BuildOptions.BuildFromProductsRequest.ProductCriteriaAir.SpecificFlightCriteria.arrivalDate` (string) The local arrival date of the flight in YYYY-MM-DD format. Example: 2025-10-25 - `BuildOptions.BuildFromProductsRequest.ProductCriteriaAir.SpecificFlightCriteria.arrivalTime` (string) The local arrival time of the flight in HH:MM:SS (24-hour) format. Example: 80100 - `BuildOptions.BuildFromProductsRequest.ProductCriteriaAir.SpecificFlightCriteria.from` (string, required) The origin IATA airport code from which the flight departs. Example: LHR - `BuildOptions.BuildFromProductsRequest.ProductCriteriaAir.SpecificFlightCriteria.to` (string, required) The destination IATA airport code where the flight arrives. Example: PAR - `BuildOptions.BuildFromProductsRequest.ProductCriteriaAir.SpecificFlightCriteria.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" - `BuildOptions.BuildFromProductsRequest.ProductCriteriaAir.SpecificFlightCriteria.classOfService` (string) The class of service. If sent for Flight Specific Search, this field is ignored. Example: F - `BuildOptions.BuildFromProductsRequest.ProductCriteriaAir.SpecificFlightCriteria.brandTier` (integer) The brand tier to price, if brand tier pricing is desired. Supported only in the full payload request. For AirReservation, send only if requesting to store brand information at the segment level. A segment is one flight with the same flight number. You can send brandTier for any or all instances of SpecificFlightCriteria. To store brand information at the offer level instead, see PricingModifiersAir. Example: 2 - `BuildOptions.BuildFromProductsRequest.ProductCriteriaAir.SpecificFlightCriteria.segmentSequence` (integer, required) Segment sequence is used to identify the order of the flight segments. A segment is one flight with the same flight number. - For AirPrice: starting with 0 for the first segment on the leg. - For AirReservation: starting with 1 for the first segment on the leg. - 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. - `BuildOptions.BuildFromProductsRequest.ProductCriteriaAir.SpecificFlightCriteria.additionalCabins` (array) Request additional SeatMap cabins (not supported in full payload Price or Book requests) Example: ["First"] - `BuildOptions.BuildFromProductsRequest.ProductCriteriaAir.SpecificFlightCriteria.passiveSegmentStatus` (string) GDS only; not supported for NDC. Applicable to Book workflow only. If the segment is to be sold as passive (booked outside the Travelport GDS) enter the passive segment status. This updates the Travelport booking with any details received from the supplier for the passive segment. Recommended to also send SupplierLocator. Supported for the following segment status codes: - AK (passive segment confirmed outside the GDS) - BK (passive segment booked with carrier) - YK (Hold confirmed airline space) Example: AK - `BuildOptions.BuildFromProductsRequest.ProductCriteriaAir.SpecificFlightCriteria.fareBasisCodeOverride` (string) Use PricingModifiersAir for fare basis code override. Example: YEE1Y - `BuildOptions.BuildFromProductsRequest.ProductCriteriaAir.SpecificFlightCriteria.id` (string) Unique id to support referencing of this specific passenger criteria in the book offer construction workflow. For AirPrice: optionally use to send a custom flight identifier value such as f1, f2, and so on when requesting pricing for one or more specific segments with OfferConstruction. If not sent, pricing for all segments is returned. GDS only; not supported for this use in NDC. - `BuildOptions.BuildFromProductsRequest.ProductCriteriaAir.SpecificFlightCriteria.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" - `BuildOptions.BuildFromProductsRequest.ProductCriteriaAir.SpecificFlightCriteria.ContentSource` (string) Indicates the owner the offer or document. Enum: "GDS", "NDC", "LCC", "API" - `BuildOptions.BuildFromProductsRequest.ProductCriteriaAir.SpecificFlightCriteria.boundFlightsInd` (boolean) The bound flights indicator boundFlightsInd is a variable indicating segments are married/bound. True indicates that the flight availability was polled (availability check) using connecting segments. If false, flights were polled as point to point segments. In full payload AirPrice, this sets whether to validate inventory on a connecting flight in the requested class of service by booking and then releasing seats. GDS only; not supported for NDC. Supported only in the full payload request. - Can be used in conjunction with reCheckInventoryInd=true on the leading segment(s) on a leg with connecting flight(s) to also check availability on the connecting flight(s) by booking and releasing seats in the requested class of service. For example, if a leg has two connections, send boundFlightsInd for the first two of the three flights. Must also send reCheckInventoryInd=true per above. If any or all segments are not bookable, AirPrice returns a message that the air segment/s are not bookable and the dates and city pairs of the segments that are not bookable. - Because this indicator temporarily affects seat availability, recommended best practice is to use validateInventoryInd instead of reCheckInventoryInd and boundFlightsInd. Some airlines have revenue management applications that monitor for high volumes of sell/ignore transactions for inventory. Regardless of pricing results, air fares and inventory are guaranteed by airlines only when ticketed and paid for. - If false (default behavior): Checks only for general seat availability on any connecting flight, not a specific class of service. In full payload AirReservation, this indicator is not sent by the user but instead is sent if included in the information stored in the price by the carrier. Not returned for NDC. - When returned with a value of true, the flight segments are polled together and usually share the same fare basis code and class of service. The indicator is returned as true 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 O&D pair has 3 flight segments, boundFlightsInd is returned only for the first two segments on that leg. - If the segments are not bound, boundFlightsInd is false and not returned. Example: true - `BuildOptions.BuildFromProductsRequest.ProductCriteriaAir.SupplierLocator` (object) Send to add a locator code for a passive segment. Required for passive segment bookings when GDS ticketing is required (AK segment status - passive segment confirmed outside the GDS). Not supported for Search or Price APIs. Required for ticket issuance; if not sent in Add Offer, must be added with a terminal program prior to ticketing. Recommended to always send with SpecificFlightCriteria /passiveSegmentStatus. - `BuildOptions.BuildFromProductsRequest.ProductCriteriaAir.SupplierLocator.value` (string) The external or supplier-issued locator. Example: WTR45G - `BuildOptions.BuildFromProductsRequest.ProductCriteriaAir.SupplierLocator.supplierCode` (string) Supplier Code; generally the releated IATA code for the carrier or agency. Example: AA - `BuildOptions.BuildFromProductsRequest.ProductCriteriaAir.SupplierLocator.supplierName` (string) Name of the supplier Example: American Airlines - `BuildOptions.BuildFromProductsRequest.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. - `BuildOptions.BuildFromProductsRequest.PricingModifiersAir.@type` (string, required) Discriminator. Child classes PricingModifiersAir and PricingModifersAirDetail Enum: "PricingModifiersAirDetail" - `BuildOptions.BuildFromProductsRequest.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 - `BuildOptions.BuildFromProductsRequest.PricingModifiersAir.PromotionalCode` (array) - `BuildOptions.BuildFromProductsRequest.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 - `BuildOptions.BuildFromProductsRequest.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 - `BuildOptions.BuildFromProductsRequest.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 - `BuildOptions.BuildFromProductsRequest.PricingModifiersAir.FareBasisCodeOverride` (array) - `BuildOptions.BuildFromProductsRequest.PricingModifiersAir.FareBasisCodeOverride.value` (string) Example: YEE1Y - `BuildOptions.BuildFromProductsRequest.PricingModifiersAir.FareBasisCodeOverride.specificFlightCriteriaRefs` (array) Reference the specificFlightCriteria you want to override. If blank, all segments will be overridden. Example: ["s1","s2"] - `BuildOptions.BuildFromProductsRequest.PricingModifiersAir.FareBasisCodeOverride.unpricedFlightSegmentRefs` (array) Reference the unpricedFlightSegment you want to override. If blank, all segments will be overridden. Example: ["up1","up2"] - `BuildOptions.BuildFromProductsRequest.PricingModifiersAir.MultiPricingAgency` (array) GDS only; not supported for NDC. Invokes Premium Flex Search POS feature. Send up to three PCCs to return offers for those point of sale agencies in addition to your provisioned PCC. If a you send more than 3 PCCs in MultiPricingAgency, only the first 3 are validated. Must append /buildpremiumflexoptions to the endpoint. See [Premium Flex Search](https://developer.travelport.com/docs/flights/guides/flights-search-guide#premium-flex-search) in the developer documentation for usage and examples, and usage of the Accept header value to specify returning aggregated or streamed content. If both PricingPCC and MultiPricingAgency are sent with PCCs, the PCC in PricingPCC is ignored. - `BuildOptions.BuildFromProductsRequest.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 - `BuildOptions.BuildFromProductsRequest.PricingModifiersAir.ManualFareAdjustment` (array) Send to manually adjust the base fare amount on all fares for a specific PTC. - `BuildOptions.BuildFromProductsRequest.PricingModifiersAir.ManualFareAdjustment.@type` (string, required) Discriminator. Child classes ManualFareAdjustmentIncrease or ManualFareAdjustmentDiscount Enum: "ManualFareAdjustmentIncrease", "ManualFareAdjustmentDiscount" - `BuildOptions.BuildFromProductsRequest.PricingModifiersAir.ManualFareAdjustment.passengerTypeCodes` (array) Send the PTC/s to be increased or decreased. This increases or discounts the fare for all passengers with the PTC/s. If not sent, ManualFareAdjustment applies to all PTCs. Example: ["ADT","CHD"] - `BuildOptions.BuildFromProductsRequest.PricingModifiersAir.BrandPreference` (array) - `BuildOptions.BuildFromProductsRequest.PricingModifiersAir.includeSplitPaymentInd` (boolean) GDS only, not supported for NDC. Split ticketing is available only for customers specifically provisioned for split ticketing. If your account is not configured for split ticketing, sending includeSplitPaymentInd returns a response without split ticket offers and a warning message. 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 (default behavior): split ticketing options are not returned. 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 supported 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 returns one-way outbound and one-way inbound fares in addition to round-trip offers. Split ticket offers are identified with CombinabilityCode j0. 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. - `BuildOptions.BuildFromProductsRequest.PricingModifiersAir.returnMostRestrictiveBrandInd` (boolean) GDS only, not supported for NDC. 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 (default behavior): return the offer brand of the most significant segment of the itinerary. - `BuildOptions.BuildFromProductsRequest.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 - `BuildOptions.BuildFromProductsRequest.PricingModifiersAir.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. - `BuildOptions.BuildFromProductsRequest.PricingModifiersAir.Brand.@type` (string, required) Discriminator. Child classes BrandID and Brand. BrandCompleteInfo is no longer in use. Enum: "Brand" - `BuildOptions.BuildFromProductsRequest.PricingModifiersAir.Brand.id` (string) Local id within a given message to support referencing this object. Example: brand_001 - `BuildOptions.BuildFromProductsRequest.PricingModifiersAir.Brand.BrandRef` (string) Reference id that corresponds to the brand 'id' in ReferenceListBrand.Brand. Example: brandRef_001 - `BuildOptions.BuildFromProductsRequest.PricingModifiersAir.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). - `BuildOptions.BuildFromProductsRequest.PricingModifiersAir.Brand.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 system generated 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'. - If not available, for Payment, any unique identifier can be sent. 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 - `BuildOptions.BuildFromProductsRequest.PricingModifiersAir.Brand.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 - `BuildOptions.BuildFromProductsRequest.PricingModifiersAir.Brand.name` (string, required) Brand name from the supplier. Example: Main Cabin Extra - `BuildOptions.BuildFromProductsRequest.PricingModifiersAir.Brand.tier` (integer) The brand tier. Not returned for NDC. Example: 2 - `BuildOptions.BuildFromProductsRequest.PricingModifiersAir.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] - `BuildOptions.BuildFromProductsRequest.PricingModifiersAir.Brand.code` (string) The ATPCO Brand Code. Example: REFMAIN - `BuildOptions.BuildFromProductsRequest.PricingModifiersAir.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. - `BuildOptions.BuildFromProductsRequest.PricingModifiersAir.Brand.BrandAttribute.@type` (string, required) Discriminator. No child classes. Example: BrandAttribute - `BuildOptions.BuildFromProductsRequest.PricingModifiersAir.Brand.BrandAttribute.inclusion` (string, required) The indicator as to how the brand and the product are associated. Enum: "Included", "Chargeable", "Not Offered" - `BuildOptions.BuildFromProductsRequest.PricingModifiersAir.Brand.BrandAttribute.ImageURL` (array) URL for an image for the brand, when available. Example: ["http:/imageurl.com"] - `BuildOptions.BuildFromProductsRequest.PricingModifiersAir.Brand.BrandAttribute.matchedAttributeInd` (boolean) Returned only if true for any attribute requested in ProductInclusionPreference.Classification. Example: true - `BuildOptions.BuildFromProductsRequest.PricingModifiersAir.Brand.BrandAttribute.groupCode` (string) Carrier group code. Returned if filed by the carrier. Example: BG - `BuildOptions.BuildFromProductsRequest.PricingModifiersAir.Brand.BrandAttribute.subGroupCode` (string) Carrier sub group code. Returned if filed by the carrier. Example: CY - `BuildOptions.BuildFromProductsRequest.PricingModifiersAir.Brand.BrandAttribute.subCode` (string) Carrier sub code. Returned if filed by the carrier. Example: 08A - `BuildOptions.BuildFromProductsRequest.PricingModifiersAir.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. - `BuildOptions.BuildFromProductsRequest.PricingModifiersAir.Brand.AdditionalBrandAttribute.@type` (string, required) Discriminator. No child classes. Example: AdditionalBrandAttribute - `BuildOptions.BuildFromProductsRequest.PricingModifiersAir.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 - `BuildOptions.BuildFromProductsRequest.PricingModifiersAir.Brand.AdditionalBrandAttribute.ImageURL` (array) URL for an image for the brand, when available. Example: ["https:/travelport/image/profile/firstviewimage"] - `BuildOptions.BuildFromProductsRequest.PricingModifiersAir.Brand.AdditionalBrandAttribute.matchedAttributeInd` (boolean) Returned only if true for any attribute requested in ProductInclusionPreference.Classification. Example: true - `BuildOptions.BuildFromProductsRequest.PricingModifiersAir.Brand.AdditionalBrandAttribute.groupCode` (string) Carrier group code. Returned if filed by the carrier. Example: BG - `BuildOptions.BuildFromProductsRequest.PricingModifiersAir.Brand.AdditionalBrandAttribute.subGroupCode` (string) Carrier sub group code. Returned if filed by the carrier. Example: CY - `BuildOptions.BuildFromProductsRequest.PricingModifiersAir.Brand.AdditionalBrandAttribute.subCode` (string) Carrier sub code. Returned if filed by the carrier. Example: 08A - `BuildOptions.BuildFromProductsRequest.PricingModifiersAir.Brand.ImageURL` (array) Example: ["http:/imageurl.com"] - `BuildOptions.BuildFromProductsRequest.PassengerCriteria` (array, required) - `BuildOptions.BuildFromProductsRequest.PassengerCriteria.@type` (string, required) Discriminator. No child classes. Enum: "PassengerCriteriaAirChange" - `BuildOptions.BuildFromProductsRequest.PassengerCriteria.number` (integer, required) The amount of passengers associated with this passenger type code. Default is 1. Example: 1 - `BuildOptions.BuildFromProductsRequest.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 - `BuildOptions.BuildFromProductsRequest.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 AF, KL, SQ, QR, AV, MH, SK, AY, BR, CX, EY, AA, QF, UA, EK, LHG, BA, AC, TO, NH, SV, and RJ 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 - `BuildOptions.BuildFromProductsRequest.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 - `BuildOptions.BuildFromProductsRequest.PassengerCriteria.id` (string) For AirSearch: NDC only, not supported for GDS. Required when using Air Canada flight pass to pay for NDC flight. For AirPrice: supported for both GDS and NDC with unique functionality. - For NDC: use id in the AirSearch and AirPrice (both full and reference payloads) to assign a custom passenger id to be returned in the response, which supports matching that specific passenger to the PriceBreakdown in the response. - For GDS: in the full payload AirPrice request only, use id to send a custom passenger id only when requesting pricing for one or more specific passengers with OfferConstruction. If not sent, pricing for all passengers is returned. GDS only; not supported for this use in NDC. Example: passengercriteria_001 - `BuildOptions.BuildFromProductsRequest.PassengerCriteria.CustomerLoyalty` (array) NDC only; not supported for GDS. Optional object for sending customer loyalty information, such as for a frequent flyer program. Required when using Air Canada flight pass to pay for NDC flight. Must contain flight pass owner's information, including value, supplier, given name, and surname (or cardholder name). Optional for other passengers in the booking. 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. - `BuildOptions.BuildFromProductsRequest.PassengerCriteria.CustomerLoyalty.value` (string, required) Number on loyalty card. Example: 132456 - `BuildOptions.BuildFromProductsRequest.PassengerCriteria.CustomerLoyalty.id` (string) Optional Customer Loyalty Id. Not saved Example: Loyalty_1 - `BuildOptions.BuildFromProductsRequest.PassengerCriteria.CustomerLoyalty.priority` (integer) Optional Numeric Priority Code Example: 2 - `BuildOptions.BuildFromProductsRequest.PassengerCriteria.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 - `BuildOptions.BuildFromProductsRequest.PassengerCriteria.CustomerLoyalty.programName` (string) Supplier's loyalty program name. Example: Frontier-EarlyReturns - `BuildOptions.BuildFromProductsRequest.PassengerCriteria.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 - `BuildOptions.BuildFromProductsRequest.PassengerCriteria.CustomerLoyalty.supplier` (string) Supplier of a loyalty program (typically 2 characters representing the hotel, brand, or airline). Example: UA - `BuildOptions.BuildFromProductsRequest.PassengerCriteria.CustomerLoyalty.tier` (string) Customer Loyalty tier Example: Silver - `BuildOptions.BuildFromProductsRequest.PassengerCriteria.CustomerLoyalty.shareWithSupplier` (array) The list of suppliers that the CustomerLoyalty number is shared. Used for cross accrual programs. If valid carrier codes are not sent, the response returns the message NO CROSS ACCRUAL AGREEMENT EXISTS. - `BuildOptions.BuildFromProductsRequest.PassengerCriteria.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 - `BuildOptions.BuildFromProductsRequest.PassengerCriteria.CustomerLoyalty.validatedInd` (boolean) Customer loyalty number has been validated by the supplier Example: true - `BuildOptions.BuildFromProductsRequest.PassengerCriteria.CustomerLoyalty.prefix` (string) The cardholder name prefix title like Mr, Mrs, Dr Example: Dr - `BuildOptions.BuildFromProductsRequest.PassengerCriteria.CustomerLoyalty.given` (string) The First Name of the Cardholder Example: John - `BuildOptions.BuildFromProductsRequest.PassengerCriteria.CustomerLoyalty.middle` (string) Middle Name of the Cardholder Example: Wilkinson - `BuildOptions.BuildFromProductsRequest.PassengerCriteria.CustomerLoyalty.surname` (string) Last Name of the Cardholder Example: Smith - `BuildOptions.BuildFromProductsRequest.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. - `BuildOptions.BuildFromProductsRequest.PassengerCriteria.TravelerGeographicLocation.value` (string) IATA code for the city, country, or state/province relevant to the local citizen//local resident fare. Example: PMI - `BuildOptions.BuildFromProductsRequest.PassengerCriteria.TravelerGeographicLocation.travelerGeographicLocationType` (string) The type of location where the fare is valid. Enum: "Country", "StateProvince", "City" - `BuildOptions.BuildFromProductsRequest.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. Example: RM - `BuildOptions.BuildFromProductsRequest.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 - `BuildOptions.BuildFromProductsRequest.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 - `BuildOptions.BuildFromProductsRequest.PassengerCriteria.specifiedPassengerTypeCodeOnlyInd` (boolean) - 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 - `BuildOptions.BuildFromProductsRequest.CustomResponseModifiersAir` (array) - `BuildOptions.sortBy` (string) Sorts offers in order by the value in BestCombinablePrice/TotalPrice. Supported value: - Price-LowToHigh: Sorts the offers returned from lowest to highest price. Supported for GDS, NDC, and combined GDS and NDC content. If sent, this sorting also applies to any following Next Leg Search. Upsell offers are not sorted. Travelport recommends as best practice that when sending sortBy and requesting NDC content, do not also send offersPerPage. If sent together some offers may be incomplete. SortBy cannot be requested in conjunction with premium flex search and will be ignored. Note the following when requesting NDC content: - NDC-only content when multiple NDC carriers return offers: - Without sorting: Search returns NDC offers consecutively by carrier; for example, all NDC AA offers, followed by all NDC UA offers. - With sorting: Search returns all offers in ascending price order regardless of carrier. - GDS and NDC combined content: - Without sorting: Search returns offers by carrier. First for GDS and then for NDC; for example, GDS AA offers, NDC AA offers, GDS UA offers, NDC UA offers. - With sorting: Search returns all offers in ascending price order regardless of carrier or content source. Enum: "Price-LowToHigh" - `BuildOptions.BuildFromCatalogProductOfferingsRequest` (object, required) Used to reference Air Search requests, such as for a Next Leg, reference-payload Price and Add Offer, or other reference-based calls. Defines the identifiers and selections needed to continue a workflow from a preceding Search response, including the cached search result id and the chosen offer and product to carry forward into the next request. - `BuildOptions.BuildFromCatalogProductOfferingsRequest.@type` (string, required) Discriminator. Child classes BuildFromCatalogProductOfferingsRequestAir, BuildFromCatalogProductOfferingsRequestAirSearch, and BuildFromCatalogProductOfferingsRequestAirChange Enum: "BuildFromCatalogProductOfferingsRequestAir" - `BuildOptions.BuildFromCatalogProductOfferingsRequest.CatalogProductOfferingsIdentifier` (object, required) Used to identify a cached Air Search result for subsequent reference-payload requests. Defines the transaction identifier returned from Search that is sent in later steps (such as Next Leg Search and other workflows) to reference a prior search response. The Search response does not return the CatalogProductOfferings/Identifier object if caching is not invoked with offersPerPage in the Search request. A subsequent reference payload request to those search results cannot be sent without caching and the CatalogProductOfferings/Identifier value. - `BuildOptions.BuildFromCatalogProductOfferingsRequest.CatalogProductOfferingsIdentifier.id` (string) Local identifier within a given message for this object. Example: cpo_1 - `BuildOptions.BuildFromCatalogProductOfferingsRequest.CatalogProductOfferingSelection` (array, required) - `BuildOptions.BuildFromCatalogProductOfferingsRequest.CatalogProductOfferingSelection.@type` (string) Discriminator. No child classes. Example: CatalogProductOfferingSelection - `BuildOptions.BuildFromCatalogProductOfferingsRequest.CatalogProductOfferingSelection.CatalogProductOfferingIdentifier` (object, required) Top level object for offer identifier. - `BuildOptions.BuildFromCatalogProductOfferingsRequest.CatalogProductOfferingSelection.CatalogProductOfferingIdentifier.id` (string) Local identifier within a given message for this object. Example: cpo_1 - `BuildOptions.BuildFromCatalogProductOfferingsRequest.CatalogProductOfferingSelection.CatalogProductOfferingIdentifier.CatalogProductOfferingRef` (string) Not used. Allows referencing another instance of this object in the same message. Example: cpo_1 - `BuildOptions.BuildFromCatalogProductOfferingsRequest.CatalogProductOfferingSelection.ProductIdentifier` (array, required) A list of values used to reference specific products. - `BuildOptions.BuildFromCatalogProductOfferingsRequest.CatalogProductOfferingSelection.ProductIdentifier.id` (string) Local identifier within a given message for this object. Example: product_1 - `BuildOptions.BuildFromCatalogProductOfferingsRequest.CatalogProductOfferingSelection.ProductIdentifier.productRef` (string) Used to reference another instance of this object in the same payload. Example: product_1 - `BuildOptions.BuildFromCatalogProductOfferingsRequest.CatalogProductOfferingSelection.SegmentSequence` (array) Example: [1,2] - `BuildOptions.BuildFromCatalogProductOfferingsRequest.UpsellOfferingIdentifier` (array) Will not implement. - `BuildOptions.BuildFromCatalogProductOfferingsRequest.UpsellOfferingIdentifier.id` (string) Local identifier within a given message for this object. Example: UpsellOffering - `BuildOptions.BuildFromCatalogProductOfferingsRequest.UpsellOfferingIdentifier.CatalogProductOfferingRef` (string) Used to reference another instance of this object in the same message - `BuildOptions.BuildFromCatalogProductOfferingsRequest.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. - By default, the CabinPreference in the initial Search request is also applied to any subsequent Next Leg Search request. To override this default and return all cabins for the next leg in the response, send ignoreCabinPreferenceInd=true in the Next Leg Search request. - In AirPrice and AirReservation (Supported for Full Payload path only) - If CabinPreference was sent in the Search request, it is cached and sent with the AirPrice reference payload request. If CabinPreference is sent 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. - `BuildOptions.BuildFromCatalogProductOfferingsRequest.CabinPreference.@type` (string, required) Discriminator. No child classes exist Example: CabinPreference - `BuildOptions.BuildFromCatalogProductOfferingsRequest.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" - `BuildOptions.BuildFromCatalogProductOfferingsRequest.CabinPreference.cabins` (array) A space-delimited list of cabins. - `BuildOptions.BuildFromCatalogProductOfferingsRequest.CabinPreference.legSequence` (array) Leg level preference is supported only for CarrierPreference, CabinPreference, and ClassOfServicePreference. Not supported at AirPrice or Book. Limits preference to the specified leg. You can apply the preference to only some legs of the itinerary, or different preferences to different legs. Best practice is to also send legSequence in SearchCriteriaFlight. To apply preference to the entire itinerary, do not send legSequence. Example: [1,2] - `BuildOptions.BuildFromCatalogProductOfferingsRequest.FareRuleCategory` (array) Not recommended use. Invoke fare rule end points directly. - `BuildOptions.BuildFromCatalogProductOfferingsRequest.lowFareFinderInd` (boolean) GDS only; not supported for NDC. 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. - If false: Provides fares for only the specified class of service. Default. 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. Example: true - `BuildOptions.BuildFromCatalogProductOfferingsRequest.reCheckInventoryInd` (boolean) If true, verifies availability for the requested number of passengers in a specific class of service at the time of the price request by booking and releasing seats. Because this indicator temporarily affects seat availability, the recommended best practice is to use validateInventoryInd instead. Some airlines monitor for high volumes of sell/ignore transactions. Regardless of pricing results, air fares and inventory are only guaranteed by airlines when ticketed and paid. Can help reduce sell failures at booking by alerting of insufficient availability. If any or all segments are not bookable, AirPrice does not return any offers and returns an error message. GDS only, not supported for NDC (NDC carriers always validate inventory at pricing). Example: true - `BuildOptions.BuildFromCatalogProductOfferingsRequest.inhibitBrandContentInd` (boolean) If true, disables the return of branded fare attributes. By default the AirPrice Reference Payload request returns branded fare attributes. Example: true - `BuildOptions.BuildFromCatalogProductOfferingsRequest.validateInventoryInd` (boolean) Verifies availability and may reduce failures at the Add Offer and Workbench Commit steps. If true, verifies availability for the requested number of passengers in a specific class of service at the time of the price request. If there are fewer seats than requested passengers available in that class of service, AirPrice returns an error message and no offers. GDS only, not supported for NDC (NDC carriers always validate inventory at pricing). Example: true ## Request examples: - `GDS flight specific led search` (unknown) ## Response 200: - `200` (unknown) OK - Successful Response - 200 ## Response 200 fields (application/json): - `CatalogProductOfferingsResponse` (object) Top level object for Search response. Includes CatalogProductOfferings, Result, and ReferenceList. - `CatalogProductOfferingsResponse.@type` (string) Example: response - `CatalogProductOfferingsResponse.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 - `CatalogProductOfferingsResponse.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 - `CatalogProductOfferingsResponse.correlationId` (string) Identifier used to correlate hotel API invocations across a multi-call business flows. Example: 49f58f5f-c443-43b4-9f5d-be405fd00a01 - `CatalogProductOfferingsResponse.reservationStatus` (string) Status of reservation or offer completion. Enum: "Success", "Fail", "Partial", "Pending", "OnHold", "Retry", "Other" - `CatalogProductOfferingsResponse.Result` (object) Returns the error and/or warning message information, if applicable. See [Error Messaging](https://developer.travelport.com/docs/flights/general/error-messaging) for additional details. - `CatalogProductOfferingsResponse.Result.@type` (string) Discriminator class Result only Example: Result - `CatalogProductOfferingsResponse.Result.status` (string) The status of an error or warning Enum: "Not processed", "Incomplete", "Complete", "Unknown" - `CatalogProductOfferingsResponse.Result.Error` (array) A list of error information returned at the provider level for a response. - `CatalogProductOfferingsResponse.Result.Error.@type` (string, required) Discriminator classes Error or ErrorDetail Enum: "ErrorDetail" - `CatalogProductOfferingsResponse.Result.Error.StatusCode` (integer) Http standard response code Example: 200 - `CatalogProductOfferingsResponse.Result.Error.Message` (string) The Travelport standardized error or warning message Example: No flights found. - `CatalogProductOfferingsResponse.Result.Error.NameValuePair` (array) - `CatalogProductOfferingsResponse.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 - `CatalogProductOfferingsResponse.Result.Error.NameValuePair.id` (string) Optional internally referenced id Example: 6 - `CatalogProductOfferingsResponse.Result.Error.NameValuePair.name` (string, required) Key, categorizing the type of remark or error. Example: Day1 - `CatalogProductOfferingsResponse.Result.Error.category` (string) A category to assist in identifying the error Example: VALIDATION - `CatalogProductOfferingsResponse.Result.Error.SourceID` (string) The identifier of the source system sending the error or warning Example: 1G - `CatalogProductOfferingsResponse.Result.Error.SourceCode` (string) The error or warning code returned by the source airline or host system Example: 1234 - `CatalogProductOfferingsResponse.Result.Error.SourceDescription` (string) The error or warning message as it is returned by the source airline or host system - `CatalogProductOfferingsResponse.Result.Warning` (array) A list of warning information returned at the provider level for a response. - `CatalogProductOfferingsResponse.Result.Warning.@type` (string, required) Discriminator classes Warning or WarningDetail Enum: "WarningDetail" - `CatalogProductOfferingsResponse.Result.Warning.StatusCode` (integer) Http standard response code Example: 200 - `CatalogProductOfferingsResponse.Result.Warning.Message` (string) The Travelport standardized error or warning message Example: Customer Loyalty could not be applied. - `CatalogProductOfferingsResponse.Result.Warning.NameValuePair` (array) - `CatalogProductOfferingsResponse.Result.Warning.category` (string) A category to assist in identifying the error Example: INFORMATION - `CatalogProductOfferingsResponse.Result.Warning.SourceID` (string) The identifier of the source system sending the error or warning Example: 1G - `CatalogProductOfferingsResponse.Result.Warning.SourceCode` (string) The error or warning code returned by the source airline or host system Example: 1234 - `CatalogProductOfferingsResponse.Result.Warning.SourceDescription` (string) The error or warning message as it is returned by the source airline or host system - `CatalogProductOfferingsResponse.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). - `CatalogProductOfferingsResponse.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 system generated 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'. - If not available, for Payment, any unique identifier can be sent. 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 - `CatalogProductOfferingsResponse.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 - `CatalogProductOfferingsResponse.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. - `CatalogProductOfferingsResponse.NextSteps.baseURI` (string, required) The base portion of the URI in order to shorten the uris in the individual steps Example: www.travelport.com - `CatalogProductOfferingsResponse.NextSteps.id` (string) Optional internally referenced id Example: 5 - `CatalogProductOfferingsResponse.NextSteps.NextStep` (array, required) - `CatalogProductOfferingsResponse.NextSteps.NextStep.value` (string) Example: www.resourcelocation.com - `CatalogProductOfferingsResponse.NextSteps.NextStep.id` (string) Identifier for the Next Step Example: 2 - `CatalogProductOfferingsResponse.NextSteps.NextStep.action` (string, required) The action this next step is intended to achieve Example: cancel - `CatalogProductOfferingsResponse.NextSteps.NextStep.method` (string, required) Describes the set of potential methods that can be taken after an operation. Enum: "GET", "DELETE", "PUT", "POST" - `CatalogProductOfferingsResponse.NextSteps.NextStep.description` (string) Additional clarification for the next step Example: remove offer from the order - `CatalogProductOfferingsResponse.ReferenceList` (array) - `CatalogProductOfferingsResponse.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. Enum: "ReferenceListSeatingChart", "ReferenceListFlight", "ReferenceListAmenity", "ReferenceListProduct", "ReferenceListTraveler", "ReferenceListOffer", "ReferenceListBrand", "ReferenceListTermsAndConditions", "ReferenceListExchangedPrice" - `CatalogProductOfferingsResponse.ReferenceList.id` (string) Uniquely identifies for the Reference List Example: referenceList_001 - `CatalogProductOfferingsResponse.ReferenceList.SeatingChart` (array) - `CatalogProductOfferingsResponse.ReferenceList.SeatingChart.@type` (string, required) Discriminator. Enum: "SeatingChart" - `CatalogProductOfferingsResponse.ReferenceList.SeatingChart.id` (string) Internally reference id - `CatalogProductOfferingsResponse.ReferenceList.SeatingChart.Cabin` (array, required) - `CatalogProductOfferingsResponse.ReferenceList.SeatingChart.Cabin.@type` (string) Example: Cabin - `CatalogProductOfferingsResponse.ReferenceList.SeatingChart.Cabin.name` (string, required) The name of the cabin Example: Economy - `CatalogProductOfferingsResponse.ReferenceList.SeatingChart.Cabin.Layout` (array, required) - `CatalogProductOfferingsResponse.ReferenceList.SeatingChart.Cabin.Layout.value` (string) - `CatalogProductOfferingsResponse.ReferenceList.SeatingChart.Cabin.Layout.position` (array, required) - `CatalogProductOfferingsResponse.ReferenceList.SeatingChart.Cabin.Layout.startRow` (integer, required) Start row for this Cabin Layout - `CatalogProductOfferingsResponse.ReferenceList.SeatingChart.Cabin.Layout.endRow` (integer, required) End row for this Cabin Layout - `CatalogProductOfferingsResponse.ReferenceList.SeatingChart.Cabin.Row` (array, required) - `CatalogProductOfferingsResponse.ReferenceList.SeatingChart.Cabin.Row.@type` (string) Example: Row - `CatalogProductOfferingsResponse.ReferenceList.SeatingChart.Cabin.Row.label` (string) The identifier for the row Example: 78 - `CatalogProductOfferingsResponse.ReferenceList.SeatingChart.Cabin.Row.Space` (array, required) - `CatalogProductOfferingsResponse.ReferenceList.SeatingChart.Cabin.Row.Characteristic` (array) - `CatalogProductOfferingsResponse.ReferenceList.Flight` (array, required) - `CatalogProductOfferingsResponse.ReferenceList.Flight.@type` (string, required) Discriminator. Child classes Flight and FlightDetail. Enum: "Flight" - `CatalogProductOfferingsResponse.ReferenceList.Flight.id` (string) Local id within a given message to support referencing this object - an internal flight identifier. Example: 126 - `CatalogProductOfferingsResponse.ReferenceList.Flight.FlightRef` (string) Reference id that corresponds to the flight 'id' in ReferenceListFlight.Flight. Example: s1 - `CatalogProductOfferingsResponse.ReferenceList.Flight.distance` (integer) Distance covered by the flight. Example: 6574 - `CatalogProductOfferingsResponse.ReferenceList.Flight.stops` (integer) Number of stops Example: 2 - `CatalogProductOfferingsResponse.ReferenceList.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 - `CatalogProductOfferingsResponse.ReferenceList.Flight.carrier` (string, required) The airline code. Example: BA - `CatalogProductOfferingsResponse.ReferenceList.Flight.number` (string, required) The marketing carrier flight number. Example: 98 - `CatalogProductOfferingsResponse.ReferenceList.Flight.operatingCarrier` (string) The operating airline IATA code. Shown in codeshare situations when the operating carrier is different to the marketing carrier. Example: BA - `CatalogProductOfferingsResponse.ReferenceList.Flight.operatingCarrierName` (string) Name of the marketing operating carrier. Example: Liberty Aerospace - `CatalogProductOfferingsResponse.ReferenceList.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 - `CatalogProductOfferingsResponse.ReferenceList.Flight.equipment` (string) Equipment model. Note that TRN, TRS, and BUS equipment codes indicate ground transportation. Example: 777 - `CatalogProductOfferingsResponse.ReferenceList.Flight.Departure` (object, required) Departure details for a given leg. - `CatalogProductOfferingsResponse.ReferenceList.Flight.Departure.@type` (string, required) Discriminator classes Departure or DepartureDetail Enum: "DepartureDetail" - `CatalogProductOfferingsResponse.ReferenceList.Flight.Departure.location` (string, required) IATA code for departure airport or city for this leg of the itinerary. Example: AMS - `CatalogProductOfferingsResponse.ReferenceList.Flight.Departure.date` (string, required) Departure date in YYYY-MM-DD format. Example: 0011-10-17 - `CatalogProductOfferingsResponse.ReferenceList.Flight.Departure.time` (string, required) Departure date in HH:mm:ss (24-hour format). Example: 04:45:00 - `CatalogProductOfferingsResponse.ReferenceList.Flight.Departure.terminal` (string) Departure terminal, returned when available. Example: Terminal 1 - `CatalogProductOfferingsResponse.ReferenceList.Flight.Departure.country` (string) Country of to departure or arrival Example: US - `CatalogProductOfferingsResponse.ReferenceList.Flight.Arrival` (object, required) Arrival information. - `CatalogProductOfferingsResponse.ReferenceList.Flight.Arrival.@type` (string, required) Discriminator classes Arrival or ArrivalDetail Enum: "ArrivalDetail" - `CatalogProductOfferingsResponse.ReferenceList.Flight.Arrival.location` (string, required) IATA code for arrival airport or city for this leg of the itinerary. Example: MAD - `CatalogProductOfferingsResponse.ReferenceList.Flight.Arrival.date` (string, required) Arrival date in YYYY-MM-DD format. Example: 0011-10-17 - `CatalogProductOfferingsResponse.ReferenceList.Flight.Arrival.time` (string) Arrival date in HH:mm:ss (24-hour format). Example: 04:45:00 - `CatalogProductOfferingsResponse.ReferenceList.Flight.Arrival.terminal` (string) Arrival terminal, returned when available. Example: Terminal 1 - `CatalogProductOfferingsResponse.ReferenceList.Flight.Arrival.country` (string) Country of to departure or arrival Example: US - `CatalogProductOfferingsResponse.ReferenceList.Flight.IntermediateStop` (array) GDS only; not supported for NDC. Returned if the flight has a technical stop but does not incur a change in flight number. - `CatalogProductOfferingsResponse.ReferenceList.Flight.IntermediateStop.value` (string) The IATA airport code for the airport where the intermediate stop occurs. - `CatalogProductOfferingsResponse.ReferenceList.Flight.IntermediateStop.arrivalFlightDuration` (string) Duration in hours and minutes of the flight arriving at the intermediate stop. ISO 8601 format Example: PT2H35M - `CatalogProductOfferingsResponse.ReferenceList.Flight.IntermediateStop.departureFlightDuration` (string) Duration in hours and minutes of the flight departing the intermediate stop. ISO 8601 format Example: PT1H35M - `CatalogProductOfferingsResponse.ReferenceList.Flight.IntermediateStop.duration` (string) Duration in hours and minutes between the arrival and departure at the intermediate stop. ISO 8601 format Example: PT1H35M - `CatalogProductOfferingsResponse.ReferenceList.Flight.IntermediateStop.equipment` (string) Equipment model, if there is a change of equipment during the stop. Example: 777 - `CatalogProductOfferingsResponse.ReferenceList.Flight.IntermediateStop.arrivalDate` (string) The local date the aircraft arrives at the intermediate stop Example: 2026-04-30 - `CatalogProductOfferingsResponse.ReferenceList.Flight.IntermediateStop.departureDate` (string) The local date the aircraft departs from the intermediate stop Example: 2026-04-30 - `CatalogProductOfferingsResponse.ReferenceList.Flight.IntermediateStop.arrivalTime` (string) The local time the aircraft arrives at the intermediate stop Example: 68400 - `CatalogProductOfferingsResponse.ReferenceList.Flight.IntermediateStop.departurelTime` (string) The local time the aircraft departs from the intermediate stop Example: 72000 - `CatalogProductOfferingsResponse.ReferenceList.Flight.IntermediateStop.arrivalTerminal` (string) Arrival terminal of the intermediate stop airport Example: Terminal2 - `CatalogProductOfferingsResponse.ReferenceList.Flight.IntermediateStop.departureTerminal` (string) Departure terminal of the intermediate stop airport Example: Terminal4 - `CatalogProductOfferingsResponse.ReferenceList.Flight.subjectToGovernmentApprovalInd` (boolean) GDS only, not supported for NDC. - If true: the airline has filed in its schedule that availability for a specific flight is subject to government approval. Returned only in the Air Search API response. Example: true - `CatalogProductOfferingsResponse.ReferenceList.Amenity` (array, required) One instance for each specific amenity. - `CatalogProductOfferingsResponse.ReferenceList.Amenity.@type` (string, required) Discriminator. No child classes. Example: Amenity - `CatalogProductOfferingsResponse.ReferenceList.Amenity.id` (string, required) A unique Travelport-assigned amenity id used for cross-referencing by each flight with this amenity. Example: amenity_001 - `CatalogProductOfferingsResponse.ReferenceList.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 - `CatalogProductOfferingsResponse.ReferenceList.Amenity.Text` (object) A free text description of the amenity. - `CatalogProductOfferingsResponse.ReferenceList.Amenity.Text.value` (string) A short free text description. - `CatalogProductOfferingsResponse.ReferenceList.Amenity.Text.language` (string) The language the text is provided in. ISO639 format. Example: EN - `CatalogProductOfferingsResponse.ReferenceList.Product` (array) - `CatalogProductOfferingsResponse.ReferenceList.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. Enum: "Product" - `CatalogProductOfferingsResponse.ReferenceList.Product.id` (string) Local id within a given message to support referencing this object. Example: product_1 - `CatalogProductOfferingsResponse.ReferenceList.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 - `CatalogProductOfferingsResponse.ReferenceList.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 - `CatalogProductOfferingsResponse.ReferenceList.Traveler` (array) - `CatalogProductOfferingsResponse.ReferenceList.Traveler.@type` (string, required) Discriminator classes TravelerID or Traveler Enum: "Traveler" - `CatalogProductOfferingsResponse.ReferenceList.Traveler.id` (string) Send value of travelerRefId_1 for the first traveler, then increment for each additional traveler (e.g., travelerRefId_2). Traveler/id is only mandatory when referenced elsewhere in the request, such as in SpecialService and PrimaryContact (TravelerIdentifier/Identifier/value). - `CatalogProductOfferingsResponse.ReferenceList.Traveler.TravelerRef` (string) - `CatalogProductOfferingsResponse.ReferenceList.Traveler.birthDate` (string) Date of birth in YYYY-MM-DD format. The TripServices APIs require this object only for infant and child PTC types (e.g., INF, INS, CHD, UNN). When sending [minimum secure flight information](https://developer.travelport.com/docs/flights/guides/booking-and-reservations/remarks-and-service-requests#minimum-secure-flight-information-ssr-docs), which is required by some carriers, this object is required for all PTCs. Example: 2021-06-05 - `CatalogProductOfferingsResponse.ReferenceList.Traveler.gender` (string) Gender Type Male, Female etc. When sending [minimum secure flight information](https://developer.travelport.com/docs/flights/guides/booking-and-reservations/remarks-and-service-requests#minimum-secure-flight-information-ssr-docs) in the Traveler object, which is required by some carriers, this object is required for all PTCs. This field is not used by Hotel APIs and will be ignored. Enum: "Male", "Female", "Unknown", "Undisclosed" - `CatalogProductOfferingsResponse.ReferenceList.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. - `CatalogProductOfferingsResponse.ReferenceList.Traveler.PersonName.@type` (string, required) Discriminator classes PersonName or PersonNameDetail Enum: "PersonNameDetail" - `CatalogProductOfferingsResponse.ReferenceList.Traveler.PersonName.Prefix` (string) Salutation of honorific (e.g. Mr., Mrs., Ms., Miss, Dr.) Example: Mr - `CatalogProductOfferingsResponse.ReferenceList.Traveler.PersonName.Given` (string) Traveler first or given name. Example: John - `CatalogProductOfferingsResponse.ReferenceList.Traveler.PersonName.Middle` (string) Traveler middle name. Example: Erick - `CatalogProductOfferingsResponse.ReferenceList.Traveler.PersonName.Surname` (string, required) Traveler last name or surname. Example: Smith - `CatalogProductOfferingsResponse.ReferenceList.Traveler.PersonName.personNameType` (string) OTA Code Enum: "Former", "Nickname", "Alternate", "Maiden" - `CatalogProductOfferingsResponse.ReferenceList.Traveler.PersonName.language` (string) 'ISO639 code of the language the name is represented Example: EN - `CatalogProductOfferingsResponse.ReferenceList.Traveler.PersonName.SurnamePrefix` (string) The surname prefix Example: Von - `CatalogProductOfferingsResponse.ReferenceList.Traveler.PersonName.Suffix` (string) Traveler name suffix such as Jr. or Sr. Example: Jr. - `CatalogProductOfferingsResponse.ReferenceList.Traveler.PersonName.Title` (string) Degree or honors Example: DR - `CatalogProductOfferingsResponse.ReferenceList.Traveler.PersonName.Privacy` (object) Confidential details for marketing purpose - `CatalogProductOfferingsResponse.ReferenceList.Traveler.PersonName.Privacy.id` (string) Optional internally referenced id Example: 2 - `CatalogProductOfferingsResponse.ReferenceList.Traveler.PersonName.Privacy.shareMarketing` (string) Used to indicate marketing preferences, Yes, No, Inherit Enum: "Yes", "No", "Inherit" - `CatalogProductOfferingsResponse.ReferenceList.Traveler.PersonName.Privacy.optInStatus` (string) Used to indicate marketing preferences, OptIn, OptOut Enum: "OptedIn", "OptedOut", "Unknown" - `CatalogProductOfferingsResponse.ReferenceList.Traveler.PersonName.Privacy.optInDate` (string) The datetime of receiving the opt in notice Example: 2026-08-07T12:12:00Z - `CatalogProductOfferingsResponse.ReferenceList.Traveler.PersonName.Privacy.optOutDate` (string) The datetime the opt out notice was received Example: 2026-08-07T12:12:00Z - `CatalogProductOfferingsResponse.ReferenceList.Traveler.PersonName.defaultInd` (boolean) If true, this is the default or primary name within a collection of names. Example: true - `CatalogProductOfferingsResponse.ReferenceList.Traveler.Address` (array) - `CatalogProductOfferingsResponse.ReferenceList.Traveler.Address.@type` (string, required) Discriminator classes Address or AddressDetail Enum: "AddressDetail", "PropertyAddress" - `CatalogProductOfferingsResponse.ReferenceList.Traveler.Address.id` (string) unique address id Example: Address_1 - `CatalogProductOfferingsResponse.ReferenceList.Traveler.Address.BldgRoom` (object) Address with building and room number - `CatalogProductOfferingsResponse.ReferenceList.Traveler.Address.BldgRoom.value` (string) Example: Moore House - `CatalogProductOfferingsResponse.ReferenceList.Traveler.Address.BldgRoom.buldingInd` (boolean) When true, the information is a building name. When false, it is an apartment or room # Example: true - `CatalogProductOfferingsResponse.ReferenceList.Traveler.Address.Number` (object) The street number alone is the numerical number that precedes the street name in the address. - `CatalogProductOfferingsResponse.ReferenceList.Traveler.Address.Number.value` (string) Street number value. Example: 23B - `CatalogProductOfferingsResponse.ReferenceList.Traveler.Address.Number.streetNmbrSuffix` (string) Street Number Suffix Example: B - `CatalogProductOfferingsResponse.ReferenceList.Traveler.Address.Number.streetDirection` (string) Direction of the Street Example: NW - `CatalogProductOfferingsResponse.ReferenceList.Traveler.Address.Number.ruralRouteNmbr` (string) RuralRoute Number Example: 76 - `CatalogProductOfferingsResponse.ReferenceList.Traveler.Address.Number.po_Box` (string) PO Box Number Example: 1001 - `CatalogProductOfferingsResponse.ReferenceList.Traveler.Address.Street` (string) Street name. May also contain the street number when the Number element is missing. Example: ABC Street - `CatalogProductOfferingsResponse.ReferenceList.Traveler.Address.AddressLine` (array) Property street address. Used in place of Street and Number. Each element of the array represents an address line. - `CatalogProductOfferingsResponse.ReferenceList.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 - `CatalogProductOfferingsResponse.ReferenceList.Traveler.Address.County` (string) County or Region Name. Example: Berkshire - `CatalogProductOfferingsResponse.ReferenceList.Traveler.Address.StateProv` (object) The standard code or abbreviation for the state, province, or region. May also include full length name. - `CatalogProductOfferingsResponse.ReferenceList.Traveler.Address.StateProv.value` (string) State, province, or region code needed to identify location (typically two characters). Example: CA - `CatalogProductOfferingsResponse.ReferenceList.Traveler.Address.StateProv.name` (string) State, province, or region name needed to identify location. Example: California - `CatalogProductOfferingsResponse.ReferenceList.Traveler.Address.Country` (object) Contains the information needed to identify a country. - `CatalogProductOfferingsResponse.ReferenceList.Traveler.Address.Country.value` (string) The ISO 3166 code for the property's address. Example: US - `CatalogProductOfferingsResponse.ReferenceList.Traveler.Address.Country.id` (string) Custom user-assigned identifier for the country. Example: 23 - `CatalogProductOfferingsResponse.ReferenceList.Traveler.Address.Country.name` (string) The full name of the country for the property's address. Example: United States - `CatalogProductOfferingsResponse.ReferenceList.Traveler.Address.Country.codeContext` (string) The source of a code, such as the organization that provided the id number Example: IATA - `CatalogProductOfferingsResponse.ReferenceList.Traveler.Address.PostalCode` (string) Postal code for the address. Example: Sl6 1AB - `CatalogProductOfferingsResponse.ReferenceList.Traveler.Address.Addressee` (string) The name of the company or person to be addressed Example: ACME INC - `CatalogProductOfferingsResponse.ReferenceList.Traveler.Address.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" - `CatalogProductOfferingsResponse.ReferenceList.Traveler.Address.addressType` (string) OTA code for address type Example: CLT - `CatalogProductOfferingsResponse.ReferenceList.Traveler.Address.use` (string) OTA code for address use Example: AUT - `CatalogProductOfferingsResponse.ReferenceList.Traveler.Address.Comment` (object) Textual information. - `CatalogProductOfferingsResponse.ReferenceList.Traveler.Address.Comment.value` (string) Actual text. May be restricted based on the type of comment. Ex: - Notepad remarks: limited to 87 characters. - Traveler name remarks: limited to 33 characters, only spaces and hyphens allowed for special characters. Example: Additional comments - `CatalogProductOfferingsResponse.ReferenceList.Traveler.Address.Comment.id` (string) Local identifier within a given message for this object. Example: comment_1 - `CatalogProductOfferingsResponse.ReferenceList.Traveler.Address.Comment.name` (string) Title of comment or type of remark. Example: Comment name - `CatalogProductOfferingsResponse.ReferenceList.Traveler.Address.Comment.language` (string) Language code using ISO-639 standard Example: EN - `CatalogProductOfferingsResponse.ReferenceList.Traveler.Address.Priority` (integer) The priority ranking within the group Example: 1 - `CatalogProductOfferingsResponse.ReferenceList.Traveler.Address.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. Example: false - `CatalogProductOfferingsResponse.ReferenceList.Traveler.Address.provisionedInd` (boolean) If true, this address came into the system through provisioning Example: false - `CatalogProductOfferingsResponse.ReferenceList.Traveler.Telephone` (array) - `CatalogProductOfferingsResponse.ReferenceList.Traveler.Telephone.@type` (string, required) Discriminator classes Telephone or TelephoneDetail Enum: "TelephoneDetail" - `CatalogProductOfferingsResponse.ReferenceList.Traveler.Telephone.countryAccessCode` (string) Phone country code Example: 1 - `CatalogProductOfferingsResponse.ReferenceList.Traveler.Telephone.areaCityCode` (string) Phone local area code Example: 972 - `CatalogProductOfferingsResponse.ReferenceList.Traveler.Telephone.phoneNumber` (string, required) Mobile/Telephone Number. Accepted characters are numeric, dash, space, and period. Example: 972-000-787 - `CatalogProductOfferingsResponse.ReferenceList.Traveler.Telephone.extension` (string) Telephone extension number Example: 234 - `CatalogProductOfferingsResponse.ReferenceList.Traveler.Telephone.id` (string) Optional custom user-assigned identifier for a phone number. Example: 3 - `CatalogProductOfferingsResponse.ReferenceList.Traveler.Telephone.cityCode` (string) IATA city code if referenced by phone number. Example: DEN - `CatalogProductOfferingsResponse.ReferenceList.Traveler.Telephone.role` (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" - `CatalogProductOfferingsResponse.ReferenceList.Traveler.Telephone.phoneLocationType` (string) Location of the phone Example: Agency - `CatalogProductOfferingsResponse.ReferenceList.Traveler.Telephone.phoneTechType` (string) Indicates the type of technology associated with the telephone number Example: Voice - `CatalogProductOfferingsResponse.ReferenceList.Traveler.Telephone.phoneUseType` (string) Agency code for how phone is used (e.g., Home, Business, Emergency Contact, Travel Arranger, Day, Evening). Example: Home - `CatalogProductOfferingsResponse.ReferenceList.Traveler.Telephone.pin` (string) Additional codes used for telephone Example: 3456 - `CatalogProductOfferingsResponse.ReferenceList.Traveler.Telephone.priority` (integer) Priority Example: 1 - `CatalogProductOfferingsResponse.ReferenceList.Traveler.Telephone.defaultInd` (boolean) When true, indicates a default value should be used. Example: true - `CatalogProductOfferingsResponse.ReferenceList.Traveler.Telephone.provisionedInd` (boolean) true indicates this phone number was created through provisioned Example: false - `CatalogProductOfferingsResponse.ReferenceList.Traveler.Email` (array) For a reservation Retrieve response, all email addresses are associated with the first traveler on the reservation for GDS. NDC supports contact information for each traveler on the reservation. - `CatalogProductOfferingsResponse.ReferenceList.Traveler.Email.value` (string) The email address. Example: exampledomain@example.com - `CatalogProductOfferingsResponse.ReferenceList.Traveler.Email.id` (string) Electronic email addresses, in IETF specified format. Example: email_1 - `CatalogProductOfferingsResponse.ReferenceList.Traveler.Email.emailType` (string) Use email type to specify if the email is to be sent "TO" or sent "FROM" Example: FROM - `CatalogProductOfferingsResponse.ReferenceList.Traveler.Email.comment` (string) Any freeform note for the email, such as its purpose. Example: work email - `CatalogProductOfferingsResponse.ReferenceList.Traveler.Email.preferredFormat` (string) Mime media type Example: text/html - `CatalogProductOfferingsResponse.ReferenceList.Traveler.Email.optInDate` (string) The datetime of receiving the opt in notice Example: 2026-03-03T11:11:00Z - `CatalogProductOfferingsResponse.ReferenceList.Traveler.Email.optOutDate` (string) The datetime the opt out notice was received Example: 2026-03-03T11:11:00Z - `CatalogProductOfferingsResponse.ReferenceList.Traveler.Email.validInd` (boolean) If true, this is a valid email address that has been system verified via a successful email transmission. Example: true - `CatalogProductOfferingsResponse.ReferenceList.Traveler.Email.provisionedInd` (boolean) If true then the email address came from the provisioning process Example: true - `CatalogProductOfferingsResponse.ReferenceList.Traveler.passengerTypeCode` (string) Passenger type code (PTC) for this traveler. Required for all PTCs other than ADT (adult); if not sent defaults to ADT. Some of the common PTCs supported include ADT, INF, INS, CHD, UNN. Private fare PTCs, including INN, JNN, VNN, ITF, JNF, and VFF, may also be supported, subject to airline support. Example: CHD - `CatalogProductOfferingsResponse.ReferenceList.Traveler.nationality` (string) Nationality on country code ISO Example: AL - `CatalogProductOfferingsResponse.ReferenceList.Traveler.age` (integer) The age of the traveller at the time of travel Example: 13 - `CatalogProductOfferingsResponse.ReferenceList.Traveler.CustomerLoyalty` (array) - `CatalogProductOfferingsResponse.ReferenceList.Traveler.CustomerLoyalty.value` (string, required) Number on loyalty card. Example: 132456 - `CatalogProductOfferingsResponse.ReferenceList.Traveler.CustomerLoyalty.id` (string) Optional Customer Loyalty Id. Not saved Example: Loyalty_1 - `CatalogProductOfferingsResponse.ReferenceList.Traveler.CustomerLoyalty.priority` (integer) Optional Numeric Priority Code Example: 2 - `CatalogProductOfferingsResponse.ReferenceList.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 - `CatalogProductOfferingsResponse.ReferenceList.Traveler.CustomerLoyalty.programName` (string) Supplier's loyalty program name. Example: Frontier-EarlyReturns - `CatalogProductOfferingsResponse.ReferenceList.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 - `CatalogProductOfferingsResponse.ReferenceList.Traveler.CustomerLoyalty.supplier` (string) Supplier of a loyalty program (typically 2 characters representing the hotel, brand, or airline). Example: UA - `CatalogProductOfferingsResponse.ReferenceList.Traveler.CustomerLoyalty.tier` (string) Customer Loyalty tier Example: Silver - `CatalogProductOfferingsResponse.ReferenceList.Traveler.CustomerLoyalty.shareWithSupplier` (array) The list of suppliers that the CustomerLoyalty number is shared. Used for cross accrual programs. If valid carrier codes are not sent, the response returns the message NO CROSS ACCRUAL AGREEMENT EXISTS. - `CatalogProductOfferingsResponse.ReferenceList.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 - `CatalogProductOfferingsResponse.ReferenceList.Traveler.CustomerLoyalty.validatedInd` (boolean) Customer loyalty number has been validated by the supplier Example: true - `CatalogProductOfferingsResponse.ReferenceList.Traveler.CustomerLoyalty.prefix` (string) The cardholder name prefix title like Mr, Mrs, Dr Example: Dr - `CatalogProductOfferingsResponse.ReferenceList.Traveler.CustomerLoyalty.given` (string) The First Name of the Cardholder Example: John - `CatalogProductOfferingsResponse.ReferenceList.Traveler.CustomerLoyalty.middle` (string) Middle Name of the Cardholder Example: Wilkinson - `CatalogProductOfferingsResponse.ReferenceList.Traveler.CustomerLoyalty.surname` (string) Last Name of the Cardholder Example: Smith - `CatalogProductOfferingsResponse.ReferenceList.Traveler.AlternateContact` (array) - `CatalogProductOfferingsResponse.ReferenceList.Traveler.AlternateContact.@type` (string) Example: AlternateContact - `CatalogProductOfferingsResponse.ReferenceList.Traveler.AlternateContact.id` (string) - `CatalogProductOfferingsResponse.ReferenceList.Traveler.AlternateContact.contactType` (string) Contact type value Example: Relative - `CatalogProductOfferingsResponse.ReferenceList.Traveler.AlternateContact.relation` (string) Relation value Example: Mother - `CatalogProductOfferingsResponse.ReferenceList.Traveler.AlternateContact.Address` (array) - `CatalogProductOfferingsResponse.ReferenceList.Traveler.AlternateContact.Telephone` (array) - `CatalogProductOfferingsResponse.ReferenceList.Traveler.AlternateContact.Email` (array) - `CatalogProductOfferingsResponse.ReferenceList.Traveler.AlternateContact.emergencyInd` (boolean) This is the contact in case of an emergency Example: true - `CatalogProductOfferingsResponse.ReferenceList.Traveler.AlternateContact.defaultInd` (boolean) This is the default contact Example: true - `CatalogProductOfferingsResponse.ReferenceList.Traveler.TravelDocument` (array) - `CatalogProductOfferingsResponse.ReferenceList.Traveler.TravelDocument.@type` (string, required) Discriminator classes TravelDocument or TravelDocumentDetail Enum: "TravelDocumentDetail" - `CatalogProductOfferingsResponse.ReferenceList.Traveler.TravelDocument.docNumber` (string) Travel document number. Example: B37201 - `CatalogProductOfferingsResponse.ReferenceList.Traveler.TravelDocument.docType` (string) Supported Travel Document types 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" - `CatalogProductOfferingsResponse.ReferenceList.Traveler.TravelDocument.issueDate` (string) Issue date of document. Required for a visa Example: 2002-10-13 - `CatalogProductOfferingsResponse.ReferenceList.Traveler.TravelDocument.expireDate` (string) Expiration date of document. Required for a visa. Example: 2002-11-13 - `CatalogProductOfferingsResponse.ReferenceList.Traveler.TravelDocument.stateProvCode` (string) State Province Code value Example: 44 - `CatalogProductOfferingsResponse.ReferenceList.Traveler.TravelDocument.placeOfIssue` (string) Place of issue value Example: Birmingham - `CatalogProductOfferingsResponse.ReferenceList.Traveler.TravelDocument.issueCountry` (string) Issuing country of document; ISO3166 standard format. Example: CA - `CatalogProductOfferingsResponse.ReferenceList.Traveler.TravelDocument.birthDate` (string) The date of birth of the document holder in YYYY-MM-DD format. Example: 1995-04-22 - `CatalogProductOfferingsResponse.ReferenceList.Traveler.TravelDocument.birthCountry` (string) Country of birth of the document holder in ISO3166 standard format. Example: AR - `CatalogProductOfferingsResponse.ReferenceList.Traveler.TravelDocument.birthPlace` (string) Birth place value Example: Ontario - `CatalogProductOfferingsResponse.ReferenceList.Traveler.TravelDocument.residence` (string) Residence value Example: 1st section 8th st - `CatalogProductOfferingsResponse.ReferenceList.Traveler.TravelDocument.id` (string) Locally referenced id Example: 34 - `CatalogProductOfferingsResponse.ReferenceList.Traveler.TravelDocument.Nationality` (string) Birth country as noted on document; specifies a 2 character country code as defined in ISO3166. Example: BR - `CatalogProductOfferingsResponse.ReferenceList.Traveler.TravelDocument.IssuedForGeoPoliticalArea` (object) The location code of the geographical location. Codes from Ref Pub - `CatalogProductOfferingsResponse.ReferenceList.Traveler.TravelDocument.IssuedForGeoPoliticalArea.value` (string) Example: G - `CatalogProductOfferingsResponse.ReferenceList.Traveler.TravelDocument.IssuedForGeoPoliticalArea.level` (string) Represents the type of geopolitical area (country, Continent, State etc) Enum: "World", "Global Area", "Continent Group", "Continent", "Country", "StateProvince", "City", "Airport" - `CatalogProductOfferingsResponse.ReferenceList.Traveler.TravelDocument.IssuedForGeoPoliticalArea.id` (string) Optional internally referenced id Example: 2 - `CatalogProductOfferingsResponse.ReferenceList.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. In Traveler this is used to send custom freeform traveler name remarks, such as a unique identifier for a given traveler. Not supported for addition/deletion in Traveler Modify. - `CatalogProductOfferingsResponse.ReferenceList.Traveler.Comments.@type` (string) Example: Comments - `CatalogProductOfferingsResponse.ReferenceList.Traveler.Comments.Comment` (array) - `CatalogProductOfferingsResponse.ReferenceList.Traveler.RailDiscountCard` (array) - `CatalogProductOfferingsResponse.ReferenceList.Traveler.RailDiscountCard.value` (string) Example: Rail1234546 - `CatalogProductOfferingsResponse.ReferenceList.Traveler.RailDiscountCard.supplierCode` (string, required) Code of the Supplier Example: Enco - `CatalogProductOfferingsResponse.ReferenceList.Traveler.RailDiscountCard.referenceNumber` (string) ReferenceNumber Example: 134256 - `CatalogProductOfferingsResponse.ReferenceList.Traveler.accompaniedByInfantInd` (boolean) Example: true - `CatalogProductOfferingsResponse.ReferenceList.Offer` (array) - `CatalogProductOfferingsResponse.ReferenceList.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. Enum: "Offer" - `CatalogProductOfferingsResponse.ReferenceList.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 - `CatalogProductOfferingsResponse.ReferenceList.Offer.offerRef` (string) Used to reference another instance of this object in the same message Example: offer_1 - `CatalogProductOfferingsResponse.ReferenceList.Offer.ContentSource` (string) Indicates the owner the offer or document. Enum: "GDS", "NDC", "LCC", "API" - `CatalogProductOfferingsResponse.ReferenceList.Offer.parentOfferRef` (string) A reference to the Offer this offer is sold in conjunction with Example: offer_1 - `CatalogProductOfferingsResponse.ReferenceList.Offer.offerModifyRef` (string) Reference to the new Offer created as a result of this Offer being subject to a schedule change. - `CatalogProductOfferingsResponse.ReferenceList.Offer.Product` (array, required) Lists the flight or flights for one leg of the itinerary. Repeats for additional leg or legs. - `CatalogProductOfferingsResponse.ReferenceList.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. Certain types of offers on a booking, such as seats and ancillaries, generally include only the CurrencyCode, Base, and TotalPrice objects. - `CatalogProductOfferingsResponse.ReferenceList.Offer.Price.@type` (string, required) Discriminator classes Price or PriceDetail Enum: "PriceDetail" - `CatalogProductOfferingsResponse.ReferenceList.Offer.Price.id` (string) Internally referenced id Example: 2 - `CatalogProductOfferingsResponse.ReferenceList.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. - `CatalogProductOfferingsResponse.ReferenceList.Offer.Price.CurrencyCode.value` (string) An ISO 4217 currency code. Example: USD - `CatalogProductOfferingsResponse.ReferenceList.Offer.Price.CurrencyCode.codeAuthority` (string) Currency code authority Example: ISO 4217 - `CatalogProductOfferingsResponse.ReferenceList.Offer.Price.CurrencyCode.decimalPlace` (integer) Number of decimal places for the currency. Example: 2 - `CatalogProductOfferingsResponse.ReferenceList.Offer.Price.CurrencyCode.decimalAuthority` (string) Currency code decimal authority Example: ISO 4217 - `CatalogProductOfferingsResponse.ReferenceList.Offer.Price.Base` (number) Base price before taxes and fees. For Hotel, may not be returned by all suppliers. Example: 20.2 - `CatalogProductOfferingsResponse.ReferenceList.Offer.Price.TotalTaxes` (number) Total taxes applied to the base price. For Hotel, may not be returned by all suppliers. Example: 34.4 - `CatalogProductOfferingsResponse.ReferenceList.Offer.Price.TotalFees` (number) Total fees included in Total Price. Example: 201 - `CatalogProductOfferingsResponse.ReferenceList.Offer.Price.TotalPrice` (number) Total price of this offer including the base price and all taxes and fees. Example: 34 - `CatalogProductOfferingsResponse.ReferenceList.Offer.Price.VendorCurrencyTotal` (object) No longer used. Previously used to expose the local vendor currency when it is different to the purchased currency - `CatalogProductOfferingsResponse.ReferenceList.Offer.Price.VendorCurrencyTotal.@type` (string) - `CatalogProductOfferingsResponse.ReferenceList.Offer.Price.VendorCurrencyTotal.currencySource` (string) The system requesting or returning the currency code specified in the attribute Enum: "Supplier", "Charged", "Requested" - `CatalogProductOfferingsResponse.ReferenceList.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 - `CatalogProductOfferingsResponse.ReferenceList.Offer.Price.VendorCurrencyTotal.Taxes` (object) Summary of all individual taxes. Child class TaxesDetail provides the breakdown of individual taxes. - `CatalogProductOfferingsResponse.ReferenceList.Offer.Price.VendorCurrencyTotal.Taxes.@type` (string, required) Discriminator class is TaxesDetail Enum: "TaxesDetail" - `CatalogProductOfferingsResponse.ReferenceList.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 - `CatalogProductOfferingsResponse.ReferenceList.Offer.Price.VendorCurrencyTotal.Taxes.TaxInfo` (array) Returned for TripChange APIS only. - `CatalogProductOfferingsResponse.ReferenceList.Offer.Price.VendorCurrencyTotal.Taxes.Tax` (array) - `CatalogProductOfferingsResponse.ReferenceList.Offer.Price.VendorCurrencyTotal.Taxes.TaxPercent` (object) Returned when the tax is expressed as a percentage of the amount. - `CatalogProductOfferingsResponse.ReferenceList.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. - `CatalogProductOfferingsResponse.ReferenceList.Offer.Price.VendorCurrencyTotal.Fees.@type` (string, required) Discriminator. Child class FeesDetail Enum: "FeesDetail" - `CatalogProductOfferingsResponse.ReferenceList.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: 55 - `CatalogProductOfferingsResponse.ReferenceList.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: 25 - `CatalogProductOfferingsResponse.ReferenceList.Offer.Price.VendorCurrencyTotal.Fees.Fee` (array) Array of individual fees. - `CatalogProductOfferingsResponse.ReferenceList.Offer.Price.VendorCurrencyTotal.Total` (number) Specifies the total price including base + taxes + fees Example: 30.13 - `CatalogProductOfferingsResponse.ReferenceList.Offer.Price.VendorCurrencyTotal.approximateInd` (boolean) True if this amount has been converted from the original amount Example: true - `CatalogProductOfferingsResponse.ReferenceList.Offer.Price.FlightPassCredits` (integer) Indicates the number of flight pass credits the offer “costs” for all passengers. Air Canada NDC only. Example: 2 - `CatalogProductOfferingsResponse.ReferenceList.Offer.Price.PriceBreakdown` (array) - `CatalogProductOfferingsResponse.ReferenceList.Offer.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. Enum: "PriceBreakdownAir", "PriceBreakdownAncillary", "PriceBreakdownHospitality", "PriceBreakdownVehiclePrice", "PriceBreakdownVehicleDeposit", "PriceBreakdownVehicleCharges" - `CatalogProductOfferingsResponse.ReferenceList.Offer.Price.PriceBreakdown.Amount` (object) Amount represents the cost applied. - `CatalogProductOfferingsResponse.ReferenceList.Offer.Price.PriceBreakdown.Commission` (object) 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). - `CatalogProductOfferingsResponse.ReferenceList.Offer.TermsAndConditionsFull` (array) For Hotel Rules and Reservation responses, this array will contain a single TermsAndConditionsFullHospitality entry. Cancellation terms with multiple time periods are represented within that entry's CancelPenalty array rather than as multiple TermsAndConditionsFull entries. For Two-Step Commit (FLights), this is a standard object, no changes. For Unified Checkout (Flights), if no payment information was sent in the request, the booking is confirmed by the airline but not yet ticketed. This object provides the payment and ticketing time limits in ExpiryDate and PaymentTimeLimit. - `CatalogProductOfferingsResponse.ReferenceList.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. Enum: "TermsAndConditionsFull", "TermsAndConditionsFullSummary" - `CatalogProductOfferingsResponse.ReferenceList.Offer.TermsAndConditionsFull.id` (string) Local identifier within a given message for this object. Example: TC_1 - `CatalogProductOfferingsResponse.ReferenceList.Offer.TermsAndConditionsFull.termsAndConditionsRef` (string) Used to reference another instance of this object in the same message. Example: TC_1 - `CatalogProductOfferingsResponse.ReferenceList.Offer.TermsAndConditionsFull.ExpiryDate` (string) The date and time in UTC the offer will no longer be valid. Example: 2022-08-07T12:12:00Z - `CatalogProductOfferingsResponse.ReferenceList.Offer.TermsAndConditionsFull.CustomerLoyalty` (array) - `CatalogProductOfferingsResponse.ReferenceList.Offer.TermsAndConditionsFull.TextBlock` (array) A list of free text terms and conditions. - `CatalogProductOfferingsResponse.ReferenceList.Offer.TermsAndConditionsFull.ExpiryDate` (string) The data and time the offer will expire Example: 2022-08-07T12:12:00Z - `CatalogProductOfferingsResponse.ReferenceList.Offer.TermsAndConditionsFull.TextBlock` (array) - `CatalogProductOfferingsResponse.ReferenceList.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 - `CatalogProductOfferingsResponse.ReferenceList.Offer.scheduleChangeInd` (boolean) - If true: this Offer is subject to a schedule change. May be seen in a Two-step Commit, on the first Commit response payload, in the event of a schedule change. If this is the case, the Product object returns previous and updated schedule details in two instances of Product/FlightSegment as follows: - The previous flight segment is identified with sequence=1 and Flight/id=flight_1 - The updated flight segment is identified with sequence=2 and Flight/id=flight_2 Offer includes a ModifyPrice object; however, unless a price change has also occurred, Offer/Price repeats the original price of the offer and Offer/ModifyPrice returns all amounts as zero (0) to indicate there is no price change. NDC only - for Reservation Retrieve, when an airline-initiated flight change has occurred, the response also returns the Offer object with @type OfferModify and scheduleChangeInd=true to indicate a change has occurred. See [NDC Flight Disruption Handing](https://developer.travelport.com/docs/flights/guides/booking-and-reservations/flights-booking-guide#ndc-flight-disruption-handling-involuntary-changes) in the Air Booking Guide for details. - `CatalogProductOfferingsResponse.ReferenceList.Brand` (array) Each instance provides details for one BrandRef id. - `CatalogProductOfferingsResponse.ReferenceList.Brand.@type` (string, required) Discriminator. Child classes BrandID and Brand. BrandCompleteInfo is no longer in use. Enum: "Brand" - `CatalogProductOfferingsResponse.ReferenceList.Brand.id` (string) Local id within a given message to support referencing this object. Example: brand_001 - `CatalogProductOfferingsResponse.ReferenceList.Brand.BrandRef` (string) Reference id that corresponds to the brand 'id' in ReferenceListBrand.Brand. Example: brandRef_001 - `CatalogProductOfferingsResponse.ReferenceList.Brand.name` (string, required) Brand name from the supplier. Example: Main Cabin Extra - `CatalogProductOfferingsResponse.ReferenceList.Brand.tier` (integer) The brand tier. Not returned for NDC. Example: 2 - `CatalogProductOfferingsResponse.ReferenceList.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] - `CatalogProductOfferingsResponse.ReferenceList.Brand.code` (string) The ATPCO Brand Code. Example: REFMAIN - `CatalogProductOfferingsResponse.ReferenceList.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. - `CatalogProductOfferingsResponse.ReferenceList.Brand.BrandAttribute.@type` (string, required) Discriminator. No child classes. Example: BrandAttribute - `CatalogProductOfferingsResponse.ReferenceList.Brand.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" - `CatalogProductOfferingsResponse.ReferenceList.Brand.BrandAttribute.inclusion` (string, required) The indicator as to how the brand and the product are associated. Enum: "Included", "Chargeable", "Not Offered" - `CatalogProductOfferingsResponse.ReferenceList.Brand.BrandAttribute.ImageURL` (array) URL for an image for the brand, when available. Example: ["http:/imageurl.com"] - `CatalogProductOfferingsResponse.ReferenceList.Brand.BrandAttribute.matchedAttributeInd` (boolean) Returned only if true for any attribute requested in ProductInclusionPreference.Classification. Example: true - `CatalogProductOfferingsResponse.ReferenceList.Brand.BrandAttribute.groupCode` (string) Carrier group code. Returned if filed by the carrier. Example: BG - `CatalogProductOfferingsResponse.ReferenceList.Brand.BrandAttribute.subGroupCode` (string) Carrier sub group code. Returned if filed by the carrier. Example: CY - `CatalogProductOfferingsResponse.ReferenceList.Brand.BrandAttribute.subCode` (string) Carrier sub code. Returned if filed by the carrier. Example: 08A - `CatalogProductOfferingsResponse.ReferenceList.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. - `CatalogProductOfferingsResponse.ReferenceList.Brand.AdditionalBrandAttribute.@type` (string, required) Discriminator. No child classes. Example: AdditionalBrandAttribute - `CatalogProductOfferingsResponse.ReferenceList.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 - `CatalogProductOfferingsResponse.ReferenceList.Brand.AdditionalBrandAttribute.ImageURL` (array) URL for an image for the brand, when available. Example: ["https:/travelport/image/profile/firstviewimage"] - `CatalogProductOfferingsResponse.ReferenceList.Brand.AdditionalBrandAttribute.matchedAttributeInd` (boolean) Returned only if true for any attribute requested in ProductInclusionPreference.Classification. Example: true - `CatalogProductOfferingsResponse.ReferenceList.Brand.AdditionalBrandAttribute.groupCode` (string) Carrier group code. Returned if filed by the carrier. Example: BG - `CatalogProductOfferingsResponse.ReferenceList.Brand.AdditionalBrandAttribute.subGroupCode` (string) Carrier sub group code. Returned if filed by the carrier. Example: CY - `CatalogProductOfferingsResponse.ReferenceList.Brand.AdditionalBrandAttribute.subCode` (string) Carrier sub code. Returned if filed by the carrier. Example: 08A - `CatalogProductOfferingsResponse.ReferenceList.Brand.ImageURL` (array) Example: ["http:/imageurl.com"] - `CatalogProductOfferingsResponse.ReferenceList.TermsAndConditions` (array) - `CatalogProductOfferingsResponse.ReferenceList.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. Enum: "TermsAndConditions" - `CatalogProductOfferingsResponse.ReferenceList.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 - `CatalogProductOfferingsResponse.ReferenceList.TermsAndConditions.termsAndConditionsRef` (string) Reference id that corresponds to the TermsAndConditions 'id' in ReferenceListTermsAndConditions.TermsAndConditions. Example: TC_1 - `CatalogProductOfferingsResponse.ReferenceList.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 - `CatalogProductOfferingsResponse.ReferenceList.TermsAndConditions.CustomerLoyalty` (array) - `CatalogProductOfferingsResponse.ReferenceList.Price` (array, required) - `CatalogProductOfferingsResponse.CurrencyRateConversion` (array) - `CatalogProductOfferingsResponse.CurrencyRateConversion.@type` (string) - `CatalogProductOfferingsResponse.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. - `CatalogProductOfferingsResponse.CurrencyRateConversion.ConversionRate.value` (number) - `CatalogProductOfferingsResponse.CurrencyRateConversion.ConversionRate.rateAuthority` (string) Contextual rate authority Example: ISO 4217 - `CatalogProductOfferingsResponse.CurrencyRateConversion.ConversionRate.rateAsOf` (string) Rate as of Example: 2026-08-07T12:12:00Z - `CatalogProductOfferingsResponse.Pagination` (object) Pagination object used when result sets span across a number of pages. - `CatalogProductOfferingsResponse.Pagination.@type` (string, required) Example: Pagination - `CatalogProductOfferingsResponse.Pagination.page` (integer, required) The current page number of the full result set Example: 1 - `CatalogProductOfferingsResponse.Pagination.pageSize` (integer, required) The total number of items on this page Example: 20 - `CatalogProductOfferingsResponse.Pagination.totalPages` (integer, required) The total number of pages in this result set Example: 5 - `CatalogProductOfferingsResponse.Pagination.totalItems` (integer, required) The total number of pages in this result set Example: 100 ## Response 201: - `201` (unknown) Created ## Response 201 fields (application/json): - `CatalogProductOfferingsResponse` (object) Top level object for Search response. Includes CatalogProductOfferings, Result, and ReferenceList. - `CatalogProductOfferingsResponse.@type` (string) Example: response - `CatalogProductOfferingsResponse.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 - `CatalogProductOfferingsResponse.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 - `CatalogProductOfferingsResponse.correlationId` (string) Identifier used to correlate hotel API invocations across a multi-call business flows. Example: 49f58f5f-c443-43b4-9f5d-be405fd00a01 - `CatalogProductOfferingsResponse.reservationStatus` (string) Status of reservation or offer completion. Enum: "Success", "Fail", "Partial", "Pending", "OnHold", "Retry", "Other" - `CatalogProductOfferingsResponse.Result` (object) Returns the error and/or warning message information, if applicable. See [Error Messaging](https://developer.travelport.com/docs/flights/general/error-messaging) for additional details. - `CatalogProductOfferingsResponse.Result.@type` (string) Discriminator class Result only Example: Result - `CatalogProductOfferingsResponse.Result.status` (string) The status of an error or warning Enum: "Not processed", "Incomplete", "Complete", "Unknown" - `CatalogProductOfferingsResponse.Result.Error` (array) A list of error information returned at the provider level for a response. - `CatalogProductOfferingsResponse.Result.Error.@type` (string, required) Discriminator classes Error or ErrorDetail Enum: "ErrorDetail" - `CatalogProductOfferingsResponse.Result.Error.StatusCode` (integer) Http standard response code Example: 200 - `CatalogProductOfferingsResponse.Result.Error.Message` (string) The Travelport standardized error or warning message Example: No flights found. - `CatalogProductOfferingsResponse.Result.Error.NameValuePair` (array) - `CatalogProductOfferingsResponse.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 - `CatalogProductOfferingsResponse.Result.Error.NameValuePair.id` (string) Optional internally referenced id Example: 6 - `CatalogProductOfferingsResponse.Result.Error.NameValuePair.name` (string, required) Key, categorizing the type of remark or error. Example: Day1 - `CatalogProductOfferingsResponse.Result.Error.category` (string) A category to assist in identifying the error Example: VALIDATION - `CatalogProductOfferingsResponse.Result.Error.SourceID` (string) The identifier of the source system sending the error or warning Example: 1G - `CatalogProductOfferingsResponse.Result.Error.SourceCode` (string) The error or warning code returned by the source airline or host system Example: 1234 - `CatalogProductOfferingsResponse.Result.Error.SourceDescription` (string) The error or warning message as it is returned by the source airline or host system - `CatalogProductOfferingsResponse.Result.Warning` (array) A list of warning information returned at the provider level for a response. - `CatalogProductOfferingsResponse.Result.Warning.@type` (string, required) Discriminator classes Warning or WarningDetail Enum: "WarningDetail" - `CatalogProductOfferingsResponse.Result.Warning.StatusCode` (integer) Http standard response code Example: 200 - `CatalogProductOfferingsResponse.Result.Warning.Message` (string) The Travelport standardized error or warning message Example: Customer Loyalty could not be applied. - `CatalogProductOfferingsResponse.Result.Warning.NameValuePair` (array) - `CatalogProductOfferingsResponse.Result.Warning.category` (string) A category to assist in identifying the error Example: INFORMATION - `CatalogProductOfferingsResponse.Result.Warning.SourceID` (string) The identifier of the source system sending the error or warning Example: 1G - `CatalogProductOfferingsResponse.Result.Warning.SourceCode` (string) The error or warning code returned by the source airline or host system Example: 1234 - `CatalogProductOfferingsResponse.Result.Warning.SourceDescription` (string) The error or warning message as it is returned by the source airline or host system - `CatalogProductOfferingsResponse.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). - `CatalogProductOfferingsResponse.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 system generated 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'. - If not available, for Payment, any unique identifier can be sent. 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 - `CatalogProductOfferingsResponse.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 - `CatalogProductOfferingsResponse.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. - `CatalogProductOfferingsResponse.NextSteps.baseURI` (string, required) The base portion of the URI in order to shorten the uris in the individual steps Example: www.travelport.com - `CatalogProductOfferingsResponse.NextSteps.id` (string) Optional internally referenced id Example: 5 - `CatalogProductOfferingsResponse.NextSteps.NextStep` (array, required) - `CatalogProductOfferingsResponse.NextSteps.NextStep.value` (string) Example: www.resourcelocation.com - `CatalogProductOfferingsResponse.NextSteps.NextStep.id` (string) Identifier for the Next Step Example: 2 - `CatalogProductOfferingsResponse.NextSteps.NextStep.action` (string, required) The action this next step is intended to achieve Example: cancel - `CatalogProductOfferingsResponse.NextSteps.NextStep.method` (string, required) Describes the set of potential methods that can be taken after an operation. Enum: "GET", "DELETE", "PUT", "POST" - `CatalogProductOfferingsResponse.NextSteps.NextStep.description` (string) Additional clarification for the next step Example: remove offer from the order - `CatalogProductOfferingsResponse.ReferenceList` (array) - `CatalogProductOfferingsResponse.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. Enum: "ReferenceListSeatingChart", "ReferenceListFlight", "ReferenceListAmenity", "ReferenceListProduct", "ReferenceListTraveler", "ReferenceListOffer", "ReferenceListBrand", "ReferenceListTermsAndConditions", "ReferenceListExchangedPrice" - `CatalogProductOfferingsResponse.ReferenceList.id` (string) Uniquely identifies for the Reference List Example: referenceList_001 - `CatalogProductOfferingsResponse.ReferenceList.SeatingChart` (array) - `CatalogProductOfferingsResponse.ReferenceList.SeatingChart.@type` (string, required) Discriminator. Enum: "SeatingChart" - `CatalogProductOfferingsResponse.ReferenceList.SeatingChart.id` (string) Internally reference id - `CatalogProductOfferingsResponse.ReferenceList.SeatingChart.Cabin` (array, required) - `CatalogProductOfferingsResponse.ReferenceList.SeatingChart.Cabin.@type` (string) Example: Cabin - `CatalogProductOfferingsResponse.ReferenceList.SeatingChart.Cabin.name` (string, required) The name of the cabin Example: Economy - `CatalogProductOfferingsResponse.ReferenceList.SeatingChart.Cabin.Layout` (array, required) - `CatalogProductOfferingsResponse.ReferenceList.SeatingChart.Cabin.Layout.value` (string) - `CatalogProductOfferingsResponse.ReferenceList.SeatingChart.Cabin.Layout.position` (array, required) - `CatalogProductOfferingsResponse.ReferenceList.SeatingChart.Cabin.Layout.startRow` (integer, required) Start row for this Cabin Layout - `CatalogProductOfferingsResponse.ReferenceList.SeatingChart.Cabin.Layout.endRow` (integer, required) End row for this Cabin Layout - `CatalogProductOfferingsResponse.ReferenceList.SeatingChart.Cabin.Row` (array, required) - `CatalogProductOfferingsResponse.ReferenceList.SeatingChart.Cabin.Row.@type` (string) Example: Row - `CatalogProductOfferingsResponse.ReferenceList.SeatingChart.Cabin.Row.label` (string) The identifier for the row Example: 78 - `CatalogProductOfferingsResponse.ReferenceList.SeatingChart.Cabin.Row.Space` (array, required) - `CatalogProductOfferingsResponse.ReferenceList.SeatingChart.Cabin.Row.Characteristic` (array) - `CatalogProductOfferingsResponse.ReferenceList.Flight` (array, required) - `CatalogProductOfferingsResponse.ReferenceList.Flight.@type` (string, required) Discriminator. Child classes Flight and FlightDetail. Enum: "Flight" - `CatalogProductOfferingsResponse.ReferenceList.Flight.id` (string) Local id within a given message to support referencing this object - an internal flight identifier. Example: 126 - `CatalogProductOfferingsResponse.ReferenceList.Flight.FlightRef` (string) Reference id that corresponds to the flight 'id' in ReferenceListFlight.Flight. Example: s1 - `CatalogProductOfferingsResponse.ReferenceList.Flight.distance` (integer) Distance covered by the flight. Example: 6574 - `CatalogProductOfferingsResponse.ReferenceList.Flight.stops` (integer) Number of stops Example: 2 - `CatalogProductOfferingsResponse.ReferenceList.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 - `CatalogProductOfferingsResponse.ReferenceList.Flight.carrier` (string, required) The airline code. Example: BA - `CatalogProductOfferingsResponse.ReferenceList.Flight.number` (string, required) The marketing carrier flight number. Example: 98 - `CatalogProductOfferingsResponse.ReferenceList.Flight.operatingCarrier` (string) The operating airline IATA code. Shown in codeshare situations when the operating carrier is different to the marketing carrier. Example: BA - `CatalogProductOfferingsResponse.ReferenceList.Flight.operatingCarrierName` (string) Name of the marketing operating carrier. Example: Liberty Aerospace - `CatalogProductOfferingsResponse.ReferenceList.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 - `CatalogProductOfferingsResponse.ReferenceList.Flight.equipment` (string) Equipment model. Note that TRN, TRS, and BUS equipment codes indicate ground transportation. Example: 777 - `CatalogProductOfferingsResponse.ReferenceList.Flight.Departure` (object, required) Departure details for a given leg. - `CatalogProductOfferingsResponse.ReferenceList.Flight.Departure.@type` (string, required) Discriminator classes Departure or DepartureDetail Enum: "DepartureDetail" - `CatalogProductOfferingsResponse.ReferenceList.Flight.Departure.location` (string, required) IATA code for departure airport or city for this leg of the itinerary. Example: AMS - `CatalogProductOfferingsResponse.ReferenceList.Flight.Departure.date` (string, required) Departure date in YYYY-MM-DD format. Example: 0011-10-17 - `CatalogProductOfferingsResponse.ReferenceList.Flight.Departure.time` (string, required) Departure date in HH:mm:ss (24-hour format). Example: 04:45:00 - `CatalogProductOfferingsResponse.ReferenceList.Flight.Departure.terminal` (string) Departure terminal, returned when available. Example: Terminal 1 - `CatalogProductOfferingsResponse.ReferenceList.Flight.Departure.country` (string) Country of to departure or arrival Example: US - `CatalogProductOfferingsResponse.ReferenceList.Flight.Arrival` (object, required) Arrival information. - `CatalogProductOfferingsResponse.ReferenceList.Flight.Arrival.@type` (string, required) Discriminator classes Arrival or ArrivalDetail Enum: "ArrivalDetail" - `CatalogProductOfferingsResponse.ReferenceList.Flight.Arrival.location` (string, required) IATA code for arrival airport or city for this leg of the itinerary. Example: MAD - `CatalogProductOfferingsResponse.ReferenceList.Flight.Arrival.date` (string, required) Arrival date in YYYY-MM-DD format. Example: 0011-10-17 - `CatalogProductOfferingsResponse.ReferenceList.Flight.Arrival.time` (string) Arrival date in HH:mm:ss (24-hour format). Example: 04:45:00 - `CatalogProductOfferingsResponse.ReferenceList.Flight.Arrival.terminal` (string) Arrival terminal, returned when available. Example: Terminal 1 - `CatalogProductOfferingsResponse.ReferenceList.Flight.Arrival.country` (string) Country of to departure or arrival Example: US - `CatalogProductOfferingsResponse.ReferenceList.Flight.IntermediateStop` (array) GDS only; not supported for NDC. Returned if the flight has a technical stop but does not incur a change in flight number. - `CatalogProductOfferingsResponse.ReferenceList.Flight.IntermediateStop.value` (string) The IATA airport code for the airport where the intermediate stop occurs. - `CatalogProductOfferingsResponse.ReferenceList.Flight.IntermediateStop.arrivalFlightDuration` (string) Duration in hours and minutes of the flight arriving at the intermediate stop. ISO 8601 format Example: PT2H35M - `CatalogProductOfferingsResponse.ReferenceList.Flight.IntermediateStop.departureFlightDuration` (string) Duration in hours and minutes of the flight departing the intermediate stop. ISO 8601 format Example: PT1H35M - `CatalogProductOfferingsResponse.ReferenceList.Flight.IntermediateStop.duration` (string) Duration in hours and minutes between the arrival and departure at the intermediate stop. ISO 8601 format Example: PT1H35M - `CatalogProductOfferingsResponse.ReferenceList.Flight.IntermediateStop.equipment` (string) Equipment model, if there is a change of equipment during the stop. Example: 777 - `CatalogProductOfferingsResponse.ReferenceList.Flight.IntermediateStop.arrivalDate` (string) The local date the aircraft arrives at the intermediate stop Example: 2026-04-30 - `CatalogProductOfferingsResponse.ReferenceList.Flight.IntermediateStop.departureDate` (string) The local date the aircraft departs from the intermediate stop Example: 2026-04-30 - `CatalogProductOfferingsResponse.ReferenceList.Flight.IntermediateStop.arrivalTime` (string) The local time the aircraft arrives at the intermediate stop Example: 68400 - `CatalogProductOfferingsResponse.ReferenceList.Flight.IntermediateStop.departurelTime` (string) The local time the aircraft departs from the intermediate stop Example: 72000 - `CatalogProductOfferingsResponse.ReferenceList.Flight.IntermediateStop.arrivalTerminal` (string) Arrival terminal of the intermediate stop airport Example: Terminal2 - `CatalogProductOfferingsResponse.ReferenceList.Flight.IntermediateStop.departureTerminal` (string) Departure terminal of the intermediate stop airport Example: Terminal4 - `CatalogProductOfferingsResponse.ReferenceList.Flight.subjectToGovernmentApprovalInd` (boolean) GDS only, not supported for NDC. - If true: the airline has filed in its schedule that availability for a specific flight is subject to government approval. Returned only in the Air Search API response. Example: true - `CatalogProductOfferingsResponse.ReferenceList.Amenity` (array, required) One instance for each specific amenity. - `CatalogProductOfferingsResponse.ReferenceList.Amenity.@type` (string, required) Discriminator. No child classes. Example: Amenity - `CatalogProductOfferingsResponse.ReferenceList.Amenity.id` (string, required) A unique Travelport-assigned amenity id used for cross-referencing by each flight with this amenity. Example: amenity_001 - `CatalogProductOfferingsResponse.ReferenceList.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 - `CatalogProductOfferingsResponse.ReferenceList.Amenity.Text` (object) A free text description of the amenity. - `CatalogProductOfferingsResponse.ReferenceList.Amenity.Text.value` (string) A short free text description. - `CatalogProductOfferingsResponse.ReferenceList.Amenity.Text.language` (string) The language the text is provided in. ISO639 format. Example: EN - `CatalogProductOfferingsResponse.ReferenceList.Product` (array) - `CatalogProductOfferingsResponse.ReferenceList.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. Enum: "Product" - `CatalogProductOfferingsResponse.ReferenceList.Product.id` (string) Local id within a given message to support referencing this object. Example: product_1 - `CatalogProductOfferingsResponse.ReferenceList.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 - `CatalogProductOfferingsResponse.ReferenceList.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 - `CatalogProductOfferingsResponse.ReferenceList.Traveler` (array) - `CatalogProductOfferingsResponse.ReferenceList.Traveler.@type` (string, required) Discriminator classes TravelerID or Traveler Enum: "Traveler" - `CatalogProductOfferingsResponse.ReferenceList.Traveler.id` (string) Send value of travelerRefId_1 for the first traveler, then increment for each additional traveler (e.g., travelerRefId_2). Traveler/id is only mandatory when referenced elsewhere in the request, such as in SpecialService and PrimaryContact (TravelerIdentifier/Identifier/value). - `CatalogProductOfferingsResponse.ReferenceList.Traveler.TravelerRef` (string) - `CatalogProductOfferingsResponse.ReferenceList.Traveler.birthDate` (string) Date of birth in YYYY-MM-DD format. The TripServices APIs require this object only for infant and child PTC types (e.g., INF, INS, CHD, UNN). When sending [minimum secure flight information](https://developer.travelport.com/docs/flights/guides/booking-and-reservations/remarks-and-service-requests#minimum-secure-flight-information-ssr-docs), which is required by some carriers, this object is required for all PTCs. Example: 2021-06-05 - `CatalogProductOfferingsResponse.ReferenceList.Traveler.gender` (string) Gender Type Male, Female etc. When sending [minimum secure flight information](https://developer.travelport.com/docs/flights/guides/booking-and-reservations/remarks-and-service-requests#minimum-secure-flight-information-ssr-docs) in the Traveler object, which is required by some carriers, this object is required for all PTCs. This field is not used by Hotel APIs and will be ignored. Enum: "Male", "Female", "Unknown", "Undisclosed" - `CatalogProductOfferingsResponse.ReferenceList.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. - `CatalogProductOfferingsResponse.ReferenceList.Traveler.PersonName.@type` (string, required) Discriminator classes PersonName or PersonNameDetail Enum: "PersonNameDetail" - `CatalogProductOfferingsResponse.ReferenceList.Traveler.PersonName.Prefix` (string) Salutation of honorific (e.g. Mr., Mrs., Ms., Miss, Dr.) Example: Mr - `CatalogProductOfferingsResponse.ReferenceList.Traveler.PersonName.Given` (string) Traveler first or given name. Example: John - `CatalogProductOfferingsResponse.ReferenceList.Traveler.PersonName.Middle` (string) Traveler middle name. Example: Erick - `CatalogProductOfferingsResponse.ReferenceList.Traveler.PersonName.Surname` (string, required) Traveler last name or surname. Example: Smith - `CatalogProductOfferingsResponse.ReferenceList.Traveler.PersonName.personNameType` (string) OTA Code Enum: "Former", "Nickname", "Alternate", "Maiden" - `CatalogProductOfferingsResponse.ReferenceList.Traveler.PersonName.language` (string) 'ISO639 code of the language the name is represented Example: EN - `CatalogProductOfferingsResponse.ReferenceList.Traveler.PersonName.SurnamePrefix` (string) The surname prefix Example: Von - `CatalogProductOfferingsResponse.ReferenceList.Traveler.PersonName.Suffix` (string) Traveler name suffix such as Jr. or Sr. Example: Jr. - `CatalogProductOfferingsResponse.ReferenceList.Traveler.PersonName.Title` (string) Degree or honors Example: DR - `CatalogProductOfferingsResponse.ReferenceList.Traveler.PersonName.Privacy` (object) Confidential details for marketing purpose - `CatalogProductOfferingsResponse.ReferenceList.Traveler.PersonName.Privacy.id` (string) Optional internally referenced id Example: 2 - `CatalogProductOfferingsResponse.ReferenceList.Traveler.PersonName.Privacy.shareMarketing` (string) Used to indicate marketing preferences, Yes, No, Inherit Enum: "Yes", "No", "Inherit" - `CatalogProductOfferingsResponse.ReferenceList.Traveler.PersonName.Privacy.optInStatus` (string) Used to indicate marketing preferences, OptIn, OptOut Enum: "OptedIn", "OptedOut", "Unknown" - `CatalogProductOfferingsResponse.ReferenceList.Traveler.PersonName.Privacy.optInDate` (string) The datetime of receiving the opt in notice Example: 2026-08-07T12:12:00Z - `CatalogProductOfferingsResponse.ReferenceList.Traveler.PersonName.Privacy.optOutDate` (string) The datetime the opt out notice was received Example: 2026-08-07T12:12:00Z - `CatalogProductOfferingsResponse.ReferenceList.Traveler.PersonName.defaultInd` (boolean) If true, this is the default or primary name within a collection of names. Example: true - `CatalogProductOfferingsResponse.ReferenceList.Traveler.Address` (array) - `CatalogProductOfferingsResponse.ReferenceList.Traveler.Address.@type` (string, required) Discriminator classes Address or AddressDetail Enum: "AddressDetail", "PropertyAddress" - `CatalogProductOfferingsResponse.ReferenceList.Traveler.Address.id` (string) unique address id Example: Address_1 - `CatalogProductOfferingsResponse.ReferenceList.Traveler.Address.BldgRoom` (object) Address with building and room number - `CatalogProductOfferingsResponse.ReferenceList.Traveler.Address.BldgRoom.value` (string) Example: Moore House - `CatalogProductOfferingsResponse.ReferenceList.Traveler.Address.BldgRoom.buldingInd` (boolean) When true, the information is a building name. When false, it is an apartment or room # Example: true - `CatalogProductOfferingsResponse.ReferenceList.Traveler.Address.Number` (object) The street number alone is the numerical number that precedes the street name in the address. - `CatalogProductOfferingsResponse.ReferenceList.Traveler.Address.Number.value` (string) Street number value. Example: 23B - `CatalogProductOfferingsResponse.ReferenceList.Traveler.Address.Number.streetNmbrSuffix` (string) Street Number Suffix Example: B - `CatalogProductOfferingsResponse.ReferenceList.Traveler.Address.Number.streetDirection` (string) Direction of the Street Example: NW - `CatalogProductOfferingsResponse.ReferenceList.Traveler.Address.Number.ruralRouteNmbr` (string) RuralRoute Number Example: 76 - `CatalogProductOfferingsResponse.ReferenceList.Traveler.Address.Number.po_Box` (string) PO Box Number Example: 1001 - `CatalogProductOfferingsResponse.ReferenceList.Traveler.Address.Street` (string) Street name. May also contain the street number when the Number element is missing. Example: ABC Street - `CatalogProductOfferingsResponse.ReferenceList.Traveler.Address.AddressLine` (array) Property street address. Used in place of Street and Number. Each element of the array represents an address line. - `CatalogProductOfferingsResponse.ReferenceList.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 - `CatalogProductOfferingsResponse.ReferenceList.Traveler.Address.County` (string) County or Region Name. Example: Berkshire - `CatalogProductOfferingsResponse.ReferenceList.Traveler.Address.StateProv` (object) The standard code or abbreviation for the state, province, or region. May also include full length name. - `CatalogProductOfferingsResponse.ReferenceList.Traveler.Address.StateProv.value` (string) State, province, or region code needed to identify location (typically two characters). Example: CA - `CatalogProductOfferingsResponse.ReferenceList.Traveler.Address.StateProv.name` (string) State, province, or region name needed to identify location. Example: California - `CatalogProductOfferingsResponse.ReferenceList.Traveler.Address.Country` (object) Contains the information needed to identify a country. - `CatalogProductOfferingsResponse.ReferenceList.Traveler.Address.Country.value` (string) The ISO 3166 code for the property's address. Example: US - `CatalogProductOfferingsResponse.ReferenceList.Traveler.Address.Country.id` (string) Custom user-assigned identifier for the country. Example: 23 - `CatalogProductOfferingsResponse.ReferenceList.Traveler.Address.Country.name` (string) The full name of the country for the property's address. Example: United States - `CatalogProductOfferingsResponse.ReferenceList.Traveler.Address.Country.codeContext` (string) The source of a code, such as the organization that provided the id number Example: IATA - `CatalogProductOfferingsResponse.ReferenceList.Traveler.Address.PostalCode` (string) Postal code for the address. Example: Sl6 1AB - `CatalogProductOfferingsResponse.ReferenceList.Traveler.Address.Addressee` (string) The name of the company or person to be addressed Example: ACME INC - `CatalogProductOfferingsResponse.ReferenceList.Traveler.Address.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" - `CatalogProductOfferingsResponse.ReferenceList.Traveler.Address.addressType` (string) OTA code for address type Example: CLT - `CatalogProductOfferingsResponse.ReferenceList.Traveler.Address.use` (string) OTA code for address use Example: AUT - `CatalogProductOfferingsResponse.ReferenceList.Traveler.Address.Comment` (object) Textual information. - `CatalogProductOfferingsResponse.ReferenceList.Traveler.Address.Comment.value` (string) Actual text. May be restricted based on the type of comment. Ex: - Notepad remarks: limited to 87 characters. - Traveler name remarks: limited to 33 characters, only spaces and hyphens allowed for special characters. Example: Additional comments - `CatalogProductOfferingsResponse.ReferenceList.Traveler.Address.Comment.id` (string) Local identifier within a given message for this object. Example: comment_1 - `CatalogProductOfferingsResponse.ReferenceList.Traveler.Address.Comment.name` (string) Title of comment or type of remark. Example: Comment name - `CatalogProductOfferingsResponse.ReferenceList.Traveler.Address.Comment.language` (string) Language code using ISO-639 standard Example: EN - `CatalogProductOfferingsResponse.ReferenceList.Traveler.Address.Priority` (integer) The priority ranking within the group Example: 1 - `CatalogProductOfferingsResponse.ReferenceList.Traveler.Address.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. Example: false - `CatalogProductOfferingsResponse.ReferenceList.Traveler.Address.provisionedInd` (boolean) If true, this address came into the system through provisioning Example: false - `CatalogProductOfferingsResponse.ReferenceList.Traveler.Telephone` (array) - `CatalogProductOfferingsResponse.ReferenceList.Traveler.Telephone.@type` (string, required) Discriminator classes Telephone or TelephoneDetail Enum: "TelephoneDetail" - `CatalogProductOfferingsResponse.ReferenceList.Traveler.Telephone.countryAccessCode` (string) Phone country code Example: 1 - `CatalogProductOfferingsResponse.ReferenceList.Traveler.Telephone.areaCityCode` (string) Phone local area code Example: 972 - `CatalogProductOfferingsResponse.ReferenceList.Traveler.Telephone.phoneNumber` (string, required) Mobile/Telephone Number. Accepted characters are numeric, dash, space, and period. Example: 972-000-787 - `CatalogProductOfferingsResponse.ReferenceList.Traveler.Telephone.extension` (string) Telephone extension number Example: 234 - `CatalogProductOfferingsResponse.ReferenceList.Traveler.Telephone.id` (string) Optional custom user-assigned identifier for a phone number. Example: 3 - `CatalogProductOfferingsResponse.ReferenceList.Traveler.Telephone.cityCode` (string) IATA city code if referenced by phone number. Example: DEN - `CatalogProductOfferingsResponse.ReferenceList.Traveler.Telephone.role` (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" - `CatalogProductOfferingsResponse.ReferenceList.Traveler.Telephone.phoneLocationType` (string) Location of the phone Example: Agency - `CatalogProductOfferingsResponse.ReferenceList.Traveler.Telephone.phoneTechType` (string) Indicates the type of technology associated with the telephone number Example: Voice - `CatalogProductOfferingsResponse.ReferenceList.Traveler.Telephone.phoneUseType` (string) Agency code for how phone is used (e.g., Home, Business, Emergency Contact, Travel Arranger, Day, Evening). Example: Home - `CatalogProductOfferingsResponse.ReferenceList.Traveler.Telephone.pin` (string) Additional codes used for telephone Example: 3456 - `CatalogProductOfferingsResponse.ReferenceList.Traveler.Telephone.priority` (integer) Priority Example: 1 - `CatalogProductOfferingsResponse.ReferenceList.Traveler.Telephone.defaultInd` (boolean) When true, indicates a default value should be used. Example: true - `CatalogProductOfferingsResponse.ReferenceList.Traveler.Telephone.provisionedInd` (boolean) true indicates this phone number was created through provisioned Example: false - `CatalogProductOfferingsResponse.ReferenceList.Traveler.Email` (array) For a reservation Retrieve response, all email addresses are associated with the first traveler on the reservation for GDS. NDC supports contact information for each traveler on the reservation. - `CatalogProductOfferingsResponse.ReferenceList.Traveler.Email.value` (string) The email address. Example: exampledomain@example.com - `CatalogProductOfferingsResponse.ReferenceList.Traveler.Email.id` (string) Electronic email addresses, in IETF specified format. Example: email_1 - `CatalogProductOfferingsResponse.ReferenceList.Traveler.Email.emailType` (string) Use email type to specify if the email is to be sent "TO" or sent "FROM" Example: FROM - `CatalogProductOfferingsResponse.ReferenceList.Traveler.Email.comment` (string) Any freeform note for the email, such as its purpose. Example: work email - `CatalogProductOfferingsResponse.ReferenceList.Traveler.Email.preferredFormat` (string) Mime media type Example: text/html - `CatalogProductOfferingsResponse.ReferenceList.Traveler.Email.optInDate` (string) The datetime of receiving the opt in notice Example: 2026-03-03T11:11:00Z - `CatalogProductOfferingsResponse.ReferenceList.Traveler.Email.optOutDate` (string) The datetime the opt out notice was received Example: 2026-03-03T11:11:00Z - `CatalogProductOfferingsResponse.ReferenceList.Traveler.Email.validInd` (boolean) If true, this is a valid email address that has been system verified via a successful email transmission. Example: true - `CatalogProductOfferingsResponse.ReferenceList.Traveler.Email.provisionedInd` (boolean) If true then the email address came from the provisioning process Example: true - `CatalogProductOfferingsResponse.ReferenceList.Traveler.passengerTypeCode` (string) Passenger type code (PTC) for this traveler. Required for all PTCs other than ADT (adult); if not sent defaults to ADT. Some of the common PTCs supported include ADT, INF, INS, CHD, UNN. Private fare PTCs, including INN, JNN, VNN, ITF, JNF, and VFF, may also be supported, subject to airline support. Example: CHD - `CatalogProductOfferingsResponse.ReferenceList.Traveler.nationality` (string) Nationality on country code ISO Example: AL - `CatalogProductOfferingsResponse.ReferenceList.Traveler.age` (integer) The age of the traveller at the time of travel Example: 13 - `CatalogProductOfferingsResponse.ReferenceList.Traveler.CustomerLoyalty` (array) - `CatalogProductOfferingsResponse.ReferenceList.Traveler.CustomerLoyalty.value` (string, required) Number on loyalty card. Example: 132456 - `CatalogProductOfferingsResponse.ReferenceList.Traveler.CustomerLoyalty.id` (string) Optional Customer Loyalty Id. Not saved Example: Loyalty_1 - `CatalogProductOfferingsResponse.ReferenceList.Traveler.CustomerLoyalty.priority` (integer) Optional Numeric Priority Code Example: 2 - `CatalogProductOfferingsResponse.ReferenceList.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 - `CatalogProductOfferingsResponse.ReferenceList.Traveler.CustomerLoyalty.programName` (string) Supplier's loyalty program name. Example: Frontier-EarlyReturns - `CatalogProductOfferingsResponse.ReferenceList.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 - `CatalogProductOfferingsResponse.ReferenceList.Traveler.CustomerLoyalty.supplier` (string) Supplier of a loyalty program (typically 2 characters representing the hotel, brand, or airline). Example: UA - `CatalogProductOfferingsResponse.ReferenceList.Traveler.CustomerLoyalty.tier` (string) Customer Loyalty tier Example: Silver - `CatalogProductOfferingsResponse.ReferenceList.Traveler.CustomerLoyalty.shareWithSupplier` (array) The list of suppliers that the CustomerLoyalty number is shared. Used for cross accrual programs. If valid carrier codes are not sent, the response returns the message NO CROSS ACCRUAL AGREEMENT EXISTS. - `CatalogProductOfferingsResponse.ReferenceList.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 - `CatalogProductOfferingsResponse.ReferenceList.Traveler.CustomerLoyalty.validatedInd` (boolean) Customer loyalty number has been validated by the supplier Example: true - `CatalogProductOfferingsResponse.ReferenceList.Traveler.CustomerLoyalty.prefix` (string) The cardholder name prefix title like Mr, Mrs, Dr Example: Dr - `CatalogProductOfferingsResponse.ReferenceList.Traveler.CustomerLoyalty.given` (string) The First Name of the Cardholder Example: John - `CatalogProductOfferingsResponse.ReferenceList.Traveler.CustomerLoyalty.middle` (string) Middle Name of the Cardholder Example: Wilkinson - `CatalogProductOfferingsResponse.ReferenceList.Traveler.CustomerLoyalty.surname` (string) Last Name of the Cardholder Example: Smith - `CatalogProductOfferingsResponse.ReferenceList.Traveler.AlternateContact` (array) - `CatalogProductOfferingsResponse.ReferenceList.Traveler.AlternateContact.@type` (string) Example: AlternateContact - `CatalogProductOfferingsResponse.ReferenceList.Traveler.AlternateContact.id` (string) - `CatalogProductOfferingsResponse.ReferenceList.Traveler.AlternateContact.contactType` (string) Contact type value Example: Relative - `CatalogProductOfferingsResponse.ReferenceList.Traveler.AlternateContact.relation` (string) Relation value Example: Mother - `CatalogProductOfferingsResponse.ReferenceList.Traveler.AlternateContact.Address` (array) - `CatalogProductOfferingsResponse.ReferenceList.Traveler.AlternateContact.Telephone` (array) - `CatalogProductOfferingsResponse.ReferenceList.Traveler.AlternateContact.Email` (array) - `CatalogProductOfferingsResponse.ReferenceList.Traveler.AlternateContact.emergencyInd` (boolean) This is the contact in case of an emergency Example: true - `CatalogProductOfferingsResponse.ReferenceList.Traveler.AlternateContact.defaultInd` (boolean) This is the default contact Example: true - `CatalogProductOfferingsResponse.ReferenceList.Traveler.TravelDocument` (array) - `CatalogProductOfferingsResponse.ReferenceList.Traveler.TravelDocument.@type` (string, required) Discriminator classes TravelDocument or TravelDocumentDetail Enum: "TravelDocumentDetail" - `CatalogProductOfferingsResponse.ReferenceList.Traveler.TravelDocument.docNumber` (string) Travel document number. Example: B37201 - `CatalogProductOfferingsResponse.ReferenceList.Traveler.TravelDocument.docType` (string) Supported Travel Document types 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" - `CatalogProductOfferingsResponse.ReferenceList.Traveler.TravelDocument.issueDate` (string) Issue date of document. Required for a visa Example: 2002-10-13 - `CatalogProductOfferingsResponse.ReferenceList.Traveler.TravelDocument.expireDate` (string) Expiration date of document. Required for a visa. Example: 2002-11-13 - `CatalogProductOfferingsResponse.ReferenceList.Traveler.TravelDocument.stateProvCode` (string) State Province Code value Example: 44 - `CatalogProductOfferingsResponse.ReferenceList.Traveler.TravelDocument.placeOfIssue` (string) Place of issue value Example: Birmingham - `CatalogProductOfferingsResponse.ReferenceList.Traveler.TravelDocument.issueCountry` (string) Issuing country of document; ISO3166 standard format. Example: CA - `CatalogProductOfferingsResponse.ReferenceList.Traveler.TravelDocument.birthDate` (string) The date of birth of the document holder in YYYY-MM-DD format. Example: 1995-04-22 - `CatalogProductOfferingsResponse.ReferenceList.Traveler.TravelDocument.birthCountry` (string) Country of birth of the document holder in ISO3166 standard format. Example: AR - `CatalogProductOfferingsResponse.ReferenceList.Traveler.TravelDocument.birthPlace` (string) Birth place value Example: Ontario - `CatalogProductOfferingsResponse.ReferenceList.Traveler.TravelDocument.residence` (string) Residence value Example: 1st section 8th st - `CatalogProductOfferingsResponse.ReferenceList.Traveler.TravelDocument.id` (string) Locally referenced id Example: 34 - `CatalogProductOfferingsResponse.ReferenceList.Traveler.TravelDocument.Nationality` (string) Birth country as noted on document; specifies a 2 character country code as defined in ISO3166. Example: BR - `CatalogProductOfferingsResponse.ReferenceList.Traveler.TravelDocument.IssuedForGeoPoliticalArea` (object) The location code of the geographical location. Codes from Ref Pub - `CatalogProductOfferingsResponse.ReferenceList.Traveler.TravelDocument.IssuedForGeoPoliticalArea.value` (string) Example: G - `CatalogProductOfferingsResponse.ReferenceList.Traveler.TravelDocument.IssuedForGeoPoliticalArea.level` (string) Represents the type of geopolitical area (country, Continent, State etc) Enum: "World", "Global Area", "Continent Group", "Continent", "Country", "StateProvince", "City", "Airport" - `CatalogProductOfferingsResponse.ReferenceList.Traveler.TravelDocument.IssuedForGeoPoliticalArea.id` (string) Optional internally referenced id Example: 2 - `CatalogProductOfferingsResponse.ReferenceList.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. In Traveler this is used to send custom freeform traveler name remarks, such as a unique identifier for a given traveler. Not supported for addition/deletion in Traveler Modify. - `CatalogProductOfferingsResponse.ReferenceList.Traveler.Comments.@type` (string) Example: Comments - `CatalogProductOfferingsResponse.ReferenceList.Traveler.Comments.Comment` (array) - `CatalogProductOfferingsResponse.ReferenceList.Traveler.RailDiscountCard` (array) - `CatalogProductOfferingsResponse.ReferenceList.Traveler.RailDiscountCard.value` (string) Example: Rail1234546 - `CatalogProductOfferingsResponse.ReferenceList.Traveler.RailDiscountCard.supplierCode` (string, required) Code of the Supplier Example: Enco - `CatalogProductOfferingsResponse.ReferenceList.Traveler.RailDiscountCard.referenceNumber` (string) ReferenceNumber Example: 134256 - `CatalogProductOfferingsResponse.ReferenceList.Traveler.accompaniedByInfantInd` (boolean) Example: true - `CatalogProductOfferingsResponse.ReferenceList.Offer` (array) - `CatalogProductOfferingsResponse.ReferenceList.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. Enum: "Offer" - `CatalogProductOfferingsResponse.ReferenceList.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 - `CatalogProductOfferingsResponse.ReferenceList.Offer.offerRef` (string) Used to reference another instance of this object in the same message Example: offer_1 - `CatalogProductOfferingsResponse.ReferenceList.Offer.ContentSource` (string) Indicates the owner the offer or document. Enum: "GDS", "NDC", "LCC", "API" - `CatalogProductOfferingsResponse.ReferenceList.Offer.parentOfferRef` (string) A reference to the Offer this offer is sold in conjunction with Example: offer_1 - `CatalogProductOfferingsResponse.ReferenceList.Offer.offerModifyRef` (string) Reference to the new Offer created as a result of this Offer being subject to a schedule change. - `CatalogProductOfferingsResponse.ReferenceList.Offer.Product` (array, required) Lists the flight or flights for one leg of the itinerary. Repeats for additional leg or legs. - `CatalogProductOfferingsResponse.ReferenceList.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. Certain types of offers on a booking, such as seats and ancillaries, generally include only the CurrencyCode, Base, and TotalPrice objects. - `CatalogProductOfferingsResponse.ReferenceList.Offer.Price.@type` (string, required) Discriminator classes Price or PriceDetail Enum: "PriceDetail" - `CatalogProductOfferingsResponse.ReferenceList.Offer.Price.id` (string) Internally referenced id Example: 2 - `CatalogProductOfferingsResponse.ReferenceList.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. - `CatalogProductOfferingsResponse.ReferenceList.Offer.Price.CurrencyCode.value` (string) An ISO 4217 currency code. Example: USD - `CatalogProductOfferingsResponse.ReferenceList.Offer.Price.CurrencyCode.codeAuthority` (string) Currency code authority Example: ISO 4217 - `CatalogProductOfferingsResponse.ReferenceList.Offer.Price.CurrencyCode.decimalPlace` (integer) Number of decimal places for the currency. Example: 2 - `CatalogProductOfferingsResponse.ReferenceList.Offer.Price.CurrencyCode.decimalAuthority` (string) Currency code decimal authority Example: ISO 4217 - `CatalogProductOfferingsResponse.ReferenceList.Offer.Price.Base` (number) Base price before taxes and fees. For Hotel, may not be returned by all suppliers. Example: 20.2 - `CatalogProductOfferingsResponse.ReferenceList.Offer.Price.TotalTaxes` (number) Total taxes applied to the base price. For Hotel, may not be returned by all suppliers. Example: 34.4 - `CatalogProductOfferingsResponse.ReferenceList.Offer.Price.TotalFees` (number) Total fees included in Total Price. Example: 201 - `CatalogProductOfferingsResponse.ReferenceList.Offer.Price.TotalPrice` (number) Total price of this offer including the base price and all taxes and fees. Example: 34 - `CatalogProductOfferingsResponse.ReferenceList.Offer.Price.VendorCurrencyTotal` (object) No longer used. Previously used to expose the local vendor currency when it is different to the purchased currency - `CatalogProductOfferingsResponse.ReferenceList.Offer.Price.VendorCurrencyTotal.@type` (string) - `CatalogProductOfferingsResponse.ReferenceList.Offer.Price.VendorCurrencyTotal.currencySource` (string) The system requesting or returning the currency code specified in the attribute Enum: "Supplier", "Charged", "Requested" - `CatalogProductOfferingsResponse.ReferenceList.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 - `CatalogProductOfferingsResponse.ReferenceList.Offer.Price.VendorCurrencyTotal.Taxes` (object) Summary of all individual taxes. Child class TaxesDetail provides the breakdown of individual taxes. - `CatalogProductOfferingsResponse.ReferenceList.Offer.Price.VendorCurrencyTotal.Taxes.@type` (string, required) Discriminator class is TaxesDetail Enum: "TaxesDetail" - `CatalogProductOfferingsResponse.ReferenceList.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 - `CatalogProductOfferingsResponse.ReferenceList.Offer.Price.VendorCurrencyTotal.Taxes.TaxInfo` (array) Returned for TripChange APIS only. - `CatalogProductOfferingsResponse.ReferenceList.Offer.Price.VendorCurrencyTotal.Taxes.Tax` (array) - `CatalogProductOfferingsResponse.ReferenceList.Offer.Price.VendorCurrencyTotal.Taxes.TaxPercent` (object) Returned when the tax is expressed as a percentage of the amount. - `CatalogProductOfferingsResponse.ReferenceList.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. - `CatalogProductOfferingsResponse.ReferenceList.Offer.Price.VendorCurrencyTotal.Fees.@type` (string, required) Discriminator. Child class FeesDetail Enum: "FeesDetail" - `CatalogProductOfferingsResponse.ReferenceList.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: 55 - `CatalogProductOfferingsResponse.ReferenceList.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: 25 - `CatalogProductOfferingsResponse.ReferenceList.Offer.Price.VendorCurrencyTotal.Fees.Fee` (array) Array of individual fees. - `CatalogProductOfferingsResponse.ReferenceList.Offer.Price.VendorCurrencyTotal.Total` (number) Specifies the total price including base + taxes + fees Example: 30.13 - `CatalogProductOfferingsResponse.ReferenceList.Offer.Price.VendorCurrencyTotal.approximateInd` (boolean) True if this amount has been converted from the original amount Example: true - `CatalogProductOfferingsResponse.ReferenceList.Offer.Price.FlightPassCredits` (integer) Indicates the number of flight pass credits the offer “costs” for all passengers. Air Canada NDC only. Example: 2 - `CatalogProductOfferingsResponse.ReferenceList.Offer.Price.PriceBreakdown` (array) - `CatalogProductOfferingsResponse.ReferenceList.Offer.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. Enum: "PriceBreakdownAir", "PriceBreakdownAncillary", "PriceBreakdownHospitality", "PriceBreakdownVehiclePrice", "PriceBreakdownVehicleDeposit", "PriceBreakdownVehicleCharges" - `CatalogProductOfferingsResponse.ReferenceList.Offer.Price.PriceBreakdown.Amount` (object) Amount represents the cost applied. - `CatalogProductOfferingsResponse.ReferenceList.Offer.Price.PriceBreakdown.Commission` (object) 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). - `CatalogProductOfferingsResponse.ReferenceList.Offer.TermsAndConditionsFull` (array) For Hotel Rules and Reservation responses, this array will contain a single TermsAndConditionsFullHospitality entry. Cancellation terms with multiple time periods are represented within that entry's CancelPenalty array rather than as multiple TermsAndConditionsFull entries. For Two-Step Commit (FLights), this is a standard object, no changes. For Unified Checkout (Flights), if no payment information was sent in the request, the booking is confirmed by the airline but not yet ticketed. This object provides the payment and ticketing time limits in ExpiryDate and PaymentTimeLimit. - `CatalogProductOfferingsResponse.ReferenceList.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. Enum: "TermsAndConditionsFull", "TermsAndConditionsFullSummary" - `CatalogProductOfferingsResponse.ReferenceList.Offer.TermsAndConditionsFull.id` (string) Local identifier within a given message for this object. Example: TC_1 - `CatalogProductOfferingsResponse.ReferenceList.Offer.TermsAndConditionsFull.termsAndConditionsRef` (string) Used to reference another instance of this object in the same message. Example: TC_1 - `CatalogProductOfferingsResponse.ReferenceList.Offer.TermsAndConditionsFull.ExpiryDate` (string) The date and time in UTC the offer will no longer be valid. Example: 2022-08-07T12:12:00Z - `CatalogProductOfferingsResponse.ReferenceList.Offer.TermsAndConditionsFull.CustomerLoyalty` (array) - `CatalogProductOfferingsResponse.ReferenceList.Offer.TermsAndConditionsFull.TextBlock` (array) A list of free text terms and conditions. - `CatalogProductOfferingsResponse.ReferenceList.Offer.TermsAndConditionsFull.ExpiryDate` (string) The data and time the offer will expire Example: 2022-08-07T12:12:00Z - `CatalogProductOfferingsResponse.ReferenceList.Offer.TermsAndConditionsFull.TextBlock` (array) - `CatalogProductOfferingsResponse.ReferenceList.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 - `CatalogProductOfferingsResponse.ReferenceList.Offer.scheduleChangeInd` (boolean) - If true: this Offer is subject to a schedule change. May be seen in a Two-step Commit, on the first Commit response payload, in the event of a schedule change. If this is the case, the Product object returns previous and updated schedule details in two instances of Product/FlightSegment as follows: - The previous flight segment is identified with sequence=1 and Flight/id=flight_1 - The updated flight segment is identified with sequence=2 and Flight/id=flight_2 Offer includes a ModifyPrice object; however, unless a price change has also occurred, Offer/Price repeats the original price of the offer and Offer/ModifyPrice returns all amounts as zero (0) to indicate there is no price change. NDC only - for Reservation Retrieve, when an airline-initiated flight change has occurred, the response also returns the Offer object with @type OfferModify and scheduleChangeInd=true to indicate a change has occurred. See [NDC Flight Disruption Handing](https://developer.travelport.com/docs/flights/guides/booking-and-reservations/flights-booking-guide#ndc-flight-disruption-handling-involuntary-changes) in the Air Booking Guide for details. - `CatalogProductOfferingsResponse.ReferenceList.Brand` (array) Each instance provides details for one BrandRef id. - `CatalogProductOfferingsResponse.ReferenceList.Brand.@type` (string, required) Discriminator. Child classes BrandID and Brand. BrandCompleteInfo is no longer in use. Enum: "Brand" - `CatalogProductOfferingsResponse.ReferenceList.Brand.id` (string) Local id within a given message to support referencing this object. Example: brand_001 - `CatalogProductOfferingsResponse.ReferenceList.Brand.BrandRef` (string) Reference id that corresponds to the brand 'id' in ReferenceListBrand.Brand. Example: brandRef_001 - `CatalogProductOfferingsResponse.ReferenceList.Brand.name` (string, required) Brand name from the supplier. Example: Main Cabin Extra - `CatalogProductOfferingsResponse.ReferenceList.Brand.tier` (integer) The brand tier. Not returned for NDC. Example: 2 - `CatalogProductOfferingsResponse.ReferenceList.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] - `CatalogProductOfferingsResponse.ReferenceList.Brand.code` (string) The ATPCO Brand Code. Example: REFMAIN - `CatalogProductOfferingsResponse.ReferenceList.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. - `CatalogProductOfferingsResponse.ReferenceList.Brand.BrandAttribute.@type` (string, required) Discriminator. No child classes. Example: BrandAttribute - `CatalogProductOfferingsResponse.ReferenceList.Brand.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" - `CatalogProductOfferingsResponse.ReferenceList.Brand.BrandAttribute.inclusion` (string, required) The indicator as to how the brand and the product are associated. Enum: "Included", "Chargeable", "Not Offered" - `CatalogProductOfferingsResponse.ReferenceList.Brand.BrandAttribute.ImageURL` (array) URL for an image for the brand, when available. Example: ["http:/imageurl.com"] - `CatalogProductOfferingsResponse.ReferenceList.Brand.BrandAttribute.matchedAttributeInd` (boolean) Returned only if true for any attribute requested in ProductInclusionPreference.Classification. Example: true - `CatalogProductOfferingsResponse.ReferenceList.Brand.BrandAttribute.groupCode` (string) Carrier group code. Returned if filed by the carrier. Example: BG - `CatalogProductOfferingsResponse.ReferenceList.Brand.BrandAttribute.subGroupCode` (string) Carrier sub group code. Returned if filed by the carrier. Example: CY - `CatalogProductOfferingsResponse.ReferenceList.Brand.BrandAttribute.subCode` (string) Carrier sub code. Returned if filed by the carrier. Example: 08A - `CatalogProductOfferingsResponse.ReferenceList.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. - `CatalogProductOfferingsResponse.ReferenceList.Brand.AdditionalBrandAttribute.@type` (string, required) Discriminator. No child classes. Example: AdditionalBrandAttribute - `CatalogProductOfferingsResponse.ReferenceList.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 - `CatalogProductOfferingsResponse.ReferenceList.Brand.AdditionalBrandAttribute.ImageURL` (array) URL for an image for the brand, when available. Example: ["https:/travelport/image/profile/firstviewimage"] - `CatalogProductOfferingsResponse.ReferenceList.Brand.AdditionalBrandAttribute.matchedAttributeInd` (boolean) Returned only if true for any attribute requested in ProductInclusionPreference.Classification. Example: true - `CatalogProductOfferingsResponse.ReferenceList.Brand.AdditionalBrandAttribute.groupCode` (string) Carrier group code. Returned if filed by the carrier. Example: BG - `CatalogProductOfferingsResponse.ReferenceList.Brand.AdditionalBrandAttribute.subGroupCode` (string) Carrier sub group code. Returned if filed by the carrier. Example: CY - `CatalogProductOfferingsResponse.ReferenceList.Brand.AdditionalBrandAttribute.subCode` (string) Carrier sub code. Returned if filed by the carrier. Example: 08A - `CatalogProductOfferingsResponse.ReferenceList.Brand.ImageURL` (array) Example: ["http:/imageurl.com"] - `CatalogProductOfferingsResponse.ReferenceList.TermsAndConditions` (array) - `CatalogProductOfferingsResponse.ReferenceList.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. Enum: "TermsAndConditions" - `CatalogProductOfferingsResponse.ReferenceList.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 - `CatalogProductOfferingsResponse.ReferenceList.TermsAndConditions.termsAndConditionsRef` (string) Reference id that corresponds to the TermsAndConditions 'id' in ReferenceListTermsAndConditions.TermsAndConditions. Example: TC_1 - `CatalogProductOfferingsResponse.ReferenceList.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 - `CatalogProductOfferingsResponse.ReferenceList.TermsAndConditions.CustomerLoyalty` (array) - `CatalogProductOfferingsResponse.ReferenceList.Price` (array, required) - `CatalogProductOfferingsResponse.CurrencyRateConversion` (array) - `CatalogProductOfferingsResponse.CurrencyRateConversion.@type` (string) - `CatalogProductOfferingsResponse.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. - `CatalogProductOfferingsResponse.CurrencyRateConversion.ConversionRate.value` (number) - `CatalogProductOfferingsResponse.CurrencyRateConversion.ConversionRate.rateAuthority` (string) Contextual rate authority Example: ISO 4217 - `CatalogProductOfferingsResponse.CurrencyRateConversion.ConversionRate.rateAsOf` (string) Rate as of Example: 2026-08-07T12:12:00Z - `CatalogProductOfferingsResponse.Pagination` (object) Pagination object used when result sets span across a number of pages. - `CatalogProductOfferingsResponse.Pagination.@type` (string, required) Example: Pagination - `CatalogProductOfferingsResponse.Pagination.page` (integer, required) The current page number of the full result set Example: 1 - `CatalogProductOfferingsResponse.Pagination.pageSize` (integer, required) The total number of items on this page Example: 20 - `CatalogProductOfferingsResponse.Pagination.totalPages` (integer, required) The total number of pages in this result set Example: 5 - `CatalogProductOfferingsResponse.Pagination.totalItems` (integer, required) The total number of pages in this result set Example: 100 ## Response 400: - `400` (unknown) Bad Request - 400 ## 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 flows. Example: 49f58f5f-c443-43b4-9f5d-be405fd00a01 - `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. See [Error Messaging](https://developer.travelport.com/docs/flights/general/error-messaging) for additional details. - `ErrorResponse.Result.@type` (string) Discriminator class Result only Example: Result - `ErrorResponse.Result.status` (string) The status of an error or warning Enum: "Not processed", "Incomplete", "Complete", "Unknown" - `ErrorResponse.Result.Error` (array) A list of error information returned at the provider level for a response. - `ErrorResponse.Result.Error.@type` (string, required) Discriminator classes Error or ErrorDetail Enum: "ErrorDetail" - `ErrorResponse.Result.Error.StatusCode` (integer) Http standard response code Example: 200 - `ErrorResponse.Result.Error.Message` (string) The Travelport standardized error or warning message Example: No flights found. - `ErrorResponse.Result.Error.NameValuePair` (array) - `ErrorResponse.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 - `ErrorResponse.Result.Error.NameValuePair.id` (string) Optional internally referenced id Example: 6 - `ErrorResponse.Result.Error.NameValuePair.name` (string, required) Key, categorizing the type of remark or error. Example: Day1 - `ErrorResponse.Result.Error.category` (string) A category to assist in identifying the error Example: VALIDATION - `ErrorResponse.Result.Error.SourceID` (string) The identifier of the source system sending the error or warning Example: 1G - `ErrorResponse.Result.Error.SourceCode` (string) The error or warning code returned by the source airline or host system Example: 1234 - `ErrorResponse.Result.Error.SourceDescription` (string) The error or warning message as it is returned by the source airline or host system - `ErrorResponse.Result.Warning` (array) A list of warning information returned at the provider level for a response. - `ErrorResponse.Result.Warning.@type` (string, required) Discriminator classes Warning or WarningDetail Enum: "WarningDetail" - `ErrorResponse.Result.Warning.StatusCode` (integer) Http standard response code Example: 200 - `ErrorResponse.Result.Warning.Message` (string) The Travelport standardized error or warning message Example: Customer Loyalty could not be applied. - `ErrorResponse.Result.Warning.NameValuePair` (array) - `ErrorResponse.Result.Warning.category` (string) A category to assist in identifying the error Example: INFORMATION - `ErrorResponse.Result.Warning.SourceID` (string) The identifier of the source system sending the error or warning Example: 1G - `ErrorResponse.Result.Warning.SourceCode` (string) The error or warning code returned by the source airline or host system Example: 1234 - `ErrorResponse.Result.Warning.SourceDescription` (string) The error or warning message as it is returned by the source airline or host system - `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.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 system generated 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'. - If not available, for Payment, any unique identifier can be sent. 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 - `ErrorResponse.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 - `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 Example: www.travelport.com - `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) - `ErrorResponse.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. Enum: "ReferenceListSeatingChart", "ReferenceListFlight", "ReferenceListAmenity", "ReferenceListProduct", "ReferenceListTraveler", "ReferenceListOffer", "ReferenceListBrand", "ReferenceListTermsAndConditions", "ReferenceListExchangedPrice" - `ErrorResponse.ReferenceList.id` (string) Uniquely identifies for the Reference List Example: referenceList_001 - `ErrorResponse.ReferenceList.SeatingChart` (array) - `ErrorResponse.ReferenceList.SeatingChart.@type` (string, required) Discriminator. Enum: "SeatingChart" - `ErrorResponse.ReferenceList.SeatingChart.id` (string) Internally reference id - `ErrorResponse.ReferenceList.SeatingChart.Cabin` (array, required) - `ErrorResponse.ReferenceList.SeatingChart.Cabin.@type` (string) Example: Cabin - `ErrorResponse.ReferenceList.SeatingChart.Cabin.name` (string, required) The name of the cabin Example: Economy - `ErrorResponse.ReferenceList.SeatingChart.Cabin.Layout` (array, required) - `ErrorResponse.ReferenceList.SeatingChart.Cabin.Layout.value` (string) - `ErrorResponse.ReferenceList.SeatingChart.Cabin.Layout.position` (array, required) - `ErrorResponse.ReferenceList.SeatingChart.Cabin.Layout.startRow` (integer, required) Start row for this Cabin Layout - `ErrorResponse.ReferenceList.SeatingChart.Cabin.Layout.endRow` (integer, required) End row for this Cabin Layout - `ErrorResponse.ReferenceList.SeatingChart.Cabin.Row` (array, required) - `ErrorResponse.ReferenceList.SeatingChart.Cabin.Row.@type` (string) Example: Row - `ErrorResponse.ReferenceList.SeatingChart.Cabin.Row.label` (string) The identifier for the row Example: 78 - `ErrorResponse.ReferenceList.SeatingChart.Cabin.Row.Space` (array, required) - `ErrorResponse.ReferenceList.SeatingChart.Cabin.Row.Characteristic` (array) - `ErrorResponse.ReferenceList.Flight` (array, required) - `ErrorResponse.ReferenceList.Flight.@type` (string, required) Discriminator. Child classes Flight and FlightDetail. Enum: "Flight" - `ErrorResponse.ReferenceList.Flight.id` (string) Local id within a given message to support referencing this object - an internal flight identifier. Example: 126 - `ErrorResponse.ReferenceList.Flight.FlightRef` (string) Reference id that corresponds to the flight 'id' in ReferenceListFlight.Flight. Example: s1 - `ErrorResponse.ReferenceList.Flight.distance` (integer) Distance covered by the flight. Example: 6574 - `ErrorResponse.ReferenceList.Flight.stops` (integer) Number of stops Example: 2 - `ErrorResponse.ReferenceList.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 - `ErrorResponse.ReferenceList.Flight.carrier` (string, required) The airline code. Example: BA - `ErrorResponse.ReferenceList.Flight.number` (string, required) The marketing carrier flight number. Example: 98 - `ErrorResponse.ReferenceList.Flight.operatingCarrier` (string) The operating airline IATA code. Shown in codeshare situations when the operating carrier is different to the marketing carrier. Example: BA - `ErrorResponse.ReferenceList.Flight.operatingCarrierName` (string) Name of the marketing operating carrier. Example: Liberty Aerospace - `ErrorResponse.ReferenceList.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 - `ErrorResponse.ReferenceList.Flight.equipment` (string) Equipment model. Note that TRN, TRS, and BUS equipment codes indicate ground transportation. Example: 777 - `ErrorResponse.ReferenceList.Flight.Departure` (object, required) Departure details for a given leg. - `ErrorResponse.ReferenceList.Flight.Departure.@type` (string, required) Discriminator classes Departure or DepartureDetail Enum: "DepartureDetail" - `ErrorResponse.ReferenceList.Flight.Departure.location` (string, required) IATA code for departure airport or city for this leg of the itinerary. Example: AMS - `ErrorResponse.ReferenceList.Flight.Departure.date` (string, required) Departure date in YYYY-MM-DD format. Example: 0011-10-17 - `ErrorResponse.ReferenceList.Flight.Departure.time` (string, required) Departure date in HH:mm:ss (24-hour format). Example: 04:45:00 - `ErrorResponse.ReferenceList.Flight.Departure.terminal` (string) Departure terminal, returned when available. Example: Terminal 1 - `ErrorResponse.ReferenceList.Flight.Departure.country` (string) Country of to departure or arrival Example: US - `ErrorResponse.ReferenceList.Flight.Arrival` (object, required) Arrival information. - `ErrorResponse.ReferenceList.Flight.Arrival.@type` (string, required) Discriminator classes Arrival or ArrivalDetail Enum: "ArrivalDetail" - `ErrorResponse.ReferenceList.Flight.Arrival.location` (string, required) IATA code for arrival airport or city for this leg of the itinerary. Example: MAD - `ErrorResponse.ReferenceList.Flight.Arrival.date` (string, required) Arrival date in YYYY-MM-DD format. Example: 0011-10-17 - `ErrorResponse.ReferenceList.Flight.Arrival.time` (string) Arrival date in HH:mm:ss (24-hour format). Example: 04:45:00 - `ErrorResponse.ReferenceList.Flight.Arrival.terminal` (string) Arrival terminal, returned when available. Example: Terminal 1 - `ErrorResponse.ReferenceList.Flight.Arrival.country` (string) Country of to departure or arrival Example: US - `ErrorResponse.ReferenceList.Flight.IntermediateStop` (array) GDS only; not supported for NDC. Returned if the flight has a technical stop but does not incur a change in flight number. - `ErrorResponse.ReferenceList.Flight.IntermediateStop.value` (string) The IATA airport code for the airport where the intermediate stop occurs. - `ErrorResponse.ReferenceList.Flight.IntermediateStop.arrivalFlightDuration` (string) Duration in hours and minutes of the flight arriving at the intermediate stop. ISO 8601 format Example: PT2H35M - `ErrorResponse.ReferenceList.Flight.IntermediateStop.departureFlightDuration` (string) Duration in hours and minutes of the flight departing the intermediate stop. ISO 8601 format Example: PT1H35M - `ErrorResponse.ReferenceList.Flight.IntermediateStop.duration` (string) Duration in hours and minutes between the arrival and departure at the intermediate stop. ISO 8601 format Example: PT1H35M - `ErrorResponse.ReferenceList.Flight.IntermediateStop.equipment` (string) Equipment model, if there is a change of equipment during the stop. Example: 777 - `ErrorResponse.ReferenceList.Flight.IntermediateStop.arrivalDate` (string) The local date the aircraft arrives at the intermediate stop Example: 2026-04-30 - `ErrorResponse.ReferenceList.Flight.IntermediateStop.departureDate` (string) The local date the aircraft departs from the intermediate stop Example: 2026-04-30 - `ErrorResponse.ReferenceList.Flight.IntermediateStop.arrivalTime` (string) The local time the aircraft arrives at the intermediate stop Example: 68400 - `ErrorResponse.ReferenceList.Flight.IntermediateStop.departurelTime` (string) The local time the aircraft departs from the intermediate stop Example: 72000 - `ErrorResponse.ReferenceList.Flight.IntermediateStop.arrivalTerminal` (string) Arrival terminal of the intermediate stop airport Example: Terminal2 - `ErrorResponse.ReferenceList.Flight.IntermediateStop.departureTerminal` (string) Departure terminal of the intermediate stop airport Example: Terminal4 - `ErrorResponse.ReferenceList.Flight.subjectToGovernmentApprovalInd` (boolean) GDS only, not supported for NDC. - If true: the airline has filed in its schedule that availability for a specific flight is subject to government approval. Returned only in the Air Search API response. Example: true - `ErrorResponse.ReferenceList.Amenity` (array, required) One instance for each specific amenity. - `ErrorResponse.ReferenceList.Amenity.@type` (string, required) Discriminator. No child classes. Example: Amenity - `ErrorResponse.ReferenceList.Amenity.id` (string, required) A unique Travelport-assigned amenity id used for cross-referencing by each flight with this amenity. Example: amenity_001 - `ErrorResponse.ReferenceList.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 - `ErrorResponse.ReferenceList.Amenity.Text` (object) A free text description of the amenity. - `ErrorResponse.ReferenceList.Amenity.Text.value` (string) A short free text description. - `ErrorResponse.ReferenceList.Amenity.Text.language` (string) The language the text is provided in. ISO639 format. Example: EN - `ErrorResponse.ReferenceList.Product` (array) - `ErrorResponse.ReferenceList.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. Enum: "Product" - `ErrorResponse.ReferenceList.Product.id` (string) Local id within a given message to support referencing this object. Example: product_1 - `ErrorResponse.ReferenceList.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 - `ErrorResponse.ReferenceList.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 - `ErrorResponse.ReferenceList.Traveler` (array) - `ErrorResponse.ReferenceList.Traveler.@type` (string, required) Discriminator classes TravelerID or Traveler Enum: "Traveler" - `ErrorResponse.ReferenceList.Traveler.id` (string) Send value of travelerRefId_1 for the first traveler, then increment for each additional traveler (e.g., travelerRefId_2). Traveler/id is only mandatory when referenced elsewhere in the request, such as in SpecialService and PrimaryContact (TravelerIdentifier/Identifier/value). - `ErrorResponse.ReferenceList.Traveler.TravelerRef` (string) - `ErrorResponse.ReferenceList.Traveler.birthDate` (string) Date of birth in YYYY-MM-DD format. The TripServices APIs require this object only for infant and child PTC types (e.g., INF, INS, CHD, UNN). When sending [minimum secure flight information](https://developer.travelport.com/docs/flights/guides/booking-and-reservations/remarks-and-service-requests#minimum-secure-flight-information-ssr-docs), which is required by some carriers, this object is required for all PTCs. Example: 2021-06-05 - `ErrorResponse.ReferenceList.Traveler.gender` (string) Gender Type Male, Female etc. When sending [minimum secure flight information](https://developer.travelport.com/docs/flights/guides/booking-and-reservations/remarks-and-service-requests#minimum-secure-flight-information-ssr-docs) in the Traveler object, which is required by some carriers, this object is required for all PTCs. This field is not used by Hotel APIs and will be ignored. Enum: "Male", "Female", "Unknown", "Undisclosed" - `ErrorResponse.ReferenceList.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. - `ErrorResponse.ReferenceList.Traveler.PersonName.@type` (string, required) Discriminator classes PersonName or PersonNameDetail Enum: "PersonNameDetail" - `ErrorResponse.ReferenceList.Traveler.PersonName.Prefix` (string) Salutation of honorific (e.g. Mr., Mrs., Ms., Miss, Dr.) Example: Mr - `ErrorResponse.ReferenceList.Traveler.PersonName.Given` (string) Traveler first or given name. Example: John - `ErrorResponse.ReferenceList.Traveler.PersonName.Middle` (string) Traveler middle name. Example: Erick - `ErrorResponse.ReferenceList.Traveler.PersonName.Surname` (string, required) Traveler last name or surname. Example: Smith - `ErrorResponse.ReferenceList.Traveler.PersonName.personNameType` (string) OTA Code Enum: "Former", "Nickname", "Alternate", "Maiden" - `ErrorResponse.ReferenceList.Traveler.PersonName.language` (string) 'ISO639 code of the language the name is represented Example: EN - `ErrorResponse.ReferenceList.Traveler.PersonName.SurnamePrefix` (string) The surname prefix Example: Von - `ErrorResponse.ReferenceList.Traveler.PersonName.Suffix` (string) Traveler name suffix such as Jr. or Sr. Example: Jr. - `ErrorResponse.ReferenceList.Traveler.PersonName.Title` (string) Degree or honors Example: DR - `ErrorResponse.ReferenceList.Traveler.PersonName.Privacy` (object) Confidential details for marketing purpose - `ErrorResponse.ReferenceList.Traveler.PersonName.Privacy.id` (string) Optional internally referenced id Example: 2 - `ErrorResponse.ReferenceList.Traveler.PersonName.Privacy.shareMarketing` (string) Used to indicate marketing preferences, Yes, No, Inherit Enum: "Yes", "No", "Inherit" - `ErrorResponse.ReferenceList.Traveler.PersonName.Privacy.optInStatus` (string) Used to indicate marketing preferences, OptIn, OptOut Enum: "OptedIn", "OptedOut", "Unknown" - `ErrorResponse.ReferenceList.Traveler.PersonName.Privacy.optInDate` (string) The datetime of receiving the opt in notice Example: 2026-08-07T12:12:00Z - `ErrorResponse.ReferenceList.Traveler.PersonName.Privacy.optOutDate` (string) The datetime the opt out notice was received Example: 2026-08-07T12:12:00Z - `ErrorResponse.ReferenceList.Traveler.PersonName.defaultInd` (boolean) If true, this is the default or primary name within a collection of names. Example: true - `ErrorResponse.ReferenceList.Traveler.Address` (array) - `ErrorResponse.ReferenceList.Traveler.Address.@type` (string, required) Discriminator classes Address or AddressDetail Enum: "AddressDetail", "PropertyAddress" - `ErrorResponse.ReferenceList.Traveler.Address.id` (string) unique address id Example: Address_1 - `ErrorResponse.ReferenceList.Traveler.Address.BldgRoom` (object) Address with building and room number - `ErrorResponse.ReferenceList.Traveler.Address.BldgRoom.value` (string) Example: Moore House - `ErrorResponse.ReferenceList.Traveler.Address.BldgRoom.buldingInd` (boolean) When true, the information is a building name. When false, it is an apartment or room # Example: true - `ErrorResponse.ReferenceList.Traveler.Address.Number` (object) The street number alone is the numerical number that precedes the street name in the address. - `ErrorResponse.ReferenceList.Traveler.Address.Number.value` (string) Street number value. Example: 23B - `ErrorResponse.ReferenceList.Traveler.Address.Number.streetNmbrSuffix` (string) Street Number Suffix Example: B - `ErrorResponse.ReferenceList.Traveler.Address.Number.streetDirection` (string) Direction of the Street Example: NW - `ErrorResponse.ReferenceList.Traveler.Address.Number.ruralRouteNmbr` (string) RuralRoute Number Example: 76 - `ErrorResponse.ReferenceList.Traveler.Address.Number.po_Box` (string) PO Box Number Example: 1001 - `ErrorResponse.ReferenceList.Traveler.Address.Street` (string) Street name. May also contain the street number when the Number element is missing. Example: ABC Street - `ErrorResponse.ReferenceList.Traveler.Address.AddressLine` (array) Property street address. Used in place of Street and Number. Each element of the array represents an address line. - `ErrorResponse.ReferenceList.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 - `ErrorResponse.ReferenceList.Traveler.Address.County` (string) County or Region Name. Example: Berkshire - `ErrorResponse.ReferenceList.Traveler.Address.StateProv` (object) The standard code or abbreviation for the state, province, or region. May also include full length name. - `ErrorResponse.ReferenceList.Traveler.Address.StateProv.value` (string) State, province, or region code needed to identify location (typically two characters). Example: CA - `ErrorResponse.ReferenceList.Traveler.Address.StateProv.name` (string) State, province, or region name needed to identify location. Example: California - `ErrorResponse.ReferenceList.Traveler.Address.Country` (object) Contains the information needed to identify a country. - `ErrorResponse.ReferenceList.Traveler.Address.Country.value` (string) The ISO 3166 code for the property's address. Example: US - `ErrorResponse.ReferenceList.Traveler.Address.Country.id` (string) Custom user-assigned identifier for the country. Example: 23 - `ErrorResponse.ReferenceList.Traveler.Address.Country.name` (string) The full name of the country for the property's address. Example: United States - `ErrorResponse.ReferenceList.Traveler.Address.Country.codeContext` (string) The source of a code, such as the organization that provided the id number Example: IATA - `ErrorResponse.ReferenceList.Traveler.Address.PostalCode` (string) Postal code for the address. Example: Sl6 1AB - `ErrorResponse.ReferenceList.Traveler.Address.Addressee` (string) The name of the company or person to be addressed Example: ACME INC - `ErrorResponse.ReferenceList.Traveler.Address.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" - `ErrorResponse.ReferenceList.Traveler.Address.addressType` (string) OTA code for address type Example: CLT - `ErrorResponse.ReferenceList.Traveler.Address.use` (string) OTA code for address use Example: AUT - `ErrorResponse.ReferenceList.Traveler.Address.Comment` (object) Textual information. - `ErrorResponse.ReferenceList.Traveler.Address.Comment.value` (string) Actual text. May be restricted based on the type of comment. Ex: - Notepad remarks: limited to 87 characters. - Traveler name remarks: limited to 33 characters, only spaces and hyphens allowed for special characters. Example: Additional comments - `ErrorResponse.ReferenceList.Traveler.Address.Comment.id` (string) Local identifier within a given message for this object. Example: comment_1 - `ErrorResponse.ReferenceList.Traveler.Address.Comment.name` (string) Title of comment or type of remark. Example: Comment name - `ErrorResponse.ReferenceList.Traveler.Address.Comment.language` (string) Language code using ISO-639 standard Example: EN - `ErrorResponse.ReferenceList.Traveler.Address.Priority` (integer) The priority ranking within the group Example: 1 - `ErrorResponse.ReferenceList.Traveler.Address.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. Example: false - `ErrorResponse.ReferenceList.Traveler.Address.provisionedInd` (boolean) If true, this address came into the system through provisioning Example: false - `ErrorResponse.ReferenceList.Traveler.Telephone` (array) - `ErrorResponse.ReferenceList.Traveler.Telephone.@type` (string, required) Discriminator classes Telephone or TelephoneDetail Enum: "TelephoneDetail" - `ErrorResponse.ReferenceList.Traveler.Telephone.countryAccessCode` (string) Phone country code Example: 1 - `ErrorResponse.ReferenceList.Traveler.Telephone.areaCityCode` (string) Phone local area code Example: 972 - `ErrorResponse.ReferenceList.Traveler.Telephone.phoneNumber` (string, required) Mobile/Telephone Number. Accepted characters are numeric, dash, space, and period. Example: 972-000-787 - `ErrorResponse.ReferenceList.Traveler.Telephone.extension` (string) Telephone extension number Example: 234 - `ErrorResponse.ReferenceList.Traveler.Telephone.id` (string) Optional custom user-assigned identifier for a phone number. Example: 3 - `ErrorResponse.ReferenceList.Traveler.Telephone.cityCode` (string) IATA city code if referenced by phone number. Example: DEN - `ErrorResponse.ReferenceList.Traveler.Telephone.role` (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" - `ErrorResponse.ReferenceList.Traveler.Telephone.phoneLocationType` (string) Location of the phone Example: Agency - `ErrorResponse.ReferenceList.Traveler.Telephone.phoneTechType` (string) Indicates the type of technology associated with the telephone number Example: Voice - `ErrorResponse.ReferenceList.Traveler.Telephone.phoneUseType` (string) Agency code for how phone is used (e.g., Home, Business, Emergency Contact, Travel Arranger, Day, Evening). Example: Home - `ErrorResponse.ReferenceList.Traveler.Telephone.pin` (string) Additional codes used for telephone Example: 3456 - `ErrorResponse.ReferenceList.Traveler.Telephone.priority` (integer) Priority Example: 1 - `ErrorResponse.ReferenceList.Traveler.Telephone.defaultInd` (boolean) When true, indicates a default value should be used. Example: true - `ErrorResponse.ReferenceList.Traveler.Telephone.provisionedInd` (boolean) true indicates this phone number was created through provisioned Example: false - `ErrorResponse.ReferenceList.Traveler.Email` (array) For a reservation Retrieve response, all email addresses are associated with the first traveler on the reservation for GDS. NDC supports contact information for each traveler on the reservation. - `ErrorResponse.ReferenceList.Traveler.Email.value` (string) The email address. Example: exampledomain@example.com - `ErrorResponse.ReferenceList.Traveler.Email.id` (string) Electronic email addresses, in IETF specified format. Example: email_1 - `ErrorResponse.ReferenceList.Traveler.Email.emailType` (string) Use email type to specify if the email is to be sent "TO" or sent "FROM" Example: FROM - `ErrorResponse.ReferenceList.Traveler.Email.comment` (string) Any freeform note for the email, such as its purpose. Example: work email - `ErrorResponse.ReferenceList.Traveler.Email.preferredFormat` (string) Mime media type Example: text/html - `ErrorResponse.ReferenceList.Traveler.Email.optInDate` (string) The datetime of receiving the opt in notice Example: 2026-03-03T11:11:00Z - `ErrorResponse.ReferenceList.Traveler.Email.optOutDate` (string) The datetime the opt out notice was received Example: 2026-03-03T11:11:00Z - `ErrorResponse.ReferenceList.Traveler.Email.validInd` (boolean) If true, this is a valid email address that has been system verified via a successful email transmission. Example: true - `ErrorResponse.ReferenceList.Traveler.Email.provisionedInd` (boolean) If true then the email address came from the provisioning process Example: true - `ErrorResponse.ReferenceList.Traveler.passengerTypeCode` (string) Passenger type code (PTC) for this traveler. Required for all PTCs other than ADT (adult); if not sent defaults to ADT. Some of the common PTCs supported include ADT, INF, INS, CHD, UNN. Private fare PTCs, including INN, JNN, VNN, ITF, JNF, and VFF, may also be supported, subject to airline support. Example: CHD - `ErrorResponse.ReferenceList.Traveler.nationality` (string) Nationality on country code ISO Example: AL - `ErrorResponse.ReferenceList.Traveler.age` (integer) The age of the traveller at the time of travel Example: 13 - `ErrorResponse.ReferenceList.Traveler.CustomerLoyalty` (array) - `ErrorResponse.ReferenceList.Traveler.CustomerLoyalty.value` (string, required) Number on loyalty card. Example: 132456 - `ErrorResponse.ReferenceList.Traveler.CustomerLoyalty.id` (string) Optional Customer Loyalty Id. Not saved Example: Loyalty_1 - `ErrorResponse.ReferenceList.Traveler.CustomerLoyalty.priority` (integer) Optional Numeric Priority Code Example: 2 - `ErrorResponse.ReferenceList.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 - `ErrorResponse.ReferenceList.Traveler.CustomerLoyalty.programName` (string) Supplier's loyalty program name. Example: Frontier-EarlyReturns - `ErrorResponse.ReferenceList.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 - `ErrorResponse.ReferenceList.Traveler.CustomerLoyalty.supplier` (string) Supplier of a loyalty program (typically 2 characters representing the hotel, brand, or airline). Example: UA - `ErrorResponse.ReferenceList.Traveler.CustomerLoyalty.tier` (string) Customer Loyalty tier Example: Silver - `ErrorResponse.ReferenceList.Traveler.CustomerLoyalty.shareWithSupplier` (array) The list of suppliers that the CustomerLoyalty number is shared. Used for cross accrual programs. If valid carrier codes are not sent, the response returns the message NO CROSS ACCRUAL AGREEMENT EXISTS. - `ErrorResponse.ReferenceList.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 - `ErrorResponse.ReferenceList.Traveler.CustomerLoyalty.validatedInd` (boolean) Customer loyalty number has been validated by the supplier Example: true - `ErrorResponse.ReferenceList.Traveler.CustomerLoyalty.prefix` (string) The cardholder name prefix title like Mr, Mrs, Dr Example: Dr - `ErrorResponse.ReferenceList.Traveler.CustomerLoyalty.given` (string) The First Name of the Cardholder Example: John - `ErrorResponse.ReferenceList.Traveler.CustomerLoyalty.middle` (string) Middle Name of the Cardholder Example: Wilkinson - `ErrorResponse.ReferenceList.Traveler.CustomerLoyalty.surname` (string) Last Name of the Cardholder Example: Smith - `ErrorResponse.ReferenceList.Traveler.AlternateContact` (array) - `ErrorResponse.ReferenceList.Traveler.AlternateContact.@type` (string) Example: AlternateContact - `ErrorResponse.ReferenceList.Traveler.AlternateContact.id` (string) - `ErrorResponse.ReferenceList.Traveler.AlternateContact.contactType` (string) Contact type value Example: Relative - `ErrorResponse.ReferenceList.Traveler.AlternateContact.relation` (string) Relation value Example: Mother - `ErrorResponse.ReferenceList.Traveler.AlternateContact.Address` (array) - `ErrorResponse.ReferenceList.Traveler.AlternateContact.Telephone` (array) - `ErrorResponse.ReferenceList.Traveler.AlternateContact.Email` (array) - `ErrorResponse.ReferenceList.Traveler.AlternateContact.emergencyInd` (boolean) This is the contact in case of an emergency Example: true - `ErrorResponse.ReferenceList.Traveler.AlternateContact.defaultInd` (boolean) This is the default contact Example: true - `ErrorResponse.ReferenceList.Traveler.TravelDocument` (array) - `ErrorResponse.ReferenceList.Traveler.TravelDocument.@type` (string, required) Discriminator classes TravelDocument or TravelDocumentDetail Enum: "TravelDocumentDetail" - `ErrorResponse.ReferenceList.Traveler.TravelDocument.docNumber` (string) Travel document number. Example: B37201 - `ErrorResponse.ReferenceList.Traveler.TravelDocument.docType` (string) Supported Travel Document types 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" - `ErrorResponse.ReferenceList.Traveler.TravelDocument.issueDate` (string) Issue date of document. Required for a visa Example: 2002-10-13 - `ErrorResponse.ReferenceList.Traveler.TravelDocument.expireDate` (string) Expiration date of document. Required for a visa. Example: 2002-11-13 - `ErrorResponse.ReferenceList.Traveler.TravelDocument.stateProvCode` (string) State Province Code value Example: 44 - `ErrorResponse.ReferenceList.Traveler.TravelDocument.placeOfIssue` (string) Place of issue value Example: Birmingham - `ErrorResponse.ReferenceList.Traveler.TravelDocument.issueCountry` (string) Issuing country of document; ISO3166 standard format. Example: CA - `ErrorResponse.ReferenceList.Traveler.TravelDocument.birthDate` (string) The date of birth of the document holder in YYYY-MM-DD format. Example: 1995-04-22 - `ErrorResponse.ReferenceList.Traveler.TravelDocument.birthCountry` (string) Country of birth of the document holder in ISO3166 standard format. Example: AR - `ErrorResponse.ReferenceList.Traveler.TravelDocument.birthPlace` (string) Birth place value Example: Ontario - `ErrorResponse.ReferenceList.Traveler.TravelDocument.residence` (string) Residence value Example: 1st section 8th st - `ErrorResponse.ReferenceList.Traveler.TravelDocument.id` (string) Locally referenced id Example: 34 - `ErrorResponse.ReferenceList.Traveler.TravelDocument.Nationality` (string) Birth country as noted on document; specifies a 2 character country code as defined in ISO3166. Example: BR - `ErrorResponse.ReferenceList.Traveler.TravelDocument.IssuedForGeoPoliticalArea` (object) The location code of the geographical location. Codes from Ref Pub - `ErrorResponse.ReferenceList.Traveler.TravelDocument.IssuedForGeoPoliticalArea.value` (string) Example: G - `ErrorResponse.ReferenceList.Traveler.TravelDocument.IssuedForGeoPoliticalArea.level` (string) Represents the type of geopolitical area (country, Continent, State etc) Enum: "World", "Global Area", "Continent Group", "Continent", "Country", "StateProvince", "City", "Airport" - `ErrorResponse.ReferenceList.Traveler.TravelDocument.IssuedForGeoPoliticalArea.id` (string) Optional internally referenced id Example: 2 - `ErrorResponse.ReferenceList.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. In Traveler this is used to send custom freeform traveler name remarks, such as a unique identifier for a given traveler. Not supported for addition/deletion in Traveler Modify. - `ErrorResponse.ReferenceList.Traveler.Comments.@type` (string) Example: Comments - `ErrorResponse.ReferenceList.Traveler.Comments.Comment` (array) - `ErrorResponse.ReferenceList.Traveler.RailDiscountCard` (array) - `ErrorResponse.ReferenceList.Traveler.RailDiscountCard.value` (string) Example: Rail1234546 - `ErrorResponse.ReferenceList.Traveler.RailDiscountCard.supplierCode` (string, required) Code of the Supplier Example: Enco - `ErrorResponse.ReferenceList.Traveler.RailDiscountCard.referenceNumber` (string) ReferenceNumber Example: 134256 - `ErrorResponse.ReferenceList.Traveler.accompaniedByInfantInd` (boolean) Example: true - `ErrorResponse.ReferenceList.Offer` (array) - `ErrorResponse.ReferenceList.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. Enum: "Offer" - `ErrorResponse.ReferenceList.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 - `ErrorResponse.ReferenceList.Offer.offerRef` (string) Used to reference another instance of this object in the same message Example: offer_1 - `ErrorResponse.ReferenceList.Offer.ContentSource` (string) Indicates the owner the offer or document. Enum: "GDS", "NDC", "LCC", "API" - `ErrorResponse.ReferenceList.Offer.parentOfferRef` (string) A reference to the Offer this offer is sold in conjunction with Example: offer_1 - `ErrorResponse.ReferenceList.Offer.offerModifyRef` (string) Reference to the new Offer created as a result of this Offer being subject to a schedule change. - `ErrorResponse.ReferenceList.Offer.Product` (array, required) Lists the flight or flights for one leg of the itinerary. Repeats for additional leg or legs. - `ErrorResponse.ReferenceList.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. Certain types of offers on a booking, such as seats and ancillaries, generally include only the CurrencyCode, Base, and TotalPrice objects. - `ErrorResponse.ReferenceList.Offer.Price.@type` (string, required) Discriminator classes Price or PriceDetail Enum: "PriceDetail" - `ErrorResponse.ReferenceList.Offer.Price.id` (string) Internally referenced id Example: 2 - `ErrorResponse.ReferenceList.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. - `ErrorResponse.ReferenceList.Offer.Price.CurrencyCode.value` (string) An ISO 4217 currency code. Example: USD - `ErrorResponse.ReferenceList.Offer.Price.CurrencyCode.codeAuthority` (string) Currency code authority Example: ISO 4217 - `ErrorResponse.ReferenceList.Offer.Price.CurrencyCode.decimalPlace` (integer) Number of decimal places for the currency. Example: 2 - `ErrorResponse.ReferenceList.Offer.Price.CurrencyCode.decimalAuthority` (string) Currency code decimal authority Example: ISO 4217 - `ErrorResponse.ReferenceList.Offer.Price.Base` (number) Base price before taxes and fees. For Hotel, may not be returned by all suppliers. Example: 20.2 - `ErrorResponse.ReferenceList.Offer.Price.TotalTaxes` (number) Total taxes applied to the base price. For Hotel, may not be returned by all suppliers. Example: 34.4 - `ErrorResponse.ReferenceList.Offer.Price.TotalFees` (number) Total fees included in Total Price. Example: 201 - `ErrorResponse.ReferenceList.Offer.Price.TotalPrice` (number) Total price of this offer including the base price and all taxes and fees. Example: 34 - `ErrorResponse.ReferenceList.Offer.Price.VendorCurrencyTotal` (object) No longer used. Previously used to expose the local vendor currency when it is different to the purchased currency - `ErrorResponse.ReferenceList.Offer.Price.VendorCurrencyTotal.@type` (string) - `ErrorResponse.ReferenceList.Offer.Price.VendorCurrencyTotal.currencySource` (string) The system requesting or returning the currency code specified in the attribute Enum: "Supplier", "Charged", "Requested" - `ErrorResponse.ReferenceList.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 - `ErrorResponse.ReferenceList.Offer.Price.VendorCurrencyTotal.Taxes` (object) Summary of all individual taxes. Child class TaxesDetail provides the breakdown of individual taxes. - `ErrorResponse.ReferenceList.Offer.Price.VendorCurrencyTotal.Taxes.@type` (string, required) Discriminator class is TaxesDetail Enum: "TaxesDetail" - `ErrorResponse.ReferenceList.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 - `ErrorResponse.ReferenceList.Offer.Price.VendorCurrencyTotal.Taxes.TaxInfo` (array) Returned for TripChange APIS only. - `ErrorResponse.ReferenceList.Offer.Price.VendorCurrencyTotal.Taxes.Tax` (array) - `ErrorResponse.ReferenceList.Offer.Price.VendorCurrencyTotal.Taxes.TaxPercent` (object) Returned when the tax is expressed as a percentage of the amount. - `ErrorResponse.ReferenceList.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. - `ErrorResponse.ReferenceList.Offer.Price.VendorCurrencyTotal.Fees.@type` (string, required) Discriminator. Child class FeesDetail Enum: "FeesDetail" - `ErrorResponse.ReferenceList.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: 55 - `ErrorResponse.ReferenceList.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: 25 - `ErrorResponse.ReferenceList.Offer.Price.VendorCurrencyTotal.Fees.Fee` (array) Array of individual fees. - `ErrorResponse.ReferenceList.Offer.Price.VendorCurrencyTotal.Total` (number) Specifies the total price including base + taxes + fees Example: 30.13 - `ErrorResponse.ReferenceList.Offer.Price.VendorCurrencyTotal.approximateInd` (boolean) True if this amount has been converted from the original amount Example: true - `ErrorResponse.ReferenceList.Offer.Price.FlightPassCredits` (integer) Indicates the number of flight pass credits the offer “costs” for all passengers. Air Canada NDC only. Example: 2 - `ErrorResponse.ReferenceList.Offer.Price.PriceBreakdown` (array) - `ErrorResponse.ReferenceList.Offer.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. Enum: "PriceBreakdownAir", "PriceBreakdownAncillary", "PriceBreakdownHospitality", "PriceBreakdownVehiclePrice", "PriceBreakdownVehicleDeposit", "PriceBreakdownVehicleCharges" - `ErrorResponse.ReferenceList.Offer.Price.PriceBreakdown.Amount` (object) Amount represents the cost applied. - `ErrorResponse.ReferenceList.Offer.Price.PriceBreakdown.Commission` (object) 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). - `ErrorResponse.ReferenceList.Offer.TermsAndConditionsFull` (array) For Hotel Rules and Reservation responses, this array will contain a single TermsAndConditionsFullHospitality entry. Cancellation terms with multiple time periods are represented within that entry's CancelPenalty array rather than as multiple TermsAndConditionsFull entries. For Two-Step Commit (FLights), this is a standard object, no changes. For Unified Checkout (Flights), if no payment information was sent in the request, the booking is confirmed by the airline but not yet ticketed. This object provides the payment and ticketing time limits in ExpiryDate and PaymentTimeLimit. - `ErrorResponse.ReferenceList.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. Enum: "TermsAndConditionsFull", "TermsAndConditionsFullSummary" - `ErrorResponse.ReferenceList.Offer.TermsAndConditionsFull.id` (string) Local identifier within a given message for this object. Example: TC_1 - `ErrorResponse.ReferenceList.Offer.TermsAndConditionsFull.termsAndConditionsRef` (string) Used to reference another instance of this object in the same message. Example: TC_1 - `ErrorResponse.ReferenceList.Offer.TermsAndConditionsFull.ExpiryDate` (string) The date and time in UTC the offer will no longer be valid. Example: 2022-08-07T12:12:00Z - `ErrorResponse.ReferenceList.Offer.TermsAndConditionsFull.CustomerLoyalty` (array) - `ErrorResponse.ReferenceList.Offer.TermsAndConditionsFull.TextBlock` (array) A list of free text terms and conditions. - `ErrorResponse.ReferenceList.Offer.TermsAndConditionsFull.ExpiryDate` (string) The data and time the offer will expire Example: 2022-08-07T12:12:00Z - `ErrorResponse.ReferenceList.Offer.TermsAndConditionsFull.TextBlock` (array) - `ErrorResponse.ReferenceList.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 - `ErrorResponse.ReferenceList.Offer.scheduleChangeInd` (boolean) - If true: this Offer is subject to a schedule change. May be seen in a Two-step Commit, on the first Commit response payload, in the event of a schedule change. If this is the case, the Product object returns previous and updated schedule details in two instances of Product/FlightSegment as follows: - The previous flight segment is identified with sequence=1 and Flight/id=flight_1 - The updated flight segment is identified with sequence=2 and Flight/id=flight_2 Offer includes a ModifyPrice object; however, unless a price change has also occurred, Offer/Price repeats the original price of the offer and Offer/ModifyPrice returns all amounts as zero (0) to indicate there is no price change. NDC only - for Reservation Retrieve, when an airline-initiated flight change has occurred, the response also returns the Offer object with @type OfferModify and scheduleChangeInd=true to indicate a change has occurred. See [NDC Flight Disruption Handing](https://developer.travelport.com/docs/flights/guides/booking-and-reservations/flights-booking-guide#ndc-flight-disruption-handling-involuntary-changes) in the Air Booking Guide for details. - `ErrorResponse.ReferenceList.Brand` (array) Each instance provides details for one BrandRef id. - `ErrorResponse.ReferenceList.Brand.@type` (string, required) Discriminator. Child classes BrandID and Brand. BrandCompleteInfo is no longer in use. Enum: "Brand" - `ErrorResponse.ReferenceList.Brand.id` (string) Local id within a given message to support referencing this object. Example: brand_001 - `ErrorResponse.ReferenceList.Brand.BrandRef` (string) Reference id that corresponds to the brand 'id' in ReferenceListBrand.Brand. Example: brandRef_001 - `ErrorResponse.ReferenceList.Brand.name` (string, required) Brand name from the supplier. Example: Main Cabin Extra - `ErrorResponse.ReferenceList.Brand.tier` (integer) The brand tier. Not returned for NDC. Example: 2 - `ErrorResponse.ReferenceList.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] - `ErrorResponse.ReferenceList.Brand.code` (string) The ATPCO Brand Code. Example: REFMAIN - `ErrorResponse.ReferenceList.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. - `ErrorResponse.ReferenceList.Brand.BrandAttribute.@type` (string, required) Discriminator. No child classes. Example: BrandAttribute - `ErrorResponse.ReferenceList.Brand.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" - `ErrorResponse.ReferenceList.Brand.BrandAttribute.inclusion` (string, required) The indicator as to how the brand and the product are associated. Enum: "Included", "Chargeable", "Not Offered" - `ErrorResponse.ReferenceList.Brand.BrandAttribute.ImageURL` (array) URL for an image for the brand, when available. Example: ["http:/imageurl.com"] - `ErrorResponse.ReferenceList.Brand.BrandAttribute.matchedAttributeInd` (boolean) Returned only if true for any attribute requested in ProductInclusionPreference.Classification. Example: true - `ErrorResponse.ReferenceList.Brand.BrandAttribute.groupCode` (string) Carrier group code. Returned if filed by the carrier. Example: BG - `ErrorResponse.ReferenceList.Brand.BrandAttribute.subGroupCode` (string) Carrier sub group code. Returned if filed by the carrier. Example: CY - `ErrorResponse.ReferenceList.Brand.BrandAttribute.subCode` (string) Carrier sub code. Returned if filed by the carrier. Example: 08A - `ErrorResponse.ReferenceList.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. - `ErrorResponse.ReferenceList.Brand.AdditionalBrandAttribute.@type` (string, required) Discriminator. No child classes. Example: AdditionalBrandAttribute - `ErrorResponse.ReferenceList.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 - `ErrorResponse.ReferenceList.Brand.AdditionalBrandAttribute.ImageURL` (array) URL for an image for the brand, when available. Example: ["https:/travelport/image/profile/firstviewimage"] - `ErrorResponse.ReferenceList.Brand.AdditionalBrandAttribute.matchedAttributeInd` (boolean) Returned only if true for any attribute requested in ProductInclusionPreference.Classification. Example: true - `ErrorResponse.ReferenceList.Brand.AdditionalBrandAttribute.groupCode` (string) Carrier group code. Returned if filed by the carrier. Example: BG - `ErrorResponse.ReferenceList.Brand.AdditionalBrandAttribute.subGroupCode` (string) Carrier sub group code. Returned if filed by the carrier. Example: CY - `ErrorResponse.ReferenceList.Brand.AdditionalBrandAttribute.subCode` (string) Carrier sub code. Returned if filed by the carrier. Example: 08A - `ErrorResponse.ReferenceList.Brand.ImageURL` (array) Example: ["http:/imageurl.com"] - `ErrorResponse.ReferenceList.TermsAndConditions` (array) - `ErrorResponse.ReferenceList.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. Enum: "TermsAndConditions" - `ErrorResponse.ReferenceList.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 - `ErrorResponse.ReferenceList.TermsAndConditions.termsAndConditionsRef` (string) Reference id that corresponds to the TermsAndConditions 'id' in ReferenceListTermsAndConditions.TermsAndConditions. Example: TC_1 - `ErrorResponse.ReferenceList.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 - `ErrorResponse.ReferenceList.TermsAndConditions.CustomerLoyalty` (array) - `ErrorResponse.ReferenceList.Price` (array, required) - `ErrorResponse.CurrencyRateConversion` (array) - `ErrorResponse.CurrencyRateConversion.@type` (string) - `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 ## Response 401: - `401` (unknown) Unauthorized - 401 ## Response 401 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 flows. Example: 49f58f5f-c443-43b4-9f5d-be405fd00a01 - `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. See [Error Messaging](https://developer.travelport.com/docs/flights/general/error-messaging) for additional details. - `ErrorResponse.Result.@type` (string) Discriminator class Result only Example: Result - `ErrorResponse.Result.status` (string) The status of an error or warning Enum: "Not processed", "Incomplete", "Complete", "Unknown" - `ErrorResponse.Result.Error` (array) A list of error information returned at the provider level for a response. - `ErrorResponse.Result.Error.@type` (string, required) Discriminator classes Error or ErrorDetail Enum: "ErrorDetail" - `ErrorResponse.Result.Error.StatusCode` (integer) Http standard response code Example: 200 - `ErrorResponse.Result.Error.Message` (string) The Travelport standardized error or warning message Example: No flights found. - `ErrorResponse.Result.Error.NameValuePair` (array) - `ErrorResponse.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 - `ErrorResponse.Result.Error.NameValuePair.id` (string) Optional internally referenced id Example: 6 - `ErrorResponse.Result.Error.NameValuePair.name` (string, required) Key, categorizing the type of remark or error. Example: Day1 - `ErrorResponse.Result.Error.category` (string) A category to assist in identifying the error Example: VALIDATION - `ErrorResponse.Result.Error.SourceID` (string) The identifier of the source system sending the error or warning Example: 1G - `ErrorResponse.Result.Error.SourceCode` (string) The error or warning code returned by the source airline or host system Example: 1234 - `ErrorResponse.Result.Error.SourceDescription` (string) The error or warning message as it is returned by the source airline or host system - `ErrorResponse.Result.Warning` (array) A list of warning information returned at the provider level for a response. - `ErrorResponse.Result.Warning.@type` (string, required) Discriminator classes Warning or WarningDetail Enum: "WarningDetail" - `ErrorResponse.Result.Warning.StatusCode` (integer) Http standard response code Example: 200 - `ErrorResponse.Result.Warning.Message` (string) The Travelport standardized error or warning message Example: Customer Loyalty could not be applied. - `ErrorResponse.Result.Warning.NameValuePair` (array) - `ErrorResponse.Result.Warning.category` (string) A category to assist in identifying the error Example: INFORMATION - `ErrorResponse.Result.Warning.SourceID` (string) The identifier of the source system sending the error or warning Example: 1G - `ErrorResponse.Result.Warning.SourceCode` (string) The error or warning code returned by the source airline or host system Example: 1234 - `ErrorResponse.Result.Warning.SourceDescription` (string) The error or warning message as it is returned by the source airline or host system - `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.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 system generated 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'. - If not available, for Payment, any unique identifier can be sent. 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 - `ErrorResponse.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 - `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 Example: www.travelport.com - `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) - `ErrorResponse.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. Enum: "ReferenceListSeatingChart", "ReferenceListFlight", "ReferenceListAmenity", "ReferenceListProduct", "ReferenceListTraveler", "ReferenceListOffer", "ReferenceListBrand", "ReferenceListTermsAndConditions", "ReferenceListExchangedPrice" - `ErrorResponse.ReferenceList.id` (string) Uniquely identifies for the Reference List Example: referenceList_001 - `ErrorResponse.ReferenceList.SeatingChart` (array) - `ErrorResponse.ReferenceList.SeatingChart.@type` (string, required) Discriminator. Enum: "SeatingChart" - `ErrorResponse.ReferenceList.SeatingChart.id` (string) Internally reference id - `ErrorResponse.ReferenceList.SeatingChart.Cabin` (array, required) - `ErrorResponse.ReferenceList.SeatingChart.Cabin.@type` (string) Example: Cabin - `ErrorResponse.ReferenceList.SeatingChart.Cabin.name` (string, required) The name of the cabin Example: Economy - `ErrorResponse.ReferenceList.SeatingChart.Cabin.Layout` (array, required) - `ErrorResponse.ReferenceList.SeatingChart.Cabin.Layout.value` (string) - `ErrorResponse.ReferenceList.SeatingChart.Cabin.Layout.position` (array, required) - `ErrorResponse.ReferenceList.SeatingChart.Cabin.Layout.startRow` (integer, required) Start row for this Cabin Layout - `ErrorResponse.ReferenceList.SeatingChart.Cabin.Layout.endRow` (integer, required) End row for this Cabin Layout - `ErrorResponse.ReferenceList.SeatingChart.Cabin.Row` (array, required) - `ErrorResponse.ReferenceList.SeatingChart.Cabin.Row.@type` (string) Example: Row - `ErrorResponse.ReferenceList.SeatingChart.Cabin.Row.label` (string) The identifier for the row Example: 78 - `ErrorResponse.ReferenceList.SeatingChart.Cabin.Row.Space` (array, required) - `ErrorResponse.ReferenceList.SeatingChart.Cabin.Row.Characteristic` (array) - `ErrorResponse.ReferenceList.Flight` (array, required) - `ErrorResponse.ReferenceList.Flight.@type` (string, required) Discriminator. Child classes Flight and FlightDetail. Enum: "Flight" - `ErrorResponse.ReferenceList.Flight.id` (string) Local id within a given message to support referencing this object - an internal flight identifier. Example: 126 - `ErrorResponse.ReferenceList.Flight.FlightRef` (string) Reference id that corresponds to the flight 'id' in ReferenceListFlight.Flight. Example: s1 - `ErrorResponse.ReferenceList.Flight.distance` (integer) Distance covered by the flight. Example: 6574 - `ErrorResponse.ReferenceList.Flight.stops` (integer) Number of stops Example: 2 - `ErrorResponse.ReferenceList.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 - `ErrorResponse.ReferenceList.Flight.carrier` (string, required) The airline code. Example: BA - `ErrorResponse.ReferenceList.Flight.number` (string, required) The marketing carrier flight number. Example: 98 - `ErrorResponse.ReferenceList.Flight.operatingCarrier` (string) The operating airline IATA code. Shown in codeshare situations when the operating carrier is different to the marketing carrier. Example: BA - `ErrorResponse.ReferenceList.Flight.operatingCarrierName` (string) Name of the marketing operating carrier. Example: Liberty Aerospace - `ErrorResponse.ReferenceList.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 - `ErrorResponse.ReferenceList.Flight.equipment` (string) Equipment model. Note that TRN, TRS, and BUS equipment codes indicate ground transportation. Example: 777 - `ErrorResponse.ReferenceList.Flight.Departure` (object, required) Departure details for a given leg. - `ErrorResponse.ReferenceList.Flight.Departure.@type` (string, required) Discriminator classes Departure or DepartureDetail Enum: "DepartureDetail" - `ErrorResponse.ReferenceList.Flight.Departure.location` (string, required) IATA code for departure airport or city for this leg of the itinerary. Example: AMS - `ErrorResponse.ReferenceList.Flight.Departure.date` (string, required) Departure date in YYYY-MM-DD format. Example: 0011-10-17 - `ErrorResponse.ReferenceList.Flight.Departure.time` (string, required) Departure date in HH:mm:ss (24-hour format). Example: 04:45:00 - `ErrorResponse.ReferenceList.Flight.Departure.terminal` (string) Departure terminal, returned when available. Example: Terminal 1 - `ErrorResponse.ReferenceList.Flight.Departure.country` (string) Country of to departure or arrival Example: US - `ErrorResponse.ReferenceList.Flight.Arrival` (object, required) Arrival information. - `ErrorResponse.ReferenceList.Flight.Arrival.@type` (string, required) Discriminator classes Arrival or ArrivalDetail Enum: "ArrivalDetail" - `ErrorResponse.ReferenceList.Flight.Arrival.location` (string, required) IATA code for arrival airport or city for this leg of the itinerary. Example: MAD - `ErrorResponse.ReferenceList.Flight.Arrival.date` (string, required) Arrival date in YYYY-MM-DD format. Example: 0011-10-17 - `ErrorResponse.ReferenceList.Flight.Arrival.time` (string) Arrival date in HH:mm:ss (24-hour format). Example: 04:45:00 - `ErrorResponse.ReferenceList.Flight.Arrival.terminal` (string) Arrival terminal, returned when available. Example: Terminal 1 - `ErrorResponse.ReferenceList.Flight.Arrival.country` (string) Country of to departure or arrival Example: US - `ErrorResponse.ReferenceList.Flight.IntermediateStop` (array) GDS only; not supported for NDC. Returned if the flight has a technical stop but does not incur a change in flight number. - `ErrorResponse.ReferenceList.Flight.IntermediateStop.value` (string) The IATA airport code for the airport where the intermediate stop occurs. - `ErrorResponse.ReferenceList.Flight.IntermediateStop.arrivalFlightDuration` (string) Duration in hours and minutes of the flight arriving at the intermediate stop. ISO 8601 format Example: PT2H35M - `ErrorResponse.ReferenceList.Flight.IntermediateStop.departureFlightDuration` (string) Duration in hours and minutes of the flight departing the intermediate stop. ISO 8601 format Example: PT1H35M - `ErrorResponse.ReferenceList.Flight.IntermediateStop.duration` (string) Duration in hours and minutes between the arrival and departure at the intermediate stop. ISO 8601 format Example: PT1H35M - `ErrorResponse.ReferenceList.Flight.IntermediateStop.equipment` (string) Equipment model, if there is a change of equipment during the stop. Example: 777 - `ErrorResponse.ReferenceList.Flight.IntermediateStop.arrivalDate` (string) The local date the aircraft arrives at the intermediate stop Example: 2026-04-30 - `ErrorResponse.ReferenceList.Flight.IntermediateStop.departureDate` (string) The local date the aircraft departs from the intermediate stop Example: 2026-04-30 - `ErrorResponse.ReferenceList.Flight.IntermediateStop.arrivalTime` (string) The local time the aircraft arrives at the intermediate stop Example: 68400 - `ErrorResponse.ReferenceList.Flight.IntermediateStop.departurelTime` (string) The local time the aircraft departs from the intermediate stop Example: 72000 - `ErrorResponse.ReferenceList.Flight.IntermediateStop.arrivalTerminal` (string) Arrival terminal of the intermediate stop airport Example: Terminal2 - `ErrorResponse.ReferenceList.Flight.IntermediateStop.departureTerminal` (string) Departure terminal of the intermediate stop airport Example: Terminal4 - `ErrorResponse.ReferenceList.Flight.subjectToGovernmentApprovalInd` (boolean) GDS only, not supported for NDC. - If true: the airline has filed in its schedule that availability for a specific flight is subject to government approval. Returned only in the Air Search API response. Example: true - `ErrorResponse.ReferenceList.Amenity` (array, required) One instance for each specific amenity. - `ErrorResponse.ReferenceList.Amenity.@type` (string, required) Discriminator. No child classes. Example: Amenity - `ErrorResponse.ReferenceList.Amenity.id` (string, required) A unique Travelport-assigned amenity id used for cross-referencing by each flight with this amenity. Example: amenity_001 - `ErrorResponse.ReferenceList.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 - `ErrorResponse.ReferenceList.Amenity.Text` (object) A free text description of the amenity. - `ErrorResponse.ReferenceList.Amenity.Text.value` (string) A short free text description. - `ErrorResponse.ReferenceList.Amenity.Text.language` (string) The language the text is provided in. ISO639 format. Example: EN - `ErrorResponse.ReferenceList.Product` (array) - `ErrorResponse.ReferenceList.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. Enum: "Product" - `ErrorResponse.ReferenceList.Product.id` (string) Local id within a given message to support referencing this object. Example: product_1 - `ErrorResponse.ReferenceList.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 - `ErrorResponse.ReferenceList.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 - `ErrorResponse.ReferenceList.Traveler` (array) - `ErrorResponse.ReferenceList.Traveler.@type` (string, required) Discriminator classes TravelerID or Traveler Enum: "Traveler" - `ErrorResponse.ReferenceList.Traveler.id` (string) Send value of travelerRefId_1 for the first traveler, then increment for each additional traveler (e.g., travelerRefId_2). Traveler/id is only mandatory when referenced elsewhere in the request, such as in SpecialService and PrimaryContact (TravelerIdentifier/Identifier/value). - `ErrorResponse.ReferenceList.Traveler.TravelerRef` (string) - `ErrorResponse.ReferenceList.Traveler.birthDate` (string) Date of birth in YYYY-MM-DD format. The TripServices APIs require this object only for infant and child PTC types (e.g., INF, INS, CHD, UNN). When sending [minimum secure flight information](https://developer.travelport.com/docs/flights/guides/booking-and-reservations/remarks-and-service-requests#minimum-secure-flight-information-ssr-docs), which is required by some carriers, this object is required for all PTCs. Example: 2021-06-05 - `ErrorResponse.ReferenceList.Traveler.gender` (string) Gender Type Male, Female etc. When sending [minimum secure flight information](https://developer.travelport.com/docs/flights/guides/booking-and-reservations/remarks-and-service-requests#minimum-secure-flight-information-ssr-docs) in the Traveler object, which is required by some carriers, this object is required for all PTCs. This field is not used by Hotel APIs and will be ignored. Enum: "Male", "Female", "Unknown", "Undisclosed" - `ErrorResponse.ReferenceList.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. - `ErrorResponse.ReferenceList.Traveler.PersonName.@type` (string, required) Discriminator classes PersonName or PersonNameDetail Enum: "PersonNameDetail" - `ErrorResponse.ReferenceList.Traveler.PersonName.Prefix` (string) Salutation of honorific (e.g. Mr., Mrs., Ms., Miss, Dr.) Example: Mr - `ErrorResponse.ReferenceList.Traveler.PersonName.Given` (string) Traveler first or given name. Example: John - `ErrorResponse.ReferenceList.Traveler.PersonName.Middle` (string) Traveler middle name. Example: Erick - `ErrorResponse.ReferenceList.Traveler.PersonName.Surname` (string, required) Traveler last name or surname. Example: Smith - `ErrorResponse.ReferenceList.Traveler.PersonName.personNameType` (string) OTA Code Enum: "Former", "Nickname", "Alternate", "Maiden" - `ErrorResponse.ReferenceList.Traveler.PersonName.language` (string) 'ISO639 code of the language the name is represented Example: EN - `ErrorResponse.ReferenceList.Traveler.PersonName.SurnamePrefix` (string) The surname prefix Example: Von - `ErrorResponse.ReferenceList.Traveler.PersonName.Suffix` (string) Traveler name suffix such as Jr. or Sr. Example: Jr. - `ErrorResponse.ReferenceList.Traveler.PersonName.Title` (string) Degree or honors Example: DR - `ErrorResponse.ReferenceList.Traveler.PersonName.Privacy` (object) Confidential details for marketing purpose - `ErrorResponse.ReferenceList.Traveler.PersonName.Privacy.id` (string) Optional internally referenced id Example: 2 - `ErrorResponse.ReferenceList.Traveler.PersonName.Privacy.shareMarketing` (string) Used to indicate marketing preferences, Yes, No, Inherit Enum: "Yes", "No", "Inherit" - `ErrorResponse.ReferenceList.Traveler.PersonName.Privacy.optInStatus` (string) Used to indicate marketing preferences, OptIn, OptOut Enum: "OptedIn", "OptedOut", "Unknown" - `ErrorResponse.ReferenceList.Traveler.PersonName.Privacy.optInDate` (string) The datetime of receiving the opt in notice Example: 2026-08-07T12:12:00Z - `ErrorResponse.ReferenceList.Traveler.PersonName.Privacy.optOutDate` (string) The datetime the opt out notice was received Example: 2026-08-07T12:12:00Z - `ErrorResponse.ReferenceList.Traveler.PersonName.defaultInd` (boolean) If true, this is the default or primary name within a collection of names. Example: true - `ErrorResponse.ReferenceList.Traveler.Address` (array) - `ErrorResponse.ReferenceList.Traveler.Address.@type` (string, required) Discriminator classes Address or AddressDetail Enum: "AddressDetail", "PropertyAddress" - `ErrorResponse.ReferenceList.Traveler.Address.id` (string) unique address id Example: Address_1 - `ErrorResponse.ReferenceList.Traveler.Address.BldgRoom` (object) Address with building and room number - `ErrorResponse.ReferenceList.Traveler.Address.BldgRoom.value` (string) Example: Moore House - `ErrorResponse.ReferenceList.Traveler.Address.BldgRoom.buldingInd` (boolean) When true, the information is a building name. When false, it is an apartment or room # Example: true - `ErrorResponse.ReferenceList.Traveler.Address.Number` (object) The street number alone is the numerical number that precedes the street name in the address. - `ErrorResponse.ReferenceList.Traveler.Address.Number.value` (string) Street number value. Example: 23B - `ErrorResponse.ReferenceList.Traveler.Address.Number.streetNmbrSuffix` (string) Street Number Suffix Example: B - `ErrorResponse.ReferenceList.Traveler.Address.Number.streetDirection` (string) Direction of the Street Example: NW - `ErrorResponse.ReferenceList.Traveler.Address.Number.ruralRouteNmbr` (string) RuralRoute Number Example: 76 - `ErrorResponse.ReferenceList.Traveler.Address.Number.po_Box` (string) PO Box Number Example: 1001 - `ErrorResponse.ReferenceList.Traveler.Address.Street` (string) Street name. May also contain the street number when the Number element is missing. Example: ABC Street - `ErrorResponse.ReferenceList.Traveler.Address.AddressLine` (array) Property street address. Used in place of Street and Number. Each element of the array represents an address line. - `ErrorResponse.ReferenceList.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 - `ErrorResponse.ReferenceList.Traveler.Address.County` (string) County or Region Name. Example: Berkshire - `ErrorResponse.ReferenceList.Traveler.Address.StateProv` (object) The standard code or abbreviation for the state, province, or region. May also include full length name. - `ErrorResponse.ReferenceList.Traveler.Address.StateProv.value` (string) State, province, or region code needed to identify location (typically two characters). Example: CA - `ErrorResponse.ReferenceList.Traveler.Address.StateProv.name` (string) State, province, or region name needed to identify location. Example: California - `ErrorResponse.ReferenceList.Traveler.Address.Country` (object) Contains the information needed to identify a country. - `ErrorResponse.ReferenceList.Traveler.Address.Country.value` (string) The ISO 3166 code for the property's address. Example: US - `ErrorResponse.ReferenceList.Traveler.Address.Country.id` (string) Custom user-assigned identifier for the country. Example: 23 - `ErrorResponse.ReferenceList.Traveler.Address.Country.name` (string) The full name of the country for the property's address. Example: United States - `ErrorResponse.ReferenceList.Traveler.Address.Country.codeContext` (string) The source of a code, such as the organization that provided the id number Example: IATA - `ErrorResponse.ReferenceList.Traveler.Address.PostalCode` (string) Postal code for the address. Example: Sl6 1AB - `ErrorResponse.ReferenceList.Traveler.Address.Addressee` (string) The name of the company or person to be addressed Example: ACME INC - `ErrorResponse.ReferenceList.Traveler.Address.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" - `ErrorResponse.ReferenceList.Traveler.Address.addressType` (string) OTA code for address type Example: CLT - `ErrorResponse.ReferenceList.Traveler.Address.use` (string) OTA code for address use Example: AUT - `ErrorResponse.ReferenceList.Traveler.Address.Comment` (object) Textual information. - `ErrorResponse.ReferenceList.Traveler.Address.Comment.value` (string) Actual text. May be restricted based on the type of comment. Ex: - Notepad remarks: limited to 87 characters. - Traveler name remarks: limited to 33 characters, only spaces and hyphens allowed for special characters. Example: Additional comments - `ErrorResponse.ReferenceList.Traveler.Address.Comment.id` (string) Local identifier within a given message for this object. Example: comment_1 - `ErrorResponse.ReferenceList.Traveler.Address.Comment.name` (string) Title of comment or type of remark. Example: Comment name - `ErrorResponse.ReferenceList.Traveler.Address.Comment.language` (string) Language code using ISO-639 standard Example: EN - `ErrorResponse.ReferenceList.Traveler.Address.Priority` (integer) The priority ranking within the group Example: 1 - `ErrorResponse.ReferenceList.Traveler.Address.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. Example: false - `ErrorResponse.ReferenceList.Traveler.Address.provisionedInd` (boolean) If true, this address came into the system through provisioning Example: false - `ErrorResponse.ReferenceList.Traveler.Telephone` (array) - `ErrorResponse.ReferenceList.Traveler.Telephone.@type` (string, required) Discriminator classes Telephone or TelephoneDetail Enum: "TelephoneDetail" - `ErrorResponse.ReferenceList.Traveler.Telephone.countryAccessCode` (string) Phone country code Example: 1 - `ErrorResponse.ReferenceList.Traveler.Telephone.areaCityCode` (string) Phone local area code Example: 972 - `ErrorResponse.ReferenceList.Traveler.Telephone.phoneNumber` (string, required) Mobile/Telephone Number. Accepted characters are numeric, dash, space, and period. Example: 972-000-787 - `ErrorResponse.ReferenceList.Traveler.Telephone.extension` (string) Telephone extension number Example: 234 - `ErrorResponse.ReferenceList.Traveler.Telephone.id` (string) Optional custom user-assigned identifier for a phone number. Example: 3 - `ErrorResponse.ReferenceList.Traveler.Telephone.cityCode` (string) IATA city code if referenced by phone number. Example: DEN - `ErrorResponse.ReferenceList.Traveler.Telephone.role` (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" - `ErrorResponse.ReferenceList.Traveler.Telephone.phoneLocationType` (string) Location of the phone Example: Agency - `ErrorResponse.ReferenceList.Traveler.Telephone.phoneTechType` (string) Indicates the type of technology associated with the telephone number Example: Voice - `ErrorResponse.ReferenceList.Traveler.Telephone.phoneUseType` (string) Agency code for how phone is used (e.g., Home, Business, Emergency Contact, Travel Arranger, Day, Evening). Example: Home - `ErrorResponse.ReferenceList.Traveler.Telephone.pin` (string) Additional codes used for telephone Example: 3456 - `ErrorResponse.ReferenceList.Traveler.Telephone.priority` (integer) Priority Example: 1 - `ErrorResponse.ReferenceList.Traveler.Telephone.defaultInd` (boolean) When true, indicates a default value should be used. Example: true - `ErrorResponse.ReferenceList.Traveler.Telephone.provisionedInd` (boolean) true indicates this phone number was created through provisioned Example: false - `ErrorResponse.ReferenceList.Traveler.Email` (array) For a reservation Retrieve response, all email addresses are associated with the first traveler on the reservation for GDS. NDC supports contact information for each traveler on the reservation. - `ErrorResponse.ReferenceList.Traveler.Email.value` (string) The email address. Example: exampledomain@example.com - `ErrorResponse.ReferenceList.Traveler.Email.id` (string) Electronic email addresses, in IETF specified format. Example: email_1 - `ErrorResponse.ReferenceList.Traveler.Email.emailType` (string) Use email type to specify if the email is to be sent "TO" or sent "FROM" Example: FROM - `ErrorResponse.ReferenceList.Traveler.Email.comment` (string) Any freeform note for the email, such as its purpose. Example: work email - `ErrorResponse.ReferenceList.Traveler.Email.preferredFormat` (string) Mime media type Example: text/html - `ErrorResponse.ReferenceList.Traveler.Email.optInDate` (string) The datetime of receiving the opt in notice Example: 2026-03-03T11:11:00Z - `ErrorResponse.ReferenceList.Traveler.Email.optOutDate` (string) The datetime the opt out notice was received Example: 2026-03-03T11:11:00Z - `ErrorResponse.ReferenceList.Traveler.Email.validInd` (boolean) If true, this is a valid email address that has been system verified via a successful email transmission. Example: true - `ErrorResponse.ReferenceList.Traveler.Email.provisionedInd` (boolean) If true then the email address came from the provisioning process Example: true - `ErrorResponse.ReferenceList.Traveler.passengerTypeCode` (string) Passenger type code (PTC) for this traveler. Required for all PTCs other than ADT (adult); if not sent defaults to ADT. Some of the common PTCs supported include ADT, INF, INS, CHD, UNN. Private fare PTCs, including INN, JNN, VNN, ITF, JNF, and VFF, may also be supported, subject to airline support. Example: CHD - `ErrorResponse.ReferenceList.Traveler.nationality` (string) Nationality on country code ISO Example: AL - `ErrorResponse.ReferenceList.Traveler.age` (integer) The age of the traveller at the time of travel Example: 13 - `ErrorResponse.ReferenceList.Traveler.CustomerLoyalty` (array) - `ErrorResponse.ReferenceList.Traveler.CustomerLoyalty.value` (string, required) Number on loyalty card. Example: 132456 - `ErrorResponse.ReferenceList.Traveler.CustomerLoyalty.id` (string) Optional Customer Loyalty Id. Not saved Example: Loyalty_1 - `ErrorResponse.ReferenceList.Traveler.CustomerLoyalty.priority` (integer) Optional Numeric Priority Code Example: 2 - `ErrorResponse.ReferenceList.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 - `ErrorResponse.ReferenceList.Traveler.CustomerLoyalty.programName` (string) Supplier's loyalty program name. Example: Frontier-EarlyReturns - `ErrorResponse.ReferenceList.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 - `ErrorResponse.ReferenceList.Traveler.CustomerLoyalty.supplier` (string) Supplier of a loyalty program (typically 2 characters representing the hotel, brand, or airline). Example: UA - `ErrorResponse.ReferenceList.Traveler.CustomerLoyalty.tier` (string) Customer Loyalty tier Example: Silver - `ErrorResponse.ReferenceList.Traveler.CustomerLoyalty.shareWithSupplier` (array) The list of suppliers that the CustomerLoyalty number is shared. Used for cross accrual programs. If valid carrier codes are not sent, the response returns the message NO CROSS ACCRUAL AGREEMENT EXISTS. - `ErrorResponse.ReferenceList.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 - `ErrorResponse.ReferenceList.Traveler.CustomerLoyalty.validatedInd` (boolean) Customer loyalty number has been validated by the supplier Example: true - `ErrorResponse.ReferenceList.Traveler.CustomerLoyalty.prefix` (string) The cardholder name prefix title like Mr, Mrs, Dr Example: Dr - `ErrorResponse.ReferenceList.Traveler.CustomerLoyalty.given` (string) The First Name of the Cardholder Example: John - `ErrorResponse.ReferenceList.Traveler.CustomerLoyalty.middle` (string) Middle Name of the Cardholder Example: Wilkinson - `ErrorResponse.ReferenceList.Traveler.CustomerLoyalty.surname` (string) Last Name of the Cardholder Example: Smith - `ErrorResponse.ReferenceList.Traveler.AlternateContact` (array) - `ErrorResponse.ReferenceList.Traveler.AlternateContact.@type` (string) Example: AlternateContact - `ErrorResponse.ReferenceList.Traveler.AlternateContact.id` (string) - `ErrorResponse.ReferenceList.Traveler.AlternateContact.contactType` (string) Contact type value Example: Relative - `ErrorResponse.ReferenceList.Traveler.AlternateContact.relation` (string) Relation value Example: Mother - `ErrorResponse.ReferenceList.Traveler.AlternateContact.Address` (array) - `ErrorResponse.ReferenceList.Traveler.AlternateContact.Telephone` (array) - `ErrorResponse.ReferenceList.Traveler.AlternateContact.Email` (array) - `ErrorResponse.ReferenceList.Traveler.AlternateContact.emergencyInd` (boolean) This is the contact in case of an emergency Example: true - `ErrorResponse.ReferenceList.Traveler.AlternateContact.defaultInd` (boolean) This is the default contact Example: true - `ErrorResponse.ReferenceList.Traveler.TravelDocument` (array) - `ErrorResponse.ReferenceList.Traveler.TravelDocument.@type` (string, required) Discriminator classes TravelDocument or TravelDocumentDetail Enum: "TravelDocumentDetail" - `ErrorResponse.ReferenceList.Traveler.TravelDocument.docNumber` (string) Travel document number. Example: B37201 - `ErrorResponse.ReferenceList.Traveler.TravelDocument.docType` (string) Supported Travel Document types 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" - `ErrorResponse.ReferenceList.Traveler.TravelDocument.issueDate` (string) Issue date of document. Required for a visa Example: 2002-10-13 - `ErrorResponse.ReferenceList.Traveler.TravelDocument.expireDate` (string) Expiration date of document. Required for a visa. Example: 2002-11-13 - `ErrorResponse.ReferenceList.Traveler.TravelDocument.stateProvCode` (string) State Province Code value Example: 44 - `ErrorResponse.ReferenceList.Traveler.TravelDocument.placeOfIssue` (string) Place of issue value Example: Birmingham - `ErrorResponse.ReferenceList.Traveler.TravelDocument.issueCountry` (string) Issuing country of document; ISO3166 standard format. Example: CA - `ErrorResponse.ReferenceList.Traveler.TravelDocument.birthDate` (string) The date of birth of the document holder in YYYY-MM-DD format. Example: 1995-04-22 - `ErrorResponse.ReferenceList.Traveler.TravelDocument.birthCountry` (string) Country of birth of the document holder in ISO3166 standard format. Example: AR - `ErrorResponse.ReferenceList.Traveler.TravelDocument.birthPlace` (string) Birth place value Example: Ontario - `ErrorResponse.ReferenceList.Traveler.TravelDocument.residence` (string) Residence value Example: 1st section 8th st - `ErrorResponse.ReferenceList.Traveler.TravelDocument.id` (string) Locally referenced id Example: 34 - `ErrorResponse.ReferenceList.Traveler.TravelDocument.Nationality` (string) Birth country as noted on document; specifies a 2 character country code as defined in ISO3166. Example: BR - `ErrorResponse.ReferenceList.Traveler.TravelDocument.IssuedForGeoPoliticalArea` (object) The location code of the geographical location. Codes from Ref Pub - `ErrorResponse.ReferenceList.Traveler.TravelDocument.IssuedForGeoPoliticalArea.value` (string) Example: G - `ErrorResponse.ReferenceList.Traveler.TravelDocument.IssuedForGeoPoliticalArea.level` (string) Represents the type of geopolitical area (country, Continent, State etc) Enum: "World", "Global Area", "Continent Group", "Continent", "Country", "StateProvince", "City", "Airport" - `ErrorResponse.ReferenceList.Traveler.TravelDocument.IssuedForGeoPoliticalArea.id` (string) Optional internally referenced id Example: 2 - `ErrorResponse.ReferenceList.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. In Traveler this is used to send custom freeform traveler name remarks, such as a unique identifier for a given traveler. Not supported for addition/deletion in Traveler Modify. - `ErrorResponse.ReferenceList.Traveler.Comments.@type` (string) Example: Comments - `ErrorResponse.ReferenceList.Traveler.Comments.Comment` (array) - `ErrorResponse.ReferenceList.Traveler.RailDiscountCard` (array) - `ErrorResponse.ReferenceList.Traveler.RailDiscountCard.value` (string) Example: Rail1234546 - `ErrorResponse.ReferenceList.Traveler.RailDiscountCard.supplierCode` (string, required) Code of the Supplier Example: Enco - `ErrorResponse.ReferenceList.Traveler.RailDiscountCard.referenceNumber` (string) ReferenceNumber Example: 134256 - `ErrorResponse.ReferenceList.Traveler.accompaniedByInfantInd` (boolean) Example: true - `ErrorResponse.ReferenceList.Offer` (array) - `ErrorResponse.ReferenceList.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. Enum: "Offer" - `ErrorResponse.ReferenceList.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 - `ErrorResponse.ReferenceList.Offer.offerRef` (string) Used to reference another instance of this object in the same message Example: offer_1 - `ErrorResponse.ReferenceList.Offer.ContentSource` (string) Indicates the owner the offer or document. Enum: "GDS", "NDC", "LCC", "API" - `ErrorResponse.ReferenceList.Offer.parentOfferRef` (string) A reference to the Offer this offer is sold in conjunction with Example: offer_1 - `ErrorResponse.ReferenceList.Offer.offerModifyRef` (string) Reference to the new Offer created as a result of this Offer being subject to a schedule change. - `ErrorResponse.ReferenceList.Offer.Product` (array, required) Lists the flight or flights for one leg of the itinerary. Repeats for additional leg or legs. - `ErrorResponse.ReferenceList.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. Certain types of offers on a booking, such as seats and ancillaries, generally include only the CurrencyCode, Base, and TotalPrice objects. - `ErrorResponse.ReferenceList.Offer.Price.@type` (string, required) Discriminator classes Price or PriceDetail Enum: "PriceDetail" - `ErrorResponse.ReferenceList.Offer.Price.id` (string) Internally referenced id Example: 2 - `ErrorResponse.ReferenceList.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. - `ErrorResponse.ReferenceList.Offer.Price.CurrencyCode.value` (string) An ISO 4217 currency code. Example: USD - `ErrorResponse.ReferenceList.Offer.Price.CurrencyCode.codeAuthority` (string) Currency code authority Example: ISO 4217 - `ErrorResponse.ReferenceList.Offer.Price.CurrencyCode.decimalPlace` (integer) Number of decimal places for the currency. Example: 2 - `ErrorResponse.ReferenceList.Offer.Price.CurrencyCode.decimalAuthority` (string) Currency code decimal authority Example: ISO 4217 - `ErrorResponse.ReferenceList.Offer.Price.Base` (number) Base price before taxes and fees. For Hotel, may not be returned by all suppliers. Example: 20.2 - `ErrorResponse.ReferenceList.Offer.Price.TotalTaxes` (number) Total taxes applied to the base price. For Hotel, may not be returned by all suppliers. Example: 34.4 - `ErrorResponse.ReferenceList.Offer.Price.TotalFees` (number) Total fees included in Total Price. Example: 201 - `ErrorResponse.ReferenceList.Offer.Price.TotalPrice` (number) Total price of this offer including the base price and all taxes and fees. Example: 34 - `ErrorResponse.ReferenceList.Offer.Price.VendorCurrencyTotal` (object) No longer used. Previously used to expose the local vendor currency when it is different to the purchased currency - `ErrorResponse.ReferenceList.Offer.Price.VendorCurrencyTotal.@type` (string) - `ErrorResponse.ReferenceList.Offer.Price.VendorCurrencyTotal.currencySource` (string) The system requesting or returning the currency code specified in the attribute Enum: "Supplier", "Charged", "Requested" - `ErrorResponse.ReferenceList.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 - `ErrorResponse.ReferenceList.Offer.Price.VendorCurrencyTotal.Taxes` (object) Summary of all individual taxes. Child class TaxesDetail provides the breakdown of individual taxes. - `ErrorResponse.ReferenceList.Offer.Price.VendorCurrencyTotal.Taxes.@type` (string, required) Discriminator class is TaxesDetail Enum: "TaxesDetail" - `ErrorResponse.ReferenceList.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 - `ErrorResponse.ReferenceList.Offer.Price.VendorCurrencyTotal.Taxes.TaxInfo` (array) Returned for TripChange APIS only. - `ErrorResponse.ReferenceList.Offer.Price.VendorCurrencyTotal.Taxes.Tax` (array) - `ErrorResponse.ReferenceList.Offer.Price.VendorCurrencyTotal.Taxes.TaxPercent` (object) Returned when the tax is expressed as a percentage of the amount. - `ErrorResponse.ReferenceList.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. - `ErrorResponse.ReferenceList.Offer.Price.VendorCurrencyTotal.Fees.@type` (string, required) Discriminator. Child class FeesDetail Enum: "FeesDetail" - `ErrorResponse.ReferenceList.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: 55 - `ErrorResponse.ReferenceList.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: 25 - `ErrorResponse.ReferenceList.Offer.Price.VendorCurrencyTotal.Fees.Fee` (array) Array of individual fees. - `ErrorResponse.ReferenceList.Offer.Price.VendorCurrencyTotal.Total` (number) Specifies the total price including base + taxes + fees Example: 30.13 - `ErrorResponse.ReferenceList.Offer.Price.VendorCurrencyTotal.approximateInd` (boolean) True if this amount has been converted from the original amount Example: true - `ErrorResponse.ReferenceList.Offer.Price.FlightPassCredits` (integer) Indicates the number of flight pass credits the offer “costs” for all passengers. Air Canada NDC only. Example: 2 - `ErrorResponse.ReferenceList.Offer.Price.PriceBreakdown` (array) - `ErrorResponse.ReferenceList.Offer.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. Enum: "PriceBreakdownAir", "PriceBreakdownAncillary", "PriceBreakdownHospitality", "PriceBreakdownVehiclePrice", "PriceBreakdownVehicleDeposit", "PriceBreakdownVehicleCharges" - `ErrorResponse.ReferenceList.Offer.Price.PriceBreakdown.Amount` (object) Amount represents the cost applied. - `ErrorResponse.ReferenceList.Offer.Price.PriceBreakdown.Commission` (object) 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). - `ErrorResponse.ReferenceList.Offer.TermsAndConditionsFull` (array) For Hotel Rules and Reservation responses, this array will contain a single TermsAndConditionsFullHospitality entry. Cancellation terms with multiple time periods are represented within that entry's CancelPenalty array rather than as multiple TermsAndConditionsFull entries. For Two-Step Commit (FLights), this is a standard object, no changes. For Unified Checkout (Flights), if no payment information was sent in the request, the booking is confirmed by the airline but not yet ticketed. This object provides the payment and ticketing time limits in ExpiryDate and PaymentTimeLimit. - `ErrorResponse.ReferenceList.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. Enum: "TermsAndConditionsFull", "TermsAndConditionsFullSummary" - `ErrorResponse.ReferenceList.Offer.TermsAndConditionsFull.id` (string) Local identifier within a given message for this object. Example: TC_1 - `ErrorResponse.ReferenceList.Offer.TermsAndConditionsFull.termsAndConditionsRef` (string) Used to reference another instance of this object in the same message. Example: TC_1 - `ErrorResponse.ReferenceList.Offer.TermsAndConditionsFull.ExpiryDate` (string) The date and time in UTC the offer will no longer be valid. Example: 2022-08-07T12:12:00Z - `ErrorResponse.ReferenceList.Offer.TermsAndConditionsFull.CustomerLoyalty` (array) - `ErrorResponse.ReferenceList.Offer.TermsAndConditionsFull.TextBlock` (array) A list of free text terms and conditions. - `ErrorResponse.ReferenceList.Offer.TermsAndConditionsFull.ExpiryDate` (string) The data and time the offer will expire Example: 2022-08-07T12:12:00Z - `ErrorResponse.ReferenceList.Offer.TermsAndConditionsFull.TextBlock` (array) - `ErrorResponse.ReferenceList.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 - `ErrorResponse.ReferenceList.Offer.scheduleChangeInd` (boolean) - If true: this Offer is subject to a schedule change. May be seen in a Two-step Commit, on the first Commit response payload, in the event of a schedule change. If this is the case, the Product object returns previous and updated schedule details in two instances of Product/FlightSegment as follows: - The previous flight segment is identified with sequence=1 and Flight/id=flight_1 - The updated flight segment is identified with sequence=2 and Flight/id=flight_2 Offer includes a ModifyPrice object; however, unless a price change has also occurred, Offer/Price repeats the original price of the offer and Offer/ModifyPrice returns all amounts as zero (0) to indicate there is no price change. NDC only - for Reservation Retrieve, when an airline-initiated flight change has occurred, the response also returns the Offer object with @type OfferModify and scheduleChangeInd=true to indicate a change has occurred. See [NDC Flight Disruption Handing](https://developer.travelport.com/docs/flights/guides/booking-and-reservations/flights-booking-guide#ndc-flight-disruption-handling-involuntary-changes) in the Air Booking Guide for details. - `ErrorResponse.ReferenceList.Brand` (array) Each instance provides details for one BrandRef id. - `ErrorResponse.ReferenceList.Brand.@type` (string, required) Discriminator. Child classes BrandID and Brand. BrandCompleteInfo is no longer in use. Enum: "Brand" - `ErrorResponse.ReferenceList.Brand.id` (string) Local id within a given message to support referencing this object. Example: brand_001 - `ErrorResponse.ReferenceList.Brand.BrandRef` (string) Reference id that corresponds to the brand 'id' in ReferenceListBrand.Brand. Example: brandRef_001 - `ErrorResponse.ReferenceList.Brand.name` (string, required) Brand name from the supplier. Example: Main Cabin Extra - `ErrorResponse.ReferenceList.Brand.tier` (integer) The brand tier. Not returned for NDC. Example: 2 - `ErrorResponse.ReferenceList.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] - `ErrorResponse.ReferenceList.Brand.code` (string) The ATPCO Brand Code. Example: REFMAIN - `ErrorResponse.ReferenceList.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. - `ErrorResponse.ReferenceList.Brand.BrandAttribute.@type` (string, required) Discriminator. No child classes. Example: BrandAttribute - `ErrorResponse.ReferenceList.Brand.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" - `ErrorResponse.ReferenceList.Brand.BrandAttribute.inclusion` (string, required) The indicator as to how the brand and the product are associated. Enum: "Included", "Chargeable", "Not Offered" - `ErrorResponse.ReferenceList.Brand.BrandAttribute.ImageURL` (array) URL for an image for the brand, when available. Example: ["http:/imageurl.com"] - `ErrorResponse.ReferenceList.Brand.BrandAttribute.matchedAttributeInd` (boolean) Returned only if true for any attribute requested in ProductInclusionPreference.Classification. Example: true - `ErrorResponse.ReferenceList.Brand.BrandAttribute.groupCode` (string) Carrier group code. Returned if filed by the carrier. Example: BG - `ErrorResponse.ReferenceList.Brand.BrandAttribute.subGroupCode` (string) Carrier sub group code. Returned if filed by the carrier. Example: CY - `ErrorResponse.ReferenceList.Brand.BrandAttribute.subCode` (string) Carrier sub code. Returned if filed by the carrier. Example: 08A - `ErrorResponse.ReferenceList.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. - `ErrorResponse.ReferenceList.Brand.AdditionalBrandAttribute.@type` (string, required) Discriminator. No child classes. Example: AdditionalBrandAttribute - `ErrorResponse.ReferenceList.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 - `ErrorResponse.ReferenceList.Brand.AdditionalBrandAttribute.ImageURL` (array) URL for an image for the brand, when available. Example: ["https:/travelport/image/profile/firstviewimage"] - `ErrorResponse.ReferenceList.Brand.AdditionalBrandAttribute.matchedAttributeInd` (boolean) Returned only if true for any attribute requested in ProductInclusionPreference.Classification. Example: true - `ErrorResponse.ReferenceList.Brand.AdditionalBrandAttribute.groupCode` (string) Carrier group code. Returned if filed by the carrier. Example: BG - `ErrorResponse.ReferenceList.Brand.AdditionalBrandAttribute.subGroupCode` (string) Carrier sub group code. Returned if filed by the carrier. Example: CY - `ErrorResponse.ReferenceList.Brand.AdditionalBrandAttribute.subCode` (string) Carrier sub code. Returned if filed by the carrier. Example: 08A - `ErrorResponse.ReferenceList.Brand.ImageURL` (array) Example: ["http:/imageurl.com"] - `ErrorResponse.ReferenceList.TermsAndConditions` (array) - `ErrorResponse.ReferenceList.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. Enum: "TermsAndConditions" - `ErrorResponse.ReferenceList.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 - `ErrorResponse.ReferenceList.TermsAndConditions.termsAndConditionsRef` (string) Reference id that corresponds to the TermsAndConditions 'id' in ReferenceListTermsAndConditions.TermsAndConditions. Example: TC_1 - `ErrorResponse.ReferenceList.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 - `ErrorResponse.ReferenceList.TermsAndConditions.CustomerLoyalty` (array) - `ErrorResponse.ReferenceList.Price` (array, required) - `ErrorResponse.CurrencyRateConversion` (array) - `ErrorResponse.CurrencyRateConversion.@type` (string) - `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 ## Response 402: - `402` (unknown) Payment Required - 402 ## Response 402 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 flows. Example: 49f58f5f-c443-43b4-9f5d-be405fd00a01 - `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. See [Error Messaging](https://developer.travelport.com/docs/flights/general/error-messaging) for additional details. - `ErrorResponse.Result.@type` (string) Discriminator class Result only Example: Result - `ErrorResponse.Result.status` (string) The status of an error or warning Enum: "Not processed", "Incomplete", "Complete", "Unknown" - `ErrorResponse.Result.Error` (array) A list of error information returned at the provider level for a response. - `ErrorResponse.Result.Error.@type` (string, required) Discriminator classes Error or ErrorDetail Enum: "ErrorDetail" - `ErrorResponse.Result.Error.StatusCode` (integer) Http standard response code Example: 200 - `ErrorResponse.Result.Error.Message` (string) The Travelport standardized error or warning message Example: No flights found. - `ErrorResponse.Result.Error.NameValuePair` (array) - `ErrorResponse.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 - `ErrorResponse.Result.Error.NameValuePair.id` (string) Optional internally referenced id Example: 6 - `ErrorResponse.Result.Error.NameValuePair.name` (string, required) Key, categorizing the type of remark or error. Example: Day1 - `ErrorResponse.Result.Error.category` (string) A category to assist in identifying the error Example: VALIDATION - `ErrorResponse.Result.Error.SourceID` (string) The identifier of the source system sending the error or warning Example: 1G - `ErrorResponse.Result.Error.SourceCode` (string) The error or warning code returned by the source airline or host system Example: 1234 - `ErrorResponse.Result.Error.SourceDescription` (string) The error or warning message as it is returned by the source airline or host system - `ErrorResponse.Result.Warning` (array) A list of warning information returned at the provider level for a response. - `ErrorResponse.Result.Warning.@type` (string, required) Discriminator classes Warning or WarningDetail Enum: "WarningDetail" - `ErrorResponse.Result.Warning.StatusCode` (integer) Http standard response code Example: 200 - `ErrorResponse.Result.Warning.Message` (string) The Travelport standardized error or warning message Example: Customer Loyalty could not be applied. - `ErrorResponse.Result.Warning.NameValuePair` (array) - `ErrorResponse.Result.Warning.category` (string) A category to assist in identifying the error Example: INFORMATION - `ErrorResponse.Result.Warning.SourceID` (string) The identifier of the source system sending the error or warning Example: 1G - `ErrorResponse.Result.Warning.SourceCode` (string) The error or warning code returned by the source airline or host system Example: 1234 - `ErrorResponse.Result.Warning.SourceDescription` (string) The error or warning message as it is returned by the source airline or host system - `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.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 system generated 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'. - If not available, for Payment, any unique identifier can be sent. 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 - `ErrorResponse.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 - `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 Example: www.travelport.com - `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) - `ErrorResponse.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. Enum: "ReferenceListSeatingChart", "ReferenceListFlight", "ReferenceListAmenity", "ReferenceListProduct", "ReferenceListTraveler", "ReferenceListOffer", "ReferenceListBrand", "ReferenceListTermsAndConditions", "ReferenceListExchangedPrice" - `ErrorResponse.ReferenceList.id` (string) Uniquely identifies for the Reference List Example: referenceList_001 - `ErrorResponse.ReferenceList.SeatingChart` (array) - `ErrorResponse.ReferenceList.SeatingChart.@type` (string, required) Discriminator. Enum: "SeatingChart" - `ErrorResponse.ReferenceList.SeatingChart.id` (string) Internally reference id - `ErrorResponse.ReferenceList.SeatingChart.Cabin` (array, required) - `ErrorResponse.ReferenceList.SeatingChart.Cabin.@type` (string) Example: Cabin - `ErrorResponse.ReferenceList.SeatingChart.Cabin.name` (string, required) The name of the cabin Example: Economy - `ErrorResponse.ReferenceList.SeatingChart.Cabin.Layout` (array, required) - `ErrorResponse.ReferenceList.SeatingChart.Cabin.Layout.value` (string) - `ErrorResponse.ReferenceList.SeatingChart.Cabin.Layout.position` (array, required) - `ErrorResponse.ReferenceList.SeatingChart.Cabin.Layout.startRow` (integer, required) Start row for this Cabin Layout - `ErrorResponse.ReferenceList.SeatingChart.Cabin.Layout.endRow` (integer, required) End row for this Cabin Layout - `ErrorResponse.ReferenceList.SeatingChart.Cabin.Row` (array, required) - `ErrorResponse.ReferenceList.SeatingChart.Cabin.Row.@type` (string) Example: Row - `ErrorResponse.ReferenceList.SeatingChart.Cabin.Row.label` (string) The identifier for the row Example: 78 - `ErrorResponse.ReferenceList.SeatingChart.Cabin.Row.Space` (array, required) - `ErrorResponse.ReferenceList.SeatingChart.Cabin.Row.Characteristic` (array) - `ErrorResponse.ReferenceList.Flight` (array, required) - `ErrorResponse.ReferenceList.Flight.@type` (string, required) Discriminator. Child classes Flight and FlightDetail. Enum: "Flight" - `ErrorResponse.ReferenceList.Flight.id` (string) Local id within a given message to support referencing this object - an internal flight identifier. Example: 126 - `ErrorResponse.ReferenceList.Flight.FlightRef` (string) Reference id that corresponds to the flight 'id' in ReferenceListFlight.Flight. Example: s1 - `ErrorResponse.ReferenceList.Flight.distance` (integer) Distance covered by the flight. Example: 6574 - `ErrorResponse.ReferenceList.Flight.stops` (integer) Number of stops Example: 2 - `ErrorResponse.ReferenceList.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 - `ErrorResponse.ReferenceList.Flight.carrier` (string, required) The airline code. Example: BA - `ErrorResponse.ReferenceList.Flight.number` (string, required) The marketing carrier flight number. Example: 98 - `ErrorResponse.ReferenceList.Flight.operatingCarrier` (string) The operating airline IATA code. Shown in codeshare situations when the operating carrier is different to the marketing carrier. Example: BA - `ErrorResponse.ReferenceList.Flight.operatingCarrierName` (string) Name of the marketing operating carrier. Example: Liberty Aerospace - `ErrorResponse.ReferenceList.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 - `ErrorResponse.ReferenceList.Flight.equipment` (string) Equipment model. Note that TRN, TRS, and BUS equipment codes indicate ground transportation. Example: 777 - `ErrorResponse.ReferenceList.Flight.Departure` (object, required) Departure details for a given leg. - `ErrorResponse.ReferenceList.Flight.Departure.@type` (string, required) Discriminator classes Departure or DepartureDetail Enum: "DepartureDetail" - `ErrorResponse.ReferenceList.Flight.Departure.location` (string, required) IATA code for departure airport or city for this leg of the itinerary. Example: AMS - `ErrorResponse.ReferenceList.Flight.Departure.date` (string, required) Departure date in YYYY-MM-DD format. Example: 0011-10-17 - `ErrorResponse.ReferenceList.Flight.Departure.time` (string, required) Departure date in HH:mm:ss (24-hour format). Example: 04:45:00 - `ErrorResponse.ReferenceList.Flight.Departure.terminal` (string) Departure terminal, returned when available. Example: Terminal 1 - `ErrorResponse.ReferenceList.Flight.Departure.country` (string) Country of to departure or arrival Example: US - `ErrorResponse.ReferenceList.Flight.Arrival` (object, required) Arrival information. - `ErrorResponse.ReferenceList.Flight.Arrival.@type` (string, required) Discriminator classes Arrival or ArrivalDetail Enum: "ArrivalDetail" - `ErrorResponse.ReferenceList.Flight.Arrival.location` (string, required) IATA code for arrival airport or city for this leg of the itinerary. Example: MAD - `ErrorResponse.ReferenceList.Flight.Arrival.date` (string, required) Arrival date in YYYY-MM-DD format. Example: 0011-10-17 - `ErrorResponse.ReferenceList.Flight.Arrival.time` (string) Arrival date in HH:mm:ss (24-hour format). Example: 04:45:00 - `ErrorResponse.ReferenceList.Flight.Arrival.terminal` (string) Arrival terminal, returned when available. Example: Terminal 1 - `ErrorResponse.ReferenceList.Flight.Arrival.country` (string) Country of to departure or arrival Example: US - `ErrorResponse.ReferenceList.Flight.IntermediateStop` (array) GDS only; not supported for NDC. Returned if the flight has a technical stop but does not incur a change in flight number. - `ErrorResponse.ReferenceList.Flight.IntermediateStop.value` (string) The IATA airport code for the airport where the intermediate stop occurs. - `ErrorResponse.ReferenceList.Flight.IntermediateStop.arrivalFlightDuration` (string) Duration in hours and minutes of the flight arriving at the intermediate stop. ISO 8601 format Example: PT2H35M - `ErrorResponse.ReferenceList.Flight.IntermediateStop.departureFlightDuration` (string) Duration in hours and minutes of the flight departing the intermediate stop. ISO 8601 format Example: PT1H35M - `ErrorResponse.ReferenceList.Flight.IntermediateStop.duration` (string) Duration in hours and minutes between the arrival and departure at the intermediate stop. ISO 8601 format Example: PT1H35M - `ErrorResponse.ReferenceList.Flight.IntermediateStop.equipment` (string) Equipment model, if there is a change of equipment during the stop. Example: 777 - `ErrorResponse.ReferenceList.Flight.IntermediateStop.arrivalDate` (string) The local date the aircraft arrives at the intermediate stop Example: 2026-04-30 - `ErrorResponse.ReferenceList.Flight.IntermediateStop.departureDate` (string) The local date the aircraft departs from the intermediate stop Example: 2026-04-30 - `ErrorResponse.ReferenceList.Flight.IntermediateStop.arrivalTime` (string) The local time the aircraft arrives at the intermediate stop Example: 68400 - `ErrorResponse.ReferenceList.Flight.IntermediateStop.departurelTime` (string) The local time the aircraft departs from the intermediate stop Example: 72000 - `ErrorResponse.ReferenceList.Flight.IntermediateStop.arrivalTerminal` (string) Arrival terminal of the intermediate stop airport Example: Terminal2 - `ErrorResponse.ReferenceList.Flight.IntermediateStop.departureTerminal` (string) Departure terminal of the intermediate stop airport Example: Terminal4 - `ErrorResponse.ReferenceList.Flight.subjectToGovernmentApprovalInd` (boolean) GDS only, not supported for NDC. - If true: the airline has filed in its schedule that availability for a specific flight is subject to government approval. Returned only in the Air Search API response. Example: true - `ErrorResponse.ReferenceList.Amenity` (array, required) One instance for each specific amenity. - `ErrorResponse.ReferenceList.Amenity.@type` (string, required) Discriminator. No child classes. Example: Amenity - `ErrorResponse.ReferenceList.Amenity.id` (string, required) A unique Travelport-assigned amenity id used for cross-referencing by each flight with this amenity. Example: amenity_001 - `ErrorResponse.ReferenceList.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 - `ErrorResponse.ReferenceList.Amenity.Text` (object) A free text description of the amenity. - `ErrorResponse.ReferenceList.Amenity.Text.value` (string) A short free text description. - `ErrorResponse.ReferenceList.Amenity.Text.language` (string) The language the text is provided in. ISO639 format. Example: EN - `ErrorResponse.ReferenceList.Product` (array) - `ErrorResponse.ReferenceList.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. Enum: "Product" - `ErrorResponse.ReferenceList.Product.id` (string) Local id within a given message to support referencing this object. Example: product_1 - `ErrorResponse.ReferenceList.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 - `ErrorResponse.ReferenceList.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 - `ErrorResponse.ReferenceList.Traveler` (array) - `ErrorResponse.ReferenceList.Traveler.@type` (string, required) Discriminator classes TravelerID or Traveler Enum: "Traveler" - `ErrorResponse.ReferenceList.Traveler.id` (string) Send value of travelerRefId_1 for the first traveler, then increment for each additional traveler (e.g., travelerRefId_2). Traveler/id is only mandatory when referenced elsewhere in the request, such as in SpecialService and PrimaryContact (TravelerIdentifier/Identifier/value). - `ErrorResponse.ReferenceList.Traveler.TravelerRef` (string) - `ErrorResponse.ReferenceList.Traveler.birthDate` (string) Date of birth in YYYY-MM-DD format. The TripServices APIs require this object only for infant and child PTC types (e.g., INF, INS, CHD, UNN). When sending [minimum secure flight information](https://developer.travelport.com/docs/flights/guides/booking-and-reservations/remarks-and-service-requests#minimum-secure-flight-information-ssr-docs), which is required by some carriers, this object is required for all PTCs. Example: 2021-06-05 - `ErrorResponse.ReferenceList.Traveler.gender` (string) Gender Type Male, Female etc. When sending [minimum secure flight information](https://developer.travelport.com/docs/flights/guides/booking-and-reservations/remarks-and-service-requests#minimum-secure-flight-information-ssr-docs) in the Traveler object, which is required by some carriers, this object is required for all PTCs. This field is not used by Hotel APIs and will be ignored. Enum: "Male", "Female", "Unknown", "Undisclosed" - `ErrorResponse.ReferenceList.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. - `ErrorResponse.ReferenceList.Traveler.PersonName.@type` (string, required) Discriminator classes PersonName or PersonNameDetail Enum: "PersonNameDetail" - `ErrorResponse.ReferenceList.Traveler.PersonName.Prefix` (string) Salutation of honorific (e.g. Mr., Mrs., Ms., Miss, Dr.) Example: Mr - `ErrorResponse.ReferenceList.Traveler.PersonName.Given` (string) Traveler first or given name. Example: John - `ErrorResponse.ReferenceList.Traveler.PersonName.Middle` (string) Traveler middle name. Example: Erick - `ErrorResponse.ReferenceList.Traveler.PersonName.Surname` (string, required) Traveler last name or surname. Example: Smith - `ErrorResponse.ReferenceList.Traveler.PersonName.personNameType` (string) OTA Code Enum: "Former", "Nickname", "Alternate", "Maiden" - `ErrorResponse.ReferenceList.Traveler.PersonName.language` (string) 'ISO639 code of the language the name is represented Example: EN - `ErrorResponse.ReferenceList.Traveler.PersonName.SurnamePrefix` (string) The surname prefix Example: Von - `ErrorResponse.ReferenceList.Traveler.PersonName.Suffix` (string) Traveler name suffix such as Jr. or Sr. Example: Jr. - `ErrorResponse.ReferenceList.Traveler.PersonName.Title` (string) Degree or honors Example: DR - `ErrorResponse.ReferenceList.Traveler.PersonName.Privacy` (object) Confidential details for marketing purpose - `ErrorResponse.ReferenceList.Traveler.PersonName.Privacy.id` (string) Optional internally referenced id Example: 2 - `ErrorResponse.ReferenceList.Traveler.PersonName.Privacy.shareMarketing` (string) Used to indicate marketing preferences, Yes, No, Inherit Enum: "Yes", "No", "Inherit" - `ErrorResponse.ReferenceList.Traveler.PersonName.Privacy.optInStatus` (string) Used to indicate marketing preferences, OptIn, OptOut Enum: "OptedIn", "OptedOut", "Unknown" - `ErrorResponse.ReferenceList.Traveler.PersonName.Privacy.optInDate` (string) The datetime of receiving the opt in notice Example: 2026-08-07T12:12:00Z - `ErrorResponse.ReferenceList.Traveler.PersonName.Privacy.optOutDate` (string) The datetime the opt out notice was received Example: 2026-08-07T12:12:00Z - `ErrorResponse.ReferenceList.Traveler.PersonName.defaultInd` (boolean) If true, this is the default or primary name within a collection of names. Example: true - `ErrorResponse.ReferenceList.Traveler.Address` (array) - `ErrorResponse.ReferenceList.Traveler.Address.@type` (string, required) Discriminator classes Address or AddressDetail Enum: "AddressDetail", "PropertyAddress" - `ErrorResponse.ReferenceList.Traveler.Address.id` (string) unique address id Example: Address_1 - `ErrorResponse.ReferenceList.Traveler.Address.BldgRoom` (object) Address with building and room number - `ErrorResponse.ReferenceList.Traveler.Address.BldgRoom.value` (string) Example: Moore House - `ErrorResponse.ReferenceList.Traveler.Address.BldgRoom.buldingInd` (boolean) When true, the information is a building name. When false, it is an apartment or room # Example: true - `ErrorResponse.ReferenceList.Traveler.Address.Number` (object) The street number alone is the numerical number that precedes the street name in the address. - `ErrorResponse.ReferenceList.Traveler.Address.Number.value` (string) Street number value. Example: 23B - `ErrorResponse.ReferenceList.Traveler.Address.Number.streetNmbrSuffix` (string) Street Number Suffix Example: B - `ErrorResponse.ReferenceList.Traveler.Address.Number.streetDirection` (string) Direction of the Street Example: NW - `ErrorResponse.ReferenceList.Traveler.Address.Number.ruralRouteNmbr` (string) RuralRoute Number Example: 76 - `ErrorResponse.ReferenceList.Traveler.Address.Number.po_Box` (string) PO Box Number Example: 1001 - `ErrorResponse.ReferenceList.Traveler.Address.Street` (string) Street name. May also contain the street number when the Number element is missing. Example: ABC Street - `ErrorResponse.ReferenceList.Traveler.Address.AddressLine` (array) Property street address. Used in place of Street and Number. Each element of the array represents an address line. - `ErrorResponse.ReferenceList.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 - `ErrorResponse.ReferenceList.Traveler.Address.County` (string) County or Region Name. Example: Berkshire - `ErrorResponse.ReferenceList.Traveler.Address.StateProv` (object) The standard code or abbreviation for the state, province, or region. May also include full length name. - `ErrorResponse.ReferenceList.Traveler.Address.StateProv.value` (string) State, province, or region code needed to identify location (typically two characters). Example: CA - `ErrorResponse.ReferenceList.Traveler.Address.StateProv.name` (string) State, province, or region name needed to identify location. Example: California - `ErrorResponse.ReferenceList.Traveler.Address.Country` (object) Contains the information needed to identify a country. - `ErrorResponse.ReferenceList.Traveler.Address.Country.value` (string) The ISO 3166 code for the property's address. Example: US - `ErrorResponse.ReferenceList.Traveler.Address.Country.id` (string) Custom user-assigned identifier for the country. Example: 23 - `ErrorResponse.ReferenceList.Traveler.Address.Country.name` (string) The full name of the country for the property's address. Example: United States - `ErrorResponse.ReferenceList.Traveler.Address.Country.codeContext` (string) The source of a code, such as the organization that provided the id number Example: IATA - `ErrorResponse.ReferenceList.Traveler.Address.PostalCode` (string) Postal code for the address. Example: Sl6 1AB - `ErrorResponse.ReferenceList.Traveler.Address.Addressee` (string) The name of the company or person to be addressed Example: ACME INC - `ErrorResponse.ReferenceList.Traveler.Address.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" - `ErrorResponse.ReferenceList.Traveler.Address.addressType` (string) OTA code for address type Example: CLT - `ErrorResponse.ReferenceList.Traveler.Address.use` (string) OTA code for address use Example: AUT - `ErrorResponse.ReferenceList.Traveler.Address.Comment` (object) Textual information. - `ErrorResponse.ReferenceList.Traveler.Address.Comment.value` (string) Actual text. May be restricted based on the type of comment. Ex: - Notepad remarks: limited to 87 characters. - Traveler name remarks: limited to 33 characters, only spaces and hyphens allowed for special characters. Example: Additional comments - `ErrorResponse.ReferenceList.Traveler.Address.Comment.id` (string) Local identifier within a given message for this object. Example: comment_1 - `ErrorResponse.ReferenceList.Traveler.Address.Comment.name` (string) Title of comment or type of remark. Example: Comment name - `ErrorResponse.ReferenceList.Traveler.Address.Comment.language` (string) Language code using ISO-639 standard Example: EN - `ErrorResponse.ReferenceList.Traveler.Address.Priority` (integer) The priority ranking within the group Example: 1 - `ErrorResponse.ReferenceList.Traveler.Address.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. Example: false - `ErrorResponse.ReferenceList.Traveler.Address.provisionedInd` (boolean) If true, this address came into the system through provisioning Example: false - `ErrorResponse.ReferenceList.Traveler.Telephone` (array) - `ErrorResponse.ReferenceList.Traveler.Telephone.@type` (string, required) Discriminator classes Telephone or TelephoneDetail Enum: "TelephoneDetail" - `ErrorResponse.ReferenceList.Traveler.Telephone.countryAccessCode` (string) Phone country code Example: 1 - `ErrorResponse.ReferenceList.Traveler.Telephone.areaCityCode` (string) Phone local area code Example: 972 - `ErrorResponse.ReferenceList.Traveler.Telephone.phoneNumber` (string, required) Mobile/Telephone Number. Accepted characters are numeric, dash, space, and period. Example: 972-000-787 - `ErrorResponse.ReferenceList.Traveler.Telephone.extension` (string) Telephone extension number Example: 234 - `ErrorResponse.ReferenceList.Traveler.Telephone.id` (string) Optional custom user-assigned identifier for a phone number. Example: 3 - `ErrorResponse.ReferenceList.Traveler.Telephone.cityCode` (string) IATA city code if referenced by phone number. Example: DEN - `ErrorResponse.ReferenceList.Traveler.Telephone.role` (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" - `ErrorResponse.ReferenceList.Traveler.Telephone.phoneLocationType` (string) Location of the phone Example: Agency - `ErrorResponse.ReferenceList.Traveler.Telephone.phoneTechType` (string) Indicates the type of technology associated with the telephone number Example: Voice - `ErrorResponse.ReferenceList.Traveler.Telephone.phoneUseType` (string) Agency code for how phone is used (e.g., Home, Business, Emergency Contact, Travel Arranger, Day, Evening). Example: Home - `ErrorResponse.ReferenceList.Traveler.Telephone.pin` (string) Additional codes used for telephone Example: 3456 - `ErrorResponse.ReferenceList.Traveler.Telephone.priority` (integer) Priority Example: 1 - `ErrorResponse.ReferenceList.Traveler.Telephone.defaultInd` (boolean) When true, indicates a default value should be used. Example: true - `ErrorResponse.ReferenceList.Traveler.Telephone.provisionedInd` (boolean) true indicates this phone number was created through provisioned Example: false - `ErrorResponse.ReferenceList.Traveler.Email` (array) For a reservation Retrieve response, all email addresses are associated with the first traveler on the reservation for GDS. NDC supports contact information for each traveler on the reservation. - `ErrorResponse.ReferenceList.Traveler.Email.value` (string) The email address. Example: exampledomain@example.com - `ErrorResponse.ReferenceList.Traveler.Email.id` (string) Electronic email addresses, in IETF specified format. Example: email_1 - `ErrorResponse.ReferenceList.Traveler.Email.emailType` (string) Use email type to specify if the email is to be sent "TO" or sent "FROM" Example: FROM - `ErrorResponse.ReferenceList.Traveler.Email.comment` (string) Any freeform note for the email, such as its purpose. Example: work email - `ErrorResponse.ReferenceList.Traveler.Email.preferredFormat` (string) Mime media type Example: text/html - `ErrorResponse.ReferenceList.Traveler.Email.optInDate` (string) The datetime of receiving the opt in notice Example: 2026-03-03T11:11:00Z - `ErrorResponse.ReferenceList.Traveler.Email.optOutDate` (string) The datetime the opt out notice was received Example: 2026-03-03T11:11:00Z - `ErrorResponse.ReferenceList.Traveler.Email.validInd` (boolean) If true, this is a valid email address that has been system verified via a successful email transmission. Example: true - `ErrorResponse.ReferenceList.Traveler.Email.provisionedInd` (boolean) If true then the email address came from the provisioning process Example: true - `ErrorResponse.ReferenceList.Traveler.passengerTypeCode` (string) Passenger type code (PTC) for this traveler. Required for all PTCs other than ADT (adult); if not sent defaults to ADT. Some of the common PTCs supported include ADT, INF, INS, CHD, UNN. Private fare PTCs, including INN, JNN, VNN, ITF, JNF, and VFF, may also be supported, subject to airline support. Example: CHD - `ErrorResponse.ReferenceList.Traveler.nationality` (string) Nationality on country code ISO Example: AL - `ErrorResponse.ReferenceList.Traveler.age` (integer) The age of the traveller at the time of travel Example: 13 - `ErrorResponse.ReferenceList.Traveler.CustomerLoyalty` (array) - `ErrorResponse.ReferenceList.Traveler.CustomerLoyalty.value` (string, required) Number on loyalty card. Example: 132456 - `ErrorResponse.ReferenceList.Traveler.CustomerLoyalty.id` (string) Optional Customer Loyalty Id. Not saved Example: Loyalty_1 - `ErrorResponse.ReferenceList.Traveler.CustomerLoyalty.priority` (integer) Optional Numeric Priority Code Example: 2 - `ErrorResponse.ReferenceList.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 - `ErrorResponse.ReferenceList.Traveler.CustomerLoyalty.programName` (string) Supplier's loyalty program name. Example: Frontier-EarlyReturns - `ErrorResponse.ReferenceList.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 - `ErrorResponse.ReferenceList.Traveler.CustomerLoyalty.supplier` (string) Supplier of a loyalty program (typically 2 characters representing the hotel, brand, or airline). Example: UA - `ErrorResponse.ReferenceList.Traveler.CustomerLoyalty.tier` (string) Customer Loyalty tier Example: Silver - `ErrorResponse.ReferenceList.Traveler.CustomerLoyalty.shareWithSupplier` (array) The list of suppliers that the CustomerLoyalty number is shared. Used for cross accrual programs. If valid carrier codes are not sent, the response returns the message NO CROSS ACCRUAL AGREEMENT EXISTS. - `ErrorResponse.ReferenceList.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 - `ErrorResponse.ReferenceList.Traveler.CustomerLoyalty.validatedInd` (boolean) Customer loyalty number has been validated by the supplier Example: true - `ErrorResponse.ReferenceList.Traveler.CustomerLoyalty.prefix` (string) The cardholder name prefix title like Mr, Mrs, Dr Example: Dr - `ErrorResponse.ReferenceList.Traveler.CustomerLoyalty.given` (string) The First Name of the Cardholder Example: John - `ErrorResponse.ReferenceList.Traveler.CustomerLoyalty.middle` (string) Middle Name of the Cardholder Example: Wilkinson - `ErrorResponse.ReferenceList.Traveler.CustomerLoyalty.surname` (string) Last Name of the Cardholder Example: Smith - `ErrorResponse.ReferenceList.Traveler.AlternateContact` (array) - `ErrorResponse.ReferenceList.Traveler.AlternateContact.@type` (string) Example: AlternateContact - `ErrorResponse.ReferenceList.Traveler.AlternateContact.id` (string) - `ErrorResponse.ReferenceList.Traveler.AlternateContact.contactType` (string) Contact type value Example: Relative - `ErrorResponse.ReferenceList.Traveler.AlternateContact.relation` (string) Relation value Example: Mother - `ErrorResponse.ReferenceList.Traveler.AlternateContact.Address` (array) - `ErrorResponse.ReferenceList.Traveler.AlternateContact.Telephone` (array) - `ErrorResponse.ReferenceList.Traveler.AlternateContact.Email` (array) - `ErrorResponse.ReferenceList.Traveler.AlternateContact.emergencyInd` (boolean) This is the contact in case of an emergency Example: true - `ErrorResponse.ReferenceList.Traveler.AlternateContact.defaultInd` (boolean) This is the default contact Example: true - `ErrorResponse.ReferenceList.Traveler.TravelDocument` (array) - `ErrorResponse.ReferenceList.Traveler.TravelDocument.@type` (string, required) Discriminator classes TravelDocument or TravelDocumentDetail Enum: "TravelDocumentDetail" - `ErrorResponse.ReferenceList.Traveler.TravelDocument.docNumber` (string) Travel document number. Example: B37201 - `ErrorResponse.ReferenceList.Traveler.TravelDocument.docType` (string) Supported Travel Document types 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" - `ErrorResponse.ReferenceList.Traveler.TravelDocument.issueDate` (string) Issue date of document. Required for a visa Example: 2002-10-13 - `ErrorResponse.ReferenceList.Traveler.TravelDocument.expireDate` (string) Expiration date of document. Required for a visa. Example: 2002-11-13 - `ErrorResponse.ReferenceList.Traveler.TravelDocument.stateProvCode` (string) State Province Code value Example: 44 - `ErrorResponse.ReferenceList.Traveler.TravelDocument.placeOfIssue` (string) Place of issue value Example: Birmingham - `ErrorResponse.ReferenceList.Traveler.TravelDocument.issueCountry` (string) Issuing country of document; ISO3166 standard format. Example: CA - `ErrorResponse.ReferenceList.Traveler.TravelDocument.birthDate` (string) The date of birth of the document holder in YYYY-MM-DD format. Example: 1995-04-22 - `ErrorResponse.ReferenceList.Traveler.TravelDocument.birthCountry` (string) Country of birth of the document holder in ISO3166 standard format. Example: AR - `ErrorResponse.ReferenceList.Traveler.TravelDocument.birthPlace` (string) Birth place value Example: Ontario - `ErrorResponse.ReferenceList.Traveler.TravelDocument.residence` (string) Residence value Example: 1st section 8th st - `ErrorResponse.ReferenceList.Traveler.TravelDocument.id` (string) Locally referenced id Example: 34 - `ErrorResponse.ReferenceList.Traveler.TravelDocument.Nationality` (string) Birth country as noted on document; specifies a 2 character country code as defined in ISO3166. Example: BR - `ErrorResponse.ReferenceList.Traveler.TravelDocument.IssuedForGeoPoliticalArea` (object) The location code of the geographical location. Codes from Ref Pub - `ErrorResponse.ReferenceList.Traveler.TravelDocument.IssuedForGeoPoliticalArea.value` (string) Example: G - `ErrorResponse.ReferenceList.Traveler.TravelDocument.IssuedForGeoPoliticalArea.level` (string) Represents the type of geopolitical area (country, Continent, State etc) Enum: "World", "Global Area", "Continent Group", "Continent", "Country", "StateProvince", "City", "Airport" - `ErrorResponse.ReferenceList.Traveler.TravelDocument.IssuedForGeoPoliticalArea.id` (string) Optional internally referenced id Example: 2 - `ErrorResponse.ReferenceList.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. In Traveler this is used to send custom freeform traveler name remarks, such as a unique identifier for a given traveler. Not supported for addition/deletion in Traveler Modify. - `ErrorResponse.ReferenceList.Traveler.Comments.@type` (string) Example: Comments - `ErrorResponse.ReferenceList.Traveler.Comments.Comment` (array) - `ErrorResponse.ReferenceList.Traveler.RailDiscountCard` (array) - `ErrorResponse.ReferenceList.Traveler.RailDiscountCard.value` (string) Example: Rail1234546 - `ErrorResponse.ReferenceList.Traveler.RailDiscountCard.supplierCode` (string, required) Code of the Supplier Example: Enco - `ErrorResponse.ReferenceList.Traveler.RailDiscountCard.referenceNumber` (string) ReferenceNumber Example: 134256 - `ErrorResponse.ReferenceList.Traveler.accompaniedByInfantInd` (boolean) Example: true - `ErrorResponse.ReferenceList.Offer` (array) - `ErrorResponse.ReferenceList.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. Enum: "Offer" - `ErrorResponse.ReferenceList.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 - `ErrorResponse.ReferenceList.Offer.offerRef` (string) Used to reference another instance of this object in the same message Example: offer_1 - `ErrorResponse.ReferenceList.Offer.ContentSource` (string) Indicates the owner the offer or document. Enum: "GDS", "NDC", "LCC", "API" - `ErrorResponse.ReferenceList.Offer.parentOfferRef` (string) A reference to the Offer this offer is sold in conjunction with Example: offer_1 - `ErrorResponse.ReferenceList.Offer.offerModifyRef` (string) Reference to the new Offer created as a result of this Offer being subject to a schedule change. - `ErrorResponse.ReferenceList.Offer.Product` (array, required) Lists the flight or flights for one leg of the itinerary. Repeats for additional leg or legs. - `ErrorResponse.ReferenceList.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. Certain types of offers on a booking, such as seats and ancillaries, generally include only the CurrencyCode, Base, and TotalPrice objects. - `ErrorResponse.ReferenceList.Offer.Price.@type` (string, required) Discriminator classes Price or PriceDetail Enum: "PriceDetail" - `ErrorResponse.ReferenceList.Offer.Price.id` (string) Internally referenced id Example: 2 - `ErrorResponse.ReferenceList.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. - `ErrorResponse.ReferenceList.Offer.Price.CurrencyCode.value` (string) An ISO 4217 currency code. Example: USD - `ErrorResponse.ReferenceList.Offer.Price.CurrencyCode.codeAuthority` (string) Currency code authority Example: ISO 4217 - `ErrorResponse.ReferenceList.Offer.Price.CurrencyCode.decimalPlace` (integer) Number of decimal places for the currency. Example: 2 - `ErrorResponse.ReferenceList.Offer.Price.CurrencyCode.decimalAuthority` (string) Currency code decimal authority Example: ISO 4217 - `ErrorResponse.ReferenceList.Offer.Price.Base` (number) Base price before taxes and fees. For Hotel, may not be returned by all suppliers. Example: 20.2 - `ErrorResponse.ReferenceList.Offer.Price.TotalTaxes` (number) Total taxes applied to the base price. For Hotel, may not be returned by all suppliers. Example: 34.4 - `ErrorResponse.ReferenceList.Offer.Price.TotalFees` (number) Total fees included in Total Price. Example: 201 - `ErrorResponse.ReferenceList.Offer.Price.TotalPrice` (number) Total price of this offer including the base price and all taxes and fees. Example: 34 - `ErrorResponse.ReferenceList.Offer.Price.VendorCurrencyTotal` (object) No longer used. Previously used to expose the local vendor currency when it is different to the purchased currency - `ErrorResponse.ReferenceList.Offer.Price.VendorCurrencyTotal.@type` (string) - `ErrorResponse.ReferenceList.Offer.Price.VendorCurrencyTotal.currencySource` (string) The system requesting or returning the currency code specified in the attribute Enum: "Supplier", "Charged", "Requested" - `ErrorResponse.ReferenceList.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 - `ErrorResponse.ReferenceList.Offer.Price.VendorCurrencyTotal.Taxes` (object) Summary of all individual taxes. Child class TaxesDetail provides the breakdown of individual taxes. - `ErrorResponse.ReferenceList.Offer.Price.VendorCurrencyTotal.Taxes.@type` (string, required) Discriminator class is TaxesDetail Enum: "TaxesDetail" - `ErrorResponse.ReferenceList.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 - `ErrorResponse.ReferenceList.Offer.Price.VendorCurrencyTotal.Taxes.TaxInfo` (array) Returned for TripChange APIS only. - `ErrorResponse.ReferenceList.Offer.Price.VendorCurrencyTotal.Taxes.Tax` (array) - `ErrorResponse.ReferenceList.Offer.Price.VendorCurrencyTotal.Taxes.TaxPercent` (object) Returned when the tax is expressed as a percentage of the amount. - `ErrorResponse.ReferenceList.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. - `ErrorResponse.ReferenceList.Offer.Price.VendorCurrencyTotal.Fees.@type` (string, required) Discriminator. Child class FeesDetail Enum: "FeesDetail" - `ErrorResponse.ReferenceList.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: 55 - `ErrorResponse.ReferenceList.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: 25 - `ErrorResponse.ReferenceList.Offer.Price.VendorCurrencyTotal.Fees.Fee` (array) Array of individual fees. - `ErrorResponse.ReferenceList.Offer.Price.VendorCurrencyTotal.Total` (number) Specifies the total price including base + taxes + fees Example: 30.13 - `ErrorResponse.ReferenceList.Offer.Price.VendorCurrencyTotal.approximateInd` (boolean) True if this amount has been converted from the original amount Example: true - `ErrorResponse.ReferenceList.Offer.Price.FlightPassCredits` (integer) Indicates the number of flight pass credits the offer “costs” for all passengers. Air Canada NDC only. Example: 2 - `ErrorResponse.ReferenceList.Offer.Price.PriceBreakdown` (array) - `ErrorResponse.ReferenceList.Offer.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. Enum: "PriceBreakdownAir", "PriceBreakdownAncillary", "PriceBreakdownHospitality", "PriceBreakdownVehiclePrice", "PriceBreakdownVehicleDeposit", "PriceBreakdownVehicleCharges" - `ErrorResponse.ReferenceList.Offer.Price.PriceBreakdown.Amount` (object) Amount represents the cost applied. - `ErrorResponse.ReferenceList.Offer.Price.PriceBreakdown.Commission` (object) 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). - `ErrorResponse.ReferenceList.Offer.TermsAndConditionsFull` (array) For Hotel Rules and Reservation responses, this array will contain a single TermsAndConditionsFullHospitality entry. Cancellation terms with multiple time periods are represented within that entry's CancelPenalty array rather than as multiple TermsAndConditionsFull entries. For Two-Step Commit (FLights), this is a standard object, no changes. For Unified Checkout (Flights), if no payment information was sent in the request, the booking is confirmed by the airline but not yet ticketed. This object provides the payment and ticketing time limits in ExpiryDate and PaymentTimeLimit. - `ErrorResponse.ReferenceList.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. Enum: "TermsAndConditionsFull", "TermsAndConditionsFullSummary" - `ErrorResponse.ReferenceList.Offer.TermsAndConditionsFull.id` (string) Local identifier within a given message for this object. Example: TC_1 - `ErrorResponse.ReferenceList.Offer.TermsAndConditionsFull.termsAndConditionsRef` (string) Used to reference another instance of this object in the same message. Example: TC_1 - `ErrorResponse.ReferenceList.Offer.TermsAndConditionsFull.ExpiryDate` (string) The date and time in UTC the offer will no longer be valid. Example: 2022-08-07T12:12:00Z - `ErrorResponse.ReferenceList.Offer.TermsAndConditionsFull.CustomerLoyalty` (array) - `ErrorResponse.ReferenceList.Offer.TermsAndConditionsFull.TextBlock` (array) A list of free text terms and conditions. - `ErrorResponse.ReferenceList.Offer.TermsAndConditionsFull.ExpiryDate` (string) The data and time the offer will expire Example: 2022-08-07T12:12:00Z - `ErrorResponse.ReferenceList.Offer.TermsAndConditionsFull.TextBlock` (array) - `ErrorResponse.ReferenceList.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 - `ErrorResponse.ReferenceList.Offer.scheduleChangeInd` (boolean) - If true: this Offer is subject to a schedule change. May be seen in a Two-step Commit, on the first Commit response payload, in the event of a schedule change. If this is the case, the Product object returns previous and updated schedule details in two instances of Product/FlightSegment as follows: - The previous flight segment is identified with sequence=1 and Flight/id=flight_1 - The updated flight segment is identified with sequence=2 and Flight/id=flight_2 Offer includes a ModifyPrice object; however, unless a price change has also occurred, Offer/Price repeats the original price of the offer and Offer/ModifyPrice returns all amounts as zero (0) to indicate there is no price change. NDC only - for Reservation Retrieve, when an airline-initiated flight change has occurred, the response also returns the Offer object with @type OfferModify and scheduleChangeInd=true to indicate a change has occurred. See [NDC Flight Disruption Handing](https://developer.travelport.com/docs/flights/guides/booking-and-reservations/flights-booking-guide#ndc-flight-disruption-handling-involuntary-changes) in the Air Booking Guide for details. - `ErrorResponse.ReferenceList.Brand` (array) Each instance provides details for one BrandRef id. - `ErrorResponse.ReferenceList.Brand.@type` (string, required) Discriminator. Child classes BrandID and Brand. BrandCompleteInfo is no longer in use. Enum: "Brand" - `ErrorResponse.ReferenceList.Brand.id` (string) Local id within a given message to support referencing this object. Example: brand_001 - `ErrorResponse.ReferenceList.Brand.BrandRef` (string) Reference id that corresponds to the brand 'id' in ReferenceListBrand.Brand. Example: brandRef_001 - `ErrorResponse.ReferenceList.Brand.name` (string, required) Brand name from the supplier. Example: Main Cabin Extra - `ErrorResponse.ReferenceList.Brand.tier` (integer) The brand tier. Not returned for NDC. Example: 2 - `ErrorResponse.ReferenceList.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] - `ErrorResponse.ReferenceList.Brand.code` (string) The ATPCO Brand Code. Example: REFMAIN - `ErrorResponse.ReferenceList.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. - `ErrorResponse.ReferenceList.Brand.BrandAttribute.@type` (string, required) Discriminator. No child classes. Example: BrandAttribute - `ErrorResponse.ReferenceList.Brand.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" - `ErrorResponse.ReferenceList.Brand.BrandAttribute.inclusion` (string, required) The indicator as to how the brand and the product are associated. Enum: "Included", "Chargeable", "Not Offered" - `ErrorResponse.ReferenceList.Brand.BrandAttribute.ImageURL` (array) URL for an image for the brand, when available. Example: ["http:/imageurl.com"] - `ErrorResponse.ReferenceList.Brand.BrandAttribute.matchedAttributeInd` (boolean) Returned only if true for any attribute requested in ProductInclusionPreference.Classification. Example: true - `ErrorResponse.ReferenceList.Brand.BrandAttribute.groupCode` (string) Carrier group code. Returned if filed by the carrier. Example: BG - `ErrorResponse.ReferenceList.Brand.BrandAttribute.subGroupCode` (string) Carrier sub group code. Returned if filed by the carrier. Example: CY - `ErrorResponse.ReferenceList.Brand.BrandAttribute.subCode` (string) Carrier sub code. Returned if filed by the carrier. Example: 08A - `ErrorResponse.ReferenceList.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. - `ErrorResponse.ReferenceList.Brand.AdditionalBrandAttribute.@type` (string, required) Discriminator. No child classes. Example: AdditionalBrandAttribute - `ErrorResponse.ReferenceList.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 - `ErrorResponse.ReferenceList.Brand.AdditionalBrandAttribute.ImageURL` (array) URL for an image for the brand, when available. Example: ["https:/travelport/image/profile/firstviewimage"] - `ErrorResponse.ReferenceList.Brand.AdditionalBrandAttribute.matchedAttributeInd` (boolean) Returned only if true for any attribute requested in ProductInclusionPreference.Classification. Example: true - `ErrorResponse.ReferenceList.Brand.AdditionalBrandAttribute.groupCode` (string) Carrier group code. Returned if filed by the carrier. Example: BG - `ErrorResponse.ReferenceList.Brand.AdditionalBrandAttribute.subGroupCode` (string) Carrier sub group code. Returned if filed by the carrier. Example: CY - `ErrorResponse.ReferenceList.Brand.AdditionalBrandAttribute.subCode` (string) Carrier sub code. Returned if filed by the carrier. Example: 08A - `ErrorResponse.ReferenceList.Brand.ImageURL` (array) Example: ["http:/imageurl.com"] - `ErrorResponse.ReferenceList.TermsAndConditions` (array) - `ErrorResponse.ReferenceList.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. Enum: "TermsAndConditions" - `ErrorResponse.ReferenceList.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 - `ErrorResponse.ReferenceList.TermsAndConditions.termsAndConditionsRef` (string) Reference id that corresponds to the TermsAndConditions 'id' in ReferenceListTermsAndConditions.TermsAndConditions. Example: TC_1 - `ErrorResponse.ReferenceList.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 - `ErrorResponse.ReferenceList.TermsAndConditions.CustomerLoyalty` (array) - `ErrorResponse.ReferenceList.Price` (array, required) - `ErrorResponse.CurrencyRateConversion` (array) - `ErrorResponse.CurrencyRateConversion.@type` (string) - `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 ## Response 403: - `403` (unknown) Forbidden - 403 ## Response 403 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 flows. Example: 49f58f5f-c443-43b4-9f5d-be405fd00a01 - `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. See [Error Messaging](https://developer.travelport.com/docs/flights/general/error-messaging) for additional details. - `ErrorResponse.Result.@type` (string) Discriminator class Result only Example: Result - `ErrorResponse.Result.status` (string) The status of an error or warning Enum: "Not processed", "Incomplete", "Complete", "Unknown" - `ErrorResponse.Result.Error` (array) A list of error information returned at the provider level for a response. - `ErrorResponse.Result.Error.@type` (string, required) Discriminator classes Error or ErrorDetail Enum: "ErrorDetail" - `ErrorResponse.Result.Error.StatusCode` (integer) Http standard response code Example: 200 - `ErrorResponse.Result.Error.Message` (string) The Travelport standardized error or warning message Example: No flights found. - `ErrorResponse.Result.Error.NameValuePair` (array) - `ErrorResponse.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 - `ErrorResponse.Result.Error.NameValuePair.id` (string) Optional internally referenced id Example: 6 - `ErrorResponse.Result.Error.NameValuePair.name` (string, required) Key, categorizing the type of remark or error. Example: Day1 - `ErrorResponse.Result.Error.category` (string) A category to assist in identifying the error Example: VALIDATION - `ErrorResponse.Result.Error.SourceID` (string) The identifier of the source system sending the error or warning Example: 1G - `ErrorResponse.Result.Error.SourceCode` (string) The error or warning code returned by the source airline or host system Example: 1234 - `ErrorResponse.Result.Error.SourceDescription` (string) The error or warning message as it is returned by the source airline or host system - `ErrorResponse.Result.Warning` (array) A list of warning information returned at the provider level for a response. - `ErrorResponse.Result.Warning.@type` (string, required) Discriminator classes Warning or WarningDetail Enum: "WarningDetail" - `ErrorResponse.Result.Warning.StatusCode` (integer) Http standard response code Example: 200 - `ErrorResponse.Result.Warning.Message` (string) The Travelport standardized error or warning message Example: Customer Loyalty could not be applied. - `ErrorResponse.Result.Warning.NameValuePair` (array) - `ErrorResponse.Result.Warning.category` (string) A category to assist in identifying the error Example: INFORMATION - `ErrorResponse.Result.Warning.SourceID` (string) The identifier of the source system sending the error or warning Example: 1G - `ErrorResponse.Result.Warning.SourceCode` (string) The error or warning code returned by the source airline or host system Example: 1234 - `ErrorResponse.Result.Warning.SourceDescription` (string) The error or warning message as it is returned by the source airline or host system - `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.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 system generated 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'. - If not available, for Payment, any unique identifier can be sent. 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 - `ErrorResponse.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 - `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 Example: www.travelport.com - `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) - `ErrorResponse.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. Enum: "ReferenceListSeatingChart", "ReferenceListFlight", "ReferenceListAmenity", "ReferenceListProduct", "ReferenceListTraveler", "ReferenceListOffer", "ReferenceListBrand", "ReferenceListTermsAndConditions", "ReferenceListExchangedPrice" - `ErrorResponse.ReferenceList.id` (string) Uniquely identifies for the Reference List Example: referenceList_001 - `ErrorResponse.ReferenceList.SeatingChart` (array) - `ErrorResponse.ReferenceList.SeatingChart.@type` (string, required) Discriminator. Enum: "SeatingChart" - `ErrorResponse.ReferenceList.SeatingChart.id` (string) Internally reference id - `ErrorResponse.ReferenceList.SeatingChart.Cabin` (array, required) - `ErrorResponse.ReferenceList.SeatingChart.Cabin.@type` (string) Example: Cabin - `ErrorResponse.ReferenceList.SeatingChart.Cabin.name` (string, required) The name of the cabin Example: Economy - `ErrorResponse.ReferenceList.SeatingChart.Cabin.Layout` (array, required) - `ErrorResponse.ReferenceList.SeatingChart.Cabin.Layout.value` (string) - `ErrorResponse.ReferenceList.SeatingChart.Cabin.Layout.position` (array, required) - `ErrorResponse.ReferenceList.SeatingChart.Cabin.Layout.startRow` (integer, required) Start row for this Cabin Layout - `ErrorResponse.ReferenceList.SeatingChart.Cabin.Layout.endRow` (integer, required) End row for this Cabin Layout - `ErrorResponse.ReferenceList.SeatingChart.Cabin.Row` (array, required) - `ErrorResponse.ReferenceList.SeatingChart.Cabin.Row.@type` (string) Example: Row - `ErrorResponse.ReferenceList.SeatingChart.Cabin.Row.label` (string) The identifier for the row Example: 78 - `ErrorResponse.ReferenceList.SeatingChart.Cabin.Row.Space` (array, required) - `ErrorResponse.ReferenceList.SeatingChart.Cabin.Row.Characteristic` (array) - `ErrorResponse.ReferenceList.Flight` (array, required) - `ErrorResponse.ReferenceList.Flight.@type` (string, required) Discriminator. Child classes Flight and FlightDetail. Enum: "Flight" - `ErrorResponse.ReferenceList.Flight.id` (string) Local id within a given message to support referencing this object - an internal flight identifier. Example: 126 - `ErrorResponse.ReferenceList.Flight.FlightRef` (string) Reference id that corresponds to the flight 'id' in ReferenceListFlight.Flight. Example: s1 - `ErrorResponse.ReferenceList.Flight.distance` (integer) Distance covered by the flight. Example: 6574 - `ErrorResponse.ReferenceList.Flight.stops` (integer) Number of stops Example: 2 - `ErrorResponse.ReferenceList.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 - `ErrorResponse.ReferenceList.Flight.carrier` (string, required) The airline code. Example: BA - `ErrorResponse.ReferenceList.Flight.number` (string, required) The marketing carrier flight number. Example: 98 - `ErrorResponse.ReferenceList.Flight.operatingCarrier` (string) The operating airline IATA code. Shown in codeshare situations when the operating carrier is different to the marketing carrier. Example: BA - `ErrorResponse.ReferenceList.Flight.operatingCarrierName` (string) Name of the marketing operating carrier. Example: Liberty Aerospace - `ErrorResponse.ReferenceList.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 - `ErrorResponse.ReferenceList.Flight.equipment` (string) Equipment model. Note that TRN, TRS, and BUS equipment codes indicate ground transportation. Example: 777 - `ErrorResponse.ReferenceList.Flight.Departure` (object, required) Departure details for a given leg. - `ErrorResponse.ReferenceList.Flight.Departure.@type` (string, required) Discriminator classes Departure or DepartureDetail Enum: "DepartureDetail" - `ErrorResponse.ReferenceList.Flight.Departure.location` (string, required) IATA code for departure airport or city for this leg of the itinerary. Example: AMS - `ErrorResponse.ReferenceList.Flight.Departure.date` (string, required) Departure date in YYYY-MM-DD format. Example: 0011-10-17 - `ErrorResponse.ReferenceList.Flight.Departure.time` (string, required) Departure date in HH:mm:ss (24-hour format). Example: 04:45:00 - `ErrorResponse.ReferenceList.Flight.Departure.terminal` (string) Departure terminal, returned when available. Example: Terminal 1 - `ErrorResponse.ReferenceList.Flight.Departure.country` (string) Country of to departure or arrival Example: US - `ErrorResponse.ReferenceList.Flight.Arrival` (object, required) Arrival information. - `ErrorResponse.ReferenceList.Flight.Arrival.@type` (string, required) Discriminator classes Arrival or ArrivalDetail Enum: "ArrivalDetail" - `ErrorResponse.ReferenceList.Flight.Arrival.location` (string, required) IATA code for arrival airport or city for this leg of the itinerary. Example: MAD - `ErrorResponse.ReferenceList.Flight.Arrival.date` (string, required) Arrival date in YYYY-MM-DD format. Example: 0011-10-17 - `ErrorResponse.ReferenceList.Flight.Arrival.time` (string) Arrival date in HH:mm:ss (24-hour format). Example: 04:45:00 - `ErrorResponse.ReferenceList.Flight.Arrival.terminal` (string) Arrival terminal, returned when available. Example: Terminal 1 - `ErrorResponse.ReferenceList.Flight.Arrival.country` (string) Country of to departure or arrival Example: US - `ErrorResponse.ReferenceList.Flight.IntermediateStop` (array) GDS only; not supported for NDC. Returned if the flight has a technical stop but does not incur a change in flight number. - `ErrorResponse.ReferenceList.Flight.IntermediateStop.value` (string) The IATA airport code for the airport where the intermediate stop occurs. - `ErrorResponse.ReferenceList.Flight.IntermediateStop.arrivalFlightDuration` (string) Duration in hours and minutes of the flight arriving at the intermediate stop. ISO 8601 format Example: PT2H35M - `ErrorResponse.ReferenceList.Flight.IntermediateStop.departureFlightDuration` (string) Duration in hours and minutes of the flight departing the intermediate stop. ISO 8601 format Example: PT1H35M - `ErrorResponse.ReferenceList.Flight.IntermediateStop.duration` (string) Duration in hours and minutes between the arrival and departure at the intermediate stop. ISO 8601 format Example: PT1H35M - `ErrorResponse.ReferenceList.Flight.IntermediateStop.equipment` (string) Equipment model, if there is a change of equipment during the stop. Example: 777 - `ErrorResponse.ReferenceList.Flight.IntermediateStop.arrivalDate` (string) The local date the aircraft arrives at the intermediate stop Example: 2026-04-30 - `ErrorResponse.ReferenceList.Flight.IntermediateStop.departureDate` (string) The local date the aircraft departs from the intermediate stop Example: 2026-04-30 - `ErrorResponse.ReferenceList.Flight.IntermediateStop.arrivalTime` (string) The local time the aircraft arrives at the intermediate stop Example: 68400 - `ErrorResponse.ReferenceList.Flight.IntermediateStop.departurelTime` (string) The local time the aircraft departs from the intermediate stop Example: 72000 - `ErrorResponse.ReferenceList.Flight.IntermediateStop.arrivalTerminal` (string) Arrival terminal of the intermediate stop airport Example: Terminal2 - `ErrorResponse.ReferenceList.Flight.IntermediateStop.departureTerminal` (string) Departure terminal of the intermediate stop airport Example: Terminal4 - `ErrorResponse.ReferenceList.Flight.subjectToGovernmentApprovalInd` (boolean) GDS only, not supported for NDC. - If true: the airline has filed in its schedule that availability for a specific flight is subject to government approval. Returned only in the Air Search API response. Example: true - `ErrorResponse.ReferenceList.Amenity` (array, required) One instance for each specific amenity. - `ErrorResponse.ReferenceList.Amenity.@type` (string, required) Discriminator. No child classes. Example: Amenity - `ErrorResponse.ReferenceList.Amenity.id` (string, required) A unique Travelport-assigned amenity id used for cross-referencing by each flight with this amenity. Example: amenity_001 - `ErrorResponse.ReferenceList.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 - `ErrorResponse.ReferenceList.Amenity.Text` (object) A free text description of the amenity. - `ErrorResponse.ReferenceList.Amenity.Text.value` (string) A short free text description. - `ErrorResponse.ReferenceList.Amenity.Text.language` (string) The language the text is provided in. ISO639 format. Example: EN - `ErrorResponse.ReferenceList.Product` (array) - `ErrorResponse.ReferenceList.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. Enum: "Product" - `ErrorResponse.ReferenceList.Product.id` (string) Local id within a given message to support referencing this object. Example: product_1 - `ErrorResponse.ReferenceList.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 - `ErrorResponse.ReferenceList.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 - `ErrorResponse.ReferenceList.Traveler` (array) - `ErrorResponse.ReferenceList.Traveler.@type` (string, required) Discriminator classes TravelerID or Traveler Enum: "Traveler" - `ErrorResponse.ReferenceList.Traveler.id` (string) Send value of travelerRefId_1 for the first traveler, then increment for each additional traveler (e.g., travelerRefId_2). Traveler/id is only mandatory when referenced elsewhere in the request, such as in SpecialService and PrimaryContact (TravelerIdentifier/Identifier/value). - `ErrorResponse.ReferenceList.Traveler.TravelerRef` (string) - `ErrorResponse.ReferenceList.Traveler.birthDate` (string) Date of birth in YYYY-MM-DD format. The TripServices APIs require this object only for infant and child PTC types (e.g., INF, INS, CHD, UNN). When sending [minimum secure flight information](https://developer.travelport.com/docs/flights/guides/booking-and-reservations/remarks-and-service-requests#minimum-secure-flight-information-ssr-docs), which is required by some carriers, this object is required for all PTCs. Example: 2021-06-05 - `ErrorResponse.ReferenceList.Traveler.gender` (string) Gender Type Male, Female etc. When sending [minimum secure flight information](https://developer.travelport.com/docs/flights/guides/booking-and-reservations/remarks-and-service-requests#minimum-secure-flight-information-ssr-docs) in the Traveler object, which is required by some carriers, this object is required for all PTCs. This field is not used by Hotel APIs and will be ignored. Enum: "Male", "Female", "Unknown", "Undisclosed" - `ErrorResponse.ReferenceList.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. - `ErrorResponse.ReferenceList.Traveler.PersonName.@type` (string, required) Discriminator classes PersonName or PersonNameDetail Enum: "PersonNameDetail" - `ErrorResponse.ReferenceList.Traveler.PersonName.Prefix` (string) Salutation of honorific (e.g. Mr., Mrs., Ms., Miss, Dr.) Example: Mr - `ErrorResponse.ReferenceList.Traveler.PersonName.Given` (string) Traveler first or given name. Example: John - `ErrorResponse.ReferenceList.Traveler.PersonName.Middle` (string) Traveler middle name. Example: Erick - `ErrorResponse.ReferenceList.Traveler.PersonName.Surname` (string, required) Traveler last name or surname. Example: Smith - `ErrorResponse.ReferenceList.Traveler.PersonName.personNameType` (string) OTA Code Enum: "Former", "Nickname", "Alternate", "Maiden" - `ErrorResponse.ReferenceList.Traveler.PersonName.language` (string) 'ISO639 code of the language the name is represented Example: EN - `ErrorResponse.ReferenceList.Traveler.PersonName.SurnamePrefix` (string) The surname prefix Example: Von - `ErrorResponse.ReferenceList.Traveler.PersonName.Suffix` (string) Traveler name suffix such as Jr. or Sr. Example: Jr. - `ErrorResponse.ReferenceList.Traveler.PersonName.Title` (string) Degree or honors Example: DR - `ErrorResponse.ReferenceList.Traveler.PersonName.Privacy` (object) Confidential details for marketing purpose - `ErrorResponse.ReferenceList.Traveler.PersonName.Privacy.id` (string) Optional internally referenced id Example: 2 - `ErrorResponse.ReferenceList.Traveler.PersonName.Privacy.shareMarketing` (string) Used to indicate marketing preferences, Yes, No, Inherit Enum: "Yes", "No", "Inherit" - `ErrorResponse.ReferenceList.Traveler.PersonName.Privacy.optInStatus` (string) Used to indicate marketing preferences, OptIn, OptOut Enum: "OptedIn", "OptedOut", "Unknown" - `ErrorResponse.ReferenceList.Traveler.PersonName.Privacy.optInDate` (string) The datetime of receiving the opt in notice Example: 2026-08-07T12:12:00Z - `ErrorResponse.ReferenceList.Traveler.PersonName.Privacy.optOutDate` (string) The datetime the opt out notice was received Example: 2026-08-07T12:12:00Z - `ErrorResponse.ReferenceList.Traveler.PersonName.defaultInd` (boolean) If true, this is the default or primary name within a collection of names. Example: true - `ErrorResponse.ReferenceList.Traveler.Address` (array) - `ErrorResponse.ReferenceList.Traveler.Address.@type` (string, required) Discriminator classes Address or AddressDetail Enum: "AddressDetail", "PropertyAddress" - `ErrorResponse.ReferenceList.Traveler.Address.id` (string) unique address id Example: Address_1 - `ErrorResponse.ReferenceList.Traveler.Address.BldgRoom` (object) Address with building and room number - `ErrorResponse.ReferenceList.Traveler.Address.BldgRoom.value` (string) Example: Moore House - `ErrorResponse.ReferenceList.Traveler.Address.BldgRoom.buldingInd` (boolean) When true, the information is a building name. When false, it is an apartment or room # Example: true - `ErrorResponse.ReferenceList.Traveler.Address.Number` (object) The street number alone is the numerical number that precedes the street name in the address. - `ErrorResponse.ReferenceList.Traveler.Address.Number.value` (string) Street number value. Example: 23B - `ErrorResponse.ReferenceList.Traveler.Address.Number.streetNmbrSuffix` (string) Street Number Suffix Example: B - `ErrorResponse.ReferenceList.Traveler.Address.Number.streetDirection` (string) Direction of the Street Example: NW - `ErrorResponse.ReferenceList.Traveler.Address.Number.ruralRouteNmbr` (string) RuralRoute Number Example: 76 - `ErrorResponse.ReferenceList.Traveler.Address.Number.po_Box` (string) PO Box Number Example: 1001 - `ErrorResponse.ReferenceList.Traveler.Address.Street` (string) Street name. May also contain the street number when the Number element is missing. Example: ABC Street - `ErrorResponse.ReferenceList.Traveler.Address.AddressLine` (array) Property street address. Used in place of Street and Number. Each element of the array represents an address line. - `ErrorResponse.ReferenceList.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 - `ErrorResponse.ReferenceList.Traveler.Address.County` (string) County or Region Name. Example: Berkshire - `ErrorResponse.ReferenceList.Traveler.Address.StateProv` (object) The standard code or abbreviation for the state, province, or region. May also include full length name. - `ErrorResponse.ReferenceList.Traveler.Address.StateProv.value` (string) State, province, or region code needed to identify location (typically two characters). Example: CA - `ErrorResponse.ReferenceList.Traveler.Address.StateProv.name` (string) State, province, or region name needed to identify location. Example: California - `ErrorResponse.ReferenceList.Traveler.Address.Country` (object) Contains the information needed to identify a country. - `ErrorResponse.ReferenceList.Traveler.Address.Country.value` (string) The ISO 3166 code for the property's address. Example: US - `ErrorResponse.ReferenceList.Traveler.Address.Country.id` (string) Custom user-assigned identifier for the country. Example: 23 - `ErrorResponse.ReferenceList.Traveler.Address.Country.name` (string) The full name of the country for the property's address. Example: United States - `ErrorResponse.ReferenceList.Traveler.Address.Country.codeContext` (string) The source of a code, such as the organization that provided the id number Example: IATA - `ErrorResponse.ReferenceList.Traveler.Address.PostalCode` (string) Postal code for the address. Example: Sl6 1AB - `ErrorResponse.ReferenceList.Traveler.Address.Addressee` (string) The name of the company or person to be addressed Example: ACME INC - `ErrorResponse.ReferenceList.Traveler.Address.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" - `ErrorResponse.ReferenceList.Traveler.Address.addressType` (string) OTA code for address type Example: CLT - `ErrorResponse.ReferenceList.Traveler.Address.use` (string) OTA code for address use Example: AUT - `ErrorResponse.ReferenceList.Traveler.Address.Comment` (object) Textual information. - `ErrorResponse.ReferenceList.Traveler.Address.Comment.value` (string) Actual text. May be restricted based on the type of comment. Ex: - Notepad remarks: limited to 87 characters. - Traveler name remarks: limited to 33 characters, only spaces and hyphens allowed for special characters. Example: Additional comments - `ErrorResponse.ReferenceList.Traveler.Address.Comment.id` (string) Local identifier within a given message for this object. Example: comment_1 - `ErrorResponse.ReferenceList.Traveler.Address.Comment.name` (string) Title of comment or type of remark. Example: Comment name - `ErrorResponse.ReferenceList.Traveler.Address.Comment.language` (string) Language code using ISO-639 standard Example: EN - `ErrorResponse.ReferenceList.Traveler.Address.Priority` (integer) The priority ranking within the group Example: 1 - `ErrorResponse.ReferenceList.Traveler.Address.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. Example: false - `ErrorResponse.ReferenceList.Traveler.Address.provisionedInd` (boolean) If true, this address came into the system through provisioning Example: false - `ErrorResponse.ReferenceList.Traveler.Telephone` (array) - `ErrorResponse.ReferenceList.Traveler.Telephone.@type` (string, required) Discriminator classes Telephone or TelephoneDetail Enum: "TelephoneDetail" - `ErrorResponse.ReferenceList.Traveler.Telephone.countryAccessCode` (string) Phone country code Example: 1 - `ErrorResponse.ReferenceList.Traveler.Telephone.areaCityCode` (string) Phone local area code Example: 972 - `ErrorResponse.ReferenceList.Traveler.Telephone.phoneNumber` (string, required) Mobile/Telephone Number. Accepted characters are numeric, dash, space, and period. Example: 972-000-787 - `ErrorResponse.ReferenceList.Traveler.Telephone.extension` (string) Telephone extension number Example: 234 - `ErrorResponse.ReferenceList.Traveler.Telephone.id` (string) Optional custom user-assigned identifier for a phone number. Example: 3 - `ErrorResponse.ReferenceList.Traveler.Telephone.cityCode` (string) IATA city code if referenced by phone number. Example: DEN - `ErrorResponse.ReferenceList.Traveler.Telephone.role` (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" - `ErrorResponse.ReferenceList.Traveler.Telephone.phoneLocationType` (string) Location of the phone Example: Agency - `ErrorResponse.ReferenceList.Traveler.Telephone.phoneTechType` (string) Indicates the type of technology associated with the telephone number Example: Voice - `ErrorResponse.ReferenceList.Traveler.Telephone.phoneUseType` (string) Agency code for how phone is used (e.g., Home, Business, Emergency Contact, Travel Arranger, Day, Evening). Example: Home - `ErrorResponse.ReferenceList.Traveler.Telephone.pin` (string) Additional codes used for telephone Example: 3456 - `ErrorResponse.ReferenceList.Traveler.Telephone.priority` (integer) Priority Example: 1 - `ErrorResponse.ReferenceList.Traveler.Telephone.defaultInd` (boolean) When true, indicates a default value should be used. Example: true - `ErrorResponse.ReferenceList.Traveler.Telephone.provisionedInd` (boolean) true indicates this phone number was created through provisioned Example: false - `ErrorResponse.ReferenceList.Traveler.Email` (array) For a reservation Retrieve response, all email addresses are associated with the first traveler on the reservation for GDS. NDC supports contact information for each traveler on the reservation. - `ErrorResponse.ReferenceList.Traveler.Email.value` (string) The email address. Example: exampledomain@example.com - `ErrorResponse.ReferenceList.Traveler.Email.id` (string) Electronic email addresses, in IETF specified format. Example: email_1 - `ErrorResponse.ReferenceList.Traveler.Email.emailType` (string) Use email type to specify if the email is to be sent "TO" or sent "FROM" Example: FROM - `ErrorResponse.ReferenceList.Traveler.Email.comment` (string) Any freeform note for the email, such as its purpose. Example: work email - `ErrorResponse.ReferenceList.Traveler.Email.preferredFormat` (string) Mime media type Example: text/html - `ErrorResponse.ReferenceList.Traveler.Email.optInDate` (string) The datetime of receiving the opt in notice Example: 2026-03-03T11:11:00Z - `ErrorResponse.ReferenceList.Traveler.Email.optOutDate` (string) The datetime the opt out notice was received Example: 2026-03-03T11:11:00Z - `ErrorResponse.ReferenceList.Traveler.Email.validInd` (boolean) If true, this is a valid email address that has been system verified via a successful email transmission. Example: true - `ErrorResponse.ReferenceList.Traveler.Email.provisionedInd` (boolean) If true then the email address came from the provisioning process Example: true - `ErrorResponse.ReferenceList.Traveler.passengerTypeCode` (string) Passenger type code (PTC) for this traveler. Required for all PTCs other than ADT (adult); if not sent defaults to ADT. Some of the common PTCs supported include ADT, INF, INS, CHD, UNN. Private fare PTCs, including INN, JNN, VNN, ITF, JNF, and VFF, may also be supported, subject to airline support. Example: CHD - `ErrorResponse.ReferenceList.Traveler.nationality` (string) Nationality on country code ISO Example: AL - `ErrorResponse.ReferenceList.Traveler.age` (integer) The age of the traveller at the time of travel Example: 13 - `ErrorResponse.ReferenceList.Traveler.CustomerLoyalty` (array) - `ErrorResponse.ReferenceList.Traveler.CustomerLoyalty.value` (string, required) Number on loyalty card. Example: 132456 - `ErrorResponse.ReferenceList.Traveler.CustomerLoyalty.id` (string) Optional Customer Loyalty Id. Not saved Example: Loyalty_1 - `ErrorResponse.ReferenceList.Traveler.CustomerLoyalty.priority` (integer) Optional Numeric Priority Code Example: 2 - `ErrorResponse.ReferenceList.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 - `ErrorResponse.ReferenceList.Traveler.CustomerLoyalty.programName` (string) Supplier's loyalty program name. Example: Frontier-EarlyReturns - `ErrorResponse.ReferenceList.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 - `ErrorResponse.ReferenceList.Traveler.CustomerLoyalty.supplier` (string) Supplier of a loyalty program (typically 2 characters representing the hotel, brand, or airline). Example: UA - `ErrorResponse.ReferenceList.Traveler.CustomerLoyalty.tier` (string) Customer Loyalty tier Example: Silver - `ErrorResponse.ReferenceList.Traveler.CustomerLoyalty.shareWithSupplier` (array) The list of suppliers that the CustomerLoyalty number is shared. Used for cross accrual programs. If valid carrier codes are not sent, the response returns the message NO CROSS ACCRUAL AGREEMENT EXISTS. - `ErrorResponse.ReferenceList.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 - `ErrorResponse.ReferenceList.Traveler.CustomerLoyalty.validatedInd` (boolean) Customer loyalty number has been validated by the supplier Example: true - `ErrorResponse.ReferenceList.Traveler.CustomerLoyalty.prefix` (string) The cardholder name prefix title like Mr, Mrs, Dr Example: Dr - `ErrorResponse.ReferenceList.Traveler.CustomerLoyalty.given` (string) The First Name of the Cardholder Example: John - `ErrorResponse.ReferenceList.Traveler.CustomerLoyalty.middle` (string) Middle Name of the Cardholder Example: Wilkinson - `ErrorResponse.ReferenceList.Traveler.CustomerLoyalty.surname` (string) Last Name of the Cardholder Example: Smith - `ErrorResponse.ReferenceList.Traveler.AlternateContact` (array) - `ErrorResponse.ReferenceList.Traveler.AlternateContact.@type` (string) Example: AlternateContact - `ErrorResponse.ReferenceList.Traveler.AlternateContact.id` (string) - `ErrorResponse.ReferenceList.Traveler.AlternateContact.contactType` (string) Contact type value Example: Relative - `ErrorResponse.ReferenceList.Traveler.AlternateContact.relation` (string) Relation value Example: Mother - `ErrorResponse.ReferenceList.Traveler.AlternateContact.Address` (array) - `ErrorResponse.ReferenceList.Traveler.AlternateContact.Telephone` (array) - `ErrorResponse.ReferenceList.Traveler.AlternateContact.Email` (array) - `ErrorResponse.ReferenceList.Traveler.AlternateContact.emergencyInd` (boolean) This is the contact in case of an emergency Example: true - `ErrorResponse.ReferenceList.Traveler.AlternateContact.defaultInd` (boolean) This is the default contact Example: true - `ErrorResponse.ReferenceList.Traveler.TravelDocument` (array) - `ErrorResponse.ReferenceList.Traveler.TravelDocument.@type` (string, required) Discriminator classes TravelDocument or TravelDocumentDetail Enum: "TravelDocumentDetail" - `ErrorResponse.ReferenceList.Traveler.TravelDocument.docNumber` (string) Travel document number. Example: B37201 - `ErrorResponse.ReferenceList.Traveler.TravelDocument.docType` (string) Supported Travel Document types 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" - `ErrorResponse.ReferenceList.Traveler.TravelDocument.issueDate` (string) Issue date of document. Required for a visa Example: 2002-10-13 - `ErrorResponse.ReferenceList.Traveler.TravelDocument.expireDate` (string) Expiration date of document. Required for a visa. Example: 2002-11-13 - `ErrorResponse.ReferenceList.Traveler.TravelDocument.stateProvCode` (string) State Province Code value Example: 44 - `ErrorResponse.ReferenceList.Traveler.TravelDocument.placeOfIssue` (string) Place of issue value Example: Birmingham - `ErrorResponse.ReferenceList.Traveler.TravelDocument.issueCountry` (string) Issuing country of document; ISO3166 standard format. Example: CA - `ErrorResponse.ReferenceList.Traveler.TravelDocument.birthDate` (string) The date of birth of the document holder in YYYY-MM-DD format. Example: 1995-04-22 - `ErrorResponse.ReferenceList.Traveler.TravelDocument.birthCountry` (string) Country of birth of the document holder in ISO3166 standard format. Example: AR - `ErrorResponse.ReferenceList.Traveler.TravelDocument.birthPlace` (string) Birth place value Example: Ontario - `ErrorResponse.ReferenceList.Traveler.TravelDocument.residence` (string) Residence value Example: 1st section 8th st - `ErrorResponse.ReferenceList.Traveler.TravelDocument.id` (string) Locally referenced id Example: 34 - `ErrorResponse.ReferenceList.Traveler.TravelDocument.Nationality` (string) Birth country as noted on document; specifies a 2 character country code as defined in ISO3166. Example: BR - `ErrorResponse.ReferenceList.Traveler.TravelDocument.IssuedForGeoPoliticalArea` (object) The location code of the geographical location. Codes from Ref Pub - `ErrorResponse.ReferenceList.Traveler.TravelDocument.IssuedForGeoPoliticalArea.value` (string) Example: G - `ErrorResponse.ReferenceList.Traveler.TravelDocument.IssuedForGeoPoliticalArea.level` (string) Represents the type of geopolitical area (country, Continent, State etc) Enum: "World", "Global Area", "Continent Group", "Continent", "Country", "StateProvince", "City", "Airport" - `ErrorResponse.ReferenceList.Traveler.TravelDocument.IssuedForGeoPoliticalArea.id` (string) Optional internally referenced id Example: 2 - `ErrorResponse.ReferenceList.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. In Traveler this is used to send custom freeform traveler name remarks, such as a unique identifier for a given traveler. Not supported for addition/deletion in Traveler Modify. - `ErrorResponse.ReferenceList.Traveler.Comments.@type` (string) Example: Comments - `ErrorResponse.ReferenceList.Traveler.Comments.Comment` (array) - `ErrorResponse.ReferenceList.Traveler.RailDiscountCard` (array) - `ErrorResponse.ReferenceList.Traveler.RailDiscountCard.value` (string) Example: Rail1234546 - `ErrorResponse.ReferenceList.Traveler.RailDiscountCard.supplierCode` (string, required) Code of the Supplier Example: Enco - `ErrorResponse.ReferenceList.Traveler.RailDiscountCard.referenceNumber` (string) ReferenceNumber Example: 134256 - `ErrorResponse.ReferenceList.Traveler.accompaniedByInfantInd` (boolean) Example: true - `ErrorResponse.ReferenceList.Offer` (array) - `ErrorResponse.ReferenceList.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. Enum: "Offer" - `ErrorResponse.ReferenceList.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 - `ErrorResponse.ReferenceList.Offer.offerRef` (string) Used to reference another instance of this object in the same message Example: offer_1 - `ErrorResponse.ReferenceList.Offer.ContentSource` (string) Indicates the owner the offer or document. Enum: "GDS", "NDC", "LCC", "API" - `ErrorResponse.ReferenceList.Offer.parentOfferRef` (string) A reference to the Offer this offer is sold in conjunction with Example: offer_1 - `ErrorResponse.ReferenceList.Offer.offerModifyRef` (string) Reference to the new Offer created as a result of this Offer being subject to a schedule change. - `ErrorResponse.ReferenceList.Offer.Product` (array, required) Lists the flight or flights for one leg of the itinerary. Repeats for additional leg or legs. - `ErrorResponse.ReferenceList.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. Certain types of offers on a booking, such as seats and ancillaries, generally include only the CurrencyCode, Base, and TotalPrice objects. - `ErrorResponse.ReferenceList.Offer.Price.@type` (string, required) Discriminator classes Price or PriceDetail Enum: "PriceDetail" - `ErrorResponse.ReferenceList.Offer.Price.id` (string) Internally referenced id Example: 2 - `ErrorResponse.ReferenceList.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. - `ErrorResponse.ReferenceList.Offer.Price.CurrencyCode.value` (string) An ISO 4217 currency code. Example: USD - `ErrorResponse.ReferenceList.Offer.Price.CurrencyCode.codeAuthority` (string) Currency code authority Example: ISO 4217 - `ErrorResponse.ReferenceList.Offer.Price.CurrencyCode.decimalPlace` (integer) Number of decimal places for the currency. Example: 2 - `ErrorResponse.ReferenceList.Offer.Price.CurrencyCode.decimalAuthority` (string) Currency code decimal authority Example: ISO 4217 - `ErrorResponse.ReferenceList.Offer.Price.Base` (number) Base price before taxes and fees. For Hotel, may not be returned by all suppliers. Example: 20.2 - `ErrorResponse.ReferenceList.Offer.Price.TotalTaxes` (number) Total taxes applied to the base price. For Hotel, may not be returned by all suppliers. Example: 34.4 - `ErrorResponse.ReferenceList.Offer.Price.TotalFees` (number) Total fees included in Total Price. Example: 201 - `ErrorResponse.ReferenceList.Offer.Price.TotalPrice` (number) Total price of this offer including the base price and all taxes and fees. Example: 34 - `ErrorResponse.ReferenceList.Offer.Price.VendorCurrencyTotal` (object) No longer used. Previously used to expose the local vendor currency when it is different to the purchased currency - `ErrorResponse.ReferenceList.Offer.Price.VendorCurrencyTotal.@type` (string) - `ErrorResponse.ReferenceList.Offer.Price.VendorCurrencyTotal.currencySource` (string) The system requesting or returning the currency code specified in the attribute Enum: "Supplier", "Charged", "Requested" - `ErrorResponse.ReferenceList.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 - `ErrorResponse.ReferenceList.Offer.Price.VendorCurrencyTotal.Taxes` (object) Summary of all individual taxes. Child class TaxesDetail provides the breakdown of individual taxes. - `ErrorResponse.ReferenceList.Offer.Price.VendorCurrencyTotal.Taxes.@type` (string, required) Discriminator class is TaxesDetail Enum: "TaxesDetail" - `ErrorResponse.ReferenceList.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 - `ErrorResponse.ReferenceList.Offer.Price.VendorCurrencyTotal.Taxes.TaxInfo` (array) Returned for TripChange APIS only. - `ErrorResponse.ReferenceList.Offer.Price.VendorCurrencyTotal.Taxes.Tax` (array) - `ErrorResponse.ReferenceList.Offer.Price.VendorCurrencyTotal.Taxes.TaxPercent` (object) Returned when the tax is expressed as a percentage of the amount. - `ErrorResponse.ReferenceList.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. - `ErrorResponse.ReferenceList.Offer.Price.VendorCurrencyTotal.Fees.@type` (string, required) Discriminator. Child class FeesDetail Enum: "FeesDetail" - `ErrorResponse.ReferenceList.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: 55 - `ErrorResponse.ReferenceList.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: 25 - `ErrorResponse.ReferenceList.Offer.Price.VendorCurrencyTotal.Fees.Fee` (array) Array of individual fees. - `ErrorResponse.ReferenceList.Offer.Price.VendorCurrencyTotal.Total` (number) Specifies the total price including base + taxes + fees Example: 30.13 - `ErrorResponse.ReferenceList.Offer.Price.VendorCurrencyTotal.approximateInd` (boolean) True if this amount has been converted from the original amount Example: true - `ErrorResponse.ReferenceList.Offer.Price.FlightPassCredits` (integer) Indicates the number of flight pass credits the offer “costs” for all passengers. Air Canada NDC only. Example: 2 - `ErrorResponse.ReferenceList.Offer.Price.PriceBreakdown` (array) - `ErrorResponse.ReferenceList.Offer.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. Enum: "PriceBreakdownAir", "PriceBreakdownAncillary", "PriceBreakdownHospitality", "PriceBreakdownVehiclePrice", "PriceBreakdownVehicleDeposit", "PriceBreakdownVehicleCharges" - `ErrorResponse.ReferenceList.Offer.Price.PriceBreakdown.Amount` (object) Amount represents the cost applied. - `ErrorResponse.ReferenceList.Offer.Price.PriceBreakdown.Commission` (object) 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). - `ErrorResponse.ReferenceList.Offer.TermsAndConditionsFull` (array) For Hotel Rules and Reservation responses, this array will contain a single TermsAndConditionsFullHospitality entry. Cancellation terms with multiple time periods are represented within that entry's CancelPenalty array rather than as multiple TermsAndConditionsFull entries. For Two-Step Commit (FLights), this is a standard object, no changes. For Unified Checkout (Flights), if no payment information was sent in the request, the booking is confirmed by the airline but not yet ticketed. This object provides the payment and ticketing time limits in ExpiryDate and PaymentTimeLimit. - `ErrorResponse.ReferenceList.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. Enum: "TermsAndConditionsFull", "TermsAndConditionsFullSummary" - `ErrorResponse.ReferenceList.Offer.TermsAndConditionsFull.id` (string) Local identifier within a given message for this object. Example: TC_1 - `ErrorResponse.ReferenceList.Offer.TermsAndConditionsFull.termsAndConditionsRef` (string) Used to reference another instance of this object in the same message. Example: TC_1 - `ErrorResponse.ReferenceList.Offer.TermsAndConditionsFull.ExpiryDate` (string) The date and time in UTC the offer will no longer be valid. Example: 2022-08-07T12:12:00Z - `ErrorResponse.ReferenceList.Offer.TermsAndConditionsFull.CustomerLoyalty` (array) - `ErrorResponse.ReferenceList.Offer.TermsAndConditionsFull.TextBlock` (array) A list of free text terms and conditions. - `ErrorResponse.ReferenceList.Offer.TermsAndConditionsFull.ExpiryDate` (string) The data and time the offer will expire Example: 2022-08-07T12:12:00Z - `ErrorResponse.ReferenceList.Offer.TermsAndConditionsFull.TextBlock` (array) - `ErrorResponse.ReferenceList.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 - `ErrorResponse.ReferenceList.Offer.scheduleChangeInd` (boolean) - If true: this Offer is subject to a schedule change. May be seen in a Two-step Commit, on the first Commit response payload, in the event of a schedule change. If this is the case, the Product object returns previous and updated schedule details in two instances of Product/FlightSegment as follows: - The previous flight segment is identified with sequence=1 and Flight/id=flight_1 - The updated flight segment is identified with sequence=2 and Flight/id=flight_2 Offer includes a ModifyPrice object; however, unless a price change has also occurred, Offer/Price repeats the original price of the offer and Offer/ModifyPrice returns all amounts as zero (0) to indicate there is no price change. NDC only - for Reservation Retrieve, when an airline-initiated flight change has occurred, the response also returns the Offer object with @type OfferModify and scheduleChangeInd=true to indicate a change has occurred. See [NDC Flight Disruption Handing](https://developer.travelport.com/docs/flights/guides/booking-and-reservations/flights-booking-guide#ndc-flight-disruption-handling-involuntary-changes) in the Air Booking Guide for details. - `ErrorResponse.ReferenceList.Brand` (array) Each instance provides details for one BrandRef id. - `ErrorResponse.ReferenceList.Brand.@type` (string, required) Discriminator. Child classes BrandID and Brand. BrandCompleteInfo is no longer in use. Enum: "Brand" - `ErrorResponse.ReferenceList.Brand.id` (string) Local id within a given message to support referencing this object. Example: brand_001 - `ErrorResponse.ReferenceList.Brand.BrandRef` (string) Reference id that corresponds to the brand 'id' in ReferenceListBrand.Brand. Example: brandRef_001 - `ErrorResponse.ReferenceList.Brand.name` (string, required) Brand name from the supplier. Example: Main Cabin Extra - `ErrorResponse.ReferenceList.Brand.tier` (integer) The brand tier. Not returned for NDC. Example: 2 - `ErrorResponse.ReferenceList.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] - `ErrorResponse.ReferenceList.Brand.code` (string) The ATPCO Brand Code. Example: REFMAIN - `ErrorResponse.ReferenceList.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. - `ErrorResponse.ReferenceList.Brand.BrandAttribute.@type` (string, required) Discriminator. No child classes. Example: BrandAttribute - `ErrorResponse.ReferenceList.Brand.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" - `ErrorResponse.ReferenceList.Brand.BrandAttribute.inclusion` (string, required) The indicator as to how the brand and the product are associated. Enum: "Included", "Chargeable", "Not Offered" - `ErrorResponse.ReferenceList.Brand.BrandAttribute.ImageURL` (array) URL for an image for the brand, when available. Example: ["http:/imageurl.com"] - `ErrorResponse.ReferenceList.Brand.BrandAttribute.matchedAttributeInd` (boolean) Returned only if true for any attribute requested in ProductInclusionPreference.Classification. Example: true - `ErrorResponse.ReferenceList.Brand.BrandAttribute.groupCode` (string) Carrier group code. Returned if filed by the carrier. Example: BG - `ErrorResponse.ReferenceList.Brand.BrandAttribute.subGroupCode` (string) Carrier sub group code. Returned if filed by the carrier. Example: CY - `ErrorResponse.ReferenceList.Brand.BrandAttribute.subCode` (string) Carrier sub code. Returned if filed by the carrier. Example: 08A - `ErrorResponse.ReferenceList.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. - `ErrorResponse.ReferenceList.Brand.AdditionalBrandAttribute.@type` (string, required) Discriminator. No child classes. Example: AdditionalBrandAttribute - `ErrorResponse.ReferenceList.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 - `ErrorResponse.ReferenceList.Brand.AdditionalBrandAttribute.ImageURL` (array) URL for an image for the brand, when available. Example: ["https:/travelport/image/profile/firstviewimage"] - `ErrorResponse.ReferenceList.Brand.AdditionalBrandAttribute.matchedAttributeInd` (boolean) Returned only if true for any attribute requested in ProductInclusionPreference.Classification. Example: true - `ErrorResponse.ReferenceList.Brand.AdditionalBrandAttribute.groupCode` (string) Carrier group code. Returned if filed by the carrier. Example: BG - `ErrorResponse.ReferenceList.Brand.AdditionalBrandAttribute.subGroupCode` (string) Carrier sub group code. Returned if filed by the carrier. Example: CY - `ErrorResponse.ReferenceList.Brand.AdditionalBrandAttribute.subCode` (string) Carrier sub code. Returned if filed by the carrier. Example: 08A - `ErrorResponse.ReferenceList.Brand.ImageURL` (array) Example: ["http:/imageurl.com"] - `ErrorResponse.ReferenceList.TermsAndConditions` (array) - `ErrorResponse.ReferenceList.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. Enum: "TermsAndConditions" - `ErrorResponse.ReferenceList.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 - `ErrorResponse.ReferenceList.TermsAndConditions.termsAndConditionsRef` (string) Reference id that corresponds to the TermsAndConditions 'id' in ReferenceListTermsAndConditions.TermsAndConditions. Example: TC_1 - `ErrorResponse.ReferenceList.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 - `ErrorResponse.ReferenceList.TermsAndConditions.CustomerLoyalty` (array) - `ErrorResponse.ReferenceList.Price` (array, required) - `ErrorResponse.CurrencyRateConversion` (array) - `ErrorResponse.CurrencyRateConversion.@type` (string) - `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 ## Response 404: - `404` (unknown) Not Found - 404 ## Response 404 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 flows. Example: 49f58f5f-c443-43b4-9f5d-be405fd00a01 - `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. See [Error Messaging](https://developer.travelport.com/docs/flights/general/error-messaging) for additional details. - `ErrorResponse.Result.@type` (string) Discriminator class Result only Example: Result - `ErrorResponse.Result.status` (string) The status of an error or warning Enum: "Not processed", "Incomplete", "Complete", "Unknown" - `ErrorResponse.Result.Error` (array) A list of error information returned at the provider level for a response. - `ErrorResponse.Result.Error.@type` (string, required) Discriminator classes Error or ErrorDetail Enum: "ErrorDetail" - `ErrorResponse.Result.Error.StatusCode` (integer) Http standard response code Example: 200 - `ErrorResponse.Result.Error.Message` (string) The Travelport standardized error or warning message Example: No flights found. - `ErrorResponse.Result.Error.NameValuePair` (array) - `ErrorResponse.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 - `ErrorResponse.Result.Error.NameValuePair.id` (string) Optional internally referenced id Example: 6 - `ErrorResponse.Result.Error.NameValuePair.name` (string, required) Key, categorizing the type of remark or error. Example: Day1 - `ErrorResponse.Result.Error.category` (string) A category to assist in identifying the error Example: VALIDATION - `ErrorResponse.Result.Error.SourceID` (string) The identifier of the source system sending the error or warning Example: 1G - `ErrorResponse.Result.Error.SourceCode` (string) The error or warning code returned by the source airline or host system Example: 1234 - `ErrorResponse.Result.Error.SourceDescription` (string) The error or warning message as it is returned by the source airline or host system - `ErrorResponse.Result.Warning` (array) A list of warning information returned at the provider level for a response. - `ErrorResponse.Result.Warning.@type` (string, required) Discriminator classes Warning or WarningDetail Enum: "WarningDetail" - `ErrorResponse.Result.Warning.StatusCode` (integer) Http standard response code Example: 200 - `ErrorResponse.Result.Warning.Message` (string) The Travelport standardized error or warning message Example: Customer Loyalty could not be applied. - `ErrorResponse.Result.Warning.NameValuePair` (array) - `ErrorResponse.Result.Warning.category` (string) A category to assist in identifying the error Example: INFORMATION - `ErrorResponse.Result.Warning.SourceID` (string) The identifier of the source system sending the error or warning Example: 1G - `ErrorResponse.Result.Warning.SourceCode` (string) The error or warning code returned by the source airline or host system Example: 1234 - `ErrorResponse.Result.Warning.SourceDescription` (string) The error or warning message as it is returned by the source airline or host system - `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.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 system generated 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'. - If not available, for Payment, any unique identifier can be sent. 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 - `ErrorResponse.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 - `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 Example: www.travelport.com - `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) - `ErrorResponse.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. Enum: "ReferenceListSeatingChart", "ReferenceListFlight", "ReferenceListAmenity", "ReferenceListProduct", "ReferenceListTraveler", "ReferenceListOffer", "ReferenceListBrand", "ReferenceListTermsAndConditions", "ReferenceListExchangedPrice" - `ErrorResponse.ReferenceList.id` (string) Uniquely identifies for the Reference List Example: referenceList_001 - `ErrorResponse.ReferenceList.SeatingChart` (array) - `ErrorResponse.ReferenceList.SeatingChart.@type` (string, required) Discriminator. Enum: "SeatingChart" - `ErrorResponse.ReferenceList.SeatingChart.id` (string) Internally reference id - `ErrorResponse.ReferenceList.SeatingChart.Cabin` (array, required) - `ErrorResponse.ReferenceList.SeatingChart.Cabin.@type` (string) Example: Cabin - `ErrorResponse.ReferenceList.SeatingChart.Cabin.name` (string, required) The name of the cabin Example: Economy - `ErrorResponse.ReferenceList.SeatingChart.Cabin.Layout` (array, required) - `ErrorResponse.ReferenceList.SeatingChart.Cabin.Layout.value` (string) - `ErrorResponse.ReferenceList.SeatingChart.Cabin.Layout.position` (array, required) - `ErrorResponse.ReferenceList.SeatingChart.Cabin.Layout.startRow` (integer, required) Start row for this Cabin Layout - `ErrorResponse.ReferenceList.SeatingChart.Cabin.Layout.endRow` (integer, required) End row for this Cabin Layout - `ErrorResponse.ReferenceList.SeatingChart.Cabin.Row` (array, required) - `ErrorResponse.ReferenceList.SeatingChart.Cabin.Row.@type` (string) Example: Row - `ErrorResponse.ReferenceList.SeatingChart.Cabin.Row.label` (string) The identifier for the row Example: 78 - `ErrorResponse.ReferenceList.SeatingChart.Cabin.Row.Space` (array, required) - `ErrorResponse.ReferenceList.SeatingChart.Cabin.Row.Characteristic` (array) - `ErrorResponse.ReferenceList.Flight` (array, required) - `ErrorResponse.ReferenceList.Flight.@type` (string, required) Discriminator. Child classes Flight and FlightDetail. Enum: "Flight" - `ErrorResponse.ReferenceList.Flight.id` (string) Local id within a given message to support referencing this object - an internal flight identifier. Example: 126 - `ErrorResponse.ReferenceList.Flight.FlightRef` (string) Reference id that corresponds to the flight 'id' in ReferenceListFlight.Flight. Example: s1 - `ErrorResponse.ReferenceList.Flight.distance` (integer) Distance covered by the flight. Example: 6574 - `ErrorResponse.ReferenceList.Flight.stops` (integer) Number of stops Example: 2 - `ErrorResponse.ReferenceList.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 - `ErrorResponse.ReferenceList.Flight.carrier` (string, required) The airline code. Example: BA - `ErrorResponse.ReferenceList.Flight.number` (string, required) The marketing carrier flight number. Example: 98 - `ErrorResponse.ReferenceList.Flight.operatingCarrier` (string) The operating airline IATA code. Shown in codeshare situations when the operating carrier is different to the marketing carrier. Example: BA - `ErrorResponse.ReferenceList.Flight.operatingCarrierName` (string) Name of the marketing operating carrier. Example: Liberty Aerospace - `ErrorResponse.ReferenceList.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 - `ErrorResponse.ReferenceList.Flight.equipment` (string) Equipment model. Note that TRN, TRS, and BUS equipment codes indicate ground transportation. Example: 777 - `ErrorResponse.ReferenceList.Flight.Departure` (object, required) Departure details for a given leg. - `ErrorResponse.ReferenceList.Flight.Departure.@type` (string, required) Discriminator classes Departure or DepartureDetail Enum: "DepartureDetail" - `ErrorResponse.ReferenceList.Flight.Departure.location` (string, required) IATA code for departure airport or city for this leg of the itinerary. Example: AMS - `ErrorResponse.ReferenceList.Flight.Departure.date` (string, required) Departure date in YYYY-MM-DD format. Example: 0011-10-17 - `ErrorResponse.ReferenceList.Flight.Departure.time` (string, required) Departure date in HH:mm:ss (24-hour format). Example: 04:45:00 - `ErrorResponse.ReferenceList.Flight.Departure.terminal` (string) Departure terminal, returned when available. Example: Terminal 1 - `ErrorResponse.ReferenceList.Flight.Departure.country` (string) Country of to departure or arrival Example: US - `ErrorResponse.ReferenceList.Flight.Arrival` (object, required) Arrival information. - `ErrorResponse.ReferenceList.Flight.Arrival.@type` (string, required) Discriminator classes Arrival or ArrivalDetail Enum: "ArrivalDetail" - `ErrorResponse.ReferenceList.Flight.Arrival.location` (string, required) IATA code for arrival airport or city for this leg of the itinerary. Example: MAD - `ErrorResponse.ReferenceList.Flight.Arrival.date` (string, required) Arrival date in YYYY-MM-DD format. Example: 0011-10-17 - `ErrorResponse.ReferenceList.Flight.Arrival.time` (string) Arrival date in HH:mm:ss (24-hour format). Example: 04:45:00 - `ErrorResponse.ReferenceList.Flight.Arrival.terminal` (string) Arrival terminal, returned when available. Example: Terminal 1 - `ErrorResponse.ReferenceList.Flight.Arrival.country` (string) Country of to departure or arrival Example: US - `ErrorResponse.ReferenceList.Flight.IntermediateStop` (array) GDS only; not supported for NDC. Returned if the flight has a technical stop but does not incur a change in flight number. - `ErrorResponse.ReferenceList.Flight.IntermediateStop.value` (string) The IATA airport code for the airport where the intermediate stop occurs. - `ErrorResponse.ReferenceList.Flight.IntermediateStop.arrivalFlightDuration` (string) Duration in hours and minutes of the flight arriving at the intermediate stop. ISO 8601 format Example: PT2H35M - `ErrorResponse.ReferenceList.Flight.IntermediateStop.departureFlightDuration` (string) Duration in hours and minutes of the flight departing the intermediate stop. ISO 8601 format Example: PT1H35M - `ErrorResponse.ReferenceList.Flight.IntermediateStop.duration` (string) Duration in hours and minutes between the arrival and departure at the intermediate stop. ISO 8601 format Example: PT1H35M - `ErrorResponse.ReferenceList.Flight.IntermediateStop.equipment` (string) Equipment model, if there is a change of equipment during the stop. Example: 777 - `ErrorResponse.ReferenceList.Flight.IntermediateStop.arrivalDate` (string) The local date the aircraft arrives at the intermediate stop Example: 2026-04-30 - `ErrorResponse.ReferenceList.Flight.IntermediateStop.departureDate` (string) The local date the aircraft departs from the intermediate stop Example: 2026-04-30 - `ErrorResponse.ReferenceList.Flight.IntermediateStop.arrivalTime` (string) The local time the aircraft arrives at the intermediate stop Example: 68400 - `ErrorResponse.ReferenceList.Flight.IntermediateStop.departurelTime` (string) The local time the aircraft departs from the intermediate stop Example: 72000 - `ErrorResponse.ReferenceList.Flight.IntermediateStop.arrivalTerminal` (string) Arrival terminal of the intermediate stop airport Example: Terminal2 - `ErrorResponse.ReferenceList.Flight.IntermediateStop.departureTerminal` (string) Departure terminal of the intermediate stop airport Example: Terminal4 - `ErrorResponse.ReferenceList.Flight.subjectToGovernmentApprovalInd` (boolean) GDS only, not supported for NDC. - If true: the airline has filed in its schedule that availability for a specific flight is subject to government approval. Returned only in the Air Search API response. Example: true - `ErrorResponse.ReferenceList.Amenity` (array, required) One instance for each specific amenity. - `ErrorResponse.ReferenceList.Amenity.@type` (string, required) Discriminator. No child classes. Example: Amenity - `ErrorResponse.ReferenceList.Amenity.id` (string, required) A unique Travelport-assigned amenity id used for cross-referencing by each flight with this amenity. Example: amenity_001 - `ErrorResponse.ReferenceList.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 - `ErrorResponse.ReferenceList.Amenity.Text` (object) A free text description of the amenity. - `ErrorResponse.ReferenceList.Amenity.Text.value` (string) A short free text description. - `ErrorResponse.ReferenceList.Amenity.Text.language` (string) The language the text is provided in. ISO639 format. Example: EN - `ErrorResponse.ReferenceList.Product` (array) - `ErrorResponse.ReferenceList.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. Enum: "Product" - `ErrorResponse.ReferenceList.Product.id` (string) Local id within a given message to support referencing this object. Example: product_1 - `ErrorResponse.ReferenceList.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 - `ErrorResponse.ReferenceList.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 - `ErrorResponse.ReferenceList.Traveler` (array) - `ErrorResponse.ReferenceList.Traveler.@type` (string, required) Discriminator classes TravelerID or Traveler Enum: "Traveler" - `ErrorResponse.ReferenceList.Traveler.id` (string) Send value of travelerRefId_1 for the first traveler, then increment for each additional traveler (e.g., travelerRefId_2). Traveler/id is only mandatory when referenced elsewhere in the request, such as in SpecialService and PrimaryContact (TravelerIdentifier/Identifier/value). - `ErrorResponse.ReferenceList.Traveler.TravelerRef` (string) - `ErrorResponse.ReferenceList.Traveler.birthDate` (string) Date of birth in YYYY-MM-DD format. The TripServices APIs require this object only for infant and child PTC types (e.g., INF, INS, CHD, UNN). When sending [minimum secure flight information](https://developer.travelport.com/docs/flights/guides/booking-and-reservations/remarks-and-service-requests#minimum-secure-flight-information-ssr-docs), which is required by some carriers, this object is required for all PTCs. Example: 2021-06-05 - `ErrorResponse.ReferenceList.Traveler.gender` (string) Gender Type Male, Female etc. When sending [minimum secure flight information](https://developer.travelport.com/docs/flights/guides/booking-and-reservations/remarks-and-service-requests#minimum-secure-flight-information-ssr-docs) in the Traveler object, which is required by some carriers, this object is required for all PTCs. This field is not used by Hotel APIs and will be ignored. Enum: "Male", "Female", "Unknown", "Undisclosed" - `ErrorResponse.ReferenceList.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. - `ErrorResponse.ReferenceList.Traveler.PersonName.@type` (string, required) Discriminator classes PersonName or PersonNameDetail Enum: "PersonNameDetail" - `ErrorResponse.ReferenceList.Traveler.PersonName.Prefix` (string) Salutation of honorific (e.g. Mr., Mrs., Ms., Miss, Dr.) Example: Mr - `ErrorResponse.ReferenceList.Traveler.PersonName.Given` (string) Traveler first or given name. Example: John - `ErrorResponse.ReferenceList.Traveler.PersonName.Middle` (string) Traveler middle name. Example: Erick - `ErrorResponse.ReferenceList.Traveler.PersonName.Surname` (string, required) Traveler last name or surname. Example: Smith - `ErrorResponse.ReferenceList.Traveler.PersonName.personNameType` (string) OTA Code Enum: "Former", "Nickname", "Alternate", "Maiden" - `ErrorResponse.ReferenceList.Traveler.PersonName.language` (string) 'ISO639 code of the language the name is represented Example: EN - `ErrorResponse.ReferenceList.Traveler.PersonName.SurnamePrefix` (string) The surname prefix Example: Von - `ErrorResponse.ReferenceList.Traveler.PersonName.Suffix` (string) Traveler name suffix such as Jr. or Sr. Example: Jr. - `ErrorResponse.ReferenceList.Traveler.PersonName.Title` (string) Degree or honors Example: DR - `ErrorResponse.ReferenceList.Traveler.PersonName.Privacy` (object) Confidential details for marketing purpose - `ErrorResponse.ReferenceList.Traveler.PersonName.Privacy.id` (string) Optional internally referenced id Example: 2 - `ErrorResponse.ReferenceList.Traveler.PersonName.Privacy.shareMarketing` (string) Used to indicate marketing preferences, Yes, No, Inherit Enum: "Yes", "No", "Inherit" - `ErrorResponse.ReferenceList.Traveler.PersonName.Privacy.optInStatus` (string) Used to indicate marketing preferences, OptIn, OptOut Enum: "OptedIn", "OptedOut", "Unknown" - `ErrorResponse.ReferenceList.Traveler.PersonName.Privacy.optInDate` (string) The datetime of receiving the opt in notice Example: 2026-08-07T12:12:00Z - `ErrorResponse.ReferenceList.Traveler.PersonName.Privacy.optOutDate` (string) The datetime the opt out notice was received Example: 2026-08-07T12:12:00Z - `ErrorResponse.ReferenceList.Traveler.PersonName.defaultInd` (boolean) If true, this is the default or primary name within a collection of names. Example: true - `ErrorResponse.ReferenceList.Traveler.Address` (array) - `ErrorResponse.ReferenceList.Traveler.Address.@type` (string, required) Discriminator classes Address or AddressDetail Enum: "AddressDetail", "PropertyAddress" - `ErrorResponse.ReferenceList.Traveler.Address.id` (string) unique address id Example: Address_1 - `ErrorResponse.ReferenceList.Traveler.Address.BldgRoom` (object) Address with building and room number - `ErrorResponse.ReferenceList.Traveler.Address.BldgRoom.value` (string) Example: Moore House - `ErrorResponse.ReferenceList.Traveler.Address.BldgRoom.buldingInd` (boolean) When true, the information is a building name. When false, it is an apartment or room # Example: true - `ErrorResponse.ReferenceList.Traveler.Address.Number` (object) The street number alone is the numerical number that precedes the street name in the address. - `ErrorResponse.ReferenceList.Traveler.Address.Number.value` (string) Street number value. Example: 23B - `ErrorResponse.ReferenceList.Traveler.Address.Number.streetNmbrSuffix` (string) Street Number Suffix Example: B - `ErrorResponse.ReferenceList.Traveler.Address.Number.streetDirection` (string) Direction of the Street Example: NW - `ErrorResponse.ReferenceList.Traveler.Address.Number.ruralRouteNmbr` (string) RuralRoute Number Example: 76 - `ErrorResponse.ReferenceList.Traveler.Address.Number.po_Box` (string) PO Box Number Example: 1001 - `ErrorResponse.ReferenceList.Traveler.Address.Street` (string) Street name. May also contain the street number when the Number element is missing. Example: ABC Street - `ErrorResponse.ReferenceList.Traveler.Address.AddressLine` (array) Property street address. Used in place of Street and Number. Each element of the array represents an address line. - `ErrorResponse.ReferenceList.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 - `ErrorResponse.ReferenceList.Traveler.Address.County` (string) County or Region Name. Example: Berkshire - `ErrorResponse.ReferenceList.Traveler.Address.StateProv` (object) The standard code or abbreviation for the state, province, or region. May also include full length name. - `ErrorResponse.ReferenceList.Traveler.Address.StateProv.value` (string) State, province, or region code needed to identify location (typically two characters). Example: CA - `ErrorResponse.ReferenceList.Traveler.Address.StateProv.name` (string) State, province, or region name needed to identify location. Example: California - `ErrorResponse.ReferenceList.Traveler.Address.Country` (object) Contains the information needed to identify a country. - `ErrorResponse.ReferenceList.Traveler.Address.Country.value` (string) The ISO 3166 code for the property's address. Example: US - `ErrorResponse.ReferenceList.Traveler.Address.Country.id` (string) Custom user-assigned identifier for the country. Example: 23 - `ErrorResponse.ReferenceList.Traveler.Address.Country.name` (string) The full name of the country for the property's address. Example: United States - `ErrorResponse.ReferenceList.Traveler.Address.Country.codeContext` (string) The source of a code, such as the organization that provided the id number Example: IATA - `ErrorResponse.ReferenceList.Traveler.Address.PostalCode` (string) Postal code for the address. Example: Sl6 1AB - `ErrorResponse.ReferenceList.Traveler.Address.Addressee` (string) The name of the company or person to be addressed Example: ACME INC - `ErrorResponse.ReferenceList.Traveler.Address.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" - `ErrorResponse.ReferenceList.Traveler.Address.addressType` (string) OTA code for address type Example: CLT - `ErrorResponse.ReferenceList.Traveler.Address.use` (string) OTA code for address use Example: AUT - `ErrorResponse.ReferenceList.Traveler.Address.Comment` (object) Textual information. - `ErrorResponse.ReferenceList.Traveler.Address.Comment.value` (string) Actual text. May be restricted based on the type of comment. Ex: - Notepad remarks: limited to 87 characters. - Traveler name remarks: limited to 33 characters, only spaces and hyphens allowed for special characters. Example: Additional comments - `ErrorResponse.ReferenceList.Traveler.Address.Comment.id` (string) Local identifier within a given message for this object. Example: comment_1 - `ErrorResponse.ReferenceList.Traveler.Address.Comment.name` (string) Title of comment or type of remark. Example: Comment name - `ErrorResponse.ReferenceList.Traveler.Address.Comment.language` (string) Language code using ISO-639 standard Example: EN - `ErrorResponse.ReferenceList.Traveler.Address.Priority` (integer) The priority ranking within the group Example: 1 - `ErrorResponse.ReferenceList.Traveler.Address.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. Example: false - `ErrorResponse.ReferenceList.Traveler.Address.provisionedInd` (boolean) If true, this address came into the system through provisioning Example: false - `ErrorResponse.ReferenceList.Traveler.Telephone` (array) - `ErrorResponse.ReferenceList.Traveler.Telephone.@type` (string, required) Discriminator classes Telephone or TelephoneDetail Enum: "TelephoneDetail" - `ErrorResponse.ReferenceList.Traveler.Telephone.countryAccessCode` (string) Phone country code Example: 1 - `ErrorResponse.ReferenceList.Traveler.Telephone.areaCityCode` (string) Phone local area code Example: 972 - `ErrorResponse.ReferenceList.Traveler.Telephone.phoneNumber` (string, required) Mobile/Telephone Number. Accepted characters are numeric, dash, space, and period. Example: 972-000-787 - `ErrorResponse.ReferenceList.Traveler.Telephone.extension` (string) Telephone extension number Example: 234 - `ErrorResponse.ReferenceList.Traveler.Telephone.id` (string) Optional custom user-assigned identifier for a phone number. Example: 3 - `ErrorResponse.ReferenceList.Traveler.Telephone.cityCode` (string) IATA city code if referenced by phone number. Example: DEN - `ErrorResponse.ReferenceList.Traveler.Telephone.role` (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" - `ErrorResponse.ReferenceList.Traveler.Telephone.phoneLocationType` (string) Location of the phone Example: Agency - `ErrorResponse.ReferenceList.Traveler.Telephone.phoneTechType` (string) Indicates the type of technology associated with the telephone number Example: Voice - `ErrorResponse.ReferenceList.Traveler.Telephone.phoneUseType` (string) Agency code for how phone is used (e.g., Home, Business, Emergency Contact, Travel Arranger, Day, Evening). Example: Home - `ErrorResponse.ReferenceList.Traveler.Telephone.pin` (string) Additional codes used for telephone Example: 3456 - `ErrorResponse.ReferenceList.Traveler.Telephone.priority` (integer) Priority Example: 1 - `ErrorResponse.ReferenceList.Traveler.Telephone.defaultInd` (boolean) When true, indicates a default value should be used. Example: true - `ErrorResponse.ReferenceList.Traveler.Telephone.provisionedInd` (boolean) true indicates this phone number was created through provisioned Example: false - `ErrorResponse.ReferenceList.Traveler.Email` (array) For a reservation Retrieve response, all email addresses are associated with the first traveler on the reservation for GDS. NDC supports contact information for each traveler on the reservation. - `ErrorResponse.ReferenceList.Traveler.Email.value` (string) The email address. Example: exampledomain@example.com - `ErrorResponse.ReferenceList.Traveler.Email.id` (string) Electronic email addresses, in IETF specified format. Example: email_1 - `ErrorResponse.ReferenceList.Traveler.Email.emailType` (string) Use email type to specify if the email is to be sent "TO" or sent "FROM" Example: FROM - `ErrorResponse.ReferenceList.Traveler.Email.comment` (string) Any freeform note for the email, such as its purpose. Example: work email - `ErrorResponse.ReferenceList.Traveler.Email.preferredFormat` (string) Mime media type Example: text/html - `ErrorResponse.ReferenceList.Traveler.Email.optInDate` (string) The datetime of receiving the opt in notice Example: 2026-03-03T11:11:00Z - `ErrorResponse.ReferenceList.Traveler.Email.optOutDate` (string) The datetime the opt out notice was received Example: 2026-03-03T11:11:00Z - `ErrorResponse.ReferenceList.Traveler.Email.validInd` (boolean) If true, this is a valid email address that has been system verified via a successful email transmission. Example: true - `ErrorResponse.ReferenceList.Traveler.Email.provisionedInd` (boolean) If true then the email address came from the provisioning process Example: true - `ErrorResponse.ReferenceList.Traveler.passengerTypeCode` (string) Passenger type code (PTC) for this traveler. Required for all PTCs other than ADT (adult); if not sent defaults to ADT. Some of the common PTCs supported include ADT, INF, INS, CHD, UNN. Private fare PTCs, including INN, JNN, VNN, ITF, JNF, and VFF, may also be supported, subject to airline support. Example: CHD - `ErrorResponse.ReferenceList.Traveler.nationality` (string) Nationality on country code ISO Example: AL - `ErrorResponse.ReferenceList.Traveler.age` (integer) The age of the traveller at the time of travel Example: 13 - `ErrorResponse.ReferenceList.Traveler.CustomerLoyalty` (array) - `ErrorResponse.ReferenceList.Traveler.CustomerLoyalty.value` (string, required) Number on loyalty card. Example: 132456 - `ErrorResponse.ReferenceList.Traveler.CustomerLoyalty.id` (string) Optional Customer Loyalty Id. Not saved Example: Loyalty_1 - `ErrorResponse.ReferenceList.Traveler.CustomerLoyalty.priority` (integer) Optional Numeric Priority Code Example: 2 - `ErrorResponse.ReferenceList.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 - `ErrorResponse.ReferenceList.Traveler.CustomerLoyalty.programName` (string) Supplier's loyalty program name. Example: Frontier-EarlyReturns - `ErrorResponse.ReferenceList.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 - `ErrorResponse.ReferenceList.Traveler.CustomerLoyalty.supplier` (string) Supplier of a loyalty program (typically 2 characters representing the hotel, brand, or airline). Example: UA - `ErrorResponse.ReferenceList.Traveler.CustomerLoyalty.tier` (string) Customer Loyalty tier Example: Silver - `ErrorResponse.ReferenceList.Traveler.CustomerLoyalty.shareWithSupplier` (array) The list of suppliers that the CustomerLoyalty number is shared. Used for cross accrual programs. If valid carrier codes are not sent, the response returns the message NO CROSS ACCRUAL AGREEMENT EXISTS. - `ErrorResponse.ReferenceList.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 - `ErrorResponse.ReferenceList.Traveler.CustomerLoyalty.validatedInd` (boolean) Customer loyalty number has been validated by the supplier Example: true - `ErrorResponse.ReferenceList.Traveler.CustomerLoyalty.prefix` (string) The cardholder name prefix title like Mr, Mrs, Dr Example: Dr - `ErrorResponse.ReferenceList.Traveler.CustomerLoyalty.given` (string) The First Name of the Cardholder Example: John - `ErrorResponse.ReferenceList.Traveler.CustomerLoyalty.middle` (string) Middle Name of the Cardholder Example: Wilkinson - `ErrorResponse.ReferenceList.Traveler.CustomerLoyalty.surname` (string) Last Name of the Cardholder Example: Smith - `ErrorResponse.ReferenceList.Traveler.AlternateContact` (array) - `ErrorResponse.ReferenceList.Traveler.AlternateContact.@type` (string) Example: AlternateContact - `ErrorResponse.ReferenceList.Traveler.AlternateContact.id` (string) - `ErrorResponse.ReferenceList.Traveler.AlternateContact.contactType` (string) Contact type value Example: Relative - `ErrorResponse.ReferenceList.Traveler.AlternateContact.relation` (string) Relation value Example: Mother - `ErrorResponse.ReferenceList.Traveler.AlternateContact.Address` (array) - `ErrorResponse.ReferenceList.Traveler.AlternateContact.Telephone` (array) - `ErrorResponse.ReferenceList.Traveler.AlternateContact.Email` (array) - `ErrorResponse.ReferenceList.Traveler.AlternateContact.emergencyInd` (boolean) This is the contact in case of an emergency Example: true - `ErrorResponse.ReferenceList.Traveler.AlternateContact.defaultInd` (boolean) This is the default contact Example: true - `ErrorResponse.ReferenceList.Traveler.TravelDocument` (array) - `ErrorResponse.ReferenceList.Traveler.TravelDocument.@type` (string, required) Discriminator classes TravelDocument or TravelDocumentDetail Enum: "TravelDocumentDetail" - `ErrorResponse.ReferenceList.Traveler.TravelDocument.docNumber` (string) Travel document number. Example: B37201 - `ErrorResponse.ReferenceList.Traveler.TravelDocument.docType` (string) Supported Travel Document types 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" - `ErrorResponse.ReferenceList.Traveler.TravelDocument.issueDate` (string) Issue date of document. Required for a visa Example: 2002-10-13 - `ErrorResponse.ReferenceList.Traveler.TravelDocument.expireDate` (string) Expiration date of document. Required for a visa. Example: 2002-11-13 - `ErrorResponse.ReferenceList.Traveler.TravelDocument.stateProvCode` (string) State Province Code value Example: 44 - `ErrorResponse.ReferenceList.Traveler.TravelDocument.placeOfIssue` (string) Place of issue value Example: Birmingham - `ErrorResponse.ReferenceList.Traveler.TravelDocument.issueCountry` (string) Issuing country of document; ISO3166 standard format. Example: CA - `ErrorResponse.ReferenceList.Traveler.TravelDocument.birthDate` (string) The date of birth of the document holder in YYYY-MM-DD format. Example: 1995-04-22 - `ErrorResponse.ReferenceList.Traveler.TravelDocument.birthCountry` (string) Country of birth of the document holder in ISO3166 standard format. Example: AR - `ErrorResponse.ReferenceList.Traveler.TravelDocument.birthPlace` (string) Birth place value Example: Ontario - `ErrorResponse.ReferenceList.Traveler.TravelDocument.residence` (string) Residence value Example: 1st section 8th st - `ErrorResponse.ReferenceList.Traveler.TravelDocument.id` (string) Locally referenced id Example: 34 - `ErrorResponse.ReferenceList.Traveler.TravelDocument.Nationality` (string) Birth country as noted on document; specifies a 2 character country code as defined in ISO3166. Example: BR - `ErrorResponse.ReferenceList.Traveler.TravelDocument.IssuedForGeoPoliticalArea` (object) The location code of the geographical location. Codes from Ref Pub - `ErrorResponse.ReferenceList.Traveler.TravelDocument.IssuedForGeoPoliticalArea.value` (string) Example: G - `ErrorResponse.ReferenceList.Traveler.TravelDocument.IssuedForGeoPoliticalArea.level` (string) Represents the type of geopolitical area (country, Continent, State etc) Enum: "World", "Global Area", "Continent Group", "Continent", "Country", "StateProvince", "City", "Airport" - `ErrorResponse.ReferenceList.Traveler.TravelDocument.IssuedForGeoPoliticalArea.id` (string) Optional internally referenced id Example: 2 - `ErrorResponse.ReferenceList.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. In Traveler this is used to send custom freeform traveler name remarks, such as a unique identifier for a given traveler. Not supported for addition/deletion in Traveler Modify. - `ErrorResponse.ReferenceList.Traveler.Comments.@type` (string) Example: Comments - `ErrorResponse.ReferenceList.Traveler.Comments.Comment` (array) - `ErrorResponse.ReferenceList.Traveler.RailDiscountCard` (array) - `ErrorResponse.ReferenceList.Traveler.RailDiscountCard.value` (string) Example: Rail1234546 - `ErrorResponse.ReferenceList.Traveler.RailDiscountCard.supplierCode` (string, required) Code of the Supplier Example: Enco - `ErrorResponse.ReferenceList.Traveler.RailDiscountCard.referenceNumber` (string) ReferenceNumber Example: 134256 - `ErrorResponse.ReferenceList.Traveler.accompaniedByInfantInd` (boolean) Example: true - `ErrorResponse.ReferenceList.Offer` (array) - `ErrorResponse.ReferenceList.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. Enum: "Offer" - `ErrorResponse.ReferenceList.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 - `ErrorResponse.ReferenceList.Offer.offerRef` (string) Used to reference another instance of this object in the same message Example: offer_1 - `ErrorResponse.ReferenceList.Offer.ContentSource` (string) Indicates the owner the offer or document. Enum: "GDS", "NDC", "LCC", "API" - `ErrorResponse.ReferenceList.Offer.parentOfferRef` (string) A reference to the Offer this offer is sold in conjunction with Example: offer_1 - `ErrorResponse.ReferenceList.Offer.offerModifyRef` (string) Reference to the new Offer created as a result of this Offer being subject to a schedule change. - `ErrorResponse.ReferenceList.Offer.Product` (array, required) Lists the flight or flights for one leg of the itinerary. Repeats for additional leg or legs. - `ErrorResponse.ReferenceList.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. Certain types of offers on a booking, such as seats and ancillaries, generally include only the CurrencyCode, Base, and TotalPrice objects. - `ErrorResponse.ReferenceList.Offer.Price.@type` (string, required) Discriminator classes Price or PriceDetail Enum: "PriceDetail" - `ErrorResponse.ReferenceList.Offer.Price.id` (string) Internally referenced id Example: 2 - `ErrorResponse.ReferenceList.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. - `ErrorResponse.ReferenceList.Offer.Price.CurrencyCode.value` (string) An ISO 4217 currency code. Example: USD - `ErrorResponse.ReferenceList.Offer.Price.CurrencyCode.codeAuthority` (string) Currency code authority Example: ISO 4217 - `ErrorResponse.ReferenceList.Offer.Price.CurrencyCode.decimalPlace` (integer) Number of decimal places for the currency. Example: 2 - `ErrorResponse.ReferenceList.Offer.Price.CurrencyCode.decimalAuthority` (string) Currency code decimal authority Example: ISO 4217 - `ErrorResponse.ReferenceList.Offer.Price.Base` (number) Base price before taxes and fees. For Hotel, may not be returned by all suppliers. Example: 20.2 - `ErrorResponse.ReferenceList.Offer.Price.TotalTaxes` (number) Total taxes applied to the base price. For Hotel, may not be returned by all suppliers. Example: 34.4 - `ErrorResponse.ReferenceList.Offer.Price.TotalFees` (number) Total fees included in Total Price. Example: 201 - `ErrorResponse.ReferenceList.Offer.Price.TotalPrice` (number) Total price of this offer including the base price and all taxes and fees. Example: 34 - `ErrorResponse.ReferenceList.Offer.Price.VendorCurrencyTotal` (object) No longer used. Previously used to expose the local vendor currency when it is different to the purchased currency - `ErrorResponse.ReferenceList.Offer.Price.VendorCurrencyTotal.@type` (string) - `ErrorResponse.ReferenceList.Offer.Price.VendorCurrencyTotal.currencySource` (string) The system requesting or returning the currency code specified in the attribute Enum: "Supplier", "Charged", "Requested" - `ErrorResponse.ReferenceList.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 - `ErrorResponse.ReferenceList.Offer.Price.VendorCurrencyTotal.Taxes` (object) Summary of all individual taxes. Child class TaxesDetail provides the breakdown of individual taxes. - `ErrorResponse.ReferenceList.Offer.Price.VendorCurrencyTotal.Taxes.@type` (string, required) Discriminator class is TaxesDetail Enum: "TaxesDetail" - `ErrorResponse.ReferenceList.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 - `ErrorResponse.ReferenceList.Offer.Price.VendorCurrencyTotal.Taxes.TaxInfo` (array) Returned for TripChange APIS only. - `ErrorResponse.ReferenceList.Offer.Price.VendorCurrencyTotal.Taxes.Tax` (array) - `ErrorResponse.ReferenceList.Offer.Price.VendorCurrencyTotal.Taxes.TaxPercent` (object) Returned when the tax is expressed as a percentage of the amount. - `ErrorResponse.ReferenceList.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. - `ErrorResponse.ReferenceList.Offer.Price.VendorCurrencyTotal.Fees.@type` (string, required) Discriminator. Child class FeesDetail Enum: "FeesDetail" - `ErrorResponse.ReferenceList.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: 55 - `ErrorResponse.ReferenceList.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: 25 - `ErrorResponse.ReferenceList.Offer.Price.VendorCurrencyTotal.Fees.Fee` (array) Array of individual fees. - `ErrorResponse.ReferenceList.Offer.Price.VendorCurrencyTotal.Total` (number) Specifies the total price including base + taxes + fees Example: 30.13 - `ErrorResponse.ReferenceList.Offer.Price.VendorCurrencyTotal.approximateInd` (boolean) True if this amount has been converted from the original amount Example: true - `ErrorResponse.ReferenceList.Offer.Price.FlightPassCredits` (integer) Indicates the number of flight pass credits the offer “costs” for all passengers. Air Canada NDC only. Example: 2 - `ErrorResponse.ReferenceList.Offer.Price.PriceBreakdown` (array) - `ErrorResponse.ReferenceList.Offer.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. Enum: "PriceBreakdownAir", "PriceBreakdownAncillary", "PriceBreakdownHospitality", "PriceBreakdownVehiclePrice", "PriceBreakdownVehicleDeposit", "PriceBreakdownVehicleCharges" - `ErrorResponse.ReferenceList.Offer.Price.PriceBreakdown.Amount` (object) Amount represents the cost applied. - `ErrorResponse.ReferenceList.Offer.Price.PriceBreakdown.Commission` (object) 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). - `ErrorResponse.ReferenceList.Offer.TermsAndConditionsFull` (array) For Hotel Rules and Reservation responses, this array will contain a single TermsAndConditionsFullHospitality entry. Cancellation terms with multiple time periods are represented within that entry's CancelPenalty array rather than as multiple TermsAndConditionsFull entries. For Two-Step Commit (FLights), this is a standard object, no changes. For Unified Checkout (Flights), if no payment information was sent in the request, the booking is confirmed by the airline but not yet ticketed. This object provides the payment and ticketing time limits in ExpiryDate and PaymentTimeLimit. - `ErrorResponse.ReferenceList.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. Enum: "TermsAndConditionsFull", "TermsAndConditionsFullSummary" - `ErrorResponse.ReferenceList.Offer.TermsAndConditionsFull.id` (string) Local identifier within a given message for this object. Example: TC_1 - `ErrorResponse.ReferenceList.Offer.TermsAndConditionsFull.termsAndConditionsRef` (string) Used to reference another instance of this object in the same message. Example: TC_1 - `ErrorResponse.ReferenceList.Offer.TermsAndConditionsFull.ExpiryDate` (string) The date and time in UTC the offer will no longer be valid. Example: 2022-08-07T12:12:00Z - `ErrorResponse.ReferenceList.Offer.TermsAndConditionsFull.CustomerLoyalty` (array) - `ErrorResponse.ReferenceList.Offer.TermsAndConditionsFull.TextBlock` (array) A list of free text terms and conditions. - `ErrorResponse.ReferenceList.Offer.TermsAndConditionsFull.ExpiryDate` (string) The data and time the offer will expire Example: 2022-08-07T12:12:00Z - `ErrorResponse.ReferenceList.Offer.TermsAndConditionsFull.TextBlock` (array) - `ErrorResponse.ReferenceList.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 - `ErrorResponse.ReferenceList.Offer.scheduleChangeInd` (boolean) - If true: this Offer is subject to a schedule change. May be seen in a Two-step Commit, on the first Commit response payload, in the event of a schedule change. If this is the case, the Product object returns previous and updated schedule details in two instances of Product/FlightSegment as follows: - The previous flight segment is identified with sequence=1 and Flight/id=flight_1 - The updated flight segment is identified with sequence=2 and Flight/id=flight_2 Offer includes a ModifyPrice object; however, unless a price change has also occurred, Offer/Price repeats the original price of the offer and Offer/ModifyPrice returns all amounts as zero (0) to indicate there is no price change. NDC only - for Reservation Retrieve, when an airline-initiated flight change has occurred, the response also returns the Offer object with @type OfferModify and scheduleChangeInd=true to indicate a change has occurred. See [NDC Flight Disruption Handing](https://developer.travelport.com/docs/flights/guides/booking-and-reservations/flights-booking-guide#ndc-flight-disruption-handling-involuntary-changes) in the Air Booking Guide for details. - `ErrorResponse.ReferenceList.Brand` (array) Each instance provides details for one BrandRef id. - `ErrorResponse.ReferenceList.Brand.@type` (string, required) Discriminator. Child classes BrandID and Brand. BrandCompleteInfo is no longer in use. Enum: "Brand" - `ErrorResponse.ReferenceList.Brand.id` (string) Local id within a given message to support referencing this object. Example: brand_001 - `ErrorResponse.ReferenceList.Brand.BrandRef` (string) Reference id that corresponds to the brand 'id' in ReferenceListBrand.Brand. Example: brandRef_001 - `ErrorResponse.ReferenceList.Brand.name` (string, required) Brand name from the supplier. Example: Main Cabin Extra - `ErrorResponse.ReferenceList.Brand.tier` (integer) The brand tier. Not returned for NDC. Example: 2 - `ErrorResponse.ReferenceList.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] - `ErrorResponse.ReferenceList.Brand.code` (string) The ATPCO Brand Code. Example: REFMAIN - `ErrorResponse.ReferenceList.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. - `ErrorResponse.ReferenceList.Brand.BrandAttribute.@type` (string, required) Discriminator. No child classes. Example: BrandAttribute - `ErrorResponse.ReferenceList.Brand.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" - `ErrorResponse.ReferenceList.Brand.BrandAttribute.inclusion` (string, required) The indicator as to how the brand and the product are associated. Enum: "Included", "Chargeable", "Not Offered" - `ErrorResponse.ReferenceList.Brand.BrandAttribute.ImageURL` (array) URL for an image for the brand, when available. Example: ["http:/imageurl.com"] - `ErrorResponse.ReferenceList.Brand.BrandAttribute.matchedAttributeInd` (boolean) Returned only if true for any attribute requested in ProductInclusionPreference.Classification. Example: true - `ErrorResponse.ReferenceList.Brand.BrandAttribute.groupCode` (string) Carrier group code. Returned if filed by the carrier. Example: BG - `ErrorResponse.ReferenceList.Brand.BrandAttribute.subGroupCode` (string) Carrier sub group code. Returned if filed by the carrier. Example: CY - `ErrorResponse.ReferenceList.Brand.BrandAttribute.subCode` (string) Carrier sub code. Returned if filed by the carrier. Example: 08A - `ErrorResponse.ReferenceList.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. - `ErrorResponse.ReferenceList.Brand.AdditionalBrandAttribute.@type` (string, required) Discriminator. No child classes. Example: AdditionalBrandAttribute - `ErrorResponse.ReferenceList.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 - `ErrorResponse.ReferenceList.Brand.AdditionalBrandAttribute.ImageURL` (array) URL for an image for the brand, when available. Example: ["https:/travelport/image/profile/firstviewimage"] - `ErrorResponse.ReferenceList.Brand.AdditionalBrandAttribute.matchedAttributeInd` (boolean) Returned only if true for any attribute requested in ProductInclusionPreference.Classification. Example: true - `ErrorResponse.ReferenceList.Brand.AdditionalBrandAttribute.groupCode` (string) Carrier group code. Returned if filed by the carrier. Example: BG - `ErrorResponse.ReferenceList.Brand.AdditionalBrandAttribute.subGroupCode` (string) Carrier sub group code. Returned if filed by the carrier. Example: CY - `ErrorResponse.ReferenceList.Brand.AdditionalBrandAttribute.subCode` (string) Carrier sub code. Returned if filed by the carrier. Example: 08A - `ErrorResponse.ReferenceList.Brand.ImageURL` (array) Example: ["http:/imageurl.com"] - `ErrorResponse.ReferenceList.TermsAndConditions` (array) - `ErrorResponse.ReferenceList.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. Enum: "TermsAndConditions" - `ErrorResponse.ReferenceList.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 - `ErrorResponse.ReferenceList.TermsAndConditions.termsAndConditionsRef` (string) Reference id that corresponds to the TermsAndConditions 'id' in ReferenceListTermsAndConditions.TermsAndConditions. Example: TC_1 - `ErrorResponse.ReferenceList.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 - `ErrorResponse.ReferenceList.TermsAndConditions.CustomerLoyalty` (array) - `ErrorResponse.ReferenceList.Price` (array, required) - `ErrorResponse.CurrencyRateConversion` (array) - `ErrorResponse.CurrencyRateConversion.@type` (string) - `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 ## Response 500: - `500` (unknown) Internal Server Error - 500 ## Response 500 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 flows. Example: 49f58f5f-c443-43b4-9f5d-be405fd00a01 - `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. See [Error Messaging](https://developer.travelport.com/docs/flights/general/error-messaging) for additional details. - `ErrorResponse.Result.@type` (string) Discriminator class Result only Example: Result - `ErrorResponse.Result.status` (string) The status of an error or warning Enum: "Not processed", "Incomplete", "Complete", "Unknown" - `ErrorResponse.Result.Error` (array) A list of error information returned at the provider level for a response. - `ErrorResponse.Result.Error.@type` (string, required) Discriminator classes Error or ErrorDetail Enum: "ErrorDetail" - `ErrorResponse.Result.Error.StatusCode` (integer) Http standard response code Example: 200 - `ErrorResponse.Result.Error.Message` (string) The Travelport standardized error or warning message Example: No flights found. - `ErrorResponse.Result.Error.NameValuePair` (array) - `ErrorResponse.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 - `ErrorResponse.Result.Error.NameValuePair.id` (string) Optional internally referenced id Example: 6 - `ErrorResponse.Result.Error.NameValuePair.name` (string, required) Key, categorizing the type of remark or error. Example: Day1 - `ErrorResponse.Result.Error.category` (string) A category to assist in identifying the error Example: VALIDATION - `ErrorResponse.Result.Error.SourceID` (string) The identifier of the source system sending the error or warning Example: 1G - `ErrorResponse.Result.Error.SourceCode` (string) The error or warning code returned by the source airline or host system Example: 1234 - `ErrorResponse.Result.Error.SourceDescription` (string) The error or warning message as it is returned by the source airline or host system - `ErrorResponse.Result.Warning` (array) A list of warning information returned at the provider level for a response. - `ErrorResponse.Result.Warning.@type` (string, required) Discriminator classes Warning or WarningDetail Enum: "WarningDetail" - `ErrorResponse.Result.Warning.StatusCode` (integer) Http standard response code Example: 200 - `ErrorResponse.Result.Warning.Message` (string) The Travelport standardized error or warning message Example: Customer Loyalty could not be applied. - `ErrorResponse.Result.Warning.NameValuePair` (array) - `ErrorResponse.Result.Warning.category` (string) A category to assist in identifying the error Example: INFORMATION - `ErrorResponse.Result.Warning.SourceID` (string) The identifier of the source system sending the error or warning Example: 1G - `ErrorResponse.Result.Warning.SourceCode` (string) The error or warning code returned by the source airline or host system Example: 1234 - `ErrorResponse.Result.Warning.SourceDescription` (string) The error or warning message as it is returned by the source airline or host system - `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.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 system generated 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'. - If not available, for Payment, any unique identifier can be sent. 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 - `ErrorResponse.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 - `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 Example: www.travelport.com - `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) - `ErrorResponse.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. Enum: "ReferenceListSeatingChart", "ReferenceListFlight", "ReferenceListAmenity", "ReferenceListProduct", "ReferenceListTraveler", "ReferenceListOffer", "ReferenceListBrand", "ReferenceListTermsAndConditions", "ReferenceListExchangedPrice" - `ErrorResponse.ReferenceList.id` (string) Uniquely identifies for the Reference List Example: referenceList_001 - `ErrorResponse.ReferenceList.SeatingChart` (array) - `ErrorResponse.ReferenceList.SeatingChart.@type` (string, required) Discriminator. Enum: "SeatingChart" - `ErrorResponse.ReferenceList.SeatingChart.id` (string) Internally reference id - `ErrorResponse.ReferenceList.SeatingChart.Cabin` (array, required) - `ErrorResponse.ReferenceList.SeatingChart.Cabin.@type` (string) Example: Cabin - `ErrorResponse.ReferenceList.SeatingChart.Cabin.name` (string, required) The name of the cabin Example: Economy - `ErrorResponse.ReferenceList.SeatingChart.Cabin.Layout` (array, required) - `ErrorResponse.ReferenceList.SeatingChart.Cabin.Layout.value` (string) - `ErrorResponse.ReferenceList.SeatingChart.Cabin.Layout.position` (array, required) - `ErrorResponse.ReferenceList.SeatingChart.Cabin.Layout.startRow` (integer, required) Start row for this Cabin Layout - `ErrorResponse.ReferenceList.SeatingChart.Cabin.Layout.endRow` (integer, required) End row for this Cabin Layout - `ErrorResponse.ReferenceList.SeatingChart.Cabin.Row` (array, required) - `ErrorResponse.ReferenceList.SeatingChart.Cabin.Row.@type` (string) Example: Row - `ErrorResponse.ReferenceList.SeatingChart.Cabin.Row.label` (string) The identifier for the row Example: 78 - `ErrorResponse.ReferenceList.SeatingChart.Cabin.Row.Space` (array, required) - `ErrorResponse.ReferenceList.SeatingChart.Cabin.Row.Characteristic` (array) - `ErrorResponse.ReferenceList.Flight` (array, required) - `ErrorResponse.ReferenceList.Flight.@type` (string, required) Discriminator. Child classes Flight and FlightDetail. Enum: "Flight" - `ErrorResponse.ReferenceList.Flight.id` (string) Local id within a given message to support referencing this object - an internal flight identifier. Example: 126 - `ErrorResponse.ReferenceList.Flight.FlightRef` (string) Reference id that corresponds to the flight 'id' in ReferenceListFlight.Flight. Example: s1 - `ErrorResponse.ReferenceList.Flight.distance` (integer) Distance covered by the flight. Example: 6574 - `ErrorResponse.ReferenceList.Flight.stops` (integer) Number of stops Example: 2 - `ErrorResponse.ReferenceList.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 - `ErrorResponse.ReferenceList.Flight.carrier` (string, required) The airline code. Example: BA - `ErrorResponse.ReferenceList.Flight.number` (string, required) The marketing carrier flight number. Example: 98 - `ErrorResponse.ReferenceList.Flight.operatingCarrier` (string) The operating airline IATA code. Shown in codeshare situations when the operating carrier is different to the marketing carrier. Example: BA - `ErrorResponse.ReferenceList.Flight.operatingCarrierName` (string) Name of the marketing operating carrier. Example: Liberty Aerospace - `ErrorResponse.ReferenceList.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 - `ErrorResponse.ReferenceList.Flight.equipment` (string) Equipment model. Note that TRN, TRS, and BUS equipment codes indicate ground transportation. Example: 777 - `ErrorResponse.ReferenceList.Flight.Departure` (object, required) Departure details for a given leg. - `ErrorResponse.ReferenceList.Flight.Departure.@type` (string, required) Discriminator classes Departure or DepartureDetail Enum: "DepartureDetail" - `ErrorResponse.ReferenceList.Flight.Departure.location` (string, required) IATA code for departure airport or city for this leg of the itinerary. Example: AMS - `ErrorResponse.ReferenceList.Flight.Departure.date` (string, required) Departure date in YYYY-MM-DD format. Example: 0011-10-17 - `ErrorResponse.ReferenceList.Flight.Departure.time` (string, required) Departure date in HH:mm:ss (24-hour format). Example: 04:45:00 - `ErrorResponse.ReferenceList.Flight.Departure.terminal` (string) Departure terminal, returned when available. Example: Terminal 1 - `ErrorResponse.ReferenceList.Flight.Departure.country` (string) Country of to departure or arrival Example: US - `ErrorResponse.ReferenceList.Flight.Arrival` (object, required) Arrival information. - `ErrorResponse.ReferenceList.Flight.Arrival.@type` (string, required) Discriminator classes Arrival or ArrivalDetail Enum: "ArrivalDetail" - `ErrorResponse.ReferenceList.Flight.Arrival.location` (string, required) IATA code for arrival airport or city for this leg of the itinerary. Example: MAD - `ErrorResponse.ReferenceList.Flight.Arrival.date` (string, required) Arrival date in YYYY-MM-DD format. Example: 0011-10-17 - `ErrorResponse.ReferenceList.Flight.Arrival.time` (string) Arrival date in HH:mm:ss (24-hour format). Example: 04:45:00 - `ErrorResponse.ReferenceList.Flight.Arrival.terminal` (string) Arrival terminal, returned when available. Example: Terminal 1 - `ErrorResponse.ReferenceList.Flight.Arrival.country` (string) Country of to departure or arrival Example: US - `ErrorResponse.ReferenceList.Flight.IntermediateStop` (array) GDS only; not supported for NDC. Returned if the flight has a technical stop but does not incur a change in flight number. - `ErrorResponse.ReferenceList.Flight.IntermediateStop.value` (string) The IATA airport code for the airport where the intermediate stop occurs. - `ErrorResponse.ReferenceList.Flight.IntermediateStop.arrivalFlightDuration` (string) Duration in hours and minutes of the flight arriving at the intermediate stop. ISO 8601 format Example: PT2H35M - `ErrorResponse.ReferenceList.Flight.IntermediateStop.departureFlightDuration` (string) Duration in hours and minutes of the flight departing the intermediate stop. ISO 8601 format Example: PT1H35M - `ErrorResponse.ReferenceList.Flight.IntermediateStop.duration` (string) Duration in hours and minutes between the arrival and departure at the intermediate stop. ISO 8601 format Example: PT1H35M - `ErrorResponse.ReferenceList.Flight.IntermediateStop.equipment` (string) Equipment model, if there is a change of equipment during the stop. Example: 777 - `ErrorResponse.ReferenceList.Flight.IntermediateStop.arrivalDate` (string) The local date the aircraft arrives at the intermediate stop Example: 2026-04-30 - `ErrorResponse.ReferenceList.Flight.IntermediateStop.departureDate` (string) The local date the aircraft departs from the intermediate stop Example: 2026-04-30 - `ErrorResponse.ReferenceList.Flight.IntermediateStop.arrivalTime` (string) The local time the aircraft arrives at the intermediate stop Example: 68400 - `ErrorResponse.ReferenceList.Flight.IntermediateStop.departurelTime` (string) The local time the aircraft departs from the intermediate stop Example: 72000 - `ErrorResponse.ReferenceList.Flight.IntermediateStop.arrivalTerminal` (string) Arrival terminal of the intermediate stop airport Example: Terminal2 - `ErrorResponse.ReferenceList.Flight.IntermediateStop.departureTerminal` (string) Departure terminal of the intermediate stop airport Example: Terminal4 - `ErrorResponse.ReferenceList.Flight.subjectToGovernmentApprovalInd` (boolean) GDS only, not supported for NDC. - If true: the airline has filed in its schedule that availability for a specific flight is subject to government approval. Returned only in the Air Search API response. Example: true - `ErrorResponse.ReferenceList.Amenity` (array, required) One instance for each specific amenity. - `ErrorResponse.ReferenceList.Amenity.@type` (string, required) Discriminator. No child classes. Example: Amenity - `ErrorResponse.ReferenceList.Amenity.id` (string, required) A unique Travelport-assigned amenity id used for cross-referencing by each flight with this amenity. Example: amenity_001 - `ErrorResponse.ReferenceList.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 - `ErrorResponse.ReferenceList.Amenity.Text` (object) A free text description of the amenity. - `ErrorResponse.ReferenceList.Amenity.Text.value` (string) A short free text description. - `ErrorResponse.ReferenceList.Amenity.Text.language` (string) The language the text is provided in. ISO639 format. Example: EN - `ErrorResponse.ReferenceList.Product` (array) - `ErrorResponse.ReferenceList.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. Enum: "Product" - `ErrorResponse.ReferenceList.Product.id` (string) Local id within a given message to support referencing this object. Example: product_1 - `ErrorResponse.ReferenceList.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 - `ErrorResponse.ReferenceList.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 - `ErrorResponse.ReferenceList.Traveler` (array) - `ErrorResponse.ReferenceList.Traveler.@type` (string, required) Discriminator classes TravelerID or Traveler Enum: "Traveler" - `ErrorResponse.ReferenceList.Traveler.id` (string) Send value of travelerRefId_1 for the first traveler, then increment for each additional traveler (e.g., travelerRefId_2). Traveler/id is only mandatory when referenced elsewhere in the request, such as in SpecialService and PrimaryContact (TravelerIdentifier/Identifier/value). - `ErrorResponse.ReferenceList.Traveler.TravelerRef` (string) - `ErrorResponse.ReferenceList.Traveler.birthDate` (string) Date of birth in YYYY-MM-DD format. The TripServices APIs require this object only for infant and child PTC types (e.g., INF, INS, CHD, UNN). When sending [minimum secure flight information](https://developer.travelport.com/docs/flights/guides/booking-and-reservations/remarks-and-service-requests#minimum-secure-flight-information-ssr-docs), which is required by some carriers, this object is required for all PTCs. Example: 2021-06-05 - `ErrorResponse.ReferenceList.Traveler.gender` (string) Gender Type Male, Female etc. When sending [minimum secure flight information](https://developer.travelport.com/docs/flights/guides/booking-and-reservations/remarks-and-service-requests#minimum-secure-flight-information-ssr-docs) in the Traveler object, which is required by some carriers, this object is required for all PTCs. This field is not used by Hotel APIs and will be ignored. Enum: "Male", "Female", "Unknown", "Undisclosed" - `ErrorResponse.ReferenceList.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. - `ErrorResponse.ReferenceList.Traveler.PersonName.@type` (string, required) Discriminator classes PersonName or PersonNameDetail Enum: "PersonNameDetail" - `ErrorResponse.ReferenceList.Traveler.PersonName.Prefix` (string) Salutation of honorific (e.g. Mr., Mrs., Ms., Miss, Dr.) Example: Mr - `ErrorResponse.ReferenceList.Traveler.PersonName.Given` (string) Traveler first or given name. Example: John - `ErrorResponse.ReferenceList.Traveler.PersonName.Middle` (string) Traveler middle name. Example: Erick - `ErrorResponse.ReferenceList.Traveler.PersonName.Surname` (string, required) Traveler last name or surname. Example: Smith - `ErrorResponse.ReferenceList.Traveler.PersonName.personNameType` (string) OTA Code Enum: "Former", "Nickname", "Alternate", "Maiden" - `ErrorResponse.ReferenceList.Traveler.PersonName.language` (string) 'ISO639 code of the language the name is represented Example: EN - `ErrorResponse.ReferenceList.Traveler.PersonName.SurnamePrefix` (string) The surname prefix Example: Von - `ErrorResponse.ReferenceList.Traveler.PersonName.Suffix` (string) Traveler name suffix such as Jr. or Sr. Example: Jr. - `ErrorResponse.ReferenceList.Traveler.PersonName.Title` (string) Degree or honors Example: DR - `ErrorResponse.ReferenceList.Traveler.PersonName.Privacy` (object) Confidential details for marketing purpose - `ErrorResponse.ReferenceList.Traveler.PersonName.Privacy.id` (string) Optional internally referenced id Example: 2 - `ErrorResponse.ReferenceList.Traveler.PersonName.Privacy.shareMarketing` (string) Used to indicate marketing preferences, Yes, No, Inherit Enum: "Yes", "No", "Inherit" - `ErrorResponse.ReferenceList.Traveler.PersonName.Privacy.optInStatus` (string) Used to indicate marketing preferences, OptIn, OptOut Enum: "OptedIn", "OptedOut", "Unknown" - `ErrorResponse.ReferenceList.Traveler.PersonName.Privacy.optInDate` (string) The datetime of receiving the opt in notice Example: 2026-08-07T12:12:00Z - `ErrorResponse.ReferenceList.Traveler.PersonName.Privacy.optOutDate` (string) The datetime the opt out notice was received Example: 2026-08-07T12:12:00Z - `ErrorResponse.ReferenceList.Traveler.PersonName.defaultInd` (boolean) If true, this is the default or primary name within a collection of names. Example: true - `ErrorResponse.ReferenceList.Traveler.Address` (array) - `ErrorResponse.ReferenceList.Traveler.Address.@type` (string, required) Discriminator classes Address or AddressDetail Enum: "AddressDetail", "PropertyAddress" - `ErrorResponse.ReferenceList.Traveler.Address.id` (string) unique address id Example: Address_1 - `ErrorResponse.ReferenceList.Traveler.Address.BldgRoom` (object) Address with building and room number - `ErrorResponse.ReferenceList.Traveler.Address.BldgRoom.value` (string) Example: Moore House - `ErrorResponse.ReferenceList.Traveler.Address.BldgRoom.buldingInd` (boolean) When true, the information is a building name. When false, it is an apartment or room # Example: true - `ErrorResponse.ReferenceList.Traveler.Address.Number` (object) The street number alone is the numerical number that precedes the street name in the address. - `ErrorResponse.ReferenceList.Traveler.Address.Number.value` (string) Street number value. Example: 23B - `ErrorResponse.ReferenceList.Traveler.Address.Number.streetNmbrSuffix` (string) Street Number Suffix Example: B - `ErrorResponse.ReferenceList.Traveler.Address.Number.streetDirection` (string) Direction of the Street Example: NW - `ErrorResponse.ReferenceList.Traveler.Address.Number.ruralRouteNmbr` (string) RuralRoute Number Example: 76 - `ErrorResponse.ReferenceList.Traveler.Address.Number.po_Box` (string) PO Box Number Example: 1001 - `ErrorResponse.ReferenceList.Traveler.Address.Street` (string) Street name. May also contain the street number when the Number element is missing. Example: ABC Street - `ErrorResponse.ReferenceList.Traveler.Address.AddressLine` (array) Property street address. Used in place of Street and Number. Each element of the array represents an address line. - `ErrorResponse.ReferenceList.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 - `ErrorResponse.ReferenceList.Traveler.Address.County` (string) County or Region Name. Example: Berkshire - `ErrorResponse.ReferenceList.Traveler.Address.StateProv` (object) The standard code or abbreviation for the state, province, or region. May also include full length name. - `ErrorResponse.ReferenceList.Traveler.Address.StateProv.value` (string) State, province, or region code needed to identify location (typically two characters). Example: CA - `ErrorResponse.ReferenceList.Traveler.Address.StateProv.name` (string) State, province, or region name needed to identify location. Example: California - `ErrorResponse.ReferenceList.Traveler.Address.Country` (object) Contains the information needed to identify a country. - `ErrorResponse.ReferenceList.Traveler.Address.Country.value` (string) The ISO 3166 code for the property's address. Example: US - `ErrorResponse.ReferenceList.Traveler.Address.Country.id` (string) Custom user-assigned identifier for the country. Example: 23 - `ErrorResponse.ReferenceList.Traveler.Address.Country.name` (string) The full name of the country for the property's address. Example: United States - `ErrorResponse.ReferenceList.Traveler.Address.Country.codeContext` (string) The source of a code, such as the organization that provided the id number Example: IATA - `ErrorResponse.ReferenceList.Traveler.Address.PostalCode` (string) Postal code for the address. Example: Sl6 1AB - `ErrorResponse.ReferenceList.Traveler.Address.Addressee` (string) The name of the company or person to be addressed Example: ACME INC - `ErrorResponse.ReferenceList.Traveler.Address.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" - `ErrorResponse.ReferenceList.Traveler.Address.addressType` (string) OTA code for address type Example: CLT - `ErrorResponse.ReferenceList.Traveler.Address.use` (string) OTA code for address use Example: AUT - `ErrorResponse.ReferenceList.Traveler.Address.Comment` (object) Textual information. - `ErrorResponse.ReferenceList.Traveler.Address.Comment.value` (string) Actual text. May be restricted based on the type of comment. Ex: - Notepad remarks: limited to 87 characters. - Traveler name remarks: limited to 33 characters, only spaces and hyphens allowed for special characters. Example: Additional comments - `ErrorResponse.ReferenceList.Traveler.Address.Comment.id` (string) Local identifier within a given message for this object. Example: comment_1 - `ErrorResponse.ReferenceList.Traveler.Address.Comment.name` (string) Title of comment or type of remark. Example: Comment name - `ErrorResponse.ReferenceList.Traveler.Address.Comment.language` (string) Language code using ISO-639 standard Example: EN - `ErrorResponse.ReferenceList.Traveler.Address.Priority` (integer) The priority ranking within the group Example: 1 - `ErrorResponse.ReferenceList.Traveler.Address.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. Example: false - `ErrorResponse.ReferenceList.Traveler.Address.provisionedInd` (boolean) If true, this address came into the system through provisioning Example: false - `ErrorResponse.ReferenceList.Traveler.Telephone` (array) - `ErrorResponse.ReferenceList.Traveler.Telephone.@type` (string, required) Discriminator classes Telephone or TelephoneDetail Enum: "TelephoneDetail" - `ErrorResponse.ReferenceList.Traveler.Telephone.countryAccessCode` (string) Phone country code Example: 1 - `ErrorResponse.ReferenceList.Traveler.Telephone.areaCityCode` (string) Phone local area code Example: 972 - `ErrorResponse.ReferenceList.Traveler.Telephone.phoneNumber` (string, required) Mobile/Telephone Number. Accepted characters are numeric, dash, space, and period. Example: 972-000-787 - `ErrorResponse.ReferenceList.Traveler.Telephone.extension` (string) Telephone extension number Example: 234 - `ErrorResponse.ReferenceList.Traveler.Telephone.id` (string) Optional custom user-assigned identifier for a phone number. Example: 3 - `ErrorResponse.ReferenceList.Traveler.Telephone.cityCode` (string) IATA city code if referenced by phone number. Example: DEN - `ErrorResponse.ReferenceList.Traveler.Telephone.role` (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" - `ErrorResponse.ReferenceList.Traveler.Telephone.phoneLocationType` (string) Location of the phone Example: Agency - `ErrorResponse.ReferenceList.Traveler.Telephone.phoneTechType` (string) Indicates the type of technology associated with the telephone number Example: Voice - `ErrorResponse.ReferenceList.Traveler.Telephone.phoneUseType` (string) Agency code for how phone is used (e.g., Home, Business, Emergency Contact, Travel Arranger, Day, Evening). Example: Home - `ErrorResponse.ReferenceList.Traveler.Telephone.pin` (string) Additional codes used for telephone Example: 3456 - `ErrorResponse.ReferenceList.Traveler.Telephone.priority` (integer) Priority Example: 1 - `ErrorResponse.ReferenceList.Traveler.Telephone.defaultInd` (boolean) When true, indicates a default value should be used. Example: true - `ErrorResponse.ReferenceList.Traveler.Telephone.provisionedInd` (boolean) true indicates this phone number was created through provisioned Example: false - `ErrorResponse.ReferenceList.Traveler.Email` (array) For a reservation Retrieve response, all email addresses are associated with the first traveler on the reservation for GDS. NDC supports contact information for each traveler on the reservation. - `ErrorResponse.ReferenceList.Traveler.Email.value` (string) The email address. Example: exampledomain@example.com - `ErrorResponse.ReferenceList.Traveler.Email.id` (string) Electronic email addresses, in IETF specified format. Example: email_1 - `ErrorResponse.ReferenceList.Traveler.Email.emailType` (string) Use email type to specify if the email is to be sent "TO" or sent "FROM" Example: FROM - `ErrorResponse.ReferenceList.Traveler.Email.comment` (string) Any freeform note for the email, such as its purpose. Example: work email - `ErrorResponse.ReferenceList.Traveler.Email.preferredFormat` (string) Mime media type Example: text/html - `ErrorResponse.ReferenceList.Traveler.Email.optInDate` (string) The datetime of receiving the opt in notice Example: 2026-03-03T11:11:00Z - `ErrorResponse.ReferenceList.Traveler.Email.optOutDate` (string) The datetime the opt out notice was received Example: 2026-03-03T11:11:00Z - `ErrorResponse.ReferenceList.Traveler.Email.validInd` (boolean) If true, this is a valid email address that has been system verified via a successful email transmission. Example: true - `ErrorResponse.ReferenceList.Traveler.Email.provisionedInd` (boolean) If true then the email address came from the provisioning process Example: true - `ErrorResponse.ReferenceList.Traveler.passengerTypeCode` (string) Passenger type code (PTC) for this traveler. Required for all PTCs other than ADT (adult); if not sent defaults to ADT. Some of the common PTCs supported include ADT, INF, INS, CHD, UNN. Private fare PTCs, including INN, JNN, VNN, ITF, JNF, and VFF, may also be supported, subject to airline support. Example: CHD - `ErrorResponse.ReferenceList.Traveler.nationality` (string) Nationality on country code ISO Example: AL - `ErrorResponse.ReferenceList.Traveler.age` (integer) The age of the traveller at the time of travel Example: 13 - `ErrorResponse.ReferenceList.Traveler.CustomerLoyalty` (array) - `ErrorResponse.ReferenceList.Traveler.CustomerLoyalty.value` (string, required) Number on loyalty card. Example: 132456 - `ErrorResponse.ReferenceList.Traveler.CustomerLoyalty.id` (string) Optional Customer Loyalty Id. Not saved Example: Loyalty_1 - `ErrorResponse.ReferenceList.Traveler.CustomerLoyalty.priority` (integer) Optional Numeric Priority Code Example: 2 - `ErrorResponse.ReferenceList.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 - `ErrorResponse.ReferenceList.Traveler.CustomerLoyalty.programName` (string) Supplier's loyalty program name. Example: Frontier-EarlyReturns - `ErrorResponse.ReferenceList.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 - `ErrorResponse.ReferenceList.Traveler.CustomerLoyalty.supplier` (string) Supplier of a loyalty program (typically 2 characters representing the hotel, brand, or airline). Example: UA - `ErrorResponse.ReferenceList.Traveler.CustomerLoyalty.tier` (string) Customer Loyalty tier Example: Silver - `ErrorResponse.ReferenceList.Traveler.CustomerLoyalty.shareWithSupplier` (array) The list of suppliers that the CustomerLoyalty number is shared. Used for cross accrual programs. If valid carrier codes are not sent, the response returns the message NO CROSS ACCRUAL AGREEMENT EXISTS. - `ErrorResponse.ReferenceList.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 - `ErrorResponse.ReferenceList.Traveler.CustomerLoyalty.validatedInd` (boolean) Customer loyalty number has been validated by the supplier Example: true - `ErrorResponse.ReferenceList.Traveler.CustomerLoyalty.prefix` (string) The cardholder name prefix title like Mr, Mrs, Dr Example: Dr - `ErrorResponse.ReferenceList.Traveler.CustomerLoyalty.given` (string) The First Name of the Cardholder Example: John - `ErrorResponse.ReferenceList.Traveler.CustomerLoyalty.middle` (string) Middle Name of the Cardholder Example: Wilkinson - `ErrorResponse.ReferenceList.Traveler.CustomerLoyalty.surname` (string) Last Name of the Cardholder Example: Smith - `ErrorResponse.ReferenceList.Traveler.AlternateContact` (array) - `ErrorResponse.ReferenceList.Traveler.AlternateContact.@type` (string) Example: AlternateContact - `ErrorResponse.ReferenceList.Traveler.AlternateContact.id` (string) - `ErrorResponse.ReferenceList.Traveler.AlternateContact.contactType` (string) Contact type value Example: Relative - `ErrorResponse.ReferenceList.Traveler.AlternateContact.relation` (string) Relation value Example: Mother - `ErrorResponse.ReferenceList.Traveler.AlternateContact.Address` (array) - `ErrorResponse.ReferenceList.Traveler.AlternateContact.Telephone` (array) - `ErrorResponse.ReferenceList.Traveler.AlternateContact.Email` (array) - `ErrorResponse.ReferenceList.Traveler.AlternateContact.emergencyInd` (boolean) This is the contact in case of an emergency Example: true - `ErrorResponse.ReferenceList.Traveler.AlternateContact.defaultInd` (boolean) This is the default contact Example: true - `ErrorResponse.ReferenceList.Traveler.TravelDocument` (array) - `ErrorResponse.ReferenceList.Traveler.TravelDocument.@type` (string, required) Discriminator classes TravelDocument or TravelDocumentDetail Enum: "TravelDocumentDetail" - `ErrorResponse.ReferenceList.Traveler.TravelDocument.docNumber` (string) Travel document number. Example: B37201 - `ErrorResponse.ReferenceList.Traveler.TravelDocument.docType` (string) Supported Travel Document types 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" - `ErrorResponse.ReferenceList.Traveler.TravelDocument.issueDate` (string) Issue date of document. Required for a visa Example: 2002-10-13 - `ErrorResponse.ReferenceList.Traveler.TravelDocument.expireDate` (string) Expiration date of document. Required for a visa. Example: 2002-11-13 - `ErrorResponse.ReferenceList.Traveler.TravelDocument.stateProvCode` (string) State Province Code value Example: 44 - `ErrorResponse.ReferenceList.Traveler.TravelDocument.placeOfIssue` (string) Place of issue value Example: Birmingham - `ErrorResponse.ReferenceList.Traveler.TravelDocument.issueCountry` (string) Issuing country of document; ISO3166 standard format. Example: CA - `ErrorResponse.ReferenceList.Traveler.TravelDocument.birthDate` (string) The date of birth of the document holder in YYYY-MM-DD format. Example: 1995-04-22 - `ErrorResponse.ReferenceList.Traveler.TravelDocument.birthCountry` (string) Country of birth of the document holder in ISO3166 standard format. Example: AR - `ErrorResponse.ReferenceList.Traveler.TravelDocument.birthPlace` (string) Birth place value Example: Ontario - `ErrorResponse.ReferenceList.Traveler.TravelDocument.residence` (string) Residence value Example: 1st section 8th st - `ErrorResponse.ReferenceList.Traveler.TravelDocument.id` (string) Locally referenced id Example: 34 - `ErrorResponse.ReferenceList.Traveler.TravelDocument.Nationality` (string) Birth country as noted on document; specifies a 2 character country code as defined in ISO3166. Example: BR - `ErrorResponse.ReferenceList.Traveler.TravelDocument.IssuedForGeoPoliticalArea` (object) The location code of the geographical location. Codes from Ref Pub - `ErrorResponse.ReferenceList.Traveler.TravelDocument.IssuedForGeoPoliticalArea.value` (string) Example: G - `ErrorResponse.ReferenceList.Traveler.TravelDocument.IssuedForGeoPoliticalArea.level` (string) Represents the type of geopolitical area (country, Continent, State etc) Enum: "World", "Global Area", "Continent Group", "Continent", "Country", "StateProvince", "City", "Airport" - `ErrorResponse.ReferenceList.Traveler.TravelDocument.IssuedForGeoPoliticalArea.id` (string) Optional internally referenced id Example: 2 - `ErrorResponse.ReferenceList.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. In Traveler this is used to send custom freeform traveler name remarks, such as a unique identifier for a given traveler. Not supported for addition/deletion in Traveler Modify. - `ErrorResponse.ReferenceList.Traveler.Comments.@type` (string) Example: Comments - `ErrorResponse.ReferenceList.Traveler.Comments.Comment` (array) - `ErrorResponse.ReferenceList.Traveler.RailDiscountCard` (array) - `ErrorResponse.ReferenceList.Traveler.RailDiscountCard.value` (string) Example: Rail1234546 - `ErrorResponse.ReferenceList.Traveler.RailDiscountCard.supplierCode` (string, required) Code of the Supplier Example: Enco - `ErrorResponse.ReferenceList.Traveler.RailDiscountCard.referenceNumber` (string) ReferenceNumber Example: 134256 - `ErrorResponse.ReferenceList.Traveler.accompaniedByInfantInd` (boolean) Example: true - `ErrorResponse.ReferenceList.Offer` (array) - `ErrorResponse.ReferenceList.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. Enum: "Offer" - `ErrorResponse.ReferenceList.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 - `ErrorResponse.ReferenceList.Offer.offerRef` (string) Used to reference another instance of this object in the same message Example: offer_1 - `ErrorResponse.ReferenceList.Offer.ContentSource` (string) Indicates the owner the offer or document. Enum: "GDS", "NDC", "LCC", "API" - `ErrorResponse.ReferenceList.Offer.parentOfferRef` (string) A reference to the Offer this offer is sold in conjunction with Example: offer_1 - `ErrorResponse.ReferenceList.Offer.offerModifyRef` (string) Reference to the new Offer created as a result of this Offer being subject to a schedule change. - `ErrorResponse.ReferenceList.Offer.Product` (array, required) Lists the flight or flights for one leg of the itinerary. Repeats for additional leg or legs. - `ErrorResponse.ReferenceList.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. Certain types of offers on a booking, such as seats and ancillaries, generally include only the CurrencyCode, Base, and TotalPrice objects. - `ErrorResponse.ReferenceList.Offer.Price.@type` (string, required) Discriminator classes Price or PriceDetail Enum: "PriceDetail" - `ErrorResponse.ReferenceList.Offer.Price.id` (string) Internally referenced id Example: 2 - `ErrorResponse.ReferenceList.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. - `ErrorResponse.ReferenceList.Offer.Price.CurrencyCode.value` (string) An ISO 4217 currency code. Example: USD - `ErrorResponse.ReferenceList.Offer.Price.CurrencyCode.codeAuthority` (string) Currency code authority Example: ISO 4217 - `ErrorResponse.ReferenceList.Offer.Price.CurrencyCode.decimalPlace` (integer) Number of decimal places for the currency. Example: 2 - `ErrorResponse.ReferenceList.Offer.Price.CurrencyCode.decimalAuthority` (string) Currency code decimal authority Example: ISO 4217 - `ErrorResponse.ReferenceList.Offer.Price.Base` (number) Base price before taxes and fees. For Hotel, may not be returned by all suppliers. Example: 20.2 - `ErrorResponse.ReferenceList.Offer.Price.TotalTaxes` (number) Total taxes applied to the base price. For Hotel, may not be returned by all suppliers. Example: 34.4 - `ErrorResponse.ReferenceList.Offer.Price.TotalFees` (number) Total fees included in Total Price. Example: 201 - `ErrorResponse.ReferenceList.Offer.Price.TotalPrice` (number) Total price of this offer including the base price and all taxes and fees. Example: 34 - `ErrorResponse.ReferenceList.Offer.Price.VendorCurrencyTotal` (object) No longer used. Previously used to expose the local vendor currency when it is different to the purchased currency - `ErrorResponse.ReferenceList.Offer.Price.VendorCurrencyTotal.@type` (string) - `ErrorResponse.ReferenceList.Offer.Price.VendorCurrencyTotal.currencySource` (string) The system requesting or returning the currency code specified in the attribute Enum: "Supplier", "Charged", "Requested" - `ErrorResponse.ReferenceList.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 - `ErrorResponse.ReferenceList.Offer.Price.VendorCurrencyTotal.Taxes` (object) Summary of all individual taxes. Child class TaxesDetail provides the breakdown of individual taxes. - `ErrorResponse.ReferenceList.Offer.Price.VendorCurrencyTotal.Taxes.@type` (string, required) Discriminator class is TaxesDetail Enum: "TaxesDetail" - `ErrorResponse.ReferenceList.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 - `ErrorResponse.ReferenceList.Offer.Price.VendorCurrencyTotal.Taxes.TaxInfo` (array) Returned for TripChange APIS only. - `ErrorResponse.ReferenceList.Offer.Price.VendorCurrencyTotal.Taxes.Tax` (array) - `ErrorResponse.ReferenceList.Offer.Price.VendorCurrencyTotal.Taxes.TaxPercent` (object) Returned when the tax is expressed as a percentage of the amount. - `ErrorResponse.ReferenceList.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. - `ErrorResponse.ReferenceList.Offer.Price.VendorCurrencyTotal.Fees.@type` (string, required) Discriminator. Child class FeesDetail Enum: "FeesDetail" - `ErrorResponse.ReferenceList.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: 55 - `ErrorResponse.ReferenceList.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: 25 - `ErrorResponse.ReferenceList.Offer.Price.VendorCurrencyTotal.Fees.Fee` (array) Array of individual fees. - `ErrorResponse.ReferenceList.Offer.Price.VendorCurrencyTotal.Total` (number) Specifies the total price including base + taxes + fees Example: 30.13 - `ErrorResponse.ReferenceList.Offer.Price.VendorCurrencyTotal.approximateInd` (boolean) True if this amount has been converted from the original amount Example: true - `ErrorResponse.ReferenceList.Offer.Price.FlightPassCredits` (integer) Indicates the number of flight pass credits the offer “costs” for all passengers. Air Canada NDC only. Example: 2 - `ErrorResponse.ReferenceList.Offer.Price.PriceBreakdown` (array) - `ErrorResponse.ReferenceList.Offer.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. Enum: "PriceBreakdownAir", "PriceBreakdownAncillary", "PriceBreakdownHospitality", "PriceBreakdownVehiclePrice", "PriceBreakdownVehicleDeposit", "PriceBreakdownVehicleCharges" - `ErrorResponse.ReferenceList.Offer.Price.PriceBreakdown.Amount` (object) Amount represents the cost applied. - `ErrorResponse.ReferenceList.Offer.Price.PriceBreakdown.Commission` (object) 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). - `ErrorResponse.ReferenceList.Offer.TermsAndConditionsFull` (array) For Hotel Rules and Reservation responses, this array will contain a single TermsAndConditionsFullHospitality entry. Cancellation terms with multiple time periods are represented within that entry's CancelPenalty array rather than as multiple TermsAndConditionsFull entries. For Two-Step Commit (FLights), this is a standard object, no changes. For Unified Checkout (Flights), if no payment information was sent in the request, the booking is confirmed by the airline but not yet ticketed. This object provides the payment and ticketing time limits in ExpiryDate and PaymentTimeLimit. - `ErrorResponse.ReferenceList.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. Enum: "TermsAndConditionsFull", "TermsAndConditionsFullSummary" - `ErrorResponse.ReferenceList.Offer.TermsAndConditionsFull.id` (string) Local identifier within a given message for this object. Example: TC_1 - `ErrorResponse.ReferenceList.Offer.TermsAndConditionsFull.termsAndConditionsRef` (string) Used to reference another instance of this object in the same message. Example: TC_1 - `ErrorResponse.ReferenceList.Offer.TermsAndConditionsFull.ExpiryDate` (string) The date and time in UTC the offer will no longer be valid. Example: 2022-08-07T12:12:00Z - `ErrorResponse.ReferenceList.Offer.TermsAndConditionsFull.CustomerLoyalty` (array) - `ErrorResponse.ReferenceList.Offer.TermsAndConditionsFull.TextBlock` (array) A list of free text terms and conditions. - `ErrorResponse.ReferenceList.Offer.TermsAndConditionsFull.ExpiryDate` (string) The data and time the offer will expire Example: 2022-08-07T12:12:00Z - `ErrorResponse.ReferenceList.Offer.TermsAndConditionsFull.TextBlock` (array) - `ErrorResponse.ReferenceList.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 - `ErrorResponse.ReferenceList.Offer.scheduleChangeInd` (boolean) - If true: this Offer is subject to a schedule change. May be seen in a Two-step Commit, on the first Commit response payload, in the event of a schedule change. If this is the case, the Product object returns previous and updated schedule details in two instances of Product/FlightSegment as follows: - The previous flight segment is identified with sequence=1 and Flight/id=flight_1 - The updated flight segment is identified with sequence=2 and Flight/id=flight_2 Offer includes a ModifyPrice object; however, unless a price change has also occurred, Offer/Price repeats the original price of the offer and Offer/ModifyPrice returns all amounts as zero (0) to indicate there is no price change. NDC only - for Reservation Retrieve, when an airline-initiated flight change has occurred, the response also returns the Offer object with @type OfferModify and scheduleChangeInd=true to indicate a change has occurred. See [NDC Flight Disruption Handing](https://developer.travelport.com/docs/flights/guides/booking-and-reservations/flights-booking-guide#ndc-flight-disruption-handling-involuntary-changes) in the Air Booking Guide for details. - `ErrorResponse.ReferenceList.Brand` (array) Each instance provides details for one BrandRef id. - `ErrorResponse.ReferenceList.Brand.@type` (string, required) Discriminator. Child classes BrandID and Brand. BrandCompleteInfo is no longer in use. Enum: "Brand" - `ErrorResponse.ReferenceList.Brand.id` (string) Local id within a given message to support referencing this object. Example: brand_001 - `ErrorResponse.ReferenceList.Brand.BrandRef` (string) Reference id that corresponds to the brand 'id' in ReferenceListBrand.Brand. Example: brandRef_001 - `ErrorResponse.ReferenceList.Brand.name` (string, required) Brand name from the supplier. Example: Main Cabin Extra - `ErrorResponse.ReferenceList.Brand.tier` (integer) The brand tier. Not returned for NDC. Example: 2 - `ErrorResponse.ReferenceList.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] - `ErrorResponse.ReferenceList.Brand.code` (string) The ATPCO Brand Code. Example: REFMAIN - `ErrorResponse.ReferenceList.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. - `ErrorResponse.ReferenceList.Brand.BrandAttribute.@type` (string, required) Discriminator. No child classes. Example: BrandAttribute - `ErrorResponse.ReferenceList.Brand.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" - `ErrorResponse.ReferenceList.Brand.BrandAttribute.inclusion` (string, required) The indicator as to how the brand and the product are associated. Enum: "Included", "Chargeable", "Not Offered" - `ErrorResponse.ReferenceList.Brand.BrandAttribute.ImageURL` (array) URL for an image for the brand, when available. Example: ["http:/imageurl.com"] - `ErrorResponse.ReferenceList.Brand.BrandAttribute.matchedAttributeInd` (boolean) Returned only if true for any attribute requested in ProductInclusionPreference.Classification. Example: true - `ErrorResponse.ReferenceList.Brand.BrandAttribute.groupCode` (string) Carrier group code. Returned if filed by the carrier. Example: BG - `ErrorResponse.ReferenceList.Brand.BrandAttribute.subGroupCode` (string) Carrier sub group code. Returned if filed by the carrier. Example: CY - `ErrorResponse.ReferenceList.Brand.BrandAttribute.subCode` (string) Carrier sub code. Returned if filed by the carrier. Example: 08A - `ErrorResponse.ReferenceList.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. - `ErrorResponse.ReferenceList.Brand.AdditionalBrandAttribute.@type` (string, required) Discriminator. No child classes. Example: AdditionalBrandAttribute - `ErrorResponse.ReferenceList.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 - `ErrorResponse.ReferenceList.Brand.AdditionalBrandAttribute.ImageURL` (array) URL for an image for the brand, when available. Example: ["https:/travelport/image/profile/firstviewimage"] - `ErrorResponse.ReferenceList.Brand.AdditionalBrandAttribute.matchedAttributeInd` (boolean) Returned only if true for any attribute requested in ProductInclusionPreference.Classification. Example: true - `ErrorResponse.ReferenceList.Brand.AdditionalBrandAttribute.groupCode` (string) Carrier group code. Returned if filed by the carrier. Example: BG - `ErrorResponse.ReferenceList.Brand.AdditionalBrandAttribute.subGroupCode` (string) Carrier sub group code. Returned if filed by the carrier. Example: CY - `ErrorResponse.ReferenceList.Brand.AdditionalBrandAttribute.subCode` (string) Carrier sub code. Returned if filed by the carrier. Example: 08A - `ErrorResponse.ReferenceList.Brand.ImageURL` (array) Example: ["http:/imageurl.com"] - `ErrorResponse.ReferenceList.TermsAndConditions` (array) - `ErrorResponse.ReferenceList.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. Enum: "TermsAndConditions" - `ErrorResponse.ReferenceList.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 - `ErrorResponse.ReferenceList.TermsAndConditions.termsAndConditionsRef` (string) Reference id that corresponds to the TermsAndConditions 'id' in ReferenceListTermsAndConditions.TermsAndConditions. Example: TC_1 - `ErrorResponse.ReferenceList.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 - `ErrorResponse.ReferenceList.TermsAndConditions.CustomerLoyalty` (array) - `ErrorResponse.ReferenceList.Price` (array, required) - `ErrorResponse.CurrencyRateConversion` (array) - `ErrorResponse.CurrencyRateConversion.@type` (string) - `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 ## Response 503: - `503` (unknown) Service Unavailable - 503. This error may be returned when the service is temporarily unavailable due to infrastructure or network issues.