Add Product API Reference

POST

book/product/reservationworkbench/{workbenchID}/shoppingcart/products/buildfromproducts

For {workbenchID} send the workbench identifier returned in ReservationResponse/Identifer/value in the workbench create response.

Base path:

Pre-production https://api.pp.travelport.com/11/air/

Production https://api.travelport.com/11/air/

Related Content: Booking Guide

GDS

Global Distribution System. A GDS aggregates and distributes air, hotel, and car rental content such as schedules, fares, and upsells. In the JSON APIs, GDS content is distributed from Travelport. only; not supported for NDC

New Distribution Capability, an XML standard for exchanging data that supports airlines in distributing their content directly to online travel agencies. See the NDC Guide.. If you are sending identifiers from a previous Search or AirPrice request, use Add Offer instead.

As an alternative to the usual JSON API workflow that starts with Search, you can skip the Search and AirPrice steps and start directly with booking A confirmed reservation with the carrier. A held booking is a reservation that has not yet been ticketed. The terms booking and reservation are interchangeable.. You must already have full details for the itinerary The entire trip on a booking, including all flights on all legs. Also called a journey. to book.

Add Product is a full payload In the JSON APIs, an API call that sends all details of the flight/s to be shopped, priced, added to the workbench, etc. instead of sending a reference to an offer in a previous API response. request best suited for corporate customers who frequently travel the same itinerary and do not need or want to check price or alternative options. The request sends flight and class of service data as sourced from outside the JSON APIs.

Add Product is sent in the booking workflow instead of Add Offer: Initiate Workbench > Add Product > Add Traveler > Workbench Commit.

You cannot book seats or ancillaries in the Add Product flow, but you can add them after creating the booking.

Request

Also see Authorization and Common Headers.

Query Parameters

None.

Request Body

Show Request Body Table

Object	Description	Required/Optional
ProductQueryBuildFromProducts	Top level object. Includes PassengerCriteria and ProductCriteriaAir.	Required
PassengerCriteria	Array. Defines the type of passenger/s on the itinerary. Send one instance for each passenger type code (PTC Passenger Type Code, used to categorize travelers. The most common PTCs are adult (ADT), child (CNN), and infant (INF). You can request a maximum of 9 passengers in one Search request.). Up to 9 total passengers across all PTCs are supported.	Required
passengerTypeCode	String. The passenger type code for the passengers on the itinerary. Common PTCs are: ADT: adult CHD: child of unknown age CNN: child when age is known INF: infant without a seat INS: infant with a seat UNN: unaccompanied child See Downloads to download a full list of PTCs.	Required
number	Number. The number of passengers with this PTC.	Required
ProductCriteriaAir	Array. Top level object. Send one instance for each leg The flight or connecting flights between one origin and destination pair. For example, on a round-trip flight, LAX > MSP could be the first leg (aka outbound leg) and MSP > DEN > LAX could be the second leg (aka inbound leg). The JSON APIs use the term product (see below) to represent one leg of the itinerary. of the itinerary to price. Includes SpecificFlightCriteria.	Required
sequence	The sequence number of this leg of the itinerary. For example, on a round-trip An itinerary in which travel goes to a single destination and returns to the origin. E.g., LHR > CDG and CDG > LHR. itinerary, the sequence number of the outbound leg is 1 and the inbound leg is 2.	Required for itineraries with multiple legs
SpecificFlightCriteria	Array. Flight details. Send one instance for each flight on this leg of the itinerary.	Required
carrier An airline.	IATA International Air Transportation Association, an organization that standardizes rules, regulations and fare construction principles for the international travel industry. airline code.	Required
flightNumber	Carrier flight number.	Required
departureDate	String. Date of departure in YYYY-MM-DD format (e.g., departureDate="2022-12-06").	Required
arrivalDate	String. Date of arrival in YYYY-MM-DD format (e.g., arrivalDate="2023-12-09").	Required
from	IATA airport code for departure airport.	Required
to	IATA airport code for arrival airport.	Required
classOfService	IATA class of service code.	Required
cabin	IATA cabin class code.	Required
segmentSequence	When sending multiple flights for this leg, specify the sequence of each in the leg. Note that the segmentSequence value for connecting flights is the same; for example, for two connecting flights on the outbound or first leg of the itinerary, both flights have the segmentSequence value 1. For example, for connecting flights MSP>ATL>DEN on the outbound leg, send both MSP>ATL and ATL>DEN with a segmentSequence value of 1.	Required when multiple flights on leg

Response

Show Response Body Table

Object	Description
ProductListResponse	Top level object. Includes Product.
Product	Top level object. Includes Identifier.
Identifier	Returns system-assigned identifier for this product. Key value pairs: authority: Source of information. value: Unique system-generated identifier In the JSON APIs, a unique identifier for specific, unique data, such as an entire response or an offer, product, or brand in a response. These identifiers must often be sent in subsequent requests to refer to a previous response, offer, product, etc. Usually returned in Identifier/value for the referenced object. Example format: 3cecf1be-0b21-4881-8f33-ae11c8d7b708. See the JSON APIs Guide..

Object

Description

ProductListResponse

Top level object.

Includes Product.

Product

Top level object.

Includes Identifier.

Identifier

Returns system-assigned identifier for this product.

Key value pairs:

authority: Source of information.

value: Unique system-generated identifier In the JSON APIs, a unique identifier for specific, unique data, such as an entire response or an offer, product, or brand in a response. These identifiers must often be sent in subsequent requests to refer to a previous response, offer, product, etc. Usually returned in Identifier/value for the referenced object. Example format: 3cecf1be-0b21-4881-8f33-ae11c8d7b708. See the JSON APIs Guide..

Example Request

Show Example Add Product Request

{
 "ProductQueryBuildFromProducts": {
  "PassengerCriteria": [
   {
    "number": 1,
    "passengerTypeCode": "ADT"
   }
  ],
  "ProductCriteriaAir": [
   {
    "SpecificFlightCriteria": [
     {
      "carrier": "QF",
      "flightNumber": "402",
      "departureDate": "2023-02-24",
      "arrivalDate": "2023-02-24",
      "from": "MEL",
      "to": "SYD",
      "classOfService": "Q"
     }
    ]
   }
  ]
 }
}

Example Response

Show Example Add Product Response

{
 "ProductListResponse": {
  "Product": [
   {
    "@type": "ProductAir",
    "Identifier": {
     "value": "e23ef774-30a8-4c4a-80d8-0592ba2a28fa",
     "authority": "Travelport"
    }
   }
  ]
 }
}