Endpoints

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

See the API references for any required or optional query parameters.

See Common Headers for the header parameters that must be sent with all Air requests.

In this topic:

Authorization
Base Path
Endpoints

Authorization

For authorization tokens, send your request to the following endpoint as appropriate:

Pre-production: https://oauth.pp.travelport.com/oauth/oauth20/token

Production: https://oauth.travelport.com/oauth/oauth20/token

Base Path

Use the following base path for all air endpoints, either pre-production or production as appropriate. Production endpoints can be used only after you are provisioned.

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

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

You must send your request to the correct version of the API you are using - check the version in the URL of the endpoint, and make sure it matches the version indicated in your message headers.

Search

Action	Endpoint (add to Base Path above)
Search	POST catalog/search/catalogproductofferings
Next Leg Search	POST catalog/search/catalogproductofferings/buildnext
Flight Specific Search (both reference and full payload)	POST catalog/search/catalogproductofferings/buildoptions
Air Availability	POST search/airAvailability

AirPrice

Action	Endpoint (add to Base Path above)
AirPrice reference payload	POST price/offers/buildfromcatalogproductofferings
AirPrice full payload	POST price/offers/buildfromproducts
Standalone Price (part of the Add Product booking workflow)	POST book/airoffer/reservationworkbench/{workbenchID}/offers/buildfromshoppingcartproducts
Fare display	POST pending

Standalone Fare Rules

Action	Endpoint (add to Base Path above)
Follow-on request for standalone fare rules after a Search or AirPrice response, or for an existing booking (post-commit)	GET farerule/farerules

Ancillaries and EMDs

Action	Endpoint (add to Base Path above)
Ancillary search	POST ancillaryshop/catalogofferingsancillaries
Ancillary price	POST ancillaryprice/offers/buildancillaryoffersfromcatalogofferings
Ancillary book (add ancillary to workbench)	POST book/airoffer/reservationworkbench/{workbenchID}/offers/buildancillaryoffersfromcatalogofferings
Retrieve an EMD	GET emds/{EMDNumber}
Void an EMD	PUT emds/{EMDNumber}

Seats

Action	Endpoint (add to Base Path above)
Return a seat map for the specified segment	POST search/seat/catalogofferingsancillaries/seatavailabilities
Seat book (add seat to workbench)	POST book/airoffer/reservationworkbench/{workbenchID}/offers/buildancillaryoffersfromcatalogofferings
Cancel a seat selection in the reservation workbench	POST book/airoffer/reservationworkbench/{workbenchID}/offers/canceloffer

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.

Action	Endpoint (add to Base Path above)
Create a workbench for a new reservation	POST book/session/reservationworkbench
Create a post-commit workbench to update or ticket an existing reservation	POST book/session/reservationworkbench/buildfromlocator?Locator={LocatorCode}
Retrieve workbench details	GET book/session/reservationworkbench/{workbenchID}
Commit the workbench	POST book/reservation/reservations/{workbenchID}
Discard workbench	DEL book/session/reservationworkbench/{workbenchID}
Add offer to workbench - reference payload	POST book/airoffer/reservationworkbench/{workbenchID}/offers/buildfromcatalogofferings
Add offer to workbench - full payload	POST book/airoffer/reservationworkbench/{workbenchID}/offers/buildfromproducts
Add traveler to workbench	POST book/traveler/reservationworkbench/{workbenchID}/travelers
Copy traveler details from the host to the workbench with Host Profile Move	POST book/profile/reservationworkbench/workbenchID}/clientprofile
Commit the workbench and issue booking and/or EMD	POST book/reservation/reservations/{workbenchID}
Standalone Price (part of the Add Product booking workflow)	POST book/airoffer/reservationworkbench/{workbenchID}/offers/buildfromshoppingcartproducts
Add Product (part of the Add Product booking workflow)	POST book/product/reservationworkbench/{workbenchID}shoppingcart/products/buildfromproducts
Retrieve a reservation	GET book/reservation/reservations/{LocatorCode}

Custom Rules

Action	Endpoint (add to Base Path above)
Add a custom rule to a booking	POST book/customrule/customrules/{workbenchID}/?RuleRecordName={NAME}
Delete a custom rule from a booking	GET book/customrule/customrules/?PCC={PCC}?RuleRecordSequence={XYZ}
Return a list of all custom rules associated with a PCC	GET book/customrule/customrules/?PCC={PCC}
Return details of a specific custom rule associated with a PCC	DEL book/customrule/customrules/?PCC={PCC}?RuleRecordName={NAME}

Remarks and Special Service Requests

Action	Endpoint (add to Base Path above)
Add primary contact remarks See Remarks & Service Requests Guide for all requests in this table.	POST book/primarycontact/reservationworkbench/{workbenchID}/primarycontacts
Delete a primary contact remark	DEL book/primarycontact/reservationworkbench/{workbenchID}/primarycontacts/{PrimaryContactID}
Add general and OSI remarks	POST book/remarks/reservationworkbench/{workbenchID}/reservationcomments/list
Add special service	POST book/specialservices/reservationworkbench/{workbenchID}/specialservices/list
Delete special meal	DEL book/specialservices/reservationworkbench/{workbenchID}/specialservices/{SpecialServiceID}
Add document override remarks	POST book/documentoverride/Reservation/{workbenchID}/documentoverrides
Add accounting, historical, and DOCI remarks	POST book/accounting/reservationworkbench/{workbenchID}/accountings

Travel Agency Details

Action	Endpoint (add to Base Path above)
Add a travel agency corporate ID	POST ticket/travelagency/reservationworkbench/{workbenchID}/travelagency/addcorporatecode
Update a travel agency corporate ID	PUT ticket/travelagency /reservationworkbench/{workbenchID}/travelagency/{travelagencyID}/updatecorporatecode
Delete a travel agency corporate ID	DEL ticket/travelagency /reservationworkbench/{workbenchID}/travelagency/{travelagencyID}/deletecorporatecode
Add a travel agency address	POST ticket/travelagency/reservationworkbench/{workbenchID}/travelagency/addaddress
Update a travel agency address	PUT ticket/travelagency /reservationworkbench/{workbenchID}/travelagency/{travelagencyID}/updateaddress
Delete a travel agency address	DEL ticket/travelagency /reservationworkbench/{workbenchID}/travelagency/{travelagencyID}/deleteaddress{addressid}

Reservation Modify

Action	Endpoint (add to Base Path above)
Retrieve a list of updatable items by traveler identifier	POST book/updatableItem/reservationworkbench{workbenchID}/travelerupdatableitems/buildfromtraveler
Update traveler information after an updatable items request	PUT book/traveler/reservationworkbench/{workbenchID}/travelers/updatefromtravelerupdateditems/{TravelerID}
Reservation divide	POST book/reservation/reservations/divide

AirTicketing

Action	Endpoint (add to Base Path above)
Add form of payment	POST payment/reservationworkbench/{workbenchID}/formofpayment
Add payment	POST paymentoffer/reservationworkbench/{workbenchID}/payments
Commit ticketing workbench and issue ticket and/or EMD	See Commit the workbench above in AirReservation.
List all tickets on a reservation	GET receipt/reservations/{LocatorCode}/receipts
Return details for a single ticket	GET ticket/tickets/{ticketID}
Cancel a reservation for GDS	POST receipt/reservations/{LocatorCode}/receipts
Void ticket for GDS	PUT ticket/tickets/updatestatus/{ticketID}

NDC Modify, Cancel, and Exchange

Action	Endpoint (add to Base Path above)
Reshop in workflow to modify booking or exchange ticket for NDC	POST change/catalogofferingsairchange
Reprice in workflow to modify booking or exchange ticket for NDC	POST reprice/reservationworkbench/{workbenchID}/offers/buildfromcatalogofferings
Resell to commit workbench to modify booking or exchange ticket for NDC	POST modify/reservations/{LocatorCode}
Refund quote when canceling and refunding NDC ticket	POST book/airoffer/reservationworkbench/{workbenchID}/offers/canceloffer
Order Cancel when voiding, canceling, or refunding NDC booking or ticket	POST receipt/reservation/{workbenchID}/receipts?OfferIdentifier={OfferID}
Cancel payment when voiding NDC ticket and payment but retaining segments	POST paymentoffer/reservationworkbench/{workbenchID}/payments/{paymentID}

GDS Ticket Exchanges

Action	Endpoint
Eligibility request using either the Ticket or Locator query parameter	POST eligibility/ticketchangeeligibilities Note the base path for Eligibility varies from that used for other JSON APIs: Pre-production https://api.pp.travelport.com/11/ Production https://api.travelport.com/11/
Exchange Search	POST exchangesearch/catalogofferingsairchange Note the base path for Exchange Search varies from that used for other JSON APIs: Pre-production https://api.pp.travelport.com/11/ Production https://api.travelport.com/11/
Exchange Ticketing	All Exchange Ticket endpoints use the standard JSON API Base Path above. Endpoints for the Add FOP, Add Payment, and Commit requests are the same as those requests in AirTicketing above. For the Add/modify offer step: Exchange: POST book/offer/reservationworkbench/{workbenchID}/offers/buildfromcatalogofferings

Action

Endpoint

Eligibility request using either the Ticket or Locator query parameter

POST eligibility/ticketchangeeligibilities

Note the base path for Eligibility varies from that used for other JSON APIs:

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

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

Exchange Search

POST exchangesearch/catalogofferingsairchange

Note the base path for Exchange Search varies from that used for other JSON APIs:

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

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

Exchange Ticketing

All Exchange Ticket endpoints use the standard JSON API Base Path above.

Endpoints for the Add FOP, Add Payment, and Commit requests are the same as those requests in AirTicketing above.

For the Add/modify offer step:

Exchange:

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