{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-docs/flights/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["admonition","img","span"]},"type":"markdown"},"seo":{"title":"TripServices Flights API Guide","description":"Create AI-native travel products with Travelport's powerful, flexible APIs.","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"tripservices-flights-api-guide","__idx":0},"children":["TripServices Flights API Guide"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This guide provides a general introduction to using the TripServices APIs to search for and book air travel. It discusses basic travel terms you need to know to develop your applications and how those terms are represented in the responses. It also summarizes the general workflow from searching for flights through ticketing."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The terms and concepts in this guide are essential to understanding travel development for all the TripServices Flights APIs."]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["After this guide, continue with the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/flights/guides/flights-search-guide"},"children":["Flights Search Guide"]},". Also see ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/flights/downloads-and-support/using-the-help"},"children":["Using the Help"]}," for details about the information in this online help."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"basic-concepts","__idx":1},"children":["Basic Concepts"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["First let's look at terms used across the travel industry. These help you understand the request and response structure of all TripServices APIs."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"ptcs-service-levels-branded-fares","__idx":2},"children":["PTCs, Service Levels, Branded Fares"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The Travelport Search APIs support any of the following types of itineraries. An ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["itinerary"]}," is the entire trip a traveler wants to book."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["One way: Trip to a single destination; e.g., LHR > CDG."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Round trip: Trip to a single destination and back to the original point of departure; e.g., LHR > CDG and CDG > LHR"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Multi-city: Trip to multiple destinations; e.g., LHR > CDG > AMS > BCN."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Open-jaw: Trip to one destination and a return from another city; e.g., LHR > CDG and AMS > LHR."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The airline industry categorizes travelers under various ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["passenger type codes (PTCs)"]},". The most common PTCs are Adult (ADT), Child (CNN), and Infant (INF). You can request a maximum of nine passengers in one search."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["An airfare with certain features included in the price is a ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["branded fare"]},". For example, a branded fare may include a seat assignment choice and wifi at no extra charge. An ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["upsell"]}," is a fare presented along with the base fare as a higher level of service, and is usually a branded fare. Upsell to a higher brand is an integral part of branding. ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/flights/guides/flights-search-guide#branded-fares-and-upsells"},"children":["Branded fares and upsells"]}," are detailed in the Flights Search Guide."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Airlines provide different ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["service levels"]},", grouping services into ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["cabin classes"]},". The following are standard cabin classes:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Economy: Travelers receive standard services with no perks. Identified by cabin class code Y or the word ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["COACH"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Premium Economy: Travelers receive a better seating preference than Economy class. Identified by cabin class code ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["W"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Business: Travelers receive more service than economy but fewer than First. Identified by cabin class code ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["C."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["First: Travelers receive upgraded service; the most expensive fares. Identified by cabin class code ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["F."]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"itinerary-leg-segment","__idx":3},"children":["Itinerary, Leg, Segment"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Next, let's look at the parts of an itinerary, sometimes called a journey."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To illustrate let's use an example round-trip booking from LAX>MSP: The trip starts with a direct flight from LAX>MSP. The return has a change of planes in DEN, so MSP>DEN>LAX."]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["In our example, the itinerary includes everything: LAX>MSP and MSP>DEN>LAX."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["leg"]}," is the part of the itinerary from one origin to one destination. A leg is also called an origin and destination (O&D) pair."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Our example has two legs:"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["LAX>MSP is the first leg, also called the outbound leg."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["MSP>DEN>LAX is the second leg, also called the return or inbound leg."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["segment"]}," is one single flight on a leg."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["In our example, the first leg has one segment (LAX>MSP). The return leg has two segments (MSP>DEN and DEN>LAX) because there is a change of plane."]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A flight on a single segment can have one or more stops that don't require a change of plane. In this case the flight number remains the same. This is called a ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["direct flight"]}," and is not the same as a nonstop flight. A ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["nonstop flight"]}," does not make any stop between the origin and destination."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"offers-in-the-tripservices-apis","__idx":4},"children":["Offers in the TripServices APIs"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Now let's look at how these terms are represented in the actual JSON code used to request and return air travel."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Here's the basic workflow for travel booking, described later in ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#flights-apis-list-by-functional-area"},"children":["Workflow Summary"]},":"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Search"]},": Enter itinerary details and shop for flights."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Price"]},": Confirm pricing on flights (optional in some cases; required for NDC and some low-cost carriers)."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Book"]},": A workflow of linked API calls to establish a workbench session, add an offer and traveler data to the workbench, and commit the workbench to create a held booking, aka reservation."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Ticket"]},": Issue tickets for the held booking."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"offers-in-search-responses","__idx":5},"children":["Offers in Search Responses"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["In the Search APIs, the various options a customer can choose from are called ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["offers"]},". Offers are returned in the responses through the full workflow. Starting with the Search APIs, a search returns multiple offers for each leg on the itinerary, depending on availability on that route. Offers for each leg are returned in the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["CatalogProductOffering"]}," object."]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Key point: ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["One leg = CatalogProductOffering object"]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["In the example below, one instance of CatalogProductOffering is the O&D pair ORD > ATL. The second instance is the return/inbound leg ATL > ORD."]},{"$$mdtype":"Tag","name":"details","attributes":{"className":"example-box"},"children":[{"$$mdtype":"Tag","name":"summary","attributes":{},"children":["Show Example CatalogProductOffering objects for two legs"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"Image","attributes":{"src":"/assets/catalogproductoffering.d5250fa22457ba6807ad644e580ae7d20616cea7b22e99ce52f608ae253204d8.20ccff99.jpg","withLightbox":false,"style":"max-width:100%"},"children":[]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The core of each offer is the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["product"]},", which is the flight or connecting flights on that leg plus a service level. The service level includes the cabin class and any applicable fare codes."]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Key point: ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Flight + service level = Product object"]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Each offer presents a product that's available at a specific price under a set of terms and conditions. These may include minimum stay requirements or the number of checked bags allowed. In the Search APIs, this information is combined in the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["ProductBrandOffering"]}," object."]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Key point: ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Product + price + terms and conditions = ProductBrandOffering object"]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This concept of an offer continues throughout the TripServices API booking workflow and is frequently used in this online help."]},{"$$mdtype":"Tag","name":"details","attributes":{"className":"example-box"},"children":[{"$$mdtype":"Tag","name":"summary","attributes":{},"children":["Show Example ProductBrandOffering object for one offer"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"Image","attributes":{"src":"/assets/productbrandoptions.ab5f97281afa4ca238ae24cd14e876cde6b015b753290e4dc94f964268adde23.20ccff99.jpg","withLightbox":false,"style":"max-width:100%"},"children":[]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The same product may be returned in multiple offers at different price points and terms and conditions, and included in various brands. Instead of repeating all this common information in each offer, the Search APIs consolidate it in the ReferenceList object later in the response. So, each offer returns a price and cross-references to the details of its product, brand, and set of terms and conditions."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For example, product details are returned in ReferenceListProduct. The example code below shows all the information returned for one product. The product ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["p0"]}," provides the specific class of service, cabin class, and the fare basis code and type, and cross-references to a set of connecting flights. Flight details are returned in instances of ReferenceListFlight for s16 and s17 (not shown here)."]},{"$$mdtype":"Tag","name":"details","attributes":{"className":"example-box"},"children":[{"$$mdtype":"Tag","name":"summary","attributes":{},"children":["Show Example Product details"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n \"@type\": \"ReferenceListProduct\",\n \"Product\": [\n {\n \"@type\": \"ProductAir\",\n \"totalDuration\": \"PT6H13M\",\n \"id\": \"p0\",\n \"Quantity\": 1,\n \"FlightSegment\": [\n {\n \"@type\": \"FlightSegment\",\n \"sequence\": 1,\n \"connectionDuration\": \"PT1H11M\",\n \"boundFlightsInd\": true,\n \"Flight\": {\n \"@type\": \"FlightID\",\n \"FlightRef\": \"s16\"\n }\n },\n {\n \"@type\": \"FlightSegment\",\n \"sequence\": 2,\n \"Flight\": {\n \"@type\": \"FlightID\",\n \"FlightRef\": \"s17\"\n }\n }\n ],\n \"PassengerFlight\": [\n {\n \"@type\": \"PassengerFlight\",\n \"passengerQuantity\": 1,\n \"passengerTypeCode\": \"ADT\",\n \"FlightProduct\": [\n {\n \"@type\": \"FlightProduct\",\n \"segmentSequence\": [\n 1,\n 2\n ],\n \"classOfService\": \"C\",\n \"cabin\": \"First\",\n \"fareBasisCode\": \"BAA0AFFN\",\n \"fareType\": \"PublicFare\",\n \"Brand\": {\n \"@type\": \"BrandID\",\n \"BrandRef\": \"b0\"\n }\n }\n ]\n }\n ]\n },\n\n","lang":"json"},"children":[]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"offers-in-booking-ticketing-and-exchangesrefunds","__idx":6},"children":["Offers in Booking, Ticketing, and Exchanges/Refunds"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["After the Search and optional ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/flights/guides/flights-pricing-guide"},"children":["price confirmation"]}," steps, book the flight/s:"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Initiate a workbench session."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Send a selected offer from a Search response."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Send traveler details."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Commit the workbench to create a booking."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["At that point the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["offer"]}," from the Search response - including the service level, price, and terms and conditions - is converted into a single ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Offer"]}," object. This offer data remains the same for all subsequent calls for that booking, including ticketing, modifications, and exchanges/refunds."]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Key point: ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Product + price + terms and conditions = Offer object in Book and following transactions"]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The example below shows the structure of the entire Offer object after the booking commit. The single Identifer/value ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["a83529a3-b291-493c-bdde-e2135f8eb3a4"]}," and Offer/id ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["offer_1"]}," can be used from this point on to refer to that offer as a whole. In addition, the Receipt object returns a booking confirmation code, also called a locator code or PNR."]},{"$$mdtype":"Tag","name":"details","attributes":{"className":"example-box"},"children":[{"$$mdtype":"Tag","name":"summary","attributes":{},"children":["Show Example Offer object after booking selected offer"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"Image","attributes":{"src":"/assets/bookoffer.95b16255039e7a76bfc4537e5b11f68425886ca0474cb76312573d2f98a4a090.20ccff99.jpg","withLightbox":false,"style":"max-width:100%"},"children":[]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The example below shows the complete JSON code of the booking commit response."]},{"$$mdtype":"Tag","name":"details","attributes":{"className":"example-box"},"children":[{"$$mdtype":"Tag","name":"summary","attributes":{},"children":["Show Example Book Commit response - consolidated offer details"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n \"ReservationResponse\": {\n \"@type\": \"ReservationResponse\",\n \"Reservation\": {\n \"@type\": \"Reservation\",\n \"Offer\": [\n {\n \"@type\": \"Offer\",\n \"id\": \"offer_1\",\n \"Identifier\": {\n \"authority\": \"Travelport\",\n \"value\": \"a83529a3-b291-493c-bdde-e2135f8eb3a4\"\n },\n \"Product\": [\n {\n \"@type\": \"ProductAir\",\n \"id\": \"product_1\",\n \"FlightSegment\": [\n {\n \"@type\": \"FlightSegment\",\n \"id\": \"FlightSegment_01\",\n \"sequence\": 1,\n \"connectionDuration\": \"PT50M\",\n \"boundFlightsInd\": true,\n \"Flight\": {\n \"@type\": \"FlightDetail\",\n \"duration\": \"PT2H22M\",\n \"carrier\": \"UA\",\n \"number\": \"763\",\n \"equipment\": \"777\",\n \"id\": \"Flight_01\",\n \"Departure\": {\n \"@type\": \"Departure\",\n \"location\": \"ORD\",\n \"date\": \"2023-03-03\",\n \"time\": \"09:45:00\"\n },\n \"Arrival\": {\n \"@type\": \"Arrival\",\n \"location\": \"ATL\",\n \"date\": \"2023-03-03\",\n \"time\": \"13:07:00\"\n },\n \"AvailabilitySourceCode\": \"P\"\n }\n },\n {\n \"@type\": \"FlightSegment\",\n \"id\": \"FlightSegment_02\",\n \"sequence\": 2,\n \"Flight\": {\n \"@type\": \"FlightDetail\",\n \"duration\": \"PT1H57M\",\n \"carrier\": \"UA\",\n \"number\": \"2290\",\n \"equipment\": \"319\",\n \"id\": \"Flight_02\",\n \"Departure\": {\n \"@type\": \"Departure\",\n \"location\": \"ATL\",\n \"date\": \"2023-03-03\",\n \"time\": \"13:57:00\"\n },\n \"Arrival\": {\n \"@type\": \"Arrival\",\n \"location\": \"DEN\",\n \"date\": \"2023-03-03\",\n \"time\": \"16:54:00\"\n },\n \"AvailabilitySourceCode\": \"P\"\n }\n }\n ],\n \"PassengerFlight\": [\n {\n \"@type\": \"PassengerFlight\",\n \"passengerQuantity\": 1,\n \"passengerTypeCode\": \"ADT\",\n \"FlightProduct\": [\n {\n \"@type\": \"FlightProduct\",\n \"segmentSequence\": [\n 1,\n 2\n ],\n \"classOfService\": \"S\",\n \"cabin\": \"Economy\"\n }\n ]\n }\n ]\n }\n ],\n \"Price\": {\n \"@type\": \"PriceDetail\",\n \"id\": \"PriceDetail_1\",\n \"CurrencyCode\": {\n \"value\": \"AUD\"\n },\n \"Base\": 272,\n \"TotalTaxes\": 55.3,\n \"TotalFees\": 0,\n \"TotalPrice\": 327.3,\n \"PriceBreakdown\": [\n {\n \"@type\": \"PriceBreakdownAir\",\n \"quantity\": 1,\n \"requestedPassengerType\": \"ADT\",\n \"Amount\": {\n \"@type\": \"Amount\",\n \"currencySource\": \"Charged\",\n \"approximateInd\": true,\n \"CurrencyCode\": {\n \"decimalPlace\": 2,\n \"value\": \"AUD\"\n },\n \"Base\": 272,\n \"Taxes\": {\n \"@type\": \"TaxesDetail\",\n \"TotalTaxes\": 55.3,\n \"Tax\": [\n {\n \"currencyCode\": \"AUD\",\n \"taxCode\": \"AY\",\n \"value\": 8.1\n },\n {\n \"currencyCode\": \"AUD\",\n \"taxCode\": \"US\",\n \"value\": 20.4\n },\n {\n \"currencyCode\": \"AUD\",\n \"taxCode\": \"XF\",\n \"value\": 13\n },\n {\n \"currencyCode\": \"AUD\",\n \"taxCode\": \"ZP\",\n \"value\": 13.8\n }\n ]\n },\n \"Total\": 327.3\n },\n \"FiledAmount\": {\n \"currencyCode\": \"USD\",\n \"decimalPlace\": 2,\n \"value\": 189.77\n }\n }\n ]\n },\n \"TermsAndConditionsFull\": [\n {\n \"@type\": \"TermsAndConditionsFullAir\",\n \"Identifier\": {\n \"authority\": \"Travelport\",\n \"value\": \"cc6d639c-a1dc-4226-be71-ac3d62806d88\"\n }\n },\n {\n \"@type\": \"TermsAndConditionsFullAir\",\n \"ExpiryDate\": \"2023-02-02T23:59:00Z\",\n \"PaymentTimeLimit\": \"2023-02-02T23:59:00Z\"\n }\n ]\n }\n ],\n \"Traveler\": [\n {\n \"@type\": \"Traveler\",\n \"birthDate\": \"1986-11-11\",\n \"gender\": \"Male\",\n \"passengerTypeCode\": \"ADT\",\n \"id\": \"travelerRefId_1\",\n \"Identifier\": {\n \"authority\": \"Travelport\",\n \"value\": \"0d6b4ede-db45-4bfa-bdd6-68e04e795278\"\n },\n \"PersonName\": {\n \"@type\": \"PersonName\",\n \"Given\": \"TESTFIRST\",\n \"Surname\": \"TESTLAST\"\n },\n \"Telephone\": [\n {\n \"@type\": \"TelephoneDetail\",\n \"countryAccessCode\": \"1\",\n \"phoneNumber\": \"212456121\",\n \"id\": \"telephone_1\",\n \"cityCode\": \"ORD\",\n \"role\": \"Home\"\n }\n ],\n \"Email\": [\n {\n \"value\": \"Traveler*On*e@gmail.com\"\n }\n ],\n \"TravelDocument\": [\n {\n \"@type\": \"TravelDocumentDetail\",\n \"docNumber\": \"A123123\",\n \"docType\": \"Passport\",\n \"expireDate\": \"2033-01-31\",\n \"issueCountry\": \"US\",\n \"birthDate\": \"1986-11-11\",\n \"Gender\": \"Male\",\n \"PersonName\": {\n \"@type\": \"PersonName\",\n \"Given\": \"TESTFIRST\",\n \"Surname\": \"TESTLAST\"\n }\n }\n ]\n }\n ],\n \"Receipt\": [\n {\n \"@type\": \"ReceiptConfirmation\",\n \"Identifier\": {\n \"authority\": \"Travelport\",\n \"value\": \"eccd6c3e-f9c3-428c-94e0-cf0b604d8af6\"\n },\n \"Confirmation\": {\n \"@type\": \"ConfirmationHold\",\n \"Locator\": {\n \"source\": \"1G\",\n \"value\": \"3HQHK3\"\n },\n \"OfferStatus\": {\n \"@type\": \"OfferStatusAir\",\n \"StatusAir\": [\n {\n \"flightRefs\": [\n \"Flight_01\",\n \"Flight_02\"\n ],\n \"code\": \"HK\",\n \"value\": \"Confirmed\"\n }\n ]\n }\n }\n },\n {\n \"@type\": \"ReceiptConfirmation\",\n \"Identifier\": {\n \"authority\": \"Travelport\",\n \"value\": \"1738f433-7f18-4f9b-9665-cc7e804f22ba\"\n },\n \"Confirmation\": {\n \"@type\": \"ConfirmationHold\",\n \"Locator\": {\n \"source\": \"UA\",\n \"value\": \"IYF0MD\"\n }\n }\n }\n ],\n \"ReservationComment\": [\n {\n \"@type\": \"ReservationComment\",\n \"commentSource\": \"Agency\"\n }\n ]\n },\n }\n},\n","lang":"json"},"children":[]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"reference-and-full-payload-requests","__idx":7},"children":["Reference and Full Payload Requests"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Using the identifiers detailed above, many of the TripServices APIs allow you to send information either by referring to a previous result. Several APIs also support sending full details instead."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Reference payload request"]},": Sends reference identifiers from a previous response. Supported for NDC and GDS."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Full payload request"]},": Sends full details without a reference to any previous response. Can be used to send information returned in a previous TripServices API response or from a non-Travelport source."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The TripServices APIs provide support for NDC only through reference payload requests that refer to previous responses in the workflow. For this reason, full payload requests are not supported for NDC in most cases."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The examples below show a reference payload Add Offer request, and then a full payload Add Offer request. The reference payload example sends response, offer, and product identifiers from a cached, previous AirPrice response while the second, full payload example sends complete flight details."]},{"$$mdtype":"Tag","name":"details","attributes":{"className":"example-box"},"children":[{"$$mdtype":"Tag","name":"summary","attributes":{},"children":["Show Example reference payload request for Add Offer"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n \"OfferQueryBuildFromCatalogProductOfferings\": {\n \"BuildFromCatalogProductOfferingsRequest\": {\n \"@type\": \"BuildFromCatalogProductOfferingsRequestAir\",\n \"CatalogProductOfferingsIdentifier\": {\n \"Identifier\": {\n \"value\": \"1fceb004-aaca-4657-930a-cb6304fa89e2\"\n }\n },\n \"CatalogProductOfferingSelection\": [\n {\n \"CatalogProductOfferingIdentifier\": {\n \"Identifier\": {\n \"value\": \"QF_CPO0\"\n }\n },\n \"ProductIdentifier\": [\n {\n \"Identifier\": {\n \"value\": \"QFp0\"\n }\n }\n ]\n },\n {\n \"CatalogProductOfferingIdentifier\": {\n \"Identifier\": {\n \"value\": \"QF_CPO1\"\n }\n },\n \"ProductIdentifier\": [\n {\n \"Identifier\": {\n \"value\": \"QFp24\"\n }\n }\n ]\n }\n ]\n }\n }\n}\n","lang":"json"},"children":[]}]},{"$$mdtype":"Tag","name":"details","attributes":{"className":"example-box"},"children":[{"$$mdtype":"Tag","name":"summary","attributes":{},"children":["Show Example full payload request for Add Offer"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n \"OfferQueryBuildFromProducts\": {\n \"BuildFromProductsRequest\": {\n \"@type\": \"BuildFromProductsRequestAir\",\n \"PassengerCriteria\": [\n {\n \"number\": 1,\n \"age\": 25,\n \"passengerTypeCode\": \"ADT\"\n }\n ],\n \"ProductCriteriaAir\": [\n {\n \"SpecificFlightCriteria\": [\n {\n \"flightNumber\": \"733\",\n \"carrier\": \"QF\",\n \"departureDate\": \"2022-01-09\",\n \"departureTime\": \"08:35:00\",\n \"arrivalDate\": \"2022-01-09\",\n \"arrivalTime\": \"10:10:00\",\n \"from\": \"SYD\",\n \"to\": \"ADL\",\n \"classOfService\": \"Q\",\n \"cabin\": \"Economy\",\n \"segmentSequence\": 1,\n \"brandTier\": \"1\"\n },\n {\n \"flightNumber\": \"680\",\n \"carrier\": \"QF\",\n \"departureDate\": \"2022-01-09\",\n \"departureTime\": \"12:05:00\",\n \"arrivalDate\": \"2022-01-09\",\n \"arrivalTime\": \"13:50:00\",\n \"from\": \"ADL\",\n \"to\": \"MEL\",\n \"classOfService\": \"Q\",\n \"cabin\": \"Economy\",\n \"segmentSequence\": 2,\n \"brandTier\": \"1\"\n }\n ]\n },\n {\n \"SpecificFlightCriteria\": [\n {\n \"flightNumber\": \"402\",\n \"carrier\": \"QF\",\n \"departureDate\": \"2022-01-16\",\n \"departureTime\": \"06:00:00\",\n \"arrivalDate\": \"2022-01-16\",\n \"arrivalTime\": \"07:25:00\",\n \"from\": \"MEL\",\n \"to\": \"SYD\",\n \"classOfService\": \"Q\",\n \"cabin\": \"Economy\",\n \"segmentSequence\": 1,\n \"brandTier\": \"1\"\n }\n ]\n }\n ]\n }\n }\n}\n","lang":"json"},"children":[]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"identifiers-in-the-tripservices-apis","__idx":8},"children":["Identifiers in the TripServices APIs"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The TripServices APIs rely on several types of identifiers used for different purposes:"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Troubleshooting and tracking ids"]},": The TripServices Flights APIs include two objects that can be used to track API calls throughout the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#minimum-required-workflow"},"children":["workflow"]},". First is the ",{"$$mdtype":"Tag","name":"span","attributes":{"class":"highlighted-doc-text"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["transactionId"]}]}," object returned under the first top-level object of every response. This unique system-generated ID is generated by the TripServices APIs and returned automatically. The same value is returned for all API calls that are connected in a workflow, such as if a reference AirPrice request is sent after a Search request, or if a series of API calls are made in the workbench. The transaction ID is returned in two places: the ",{"$$mdtype":"Tag","name":"span","attributes":{"class":"highlighted-doc-text"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["transactionId"]}]}," object and the the ",{"$$mdtype":"Tag","name":"span","attributes":{"class":"highlighted-doc-text"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["E2EtrackingId"]}]}," header field. Optionally, developers can send their own custom trace ID in the traceID field in the header to serve as their own tracking number; if a traceId is sent, all responses in the workflow return that string in the ",{"$$mdtype":"Tag","name":"span","attributes":{"class":"highlighted-doc-text"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["traceId"]}]}," object. In the example below, no trace ID was sent in the request header so only transactionId is returned. For details see ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/flights/general/transaction-and-trace-ids"},"children":["Transaction and Trace IDs"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Long identifiers"]},": Many objects in the same response return an ",{"$$mdtype":"Tag","name":"span","attributes":{"class":"highlighted-doc-text"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["identifier"]}]}," in ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Identifier/value"]},". This is always a long system-generated string, for example, ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["3cecf1be-0b21-4881-8f33-ae11c8d7b708"]},". Such identifier values are unique within the same transaction and across all Search transactions. These identifiers must frequently be sent in subsequent ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#reference-and-full-payload-requests"},"children":["reference payload"]}," requests to refer to data in a preceding response."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Short reference ids"]},": An ",{"$$mdtype":"Tag","name":"span","attributes":{"class":"highlighted-doc-text"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["id"]}]}," is an internal reference number in the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["id"]}," object and is always a short, system-generated string, such as ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["p1"]}," or ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["SQ_CPO1"]},". An id is unique within the response but not across multiple responses. This type of id is used to cross-reference details in a offer with consolidated reference information in the same response for offers, products, brands, flights, etc., or to provide a short identifier for an object, such as Offer/id ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["offer_1"]},"."]}]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"warning"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Be sure to code your API to send the correct id and/or identifier values from the response when required in a subsequent request. These mappings are noted in the API references for each API."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The following example shows several types of identifiers in a Search API response."]},{"$$mdtype":"Tag","name":"details","attributes":{"className":"example-box"},"children":[{"$$mdtype":"Tag","name":"summary","attributes":{},"children":["Show Example Identifiers"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"Image","attributes":{"src":"/assets/identifiers.e37286a64ce3575e7bba4bc1a7e0d0aa92666f520da593c9d6cd4a2baada186a.20ccff99.jpg","withLightbox":false,"style":"max-width:100%"},"children":[]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"gds-and-ndc-content","__idx":9},"children":["GDS and NDC Content"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The Flights APIs support both NDC and GDS content, or simply NDC and GDS. These terms refer to the content distribution method:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["GDS"]}," stands for Global Distribution System. A GDS aggregates and distributes air, hotel, and car rental content such as schedules, fares, and upsells. Travelport owns the Galileo, Worldspan, and Apollo GDSs, which are also known by the IATA abbreviations 1G, 1P, and 1V."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["NDC"]}," is for New Distribution Capability, a program launched by the International Air Transport Association (IATA), the trade association for the world's airlines. NDC distributes content"," ","directly from airlines to online travel agencies. NDC content is provided and fulfilled directly by the airline, and may include differentiated content available only through the airlines' direct channels."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Although most TripServices API workflows, requests, and responses are the same for both GDS and NDC, airline-specific processes do create some differences. Some functionality is supported only for NDC or only for GDS."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/flights/ndc/ndc-guide"},"children":["NDC Guide"]}," compares NDC and GDS and details high-level differences by API. Individual API references provide object-level details on differences in usage or responses. Because NDC is only available to provisioned customers, the online help has a separate NDC top-level menu to group information that is applicable only to NDC."]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If the online help doesn't include the text ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["GDS only; not supported for NDC"]}," or vice versa, the functionality presented is supported for both NDC and GDS in the same way. Any differences in NDC and GDS functionality are noted where applicable."]}]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To access NDC content you must be provisioned for NDC with Travelport and registered with the NDC airline."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Content for both NDC and GDS in the TripServices APIs is sourced from the Galileo GDS (Global Distribution System) for most customers. NDC content from the Apollo and Worldspan GDSs is available to specifically provisioned customers. See the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/flights/ndc/ndc-guide-for-apollo-and-worldspan"},"children":["NDC Guide for Apollo and Worldspan"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"identifiers-for-ndc-and-gds","__idx":10},"children":["Identifiers for NDC and GDS"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The Flights APIs return slightly different ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#identifiers-in-the-tripservices-apis"},"children":["identifiers"]}," for NDC and GDS. In the short ids for brands, flights, terms and conditions, etc., NDC incorporates the carrier code and GDS does not. For example, NDC products on Singapore Airlines are numbered ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["SQp0"]},", ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["SQp1"]},", etc."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"flights-apis-list-by-functional-area","__idx":11},"children":["Flights APIs List by Functional Area"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The following table lists the general areas of the APIs and summarizes the functionality available in each."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This general description does not cover all possible options. See the workflow diagrams in the following section. Also see the all linked ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/flights/guides/flights-guides"},"children":["guides"]}," (guides provide a functional overview and basic usage information for each type of API) and the API references (a full technical reference for every API, including endpoints, headers, and object-level details such as supported formats and values)."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"class":"doc-table md","className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Step"},"children":["Step"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"TripServices APIs"},"children":["TripServices APIs"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Associated Guide"},"children":["Associated Guide"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Search"]}]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Search"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Next Leg Search"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Flight Specific Search"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Air Availability"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Search for flights for either the entire itinerary at once (Search API), or the first leg and then the subsequent leg (Search + Next Leg Search APIs). Flights are returned as ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#offers-in-the-tripservices-apis"},"children":["offers"]}," in the search results."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If desired, use the Flight Specific Search API to return additional upsell options on selected flights."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Alternately, you can use Air Availability to focus your search on availability rather than cost. Air Availability returns flights along with seat availability by class of service. It does not return pricing information."]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/flights/guides/flights-search-guide"},"children":["FlightsSearch Guide"]}]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Price"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["AirPrice"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Confirm pricing on a selected offer. Optional for most carriers; required for some NDC and low-cost carriers."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/flights/guides/flights-pricing-guide"},"children":["Air Pricing Guide"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Fare Rules"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Fare Rules"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Request fare rules by type (short, long, structured). Optional."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/flights/guides/fare-rules-guide"},"children":["Fare Rules Guide"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Book"]}]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Create Initial Workbench"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Add Offer"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Add Traveler"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Workbench Commit"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Reservation Retrieve"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Establish a workbench session for sending requests to book an offer:"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Initiate a workbench session."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Add the offer you want to book using either of the following:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Send Add Offer with reference identifiers from for the offer to book from a previous Search or AirPrice response. Reference payload request."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Send Add Offer with all required itinerary details. Full payload request. Can be sent with or without first using the TripServices Search APIs."]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Add traveler details to the booking using either of the following:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Send Add Traveler with required traveler details."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["If your agency already has traveler details stored in the Travelport host system, you can send Host Profile Move to copy traveler details from the host into the TripServices API booking workbench."]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Commit the workbench to create a held booking, or reservation."]}]}]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/flights/guides/flights-search-guide"},"children":["Booking Guide"]}]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Seats"]}]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Seat Map"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Seat Book"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Optional. You can check seat availability and book seats at various points in the workfow."]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/flights/guides/seats-and-ancillaries/seats-guide"},"children":["Seats Guide"]}]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Ancillaries"]}]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Ancillary Shop"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Ancillary Price"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Ancillary Book"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Optional. You can shop for and book paid ancillaries such as paid baggage at various points in the workfow."]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/flights/guides/seats-and-ancillaries/ancillaries-and-emd-guide"},"children":["Ancillary and EMD Guide"]}]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Remarks"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Various Traveler and Remarks payloads"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional. Several APIs support adding special service requests and remarks at various points in the workflow. Some remarks are required by certain carriers."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Remarks & Service Requests Guide & API Reference"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Custom Rules"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Custom Rule APIs"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional. If your agency has configured custom rules in a separate booking file management tool, you can add them to TripServices API bookings to validate against specific criteria when you commit the workbench."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/flights/guides/flights-search-guide#custom-booking-rules"},"children":["Booking Guide"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Ticket"]}]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Post-Commit Workbench"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Add Form of Payment (FOP)"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Add Payment"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Workbench Commit"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A booking must be ticketed within a certain time or it expires. Send requests in a workbench to ticket a held booking:"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Initiate a workbench session."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Send details for the form of payment to use."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Send that payment."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Commit the workbench to issue tickets."]}]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/flights/guides/ticketing-guide"},"children":["Ticketing Guide"]}]}]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"tripservices-apis-end-to-end-workflows","__idx":12},"children":["TripServices APIs End-to-End Workflows"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"minimum-required-workflow","__idx":13},"children":["Minimum Required Workflow"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The following diagram shows the API requests in the minimum required workflow to search, book, and ticket a flight in the TripServices APIs."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The TripServices APIs provide additional options for some of these steps; see the preceding section for a full list."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Each box in the diagram represents one API call in the workflow."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"json-apis-full-workflow-minimum-required-steps","__idx":14},"children":["JSON APIs full workflow: Minimum required steps"]},{"$$mdtype":"Tag","name":"Diagram","attributes":{"data-language":"mermaid","align":"center","diagramType":"mermaid","diagramSource":"flowchart TD\n A[\"Search for flights\"]\n B[\"Price\\n(required for some low-cost\\n& NDC carriers)\"]\n C[\"Create new workbench\"]\n D[\"Add offer\"]\n E[\"Add traveler/s\"]\n F[\"Commit workbench;\\ncreate reservation\"]\n G[\"Create post-commit\\nworkbench\"]\n H[\"Form of payment\"]\n I[\"Payment\"]\n J[\"Commit workbench;\\nissue ticket/s\"]\n\n A --> B --> C --> D --> E --> F --> G --> H --> I --> J\n\n","diagramHtml":"","diagramHtmlDark":""},"children":["flowchart TD\n A[\"Search for flights\"]\n B[\"Price\\n(required for some low-cost\\n& NDC carriers)\"]\n C[\"Create new workbench\"]\n D[\"Add offer\"]\n E[\"Add traveler/s\"]\n F[\"Commit workbench;\\ncreate reservation\"]\n G[\"Create post-commit\\nworkbench\"]\n H[\"Form of payment\"]\n I[\"Payment\"]\n J[\"Commit workbench;\\nissue ticket/s\"]\n\n A --> B --> C --> D --> E --> F --> G --> H --> I --> J\n\n"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Note that the above TripServices APIs workflow uses reference payload requests, which send identifiers to select an offer from previous TripServices API responses. Optionally, you can send the AirPrice full payload request and omit the Search request, or send an Add Offer full payload request and omit the Search and AirPrice requests. This allows you to source your flights outside the TripServices APIs and skip these steps of the TripServices workflow."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"full-workflow-with-optional-steps","__idx":15},"children":["Full Workflow with Optional Steps"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The following diagram shows all required API requests in the TripServices API workflow plus several optional steps."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Each box in the diagram represents one API call in the workflow."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Some steps can take place at other points in the workflow; see these guides for support details:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["See ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/flights/workflows/booking-and-ticketing/all-book-and-ticketing-workflows"},"children":["All Book and Ticketing Workflows"]}," for all book and ticketing options."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/flights/guides/fare-rules-guide"},"children":["Fare Rules"]}," can be requested after Search, after Price, or for an existing reservation."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Seats and ancillaries can be shopped and/or added at various points in the workflow per the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/flights/guides/seats-and-ancillaries/seats-guide"},"children":["Seats"]}," and ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/flights/guides/seats-and-ancillaries/ancillaries-and-emd-guide"},"children":["Ancillaries"]}," guides."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/flights/guides/booking-and-reservations/remarks-and-service-requests"},"children":["Comments and special service requests"]}," can be added either in the initial booking flow or in a post-commit session."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/flights/guides/booking-and-reservations/flights-booking-guide"},"children":["Form of payment"]}," for GDS can be added during either initial booking or ticketing. Form of payment for NDC can be added at ticketing unless you use the NDC-only Instant Pay Workflow."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"json-apis-full-workflow-required-and-optional-steps","__idx":16},"children":["JSON APIs full workflow: Required and optional steps"]},{"$$mdtype":"Tag","name":"Diagram","attributes":{"data-language":"mermaid","align":"center","diagramType":"mermaid","diagramSource":"flowchart TD\n A[\"Search\\nfor flights\"]\n B[\"Flight Specific\\nSearch\\n(optional)\"]\n C[\"Price\\n(required for\\nsome low-cost\\n& NDC carriers)\"]\n D[\"Standalone fare\\nrules\\n(optional)\"]\n E[\"Create\\nnew workbench\"]\n F[\"Add\\noffer\"]\n G[\"Add\\ntraveler/s\\n(traveler\\nremarks optional)\"]\n H[\"Seat map\\n(optional)\"]\n I[\"Book seat/s\\n(optional;\\nrepeat for each\\nsegment)\"]\n J[\"Commit\\nworkbench;\\ncreate\\nreservation\"]\n K[\"Create post-\\ncommit\\nworkbench\"]\n L[\"Add\\nnon-traveler\\nremarks\\n(optional)\"]\n M[\"Ancillary shop\\n(optional)\"]\n N[\"Ancillary price\\n(required for NDC\\nancillaries;\\nnot supported\\nfor GDS)\"]\n O[\"Book\\nancillary\\n(optional)\"]\n P[\"Commit\\nworkbench\"]\n Q[\"Create post-\\ncommit\\nworkbench\"]\n R[\"Form of\\npayment\"]\n S[\"Payment for air,\\nseats, and\\nancillaries\"]\n T[\"Commit\\nworkbench;\\nissue\\nticket/s & EMDs\"]\n\n A --> B --> C --> D --> E --> F --> G --> H --> I --> J --> K --> L --> M --> N --> O --> P --> Q --> R --> S --> T\n\n","diagramHtml":"","diagramHtmlDark":""},"children":["flowchart TD\n A[\"Search\\nfor flights\"]\n B[\"Flight Specific\\nSearch\\n(optional)\"]\n C[\"Price\\n(required for\\nsome low-cost\\n& NDC carriers)\"]\n D[\"Standalone fare\\nrules\\n(optional)\"]\n E[\"Create\\nnew workbench\"]\n F[\"Add\\noffer\"]\n G[\"Add\\ntraveler/s\\n(traveler\\nremarks optional)\"]\n H[\"Seat map\\n(optional)\"]\n I[\"Book seat/s\\n(optional;\\nrepeat for each\\nsegment)\"]\n J[\"Commit\\nworkbench;\\ncreate\\nreservation\"]\n K[\"Create post-\\ncommit\\nworkbench\"]\n L[\"Add\\nnon-traveler\\nremarks\\n(optional)\"]\n M[\"Ancillary shop\\n(optional)\"]\n N[\"Ancillary price\\n(required for NDC\\nancillaries;\\nnot supported\\nfor GDS)\"]\n O[\"Book\\nancillary\\n(optional)\"]\n P[\"Commit\\nworkbench\"]\n Q[\"Create post-\\ncommit\\nworkbench\"]\n R[\"Form of\\npayment\"]\n S[\"Payment for air,\\nseats, and\\nancillaries\"]\n T[\"Commit\\nworkbench;\\nissue\\nticket/s & EMDs\"]\n\n A --> B --> C --> D --> E --> F --> G --> H --> I --> J --> K --> L --> M --> N --> O --> P --> Q --> R --> S --> T\n\n"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Note that the above TripServices APIs workflow uses reference payload requests, which send identifiers to select an offer from previous TripServices API responses. Optionally, you can send the AirPrice full payload request and omit the Search request, or send an Add Offer full payload request and omit the Search and AirPrice requests. This allows you to source your flights outside the TripServices APIs and skip these steps of the TripServices workflow."]}]},"headings":[{"value":"TripServices Flights API Guide","id":"tripservices-flights-api-guide","depth":1},{"value":"Basic Concepts","id":"basic-concepts","depth":2},{"value":"PTCs, Service Levels, Branded Fares","id":"ptcs-service-levels-branded-fares","depth":3},{"value":"Itinerary, Leg, Segment","id":"itinerary-leg-segment","depth":3},{"value":"Offers in the TripServices APIs","id":"offers-in-the-tripservices-apis","depth":2},{"value":"Offers in Search Responses","id":"offers-in-search-responses","depth":3},{"value":"Offers in Booking, Ticketing, and Exchanges/Refunds","id":"offers-in-booking-ticketing-and-exchangesrefunds","depth":3},{"value":"Reference and Full Payload Requests","id":"reference-and-full-payload-requests","depth":2},{"value":"Identifiers in the TripServices APIs","id":"identifiers-in-the-tripservices-apis","depth":2},{"value":"GDS and NDC Content","id":"gds-and-ndc-content","depth":2},{"value":"Identifiers for NDC and GDS","id":"identifiers-for-ndc-and-gds","depth":3},{"value":"Flights APIs List by Functional Area","id":"flights-apis-list-by-functional-area","depth":2},{"value":"TripServices APIs End-to-End Workflows","id":"tripservices-apis-end-to-end-workflows","depth":2},{"value":"Minimum Required Workflow","id":"minimum-required-workflow","depth":3},{"value":"JSON APIs full workflow: Minimum required steps","id":"json-apis-full-workflow-minimum-required-steps","depth":4},{"value":"Full Workflow with Optional Steps","id":"full-workflow-with-optional-steps","depth":3},{"value":"JSON APIs full workflow: Required and optional steps","id":"json-apis-full-workflow-required-and-optional-steps","depth":4}],"frontmatter":{"seo":{"title":"TripServices Flights API Guide"}},"lastModified":"2026-06-03T19:46:19.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/docs/flights/guides/flights-general-guide","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}