Seats API Reference

This topic details the requests, payloads, and responses for the Seat Map and Seat Book requests detailed in Seat Maps and Booking, which discusses the workflow and provides code examples.

In this topic:

Seat Map

POST Request

Use the following resource for the Seat Map request. 

POST search/seat/catalogofferingsancillaries/seatavailabilities

Base path:

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

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

Payload

The table below details the message payload for the Seat Map request.

Object Description Required Attributes Optional attributes

CatalogOfferingsQuerySeatAvailability

Top level object.

None

None

SeatAvailabilityOfferings

Top level object.

None

None

BuildFromReservationWorkbench

Top level object.

None

None

ReservationIdentifier

Top level object for the workbench ID.

None

None

ReservationIdentifier/Identifier

The reservation workbench ID.

authority: This value should be Travelport.

value: The ID for the reservation workbench already established for the reservation workflow.

None

OfferIdentifier

Top level object for the offer ID.

None

None

OfferIdentifier/Identifier

The identifier value for the offer.

authority: Send with a value of Travelport.

value: Send the offer identifier value:

  • If requesting seats as part the initial booking, send the identifier returned in the Add Offer step of the AirReservation workflow. You can also view the offer identifier by retrieving workbench details.
  • For an existing PNR, send the identifier value from Reservation/Offer/Identifier in the PNR retrieve.

None

ProductIdentifier

Top level object for the product ID.

None

None

ProductIdentifier/Identifier

The identifier value for the product.

  • For a GDS content, send the ‘Product id’ value in ProductIdentifier object. Send multiple instances if multiple products.

  • For a NDC content, send the ‘Product identfier’ value in ProductIdentifier object.

value: The product identifier from the offer.

None

SegmentSequence

The flight number or numbers of the flight for which to retrieve the seat map.

  • For GDS, send the flight number. GDS supports more than one flight.

  • For NDC, send a reference to the flight sequence number. Only one flight sequence number is supported.

Flight number to request seat map for, or comma-delimited list for multiple flights (GDS only).

None

Response

The table below details the objects returned in the Seat Map response.

Object Description

CatalogOfferingsAncillaryListResponse

Top level object for response.

Includes CatalogOfferingsID, Identifier, and ReferenceList objects.

CatalogOfferingsAncillaryListResponse/Identifier

Includes the following attribute:

  • value: Internal identifier for the response.

This value must be sent in any subsequent seat book request in CatalogOfferingsIdentifier/Identifier (note the s in CatalogOfferingsIdentifier).

CatalogOfferingsID

Each instance of CatalogOfferingsID returns seat details for one requested flight. Contains the following attribute:

  • id: Identifier for that CatalogOfferingsID.

Contains Identifier, AncillaryOffering, Traveler, and Flight objects.

CatalogOfferingsID/Identifier

Includes the following attribute:

  • value: Internal identifier for the CatalogOfferingsID.

This value must be sent in any subsequent seat book request in CatalogOfferingIdentifier/Identifier (note no s in CatalogOfferingIdentifier).

CatalogOffering

Top level object. Multiple instances may be returned in the case of paid seats.

Includes the following attribute:

  • id: ID for the object.

Contains ProductOptions objects. Includes Price object if paid seats are returned.

ProductOptions

Top level object.

Contains Product object.

Product

Includes the following attribute:

  • id: ID for the product seat object.

Contains SeatAvailability and SeatingChartRef objects.

SeatAvailability

The response returns several instances of SeatAvailability, each with a different seatAvailabilityStatus. Includes the following attributes:

  • seatAvailabilityStatus: The status of all seats listed in that instance of SeatAvailability. Possible values are:
    • Available: Seats are available to book.
    • NoSeat : Seats are not available.
    • Blocked : Seats are blocked and unavailable to book.
    • Reserved: Seats are reserved and unavailable to book.
  • value: A list of all seat numbers on that flight with that seatAvailabilityStatus.

SeatingChartRef

A reference identifier for the seating chart of the seats listed in the SeatAvailability object. Maps to corresponding information in the ReferenceList object below.

Price

For GDS, returned only for instances of CatalogOffering for paid seats. For NDC, returned for all instances of CatalogOffering; will have values of zero for free seats.

Traveler

Any Traveler information sent in the previous Add Traveler step.

Flight

Flight information from the selected offer.

ReferenceList

Top level object to consolidate seats information across flights.

SeatingChart

One instance of SeatingChart is returned for each flight requested. Includes the id attribute, which references the SeatingChartRef object value above.

Includes the Cabin object.

Cabin

Includes Row object.

Row

One instance of Row is returned for each row in the seat map. Returns seats information by row. Includes the following attribute:

  • label: The row number.

Includes Space object.

Space

One instance of Space is returned for each seat in the row. Includes the following attribute:

  • location: Seat number. Possible values and their meanings include the following; note that only the alpha value is returned and these meanings are examples only and may vary by aircraft and flight:

    • A: Window seat

    • B: Middle seat

    • C: Aisle seat

    • D: Aisle seat

    • E: Middle seat

    • F: Window seat

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, which adds a seat selection to the reservation workbench. 

POST book/ancillary/reservationworkbench/{workbenchId}/offers/buildancillaryoffersfromcatalogofferings

Base path:

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

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

Payload

The following table lists the objects and attributes for the Seat Book v9 request.

Object Description Required Attributes Optional attributes

OfferQueryBuildAncillaryOffersFromCatalogOfferings

Top level object.

None

None

BuildAncillaryOffersFromCatalogOfferings

Details for one seat on one flight. Send one instance for each traveler on each flight.

See Seats for examples.

None

Includes CatalogOfferingsIdentifier, CatalogOfferingIdentifier, TravelerIdentifier, and SeatAssignment objects.

None

CatalogOfferingsIdentifier

Top level object.

None

None

CatalogOfferingsIdentifier/Identifier

The identifier value for the seat map response.

Required for GDS only

value: Send the value from CatalogOfferingsAncillaryListResponse/
Identifier in the seat map response.

CatalogOfferingIdentifier

Top level object.

None

None

CatalogOfferingIdentifier/Identifier

The identifier value for the seat map offer in the response.

value: Send the value from CatalogOfferingsAncillaryListResponse/
CatalogOfferingsID/Identifier in the seat map response.

TravelerIdentifier

The traveler for whom to book the seat.

Required for GDS only

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 when the post-commit workbench is created.

SeatAssignment

Seat number.

Send the seat number to book for the identified traveler on the identified seat map response and offer.

Response

The response returns an identifier for the transaction.

Object Description

OfferListResponse

Top level object.

OfferID

Includes the Identifier object.

In the Seat book response for Seats 21.9.3 and later, OfferListResponse/OfferID for NDC is returned with type of Offer, while the same object in the GDS response is returned with type of OfferIdentifier.

Identifier

Includes the following attributes:

authority: Value of Travelport.

value: Provides the transaction identifier.