Seats API Reference
This topic details the requests, payloads, and responses for the Seat Map and Seat Book requests in Seat Maps and Booking, which discusses the workflow and provides code examples.
In this topic:
Seat Map
GET Request
Use the following resource for the seat map request.
GET search/seat/reservations/{workbenchID}/offers/{offerId}/productAirs/{productAirId}/segments/{segmentId}
Base path:
Pre-production https://api.pp.travelport.com/6/air/
Production https://api.travelport.com/6/air/
The table below details the variables in the GET request.
Variables | Description | Required/Optional |
---|---|---|
{reservationID} |
ID for the reservation workbench already established. |
Required |
{offerID} |
ID of the selected offer. Send the offer id returned in Reservation/Offer/id in either the PNR retrieve (if the itinerary has already been booked) or by retrieving workbench details. |
Required |
{productID} |
ID of the selected product. |
Required |
{flightID} |
ID of the flight. |
Required |
Response
The table below details the objects returned in the Seat Map response.
Object | Description |
---|---|
CatalogOfferingsResponse |
Top level object for response. Includes CatalogOfferings and Identifier objects. |
CatalogOfferings |
Top level object for CatalogOfferings. Contains Identifier. |
CatalogOffering |
Returned as type CatalogOffering for NDC content and as type CatalogOfferingSupplierResponse for GDS. |
ProductOptions |
Top level object. |
Product |
The seat availability response returns two instances of Product, one of type ProductAir and another of type ProductSeatAvailability:
|
SeatAvailability |
The response returns several instances of SeatAvailability, each with a different status in seatAvailabilityStatus. Includes the following attributes:
|
SeatingChartRef |
A reference identifier for the seating chart of the seats listed in the SeatAvailability object. |
TermsAndConditions |
Includes the Traveler object and any traveler information sent in the Add Traveler step. |
Identifier |
Internal identifier for the seat availability response. Note: This identifier must be sent in any subsequent seat book request. |
ReferenceList |
Consolidates seats information. |
SeatingChart |
Includes the id attribute, which references the SeatingChartRef object. Includes the Cabin object. |
Cabin |
Returns seats information by row. Includes Row object. |
Row |
Contains details for one row. Includes the following attribute:
Includes Space object. |
Space |
Contains detail for one seat in the row. Includes the following attribute:
Includes the Characteristic object. |
Characteristic |
List of characteristics for that seat. For the list of characteristic codes refer to IATA PADIS 9882. |
Seat Book
POST Request
Use the following resource for the seat book request. Send the workbenchID and the ID for the seats offer.
POST book/ancillary/reservations/{workbenchID}/offers/{offerId}
Base path:
Pre-production https://api.pp.travelport.com/6/air/
Production https://api.travelport.com/6/air/
Payload
The following table lists the objects and attributes for the Seat Book request. The response returns an identifier for the transaction.
Object | Description | Required Attributes | Optional attributes |
---|---|---|---|
OfferQueryBuildAncillaryOffersFromCatalogOfferings |
Top level object. |
None |
None |
BuildAncillaryOffersFromCatalogOfferings |
Top level object. If selecting seats for more than one traveler, send one instance for each traveler. See Seats v6 for examples.
|
None |
None |
CatalogOfferingsIdentifier |
Top level object. |
None |
None |
CatalogOfferingsIdentifier/Identifier |
The identifier value for the seat offer. |
value: The value from CatalogOfferingsResponse/Identifier/value in the seat availability response. |
None |
TravelerIdentifier |
The traveler for whom to book the seat. |
None |
None |
TravelerIdentifier/Identifier |
Traveler ID. |
authority: Should always be Travelport. value: The traveler identifier returned in the Add Traveler response. For the post-reservation workflow the traveler identifier is returned in the response to creating a workbench post-reservation. |
|
Response
The response returns an identifier for the transaction.
Object | Description |
---|---|
OfferResponse |
Top level object. |
OfferID |
Includes the Identifier object. |
Identifier |
Includes the following attributes: authority: Value of Travelport. value: Provides the transaction identifier. |