--- title: "NDC Reshop" method: POST path: "/air/change/catalogofferingsairchange" tags: ["NDC Modify Cancel Exchange"] --- # NDC Reshop `POST /air/change/catalogofferingsairchange` NDC only; not supported for GDS. The Reshop API searches for a new itinerary when modifying a held booking or exchanging a ticket for NDC. Reshop is part of the NDC modify/exchange workflow. Create a post-commit workbench, Reshop with this API call, Reprice to confirm pricing, and commit the workbench to confirm the changes. See the [NDC Exchanges and Refunds](https://developer.travelport.com/docs/flights/ndc/ndc-exchanges-and-refunds) guide for more details. ## Headers - `TraceId` string - `XAUTH_TRAVELPORT_ACCESSGROUP` string - `travelportPlusSessionIdentifier` string - `TVP-PCC-Core` string ## Request body - CatalogOfferingsQueryAirChange — Discriminator class CatalogOfferingsQueryAirChange only - `@type` string, required - `CatalogOfferingsAirChangeRequest` CatalogOfferingsAirChangeRequestReservation, required — Discriminator classes CatalogOfferingsAirChangeRequestReservation or CatalogOfferingsAirChangeRequestDocumentNumber - `@type` string, required - `catalogOfferingsPerPage` integer — Catalog Offerings per page value - `SearchCriteriaFlight` SearchCriteriaFlight[], required - `departureDate` string, date — Preferred local departure date in YYYY-MM-DD format. For GDS, send either departureDate or arrivalDate. If both departureDate and arrivalDate are sent, departureDate is ignored. For NDC, departureDate is required. - `daysBeforeDeparture` integer — GDS only; not supported for NDC. Available for flex search only; must append /premiumflex to the endpoint. Send to specify a number of days to search before the date in departureDate, up to three days. - `daysAfterDeparture` integer — GDS only; not supported for NDC. Available for flex search only; must append /premiumflex to the endpoint. Send to specify a number of days to search after the date in departureDate, up to three days. - `departureTime` string, time — Returns NDC offers with flights between two hours before and two hours after the departure time. - Ex: for departureTime of 10:00:00, Search returns available flights between 8:00 and 12:00. For NDC content, if multiple time options are sent in the same instance of SearchCriteriaFlight, they are applied in the order DepartureTimeRange, departureTime, and arrivalTime. Do not use for GDS; instead, use DepartureTimeRange. - `arrivalDate` string, date — Date of arrival in YYYY-MM-DD format. For GDS, send either arrivalDate or departureDate. If both departureDate and arrivalDate are sent, departureDate is ignored. For NDC, arrivalDate is optional and departureDate is always required; if sent, offers returned are filtered by both arrivalDate and departureDate. - `arrivalTime` string, time — Returns NDC offers with flights between two hours before and two hours after the arrival time. - Ex: for arrivalTime of 10:00:00, Search returns available flights between 8:00 and 12:00. Do not use for GDS; instead, use ArrivalTimeRange. Supported only by specific NDC carriers. 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. - `legSequence` integer — Recommended to send when requesting cabin, class of service, and/or connection preferences at the leg level. Do not send if requesting preferences at itinerary level. - `From` FromTo, required — Origin Destination Information - `value` string — The IATA airport or city code for the departure or arrival airport/city for this leg. - `cityOrAirport` 'Airport Only' | 'City or Airport' | 'City Only' | 'Use Default' — Optional enumeration specifying whether to restrict the search based on the city/airport code sent in From/value. Possible options and behavior are as follows. These behaviors are for availability selection only. Actual content may vary based on calculated price and diversity. Not all NDC carriers may support all options. - Airport code with no cityOrAirport value: expands the availability selection to the city while giving preference to the requested airport. - For example, LGA would return flights for LGA, EWR, and JFK but would target more content from LGA. - City code with no cityOrAirport value: returns an unweighted selection of inventory for all airports in the city. - For example, NYC would search content equally between LGA, EWR, and JFK. - This behavior also applies to: - City code with Airport Only - Note: For NDC, do not use the Airport Only value, as any flight segment that does not match the search criteria are removed. - City code with City Only - City or Airport code with City or Airport. - Note: Use this value when sending metro codes, such as PAR, LON, and NYC. - Airport code with cityOrAirport value Airport Only: returns content only from the specified airport. - For example, LGA will return content from only LGA. - Airport code with cityOrAirport value City: expands the availability selection to the city without giving preference to the requested airport. - For example, LGA would instead be treated as NYC and would return flights for LGA, EWR, and JFK with no preference. - This behavior is equivalent to searching by the airport city code. - `radius` integer — Available for flex search only. Return offers from airports within a specified distance from the origin and/or destination. - `radiusMeasurement` 'Miles' | 'Kilometers' — For Hotels: Optional object to request either miles or kilometers for the search radius from the specified location. If unitOfDistance is not specified, the search defaults to miles for properties in the United States, Myanmar, and Liberia. The search defaults to kilometers in all other countries. - `To` FromTo, required — Origin Destination Information - `value` string — The IATA airport or city code for the departure or arrival airport/city for this leg. - `cityOrAirport` 'Airport Only' | 'City or Airport' | 'City Only' | 'Use Default' — Optional enumeration specifying whether to restrict the search based on the city/airport code sent in From/value. Possible options and behavior are as follows. These behaviors are for availability selection only. Actual content may vary based on calculated price and diversity. Not all NDC carriers may support all options. - Airport code with no cityOrAirport value: expands the availability selection to the city while giving preference to the requested airport. - For example, LGA would return flights for LGA, EWR, and JFK but would target more content from LGA. - City code with no cityOrAirport value: returns an unweighted selection of inventory for all airports in the city. - For example, NYC would search content equally between LGA, EWR, and JFK. - This behavior also applies to: - City code with Airport Only - Note: For NDC, do not use the Airport Only value, as any flight segment that does not match the search criteria are removed. - City code with City Only - City or Airport code with City or Airport. - Note: Use this value when sending metro codes, such as PAR, LON, and NYC. - Airport code with cityOrAirport value Airport Only: returns content only from the specified airport. - For example, LGA will return content from only LGA. - Airport code with cityOrAirport value City: expands the availability selection to the city without giving preference to the requested airport. - For example, LGA would instead be treated as NYC and would return flights for LGA, EWR, and JFK with no preference. - This behavior is equivalent to searching by the airport city code. - `radius` integer — Available for flex search only. Return offers from airports within a specified distance from the origin and/or destination. - `radiusMeasurement` 'Miles' | 'Kilometers' — For Hotels: Optional object to request either miles or kilometers for the search radius from the specified location. If unitOfDistance is not specified, the search defaults to miles for properties in the United States, Myanmar, and Liberia. The search defaults to kilometers in all other countries. - `AdditionalFrom` AdditionalFromTo[] — Available for flex search only. Select additional origin cities to expand your flight options. - `value` string — The additional IATA airport or city codes for the departure or arrival airport/city for this leg. - `cityOrAirport` 'Airport Only' | 'City or Airport' | 'City Only' | 'Use Default' — Optional enumeration specifying whether to restrict the search based on the city/airport code sent in From/value. Possible options and behavior are as follows. These behaviors are for availability selection only. Actual content may vary based on calculated price and diversity. Not all NDC carriers may support all options. - Airport code with no cityOrAirport value: expands the availability selection to the city while giving preference to the requested airport. - For example, LGA would return flights for LGA, EWR, and JFK but would target more content from LGA. - City code with no cityOrAirport value: returns an unweighted selection of inventory for all airports in the city. - For example, NYC would search content equally between LGA, EWR, and JFK. - This behavior also applies to: - City code with Airport Only - Note: For NDC, do not use the Airport Only value, as any flight segment that does not match the search criteria are removed. - City code with City Only - City or Airport code with City or Airport. - Note: Use this value when sending metro codes, such as PAR, LON, and NYC. - Airport code with cityOrAirport value Airport Only: returns content only from the specified airport. - For example, LGA will return content from only LGA. - Airport code with cityOrAirport value City: expands the availability selection to the city without giving preference to the requested airport. - For example, LGA would instead be treated as NYC and would return flights for LGA, EWR, and JFK with no preference. - This behavior is equivalent to searching by the airport city code. - `AdditionalTo` AdditionalFromTo[] — Available for flex search only. Select additional destination cities to expand your flight options. - `value` string — The additional IATA airport or city codes for the departure or arrival airport/city for this leg. - `cityOrAirport` 'Airport Only' | 'City or Airport' | 'City Only' | 'Use Default' — Optional enumeration specifying whether to restrict the search based on the city/airport code sent in From/value. Possible options and behavior are as follows. These behaviors are for availability selection only. Actual content may vary based on calculated price and diversity. Not all NDC carriers may support all options. - Airport code with no cityOrAirport value: expands the availability selection to the city while giving preference to the requested airport. - For example, LGA would return flights for LGA, EWR, and JFK but would target more content from LGA. - City code with no cityOrAirport value: returns an unweighted selection of inventory for all airports in the city. - For example, NYC would search content equally between LGA, EWR, and JFK. - This behavior also applies to: - City code with Airport Only - Note: For NDC, do not use the Airport Only value, as any flight segment that does not match the search criteria are removed. - City code with City Only - City or Airport code with City or Airport. - Note: Use this value when sending metro codes, such as PAR, LON, and NYC. - Airport code with cityOrAirport value Airport Only: returns content only from the specified airport. - For example, LGA will return content from only LGA. - Airport code with cityOrAirport value City: expands the availability selection to the city without giving preference to the requested airport. - For example, LGA would instead be treated as NYC and would return flights for LGA, EWR, and JFK with no preference. - This behavior is equivalent to searching by the airport city code. - `DepartureTimeRange` TimeRange — In Air Search API supports searching by a departure or arrival time window for any leg of the itinerary. For NDC, supported only by specific NDC carriers. 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. - `start` string — The start time of the departure or arrival time window to search. Either start or end is required. - `end` string — The end time of the departure or arrival time window to search. Either start or end is required. - `ArrivalTimeRange` TimeRange — In Air Search API supports searching by a departure or arrival time window for any leg of the itinerary. For NDC, supported only by specific NDC carriers. 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. - `start` string — The start time of the departure or arrival time window to search. Either start or end is required. - `end` string — The end time of the departure or arrival time window to search. Either start or end is required. - `PassengerCriteria` PassengerCriteria[], required - `@type` string, required — Discriminator. No child classes. - `number` integer, required — The amount of passengers associated with this passenger type code. Default is 1. - `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). - `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. - `birthDate` string, Date — The date of birth of the passenger. May be used in age validation for fares with age restrictions. - `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. - `CustomerLoyalty` CustomerLoyalty[] — 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. - `value` string, required — Number on loyalty card. - `id` string — Optional Customer Loyalty Id. Not saved - `priority` integer — Optional Numeric Priority Code - `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. - `programName` string — Supplier's loyalty program name. - `supplierType` string — The type of supplier of a loyalty program. Uses 'hotel' for frequent guest number or 'air' for frequent flyer number. - `supplier` string — Supplier of a loyalty program (typically 2 characters representing the hotel, brand, or airline). - `tier` string — Customer Loyalty tier - `shareWithSupplier` string[] — 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. - `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 - `validatedInd` boolean — Customer loyalty number has been validated by the supplier - `prefix` string — The cardholder name prefix title like Mr, Mrs, Dr - `given` string — The First Name of the Cardholder - `middle` string — Middle Name of the Cardholder - `surname` string — Last Name of the Cardholder - `TravelerGeographicLocation` TravelerGeographicLocation — 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. - `value` string — IATA code for the city, country, or state/province relevant to the local citizen//local resident fare. - `travelerGeographicLocationType` 'Country' | 'StateProvince' | 'City' — The type of location where the fare is valid. - `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. - `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. - `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. - `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. - `SearchModifiersAir` SearchModifiersAir — Add one or more optional modifiers to filter search results by criteria related to the journey itself. All journey modifiers are in CatalogProductOfferingsQueryRequest/CatalogProductOfferingsRequest/SearchModifiersAir. Any modifiers sent in the initial Search request are applied to any subsequent Next Leg Search request. All modifiers apply to the entire itinerary, not at the leg level, unless otherwise specified with legSequence per below. - `@type` string, required — discriminator - `excludeGround` 'Train' | 'All' — GDS only, not supported for NDC. Excludes certain ground transportation from the response. By default, the response may return ground transportation options such as trains and buses, depending on the routing. In the response, ground transportation options are identified in ReferenceList/Flight by the TRN, TRS, or BUS equipment codes. - `CarrierPreference` CarrierPreference[] - `@type` string, required — Discriminator. No child classes exist - `preferenceType` 'Preferred' | 'Permitted' | 'Prohibited', required — The type of carrier preference - `carriers` string[], required — One or more carrier codes to permit, prohibit, or prefer. Preferred alliances are also supported; send the alliance code (e.g., /*A) instead of the carrier code. - `legSequence` integer[] — Applies the carrier/alliance preference to only specific legs of the itinerar referencing legSequence sent in SearchCriteriaFlight. Do not send if requesting preference at itinerary level. GDS only, not supported for NDC. - `CabinPreference` CabinPreference[] - `@type` string, required — Discriminator. No child classes exist - `preferenceType` 'Preferred' | 'Permitted' | 'PreferredWithUpgrade' | 'Prohibited' — 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. - `cabins` CabinAirEnum[] — A space-delimited list of cabins. - `legSequence` integer[] — 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. - `ClassOfServicePreference` ClassOfServicePreference[] - `@type` string — Discriminator. No child classes exist - `legSequence` integer[] — Applies preference to specified leg/s of the itinerary, referencing the leg sequence in SearchCriteriaFlight. Do not send if requesting preference at itinerary level. - `ClassesOfService` string[], required — One or more classes of service to permit or prohibit. - `PreferenceType` 'Preferred' | 'Permitted' | 'Prohibited' — Class of Service preference options. - `ProductInclusionPreference` ProductInclusionPreference[] - `@type` string — Discriminator. No child classes exist - `legSequence` integer[] — Leg sequence is not supported for ProductInclusionPreference. Preference will be applied to the whole journey. - `Classification` BrandClassificationEnum[], required — Send one or more of the enumerated values to return only fares that include those attributes in the price. For example, sending CarryOn returns only fares that include a carry-on bag in the price. - `AdditionalClassification` string[] — Currently unused. Only items enumerated in BrandClassificationENUM are currently supported. Any additional items sent are ignored and the lowest fares are returned regardless of associated brand attributes. - `exactMatchInd` boolean — Will not implement. The default behavior will be to provide an exact match to the product inclusion preferences. - `bestMatchInd` boolean — Will not implement. The default behavior will be to provide an exact match to the product inclusion preferences. - `ConnectionPreferences` ConnectionPreferencesAir[] - `@type` string — Discriminator classes ConnectionPreferences or ConnectionPreferencesAir. Must send “ConnectionPreferencesAir” when sending FlightType. If the @type value is not sent, FlightType is ignored for GDS; for NDC, a time out error is returned. - `legSequence` integer[] — Applies preference to only specific leg/s of the itinerary referencing legSequence sent in SearchCriteriaFlight. Do not send for preference at itinerary level. - `maxConnectionDuration` string — Limits results to itineraries that do not exceed a set length of time between flights on the same leg. Applies to all connections on the itinerary. Use the format PT{x}H, in which P is the duration designator, T is the time designator, and {x}H is the number of hours the connection should not exceed . For minutes use {x}H{x}M. - `maxOvernightDuration` string — Limits results to itineraries that do not exceed a set length of time for any overnight connection. If the first flight in the connection arrives on one calendar date and the connecting flight arrives on another calendar date, this constitutes an overnight connection. Use the format PT{x}H, in which P is the duration designator, T is the time designator, and {x}H is the number of hours the connection should not exceed. For minutes use {x}H{x}M. - `preferenceType` 'Preferred' | 'Permitted' | 'Prohibited', required — The type of connection preference. Only one preference type can be requested for an O&D pair. - `ConnectionPoint` string[], required — IATA code for the connecting location/s for a connection preference. For example, if you specify three locations, for GDS, any flights connecting in any one of those locations will be permitted/preferred/prohibited per the specified preferenceType. For NDC, only itineraries that match all connection location/s are returned. - `cityOrAirport` 'Airport Only' | 'City or Airport' | 'City Only' | 'Use Default' — Optional enumeration specifying whether to restrict the search based on the city/airport code sent in From/value. Possible options and behavior are as follows. These behaviors are for availability selection only. Actual content may vary based on calculated price and diversity. Not all NDC carriers may support all options. - Airport code with no cityOrAirport value: expands the availability selection to the city while giving preference to the requested airport. - For example, LGA would return flights for LGA, EWR, and JFK but would target more content from LGA. - City code with no cityOrAirport value: returns an unweighted selection of inventory for all airports in the city. - For example, NYC would search content equally between LGA, EWR, and JFK. - This behavior also applies to: - City code with Airport Only - Note: For NDC, do not use the Airport Only value, as any flight segment that does not match the search criteria are removed. - City code with City Only - City or Airport code with City or Airport. - Note: Use this value when sending metro codes, such as PAR, LON, and NYC. - Airport code with cityOrAirport value Airport Only: returns content only from the specified airport. - For example, LGA will return content from only LGA. - Airport code with cityOrAirport value City: expands the availability selection to the city without giving preference to the requested airport. - For example, LGA would instead be treated as NYC and would return flights for LGA, EWR, and JFK with no preference. - This behavior is equivalent to searching by the airport city code. - `FlightType` FlightType — The type of flight connection - `@type` string, required — Discriminator. No child classes. - `connectionType` 'NonStopDirect' | 'StopDirect' | 'SingleConnection' | 'DoubleConnection' | 'TripleConnection' — Limits the connection type returned. Each value returns the specified type and all higher types. For example, StopDirect could return both flights that stop without a change of planes (StopDirect) and non-stop direct flights (NonStopDirect). SingleConnection or DoubleConnection will not exclude StopDirect flights from the journey. For example, SingleConnection could return an itinerary with two flight numbers, and either of these flights could have intermediate stops. - `excludeInterlineConnectionsInd` boolean — GDS only, not supported for NDC. Excludes interline connectionsClosed from results. - If true: does not return offers with interline connections. - If false (default behavior): may return interline connections in results. When a product contains multiple interline air segments, brand details return only the brand of the significant carrier, not the validating/plating carrier brand information. The IATA rules for determining the significant carrier on an itinerary are based on the areas in which the transportation takes place. - `prohibitChangeOfAirportInd` boolean — Suppresses return of offers that require a change of airport at connection. - If true: excludes itineraries that require changing airports during connections. - If false (default behavior): may return itineraries that require change of airport. - `PricingModifiersAirChange` PricingModifiersAirChange — 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). - `@type` string - `currencyCode` string — ISO 4217 currency code - `FareSelection` FareSelection — 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. - `@type` string, required — Discriminator. Child class FareSelectionDetail. - `fareType` 'PublicFaresOnly' | 'PrivateFaresOnly' | 'AgencyPrivateFaresOnly' | 'AirlinePrivateFaresOnly' | 'PublicAndPrivateFares' | 'NetFaresOnly' | 'AllFares' — 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. - `RefundOptions` RefundOptions — 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 - `@type` string, required — Discriminator. No child classes. - `refundTypes` RefundTypeEnum[], required - `RefundPenaltyRange` RefundPenaltyRange — Not currently supported. User can express a minimum and maximum Refund penalty range that will be included in the result set. - `@type` string - `Minimum` AmountPercent — Parent object when amount is applied as an Amount or a Percent. - … - `Maximum` AmountPercent — Parent object when amount is applied as an Amount or a Percent. - … - `ChangeOptions` ChangeOptions — 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 - `@type` string — Discriminator. No child classes. - `changeTypes` ChangeTypeENUM[], required - `ChangePenaltyRange` ChangePenaltyRange — Not currently supported. User can express a minimum and maximum Change penalty range that will be included in the result set - `@type` string - `Minimum` AmountPercent — Parent object when amount is applied as an Amount or a Percent. - … - `Maximum` AmountPercent — Parent object when amount is applied as an Amount or a Percent. - … - `FareQualifier` FareQualifierENUM[] - `value` 'Consolidator' | 'Government' | 'Marine' | 'Military' | 'Reward' | 'StandBy' | 'Staff' | 'Student' | 'Tour' | 'Youth' | 'VistFriendsAndRelatives' — Deprecated - do not use. Replaced by FareQualiferString - `FareQualiferString` string[] — 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)" - `OrganizationInformation` OrganizationInformation — 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. - `@type` string, required — Discriminator. No child classes - `OrganizationIdentifier` OrganizationIdentifier[] — 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. - `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. - For NDC, 1 account code per carrier is supported - `supplier` string — The IATA code for the airline on which the code is applicable. - `organizationCodeType` 'Account' | 'OrganizationLoyaltyProgram' | 'Tour' | 'TicketDesignator' — Sends a description for the OrganizationIdentifer value. For AirPrice, always send with a value of Account. - `segmentSequenceList` integer[] — Returned in response when the code is applicable to a specified segment sequence - `productRef` string[] — Returned in response when the code is applicable to a specified product - `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. - `GSTRegistrationNumber` GSTRegistrationNumber[] — 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. - `value` string, required — The GST registered number for the business. - `telephone` string, required — Business telephone number - `address` string, required — Business address - `country` string, required — IATA country code of the business. - `companyName` string, required — Business name - `email` string, required — Business E-Mail address - `WaiverCode` WaiverCode — 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. - `value` string - `reasonCode` integer — A code assigned to identify the reason for disruption - `waiverType` 'ChangePenalty' | 'PriceDifference' | 'ChangePenaltyAndPriceDifference' | 'RefundPenalty' | 'NameChangePenalty' — List of waiver types. - `TaxExemption` TaxExemption — 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. - `@type` string — Discriminator. No child classes. - `countries` string[] — One or more ISO codes for the countries in which the paired taxCodes sent are tax exempt. Must also send taxCodes object. - `taxCodes` string[] — 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. - `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. - `PromotionalCode` PromotionalCode — NDC only. Not supported for GDS. Any NDC airline designated promotional code. - `value` string — The promotional code to apply - `supplierCode` string, required — The IATA code for the airline on which the promotional code is applicable. - `SellCity` string — Overrides the sell city of the requestor - `TicketCity` string — Overrides the ticket city of the requestor - `PricingPCC` string — Overrides the pricing PCC of the requestor - `TicketingPCC` string — Overrides the ticketing PCC of the requestor - `CalculatedFareAdjustment` CalculatedFareAdjustment — Used in Exchange Search to modify the Price of the Fare. Discriminator classes CalculatedFareAdjustmentDiscount or CalculatedFareAdjustmentIncrease - `@type` string, required - `BrandPreference` BrandPreference[] - `@type` string, required — Discriminator. No child classes exist - `brandTier` integer — The brand tier - `legSequence` integer[] — Correlates with legSequence in SearchCriteriaFlight - `keepToBrandInd` boolean — If true, the offerings returned will be of the same brand as the original Offer - `returnMostRestrictiveBrandInd` boolean — if true, the most restrictive brand will be returned in the response when there are different brands present in the Offering - `doNotNetInd` boolean — If true, this exchange will not net any residual/refundable amounts against due amounts. - `SearchControlConsoleChannelID` SearchControlConsoleChannelID — The Search API supports the Travelport Content Optimizer (formerly known as Search Control Console/SCC) for GDS content only. Send either the value or the sccType. If both values are sent, the sccType is applied. Travel agency administrators use Content Optimizer to create business rules for filtering certain air shopping results. If your client's application does not use Content Optimizer, do not use these attributes. Contact your Travelport representative if you would like additional information. - `value` string — String for the Content Optimizer channel ID. - `sccType` string — String for the Content Optimizer type. - `CustomResponseModifiersAir` CustomResponseModifiersAir — 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. - `@type` string, required — discriminator - `BrandAttributeInclusion` BrandAttributeInclusion[] — Supported in AirSearch and AirPrice. Returns only information about the brand attributes specified and does not return any other brand attributes. - `@type` string - `legSequence` integer[] — Leg sequence not supported for BrandAttributeInclusion. - `Classification` BrandClassificationEnum[] — 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. - `AdditionalClassification` string[] — 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 - `SearchRepresentation` 'Leg' | 'Journey' | 'LegWithJourneyData' — 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. - `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. - `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. - `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. - `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. - `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. - `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. - `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. - `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. - `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. - `includeFullPenaltyDisclosureInd` boolean — If true, penalty information sourced from ATPCO Cat 31 and 33 will be disclosed. Penalties may be exposed at fare component level and include time windows. - `returnBrandedFaresInd` boolean - `upsellInd` boolean - `detailViewInd` boolean - `divideReservationByTravelerInd` boolean — If true, this reprice request will result in the original reservation being divided and modified for the specified traveler. When true, TravelerRef is mandatory in the request payload. - `BuildFromReservationWorkbench` BuildFromReservationWorkbench, required - `@type` string, required — Discriminator. - `ReservationIdentifier` ReservationIdentifier — Reservation Identifier object. - `@type` string - `id` string — Internal ID - `Identifier` Identifier — 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). - `value` string — Unique offer identifier that can be sent in subsequent payload requests to reference this offer. When used for reference flight calls, the CatalogProductOfferingsIdentifier will be the transaction identifier from the Search, Next Leg Search, or Flight Specific Search response in CatalogProductOfferings/Identifier/value. If you choose to pull the CatalogProductOfferingsIdentifier from the Price response instead (OfferListResponse/Identifier/value), either full or reference payload, please note for subsequent Add Offer requests you must remove the _PC appended to the end of the value in the AirPrice response (e.g., change value: '93d2091d-3d04-48ab-8091-6ae1525f02ea_PC' to value: '93d2091d-3d04-48ab-8091-6ae1525f02ea'). When building an AirPrice or Add Offer reference payload request: - Look for the CatalogProductOfferingIdentifier (ex: o1) in a Search response at CatalogProductOfferings/CatalogProductOffering/id or a Price response at OfferListResponse/OfferID/id. - Look for the ProductIdentifier (ex: p0) in a Search response at CatalogProductOfferings/CatalogProductOffering/ProductBrandOptions/ProductBrandOffering/Product/productRef or from a Price response at OfferListResponse/OfferID/Product/id. When returned from a Workbench, this value is the workbench identifier that must be sent in all subsequent requests for this workbench session. When returned from Air Exchange Eligibility, value is the ticket number sent with the eligibility request. When used specifically for form of payment, the value will begin with the characters 'FOP'. Similarly, the OfferIdentifier associated will begin with the character 'O'. For Hotel Create Reservation (Reference Payload), send the value from the Availability response in CatalogOffering/id or the value from SearchComplete returned in propertyItems/lowestPublicAvailableRate/rateKey/value. Results from Hotel Availability and Hotel SearchComplete are stored in the cache for 30 minutes. If the offers expire before booking, you must send a new request. - `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. - `IdentifierType` 'Reservation' | 'Locator' | 'SupplierLocator' | 'DocumentNumber' - `OfferIdentifier` OfferIdentifier — Travelport-generated offer identifier number. - `id` string — Local identifier within a given message for this object. - `offerRef` string — Used to reference another instance of this object in the same message - `Identifier` Identifier — 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). - `value` string — Unique offer identifier that can be sent in subsequent payload requests to reference this offer. When used for reference flight calls, the CatalogProductOfferingsIdentifier will be the transaction identifier from the Search, Next Leg Search, or Flight Specific Search response in CatalogProductOfferings/Identifier/value. If you choose to pull the CatalogProductOfferingsIdentifier from the Price response instead (OfferListResponse/Identifier/value), either full or reference payload, please note for subsequent Add Offer requests you must remove the _PC appended to the end of the value in the AirPrice response (e.g., change value: '93d2091d-3d04-48ab-8091-6ae1525f02ea_PC' to value: '93d2091d-3d04-48ab-8091-6ae1525f02ea'). When building an AirPrice or Add Offer reference payload request: - Look for the CatalogProductOfferingIdentifier (ex: o1) in a Search response at CatalogProductOfferings/CatalogProductOffering/id or a Price response at OfferListResponse/OfferID/id. - Look for the ProductIdentifier (ex: p0) in a Search response at CatalogProductOfferings/CatalogProductOffering/ProductBrandOptions/ProductBrandOffering/Product/productRef or from a Price response at OfferListResponse/OfferID/Product/id. When returned from a Workbench, this value is the workbench identifier that must be sent in all subsequent requests for this workbench session. When returned from Air Exchange Eligibility, value is the ticket number sent with the eligibility request. When used specifically for form of payment, the value will begin with the characters 'FOP'. Similarly, the OfferIdentifier associated will begin with the character 'O'. For Hotel Create Reservation (Reference Payload), send the value from the Availability response in CatalogOffering/id or the value from SearchComplete returned in propertyItems/lowestPublicAvailableRate/rateKey/value. Results from Hotel Availability and Hotel SearchComplete are stored in the cache for 30 minutes. If the offers expire before booking, you must send a new request. - `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. - `ProductIdentifier` ProductIdentifier[] - `id` string — Local identifier within a given message for this object. - `productRef` string — Used to reference another instance of this object in the same payload. - `Identifier` Identifier — 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). - `value` string — Unique offer identifier that can be sent in subsequent payload requests to reference this offer. When used for reference flight calls, the CatalogProductOfferingsIdentifier will be the transaction identifier from the Search, Next Leg Search, or Flight Specific Search response in CatalogProductOfferings/Identifier/value. If you choose to pull the CatalogProductOfferingsIdentifier from the Price response instead (OfferListResponse/Identifier/value), either full or reference payload, please note for subsequent Add Offer requests you must remove the _PC appended to the end of the value in the AirPrice response (e.g., change value: '93d2091d-3d04-48ab-8091-6ae1525f02ea_PC' to value: '93d2091d-3d04-48ab-8091-6ae1525f02ea'). When building an AirPrice or Add Offer reference payload request: - Look for the CatalogProductOfferingIdentifier (ex: o1) in a Search response at CatalogProductOfferings/CatalogProductOffering/id or a Price response at OfferListResponse/OfferID/id. - Look for the ProductIdentifier (ex: p0) in a Search response at CatalogProductOfferings/CatalogProductOffering/ProductBrandOptions/ProductBrandOffering/Product/productRef or from a Price response at OfferListResponse/OfferID/Product/id. When returned from a Workbench, this value is the workbench identifier that must be sent in all subsequent requests for this workbench session. When returned from Air Exchange Eligibility, value is the ticket number sent with the eligibility request. When used specifically for form of payment, the value will begin with the characters 'FOP'. Similarly, the OfferIdentifier associated will begin with the character 'O'. For Hotel Create Reservation (Reference Payload), send the value from the Availability response in CatalogOffering/id or the value from SearchComplete returned in propertyItems/lowestPublicAvailableRate/rateKey/value. Results from Hotel Availability and Hotel SearchComplete are stored in the cache for 30 minutes. If the offers expire before booking, you must send a new request. - `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. - `SegmentSequenceList` integer[] — The segmentSequence within the product the action is being requested for. Used when multiple flights exist within a product. Only one product may be selected with this option. - `TravelerRefs` string[] — A list of Traveler references. ## Response `200` OK - Successful Response - 200 - CatalogOfferingsAirChangeResponseWrapper — Wrapper schema to expose the name of the top level schema in the JSON example - `CatalogOfferingsAirChangeResponse` CatalogOfferingsAirChangeResponse — Base response is part of all TripServices responses and includes common items which are relevant across all APIs - `@type` string - `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. - `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. - `correlationId` string, uuid — Identifier used to correlate hotel API invocations across a multi-call business flows. - `reservationStatus` 'Success' | 'Fail' | 'Partial' | 'Pending' | 'OnHold' | 'Retry' | 'Other' — Status of reservation or offer completion. - `Result` Result — Returns the error and/or warning message information, if applicable. - `@type` string — Discriminator class Result only - `status` 'Not processed' | 'Incomplete' | 'Complete' | 'Unknown' — The status of an error or warning - `Error` Error[] — A list of error information returned at the provider level for a response. - `@type` string, required — Discriminator classes Error or ErrorDetail - `StatusCode` integer — Http standard response code - `Message` string — The Travelport standardized error or warning message - `NameValuePair` 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). - `id` string — Optional internally referenced id - `name` string, required — Key, categorizing the type of remark or error. - `Warning` Warning[] — A list of warning information returned at the provider level for a response. - `@type` string, required — Discriminator classes Warning or WarningDetail - `StatusCode` integer — Http standard response code - `Message` string — The Travelport standardized error or warning message - `NameValuePair` 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). - `id` string — Optional internally referenced id - `name` string, required — Key, categorizing the type of remark or error. - `Identifier` Identifier — 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). - `value` string — Unique offer identifier that can be sent in subsequent payload requests to reference this offer. When used for reference flight calls, the CatalogProductOfferingsIdentifier will be the transaction identifier from the Search, Next Leg Search, or Flight Specific Search response in CatalogProductOfferings/Identifier/value. If you choose to pull the CatalogProductOfferingsIdentifier from the Price response instead (OfferListResponse/Identifier/value), either full or reference payload, please note for subsequent Add Offer requests you must remove the _PC appended to the end of the value in the AirPrice response (e.g., change value: '93d2091d-3d04-48ab-8091-6ae1525f02ea_PC' to value: '93d2091d-3d04-48ab-8091-6ae1525f02ea'). When building an AirPrice or Add Offer reference payload request: - Look for the CatalogProductOfferingIdentifier (ex: o1) in a Search response at CatalogProductOfferings/CatalogProductOffering/id or a Price response at OfferListResponse/OfferID/id. - Look for the ProductIdentifier (ex: p0) in a Search response at CatalogProductOfferings/CatalogProductOffering/ProductBrandOptions/ProductBrandOffering/Product/productRef or from a Price response at OfferListResponse/OfferID/Product/id. When returned from a Workbench, this value is the workbench identifier that must be sent in all subsequent requests for this workbench session. When returned from Air Exchange Eligibility, value is the ticket number sent with the eligibility request. When used specifically for form of payment, the value will begin with the characters 'FOP'. Similarly, the OfferIdentifier associated will begin with the character 'O'. For Hotel Create Reservation (Reference Payload), send the value from the Availability response in CatalogOffering/id or the value from SearchComplete returned in propertyItems/lowestPublicAvailableRate/rateKey/value. Results from Hotel Availability and Hotel SearchComplete are stored in the cache for 30 minutes. If the offers expire before booking, you must send a new request. - `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. - `NextSteps` NextSteps — Container for the steps that describe actions that may be taken on the containing object. Not applicable for an Eligibility or Exchange response. - `baseURI` string, required — The base portion of the URI in order to shorten the uris in the individual steps - `id` string — Optional internally referenced id - `NextStep` NextStep[], required - `value` string - `id` string — Identifier for the Next Step - `action` string, required — The action this next step is intended to achieve - `method` 'GET' | 'DELETE' | 'PUT' | 'POST', required — Describes the set of potential methods that can be taken after an operation. - `description` string — Additional clarification for the next step - `ReferenceList` 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. - `id` string — Uniquely identifies for the Reference List - `CurrencyRateConversion` CurrencyRateConversion[] - `@type` string - `SourceCurrency` CurrencyCode, required — Currency codes are the three-letter alphabetic codes that represent the various currencies used throughout the world. Unless changed in the request, the currency is the default associated with your provisioned PCC from Travelport. For Hotel: SourceCurrency is based on the location of the hotel and used for all rates in the response. TargetCurrency is the currency code sent in the request in requestedCurrency. - `value` string — An ISO 4217 currency code. - `codeAuthority` string — Currency code authority - `decimalPlace` integer — Number of decimal places for the currency. - `decimalAuthority` string — Currency code decimal authority - `TargetCurrency` CurrencyCode, required — Currency codes are the three-letter alphabetic codes that represent the various currencies used throughout the world. Unless changed in the request, the currency is the default associated with your provisioned PCC from Travelport. For Hotel: SourceCurrency is based on the location of the hotel and used for all rates in the response. TargetCurrency is the currency code sent in the request in requestedCurrency. - `value` string — An ISO 4217 currency code. - `codeAuthority` string — Currency code authority - `decimalPlace` integer — Number of decimal places for the currency. - `decimalAuthority` string — Currency code decimal authority - `ConversionRate` ConversionRate, 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. - `value` number, float - `rateAuthority` string — Contextual rate authority - `rateAsOf` string, date-time — Rate as of - `Pagination` Pagination — Pagination object used when result sets span across a number of pages. - `@type` string, required - `page` integer, required — The current page number of the full result set - `pageSize` integer, required — The total number of items on this page - `totalPages` integer, required — The total number of pages in this result set - `totalItems` integer, required — The total number of pages in this result set ## Other responses - `400` — Bad Request - 400 - `401` — Unauthorized - 401 - `402` — Payment Required - 402 - `403` — Forbidden - 403 - `404` — Not Found - 404 - `500` — Internal Server Error - 500 - `503` — Service Unavailable - 503. This error may be returned when the service is temporarily unavailable due to infrastructure or network issues. --- [API](https://skmtc.net/travelport/apis/tripservices-flights.md) · [All operations](https://skmtc.net/travelport/apis/tripservices-flights/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/travelport/tripservices-flights/revisions/90abcc916990/schema)