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.

Base path:

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

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

The Ancillary Book request adds a selected ancillary to a workbench for either a new booking or an existing reservation. You must first send an Ancillary Shop request and, for NDC only, an Ancillary Price request.

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

Also see Authorization and Common Headers.

Query Parameters

None.

Request Body

Show Ancillary Book Request Body Table - GDS

Object	Description	Required/Optional
OfferQueryBuildAncillaryOffersFromCatalogOfferings	Top level object.	Required
BuildAncillaryOffersFromCatalogOfferings	Top level object.	Required
CatalogOfferingsIdentifier	Includes response transaction identifiers from the ancillary shop response.	Required
id	Send the value returned in CatalogOfferingsID/id from the Ancillary Shop response.	Required
CatalogOfferingsIdentifier/Identifier	Sends identifiers from ancillary shop response.	Required
authority	Send the value in CatalogOfferingsID/CatalogOffering/Identifier/authority from the Ancillary Shop response.	Required
value	Send the value in CatalogOfferingsID/CatalogOffering/Identifier/value from the Ancillary Shop response.	Required
CatalogOfferingIdentifier	Sends offer identifier.	Required
id	Send value in CatalogOfferingsID/CatalogOffering/id from the Ancillary Shop response.
ProductIdentifier	Sends product identifier.	Required
id	Send the value in CatalogOfferingsID/CatalogOffering/ProductOptions/Product/id for the product you want to book from the Ancillary Shop response.	Required
TravelerIdentifierRef	Sends identifier of traveler for whom to price the ancillary.	Required
id	Send the value in CatalogOfferingsID/TravelerIdentifierRef/id from the Ancillary Shop response. You can also verify passenger ID details via a Reservation Retrieve.	Required
Quantity	The amount of this ancillary product requested.	Required

Show Ancillary Book Request Body Table - NDC

Because Ancillary Price is a required step for NDC ancillaries, and not supported for GDS, the NDC ancillary book request differs slightly from the GDS request, and it sends identifiers from the Ancillary Price response, not the Ancillary Shop response.

Object	Description	Required/Optional
OfferQueryBuildAncillaryOffersFromCatalogOfferings	Top level object.	Required
BuildAncillaryOffersFromCatalogOfferings	Top level object.	Required
CatalogOfferingsIdentifier	Includes response transaction identifiers from the ancillary price response.	Required
CatalogOfferingsIdentifier/Identifier	Sends transaction identifiers from ancillary price response.	Required
authority	Send the value in OfferListResponse/Identifier/authority from the Ancillary Price response.	Required
value	Send the value in OfferListResponse/Identifier/value from the Ancillary Price response.	Required
CatalogOfferingIdentifier	Sends offer identifier.	Required
id	Send value in OfferID/id from the Ancillary Price response.	Required
ProductIdentifier	Sends product identifier.	Required
id	Send the value in OfferID/Product/id from the Ancillary Price response.	Required
TravelerIdentifierRef	Sends identifier of traveler for whom to book the ancillary.	Required
id	Send identifier of traveler for whom to book the ancillary, returned in the Create Workbench response. You can also verify passenger ID details via a Reservation Retrieve.	Required
Quantity	The amount of this ancillary product requested.	Required

Response

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

Show Ancillary Book Response Table

Object	Description
OfferListResponse	Top level object. Returns OfferID, Identifier, and ReferenceList objects.
OfferID	Returns product and pricing details for booked offer. Key value pair: id: Internal offer id. Includes Identifier, Product, Price, and TermsAndConditions objects.
OfferID/Identifier	Identifier for the offer. Key value pairs: authority: Source of information. value: Unique system-generated identifier.
Product	Array. Returns one instance of @type ProductAncillary to detail the ancillary product. Key value pair: id: Internal product id. Includes Quantity and Ancillary.
Quantity	The available number of this ancillary product.
Ancillary	Details of this ancillary. Includes Description and FlightRef.
Description	Supplier-provided description of this ancillary product. Key value pairs: code: Supplier code for ancillary. value: Supplier description of ancillary.
FlightRef	Internal reference number for the flight on which this ancillary is available. Matches to FlightRef in ReferenceList/ReferenceListFlight.
Price	Price details for this ancillary. Includes CurrencyCode, Base, TotalTaxes, TotalPrice objects.
CurrencyCode	The currency in which the price is returned. Unless changed in the request, the currency is the default associated with your provisioned PCC from Travelport. Key value pairs: decimalPlace: Number of decimal places in the currency. value: Currency code value.
Base	Base price before taxes.
TotalTaxes	Sum of all taxes for the product.
TotalPrice	Total price including base and taxes.
TermsAndConditionsFull	Returned with @typeTermsAndConditionsFullAncillary. Terms and conditions for this ancillary. Includes TravelerProduct and ApplicationLimit.
TravelerProduct	Includes TravelerIdentifierRef.
TravelerIdentiferRef	Returns details of the traveler the ancillary is priced for. Key value pairs: id: Internal system-generated traveler id. value: Internal system-generated traveler id.
ApplicationLimit	Any restrictions on the number of this ancillary product that can be purchased. Key value pairs: start: Minimum quantity that can be purchased. end: Maximum quantity that can be purchased. value: The unit represented by this quantity. Possible values are: PassengerSegment: Ancillary limit applies to each passenger at the segment level. E.g, Itinerary is LON-SIN-LON and the ancillary limit is “n” per segment per passenger. Segment: Ancillary limit applies to all passengers at the segment level (one flight, or flights under the same number). Itinerary: Ancillary limit applies to all passengers for the full itinerary. Passenger: Ancillary limit applies per passenger for the full itinerary. PassengerOD: Ancillary limit applies per passenger for the origin destination. E.g., Itinerary is LON X/SIN SYD X/SIN LON and the ancillary limit is “n” per origin destination (LON XSIN SYD) Other For example, a start quantity of 1 and end quantity of 2 with a value of Itinerary means that at least 1 but no more than 2 of this ancillary product can be purchased for the full itinerary.
OfferListResponse/Identifier	Identifier for ancillary price response as a whole. Key value pairs: authority: Source of information. value: Unique system-generated identifier. CatalogOfferingsAncillaryListResponse/Identifier/value must be sent as the response identifier in subsequent ancillary price and/or book requests.
ReferenceList	Consolidates flight details in ReferenceList/ReferenceListFlight. Includes ReferenceListFlight. See table below.

The ancillary book response returns ReferenceList/ReferenceListFlight for flight details, Note it does not return the AvailabilitySourceCode or IntermediateStop objects below.

Object	Description
ReferenceListFlight	Returns an array of Flight objects that match to the flights that make up a product. ReferenceListFlight is a common object in the model. Not all objects in this table may be returned in this specific API.
Flight	One instance for one flight. Key value pairs: distance: Distance covered by the flight. duration: Time of the flight in hours (H) and minutes (M). carrier: Airline carrier. number: Flight number. operatingCarrier: When the carrier has filed a codeshare operating carrier for the flight, the IATA code for that codeshare carrier. operatingCarrierName: Name of the marketing operating carrier. operatingCarrierNumber: Number of the operating carrier flight. If there is no operating carrier number, then CO2 emission estimates for operating carriers is not supported. GDS only; not returned for NDC. Returned only in Search response. equipment: Equipment model. Note that TRN, TRS, and BUS equipment codes indicate ground transportation. id: id for internal flight reference number, also used in products and offers. subjectToGovernmentApproval: Returned with value of true when an airline has filed in its schedule that availability for a specific flight is subject to government approval. GDS only, not supported for NDC. Returned only in the Search API response. For GDS, the Flight id is formatted as the letter ‘s’+ unique numeric value, as in s1. For NDC, the Flight id is formatted as the two letter NDC carrier code + s+ unique numeric value, as in QFs1. Includes Departure, Arrival, AvailabilitySourceCode, and IntermediateStop objects.
Departure	Departure details. Key value pairs are the location, date, time, and terminal of departure.
Arrival	Arrival details. Key value pairs are the location, date, time, and terminal of arrival.
AvailabilitySourceCode	Returned to assist in troubleshooting. Returned in Search, Air Availability, Exchange Search, AirPrice, and AirReservation commit responses. Recommended to be sent in the AirPrice Full Payload and Add Offer Full Payload requests. Supported values and definitions for AvailabilitySourceCode are as follows: A: AVS (availability and schedules) B: Travelport cache C: AVS D: Direct Access E: Travelport cache F: Travelport cache G: Travelport cache H: Travelport cache I: Travelport cache K: Travelport cache L: Last seat availability M: Unknown source O: Travelport cache P: Travelport cache Q: Travelport cache S: Seamless T: Travelport cache U: Unknown source X: Customer reusing availability data from customer cache (data originally obtained from Travelport) Y: Customer reusing data obtained from another system (e.g., another GDS) (data may be fresh or stored in customer cache) Z: Customer sold from e-streamed data stored in customer cache
IntermediateStop	Returned if the flight has a technical stop but does not incur a change in flight number. Returned only in Search and Exchange Search responses. Key value pairs: arrivalFlightDuration: Length in hours and minutes of the flight arriving at the stop. departureFlightDuration: Length in hours and minutes of the flight departing the stop. duration: Length in hours and minutes on the ground of the intermediate stop. equipment: Equipment model, if there is a change of equipment during the stop. arrivalDate: Arrival date for stop. departureDate: Departure date of stop. arrivalTime: Arrival time for stop. departureTime: Departure time for stop. arrivalTerminal: Arrival terminal for stop. departureTerminal: Departure terminal for stop. value: The code for the airport where the intermediate stop occurs.

Example Request

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

The GDS and NDC ancillary book requests differ in the following:

The GDS book request must send CatalogOfferingsIdentifier/id per the first example below. It sends identifiers from the Ancillary Shop request. Ancillary Price is not supported for GDS.
The NDC book request does not send CatalogOfferingsIdentifier/id. It sends identifiers from the Ancillary Price request, which is a mandatory step for NDC ancillaries.

Show Example Ancillary Book Request - GDS

{
    "OfferQueryBuildAncillaryOffersFromCatalogOfferings": {
        "BuildAncillaryOffersFromCatalogOfferings": [
            {
                "@type": "BuildAncillaryOffersFromCatalogOfferings",
                "CatalogOfferingsIdentifier": {
                    "id": "CT1",
                    "Identifier": {
                        "authority": "Travelport",
                        "value": "85d34008-c5ad-42f6-99ee-a7c0e6d5a2a3"
                    }
                },
                "CatalogOfferingIdentifier": {
                    "id": "anc_off2"
                },
                "ProductIdentifier": {
                    "id": "an2"
                },
                "TravelerIdentifierRef": {
                    "id": "travelerRefId_1"
                },
                "Quantity": 1
            }
        ]
    }
}

Show Example Ancillary Book Request - NDC

The following example adds an ancillary to the workbench for NDC.

{
 "OfferQueryBuildAncillaryOffersFromCatalogOfferings": {
  "BuildAncillaryOffersFromCatalogOfferings": [
   {
    "@type": "BuildAncillaryOffersFromCatalogOfferings",
    "CatalogOfferingsIdentifier": {
     "Identifier": {
      "authority": "Travelport",
      "value": "653f9c6f-4618-44e5-8f2d-2a23dd6fcc40_PC"
     }
    },
    "CatalogOfferingIdentifier": {
     "id": "SQa1"
    },
    "ProductIdentifier": {
     "id": "SQpa0"
    },
    "Quantity": 1,
    "TravelerIdentifierRef": {
     "id": "CT1"
    }
   }
  ]
 }
}

Example Response

Show Example Ancillary Book Response

The following example includes details about the ancillary added to the workbench.

{
    "OfferListResponse": {
        "transactionId": "261428fc-2428-411f-89e6-e9c8deef6c79",
        "OfferID": [
            {
                "@type": "Offer",
                "id": "an_o1",
                "Identifier": {
                    "authority": "Travelport",
                    "value": "45616c60-f5af-40e1-b978-d195b9c9d731"
                },
                "Product": [
                    {
                        "@type": "ProductAncillary",
                        "id": "an1",
                        "Quantity": 1,
                        "Ancillary": {
                            "@type": "AncillaryAir",
                            "quantity": 1,
                            "Description": [
                                {
                                    "code": "BG",
                                    "subCode": "0C1",
                                    "value": "EXTRA 15KG FOR KG ALLOWANCE"
                                }
                            ],
                            "FlightRef": [
                                "Flight_01"
                            ]
                        }
                    }
                ],
                "Price": {
                    "@type": "PriceDetail",
                    "CurrencyCode": {
                        "value": "AUD"
                    },
                    "Base": 22.73,
                    "TotalTaxes": 2.27,
                    "TotalPrice": 25
                },
                "TermsAndConditionsFull": [
                    {
                        "@type": "TermsAndConditionsFullAncillary",
                        "TravelerProduct": [
                            {
                                "@type": "TravelerProduct",
                                "TravelerIdentifierRef": {
                                    "name": "TESTFIRST",
                                    "passengerTypeCode": "ADT",
                                    "id": "travelerRefId_1",
                                    "value": ""
                                },
                                "ProductRefs": [
                                    "an1"
                                ]
                            }
                        ],
                        "ApplicationLimit": {
                            "value": "PassengerSegment"
                        }
                    }
                ]
            }
        ],
        "Identifier": {
            "authority": "Travelport",
            "value": "85d34008-c5ad-42f6-99ee-a7c0e6d5a2a3"
        },
        "ReferenceList": [
            {
                "@type": "ReferenceListFlight",
                "Flight": [
                    {
                        "@type": "Flight",
                        "duration": "PT1H35M",
                        "carrier": "QF",
                        "number": "407",
                        "equipment": "73H",
                        "id": "Flight_01",
                        "Identifier": {
                            "authority": "Travelport",
                            "value": "feb8d4aa-338e-4e0f-930b-eeaa1ce2a2cc"
                        },
                        "Departure": {
                            "@type": "Departure",
                            "location": "SYD",
                            "date": "2022-07-13",
                            "time": "06:45:00"
                        },
                        "Arrival": {
                            "@type": "Arrival",
                            "location": "MEL",
                            "date": "2022-07-13",
                            "time": "08:20:00"
                        }
                    }
                ]
            }
        ]
    }
}