Ancillary Book API Reference

POST

book/airoffer/reservationworkbench/{workbenchID}/offers/buildancillaryoffersfromcatalogofferings

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

Use this base path if you have not yet received or not migrated to the new credentials from Travelport:

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

Use this base path after you have migrated to the new credentials from Travelport (.net instead of .com):

Pre-production https://api.pp.travelport.net/11/air/ | Production https://api.travelport.net/11/air/

Related Content: Ancillary and EMD Guide, Ancillary Shop API Reference, Ancillary Workflow Diagram

The Ancillary Book request adds a selected ancillary to a workbench for an existing reservation. You must first send an Ancillary Shop request and, for NDC only, an Ancillary Price request. Ancillaries can include baggage, pets, meals, lounge access, wifi, etc.

See the Ancillary and EMD Guide for a list of supported ancillaries. To book seats, use the Seat Book request.

To add ancillaries or seats to a multi-offer booking, send the Ancillary Shop or Seat Map request, then send one book request for each offer, in any order. Supported in the initial booking workflow only for free seats; supported for an existing booking for both ancillaries and seats. GDS only; multi-offers not supported for NDC.
You may also need to add payment for the ancillary in the same workbench session. See payment and EMD details in the Ancillary and EMD Guide.

Request

As part of the request requirements, also see Authentication and Common Air Headers.

Query Parameters

None.

Request Body

Response

The Ancillary Book response returns details of the ancillary added to the workbench.

Example Request

For additional examples, download the developer toolkits and see Using Postman and Developer Toolkits.

The GDS ancillary book request sends identifiers from the Ancillary Shop request. Ancillary Price is not supported for GDS.

The NDC ancillary book request sends identifiers from the Ancillary Price request, which is a mandatory step for NDC ancillaries.

Some carriers require a freeform text comment for certain types of ancillary bookings. The following example shows a complete Ancillary Book request including a Comments object to send a required freeform text comment.

If such a comment is required by the carrier but not provided, when possible, Ancillary Book determines the required comment from a static SSR table maintained by Travelport and automatically adds that comment to the booking; see the response examples below. If the comment or formatting is not accepted by the carrier, the ancillary booking fails. Recommended best practice is to send in the Ancillary Book request the applicable comment for carriers that require it when possible.

 

Example Response

Some carriers require a freeform text comment for certain types of ancillary bookings. If such a comment is not provided, when possible, Ancillary Book determines the required comment from a static SSR table maintained by Travelport and automatically adds that comment to the booking. The following example shows the Special Service object automatically added in this case.

If the comment or formatting is not accepted by the carrier, the ancillary booking fails. Recommended best practice is to send in the Ancillary Book request the applicable comment for carriers that require it when possible, per the example request earlier.