Skip to content
Last updated

Flights API Endpoints

This topic provides a consolidated list of endpoints and associated methods for all v11 Flights APIs.

See Common Headers for the header parameters to send with all Air requests.

See the individual API References for query parameters and payloads.

Authentication

All Travelport TripServices APIs require authentication with OAuth 2.0. Before calling any API, you must follow an OAuth-based authorization procedure to obtain an access token. That access token is valid for 24 hours and must be sent with every call during that time. Do not request a new token for each API call. See Authentication for full details.

Use these endpoints for authentication requests:

Pre-production https://auth.pp.travelport.net/oauth/token

Production https://auth.travelport.net/oauth/token

Base Path for Flights APIs

Every TripServices API requires a request sent to an authorization endpoint unique to that API. This unique endpoint is listed at the top of every API Reference in this online help. In addition, this topic provides a consolidated list of all endpoints.

The beginning string of these endpoints are the same across almost all Flights APIs, and is called a base path because it is shared across APIs. The following are the current, post-migration base paths for the TripServices Flights API endpoints.

Base path:

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

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

Combine the appropriate base path with the Flights API authorization endpoints in the next section. For example, the complete post-migration endpoint for the Search API in the production environment is

https://api.travelport.net/11/air/catalog/search/catalogproductofferings

The following TripServices APIs do not include /air in their base path, generally because they can also be used for non-air content, as noted below and in their API References: Cancel Workbench Items, Document History, Document List, Batch Void, and the GDS Exchange APIs. messages.

TripServices Flights API Endpoints

ActionEndpoint (add to Base Path above)

Search

POST catalog/search/catalogproductofferings

When sending a flex search request, append /premiumflex to the endpoint above

Next Leg Search

POST catalog/search/catalogproductofferings/buildnext

When sending a flex search request, append /premiumflex to the endpoint above

Flight Specific Search (both reference and full payload)

POST catalog/search/catalogproductofferings/buildoptions

When sending a Premium Flex full payload request, use the endpoint catalog/search/catalogproductofferings/buildpremiumflexoptions

Air AvailabilityPOST search/airAvailability

AirPrice

ActionEndpoint (add to Base Path above)
AirPrice reference payloadPOST price/offers/buildfromcatalogproductofferings
AirPrice full payloadPOST price/offers/buildfromproducts
Autoprice / Manual Fare for unpriced segmentsPOST book/airoffer/reservationworkbench/{workbenchID}/offers/buildfromunpricedsegments
Fare displayPOST air/faredisplay/fares

Standalone Fare Rules

ActionEndpoint (add to Base Path above)
Follow-on request for standalone fare rulesGET farerule/farerules

Seats, Ancillaries, and EMDs

ActionEndpoint (add to Base Path above)
Ancillary searchPOST ancillaryshop/catalogofferingsancillaries
Ancillary pricePOST ancillaryprice/offers/buildancillaryoffersfromcatalogofferings
Seat map (reference payload)POST search/seat/catalogofferingsancillaries/seatavailabilities
Standalone seat map (full payload)POST search/seat/catalogofferingsancillaries/seatavailabilities
Seat/ancillary book (add seat or ancillary to workbench)POST book/airoffer/reservationworkbench/{workbenchID}/offers/buildancillaryoffersfromcatalogofferings
Cancel seat or ancillaryPOST book/airoffer/reservationworkbench/{workbenchID}/offers/canceloffer
Retrieve an EMDGET emds/{EMDNumber}
Void an EMDPUT emds/{EMDNumber}

AirReservation (workbench and booking flow)

For {workbenchID}, send the workbench identifier returned when the workbench was created. For {LocatorCode} send the reservation locator code. For {ticketID} send the ticket number. For {OfferID} send the offer identifier.

ActionEndpoint (add to Base Path above)
Create a workbench for a new reservationPOST book/session/reservationworkbench
Create a post-commit workbench to update or ticket an existing reservationPOST book/session/reservationworkbench/buildfromlocator?Locator={LocatorCode}

Cancel workbench Items (cancels a booking, or removes only specified offers, segments, etc. from a booking or from the workbench)

POST book/reservationworkbench/{workbenchID]}/reservations/cancelitems

The base path varies from most TripServices APIs and does not use /air; see Cancel Workbench Items.

Retrieve workbench detailsGET book/session/reservationworkbench/{workbenchID}
Commit the workbenchPOST book/reservation/reservations/{workbenchID}
Discard workbenchDEL book/session/reservationworkbench/{workbenchID}
Add offer to workbench - reference payloadPOST book/airoffer/reservationworkbench/{workbenchID}/offers/buildfromcatalogofferings
Add offer to workbench - full payloadPOST book/airoffer/reservationworkbench/{workbenchID}/offers/buildfromproducts
Add unpriced segment to workbenchPOST book/airoffer/reservationworkbench/{workbenchID}/offers/unpricedsegments
Autoprice / Manual Fare for unpriced segmentsPOST book/airoffer/reservationworkbench/{workbenchID}/offers/buildfromunpricedsegments
Add a single traveler to workbenchPOST book/traveler/reservationworkbench/{workbenchID}/travelers
Add multiple travelers in one request to workbenchPOST book/traveler/reservationworkbench/{workbenchID}/travelers/list
Copy traveler details from the host to the workbench with Host Profile MovePOST book/profile/reservationworkbench/{workbenchID}/clientprofile
Commit the workbench and create bookingPOST book/reservation/reservations/{workbenchID}
Retrieve a reservationGET book/reservation/reservations/{LocatorCode}
Document HistoryPOST documents/history

The base path varies from most TripServices APIs and does not use /air; see Document History.

Custom Rules

ActionEndpoint (add to Base Path above)
Add a custom rule to a bookingPOST book/customrule/customrules/{workbenchID}?RuleRecordName={NAME}
Delete a custom rule from a bookingGET book/customrule/customrules?PCC={PCC}?RuleRecordSequence={XYZ}
Return a list of all custom rules associated with a PCCGET book/customrule/customrules?PCC={PCC}
Return details of a specific custom rule associated with a PCCDEL book/customrule/customrules?PCC={PCC}?RuleRecordName={NAME}

Remarks and Special Service Requests

ActionEndpoint (add to Base Path above)
Add primary contact remarks

See Remarks & Service Requests Guide for details on all requests in this table.

POST book/primarycontact/reservationworkbench/{workbenchID}/primarycontacts
Delete a primary contact remarkDEL book/primarycontact/reservationworkbench/{workbenchID}/primarycontacts/{PrimaryContactID}
Add general and OSI remarksPOST book/remarks/reservationworkbench/{workbenchID}/reservationcomments/list
Add special servicePOST book/specialservices/reservationworkbench/{workbenchID}/specialservices/list
Delete special mealDEL book/specialservices/reservationworkbench/{workbenchID}/specialservices/{SpecialServiceID}
Delete multiple SSRsDEL book/specialservices/reservationworkbench/{workbenchID}/specialservices/deletemultiple
Add document override remarksPOST book/documentoverride/Reservation/{workbenchID}/documentoverrides
Add accounting, historical, and DOCI remarksPOST book/accounting/reservationworkbench/{workbenchID}/accountings

Travel Agency Details

ActionEndpoint (add to Base Path above)

Add, modify, or delete a travel agency corporate ID

POST ticket/travelagency/reservationworkbench/{workbenchID}/travelagency/addcorporatecode

PUT ticket/travelagency /reservationworkbench/{workbenchID}/travelagency/{travelagencyID}/updatecorporatecode

DEL ticket/travelagency/reservationworkbench/{workbenchID}/travelagency/{travelagencyID}/deletecorporatecode

Add travel agency details to a booking in a single payloadPOST ticket/travelagency/reservationworkbench/{workbenchID}/travelagency

Add, modify, or delete a travel agency address on a booking

POST ticket/travelagency /reservationworkbench/{workbenchID}/travelagency/{travelagencyID}/updateaddress

PUT ticket/travelagency /reservationworkbench/{workbenchID}/travelagency/{travelagencyID}/updateaddress

DEL ticket/travelagency /reservationworkbench/{workbenchID}/travelagency/{travelagencyID}/deleteaddress{addressID}

Add, modify, or delete a travel agency email on a booking

POST ticket/travelagency/reservationworkbench//{workbenchID}/travelagency/{travelagencyID}/addemail

PUT ticket/travelagency/reservationworkbench//{workbenchID}/travelagency/{travelagencyID}/updateemail

DEL ticket/travelagency/reservationworkbench/{workbenchID}/travelagency/{travelagencyID}//deleteemail/{emailID}

Add, modify, or delete a travel agency telephone number on a booking

POST ticket/travelagency/reservationworkbench/{workbenchID}/travelagency/{travelagencyID}/addtelephone

PUT ticket/travelagency/reservationworkbench/{workbenchID}/travelagency/{travelagencyID}//updatetelephone

DEL ticket/travelagency/reservationworkbench/{workbenchID}/travelagency/{travelagencyID}/deletetelephone/{telephoneID}

Reservation Modify (non-air details)

ActionEndpoint (add to Base Path above)
Retrieve a list of updatable items by traveler identifierPOST book/updatableItem/reservationworkbench{workbenchID}/travelerupdatableitems/buildfromtraveler
Update traveler information after an updatable items requestPUT book/traveler/reservationworkbench/{workbenchID}/travelers/updatefromtravelerupdateditems/{TravelerID}
Reservation dividePOST book/reservation/reservations/divide

AirTicketing

ActionEndpoint (add to Base Path above)
Add form of paymentPOST payment/reservationworkbench/{workbenchID}/formofpayment
Update form of paymentPUT payment/reservationworkbench/{workbenchID}/formofpayment/{FormOfPayment_Identifier}
Delete form of paymentDEL payment/reservationworkbench/{workbenchID}/formofpayment/{FormOfPayment_Identifier}
Add paymentPOST paymentoffer/reservationworkbench/{workbenchID}/payments
Commit the workbench and issue ticketPOST book/reservation/reservations/{workbenchID}
List all tickets on a reservationGET receipt/reservations/{LocatorCode}/receipts
Return ticket details for all tickets for a booking (GDS) or for a single ticket (NDC)POST ticket/tickets/getbylocator
Cancel a reservation for GDSPOST receipt/reservations/{LocatorCode}/receipts
Void single ticket for GDSPUT ticket/tickets/updatestatus/{ticketID}

Batch void multiple tickets on a GDS booking

POST documents/void

The base path varies from other TripServices Flights APIs and does not use /air.

Return details for a single GDS ticket with Ticket Display (GDS, single ticket only)GET ticket/tickets/{ticketID}
Queue placementPOST queue/queue
List all bookings on the queuePOST queue/queue/list
Remove a booking from the queuePOST queue/queue/remove

NDC Modify, Cancel, and Exchange

ActionEndpoint (add to Base Path above)
Reshop in workflow to modify booking or exchange ticket for NDCPOST change/catalogofferingsairchange
Reprice in workflow to modify booking or exchange ticket for NDCPOST reprice/reservationworkbench/{workbenchID}/offers/buildfromcatalogofferings
Modify to commit workbench to modify booking or exchange ticket for NDCPOST modify/reservations/{LocatorCode}
Standalone Reprice to reprice itinerary before or after price guarantee expiresPOST reprice/reservationworkbench/{workbenchID}/offers/buildfromoffer
Refund quote when canceling and refunding NDC ticketPOST book/airoffer/reservationworkbench/{workbenchID}/offers/canceloffer
Cancel when voiding, canceling, or refunding NDC booking or ticketPOST receipt/reservation/{workbenchID}/receipts?OfferIdentifier={OfferID}
Cancel payment when voiding NDC ticket and payment but retaining segmentsPOST paymentoffer/reservationworkbench/{workbenchID}/payments/{paymentID}

GDS Ticket Exchange

Endpoints for Add FOP, Add Payment, and Workbench Commit for exchanges are the same as in AirTicketing above. See the Exchange, Refund, and Void Guide for usage details.

ActionEndpoint

Eligibility using either the Ticket or Locator query parameter

POST eligibility/ticketchangeeligibilities

The base path varies from other TripServices Flights APIs and does not use /air at the end.

Exchange Search

POST exchangesearch/catalogofferingsairchange

The base path varies from other TripServices Flights APIs and does not use /air at the end.

Add/Modify Offer reference payload

POST book/offer/reservationworkbench/{workbenchID}/offers/buildfromcatalogofferings

(add to Base Path above)