Air Endpoints

Travelport is updating the authentication and authorization endpoints for all JSON APIs and providing new credentials. All customers either already have received or will receive new credentials and have or will be migrated to the new endpoints. If your company has not yet migrated to new credentials, continue to use your existing credentials and endpoints. See Authentication for migration details.

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

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

See the individual API References for query parameters and payloads.

In this topic:

Authentication

Travelport is updating the authentication and authorization endpoints for all JSON APIs and providing new application credentials to all customers. See Authentication for migration details.

Use these endpoints for authentication requests if you haven't received or haven't migrated to the new credentials from Travelport:

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

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

Use these endpoints for authentication requests after you have migrated to the new credentials from Travelport:

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

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

Base Path for All Air APIs

Combine the appropriate base path below with all Air API authorization endpoints in the next section.

Base path:

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 (using .net instead of .com):

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

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

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

A small number of JSON Air APIs do not use /air in their base path, as noted in Air Endpoints and their API References: Cancel Workbench Item, Document History, Document List, and Exchange Air Offer.

JSON Air API Endpoints

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 air/faredisplay/fares

Standalone Fare Rules

Action

Endpoint (add to Base Path above)

Follow-on request for standalone fare rules GET farerule/farerules

Seats, Ancillaries, and EMDs

Action

Endpoint (add to Base Path above)

Ancillary search

POST ancillaryshop/catalogofferingsancillaries

Ancillary price

POST 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 ancillary

POST book/airoffer/reservationworkbench/{workbenchID}/offers/canceloffer

Retrieve an EMD

GET emds/{EMDNumber}

Void an EMD

PUT 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.

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}

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 JSON APIs and does not use /air; see Cancel Workbench Items.
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 travelers 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 create booking

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}

Document History

 

POST documents/history

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

Document List

GET documents/documentlist/{LocatorCode}

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

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 details on 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, 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 payload

POST 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)

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

Update form of payment

PUT payment/reservationworkbench/{workbenchID}/formofpayment/{FormOfPayment_Identifier}

Delete form of payment

DEL payment/reservationworkbench/{workbenchID}/formofpayment/{FormOfPayment_Identifier}

Add payment

POST paymentoffer/reservationworkbench/{workbenchID}/payments

Commit the workbench and issue ticket

POST book/reservation/reservations/{workbenchID}

List all tickets on a reservation

GET 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 GDS

POST receipt/reservations/{LocatorCode}/receipts

Void ticket for GDS

PUT ticket/tickets/updatestatus/{ticketID}

Return details for a single GDS ticket with Ticket Display (GDS, single ticket only)

GET ticket/tickets/{ticketID}

Queue placement

POST queue/queue

List all bookings on the queue

POST queue/queue/list

Remove a booking from the queue

POST queue/queue/remove

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

Modify to commit workbench to modify booking or exchange ticket for NDC

POST  modify/reservations/{LocatorCode}

Standalone Reprice to reprice itinerary before or after price guarantee expires

POST reprice/reservationworkbench/[workbenchID//offers/buildfromoffer

Refund quote when canceling and refunding NDC ticket

POST book/airoffer/reservationworkbench/{workbenchID}/offers/canceloffer

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 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.

Action

Endpoint

Eligibility using either the Ticket or Locator query parameter

POST eligibility/ticketchangeeligibilities

The base path varies from most JSON APIs and does not use /air; see Eligibility.

Exchange Search

POST exchangesearch/catalogofferingsairchange

The base path varies from most JSON APIs and does not use /air; see Exchange Search.

Add/Modify Offer reference payload

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

(add to Base Path above)