API References

The following table groups all API references by resource/domain. API References are grouped by functional area on the API References menu above.

Each reference describes the resources and operations for that call. References provide endpoints, object-level details with supported formats and values, plus sample requests and responses.

See the Guides for overviews of each functional area of air travel, along with basic concepts, usage information, and business rules.
See Endpoints for a consolidated list of all Air endpoints.

Air Shopping

RESOURCE

Search

ENDPOINTS

POST Initial flight search

POST Search for flights on next leg

POST Return all upsells on a specific flight - reference payload

POST Return all upsells on a specific flight - full payload

POST Search by air availability

Air Pricing

RESOURCE

Price

ENDPOINTS

POST Price request with reference payload

POST Price request with full payload

 

RESOURCE

BrandFullInfo

ENDPOINTS

POST Follow-on request for full brand pricing

 

RESOURCE

AirOffer

ENDPOINTS

POST Standalone pricing

 

RESOURCE

pending

ENDPOINTS

POST Fare Display

Standalone Fare Rules

RESOURCE

FareRule

ENDPOINTS

POST Return standalone fare rules

 

Seats

RESOURCE

Seat

ENDPOINTS

POST Request seat map

 

RESOURCE

Book (book/airoffer)

ENDPOINTS

POST Add seat assignment (seat book)

POST Seat cancel

Ancillaries & EMDs

RESOURCE

AncillaryShop

ENDPOINTS

POST Search for ancillaries

 

RESOURCE

AncillaryPrice

ENDPOINTS

POST Confirm ancillary pricing (NDC only)

 

RESOURCE

Book (book/airoffer)

POST Add ancillary offer (ancillary book)

 

RESOURCE

EMDs

ENDPOINTS

GET Retrieve an EMD

PUT Void an EMD

 

 

Remarks & Service requests

All resources are under book, e.g., book/primarycontacts

RESOURCE

PrimaryContacts

ENDPOINTS

POST Add primary contact

DEL Delete primary contact

 

RESOURCE

ReservationComments

ENDPOINTS

POST Add general, OSI, notepad, vendor, itinerary remarks

DEL Delete general, OSI, notepad, vendor, itinerary remarks

 

RESOURCE

SpecialServices

ENDPOINTS

POST Add special service request (disability and meals)

DEL Delete special service request (meals only)

 

RESOURCE

DocumentOverride

ENDPOINTS

POST Add document override remarks

 

RESOURCE

Accounting

ENDPOINTS

POST Add accounting, historical, and DOCI remarks

DEL Delete accounting, historical, and DOCI remarks

Booking & Reservations

All resources are under book, e.g., book/session

RESOURCE

Session

ENDPOINTS

POST Create a workbench for new booking

POST Create a workbench for existing booking

GET Retrieve workbench details

DEL Discard workbench

 

RESOURCE

AirOffer

ENDPOINTS

POST Add offer to booking - reference payload

POST Add offer to booking - full payload

POST Add ancillary offer (ancillary book)

POST Add seat assignment (seat book)

POST Refund quote when canceling and refunding an NDC ticket

POST Cancel a seat selection in workbench

POST Standalone pricing

POST Unused ticket as form of payment (NDC only)

 

RESOURCE

Traveler

ENDPOINTS

POST Add traveler and traveler remarks to booking

PUT Modify traveler information after Updatable Items request

 

RESOURCE

ClientProfile

ENDPOINTS

POST Copy host profile to JSON

 

RESOURCE

CustomRule

ENDPOINTS

POST Add a custom rule to booking

GET Retrieve list of all custom rules for a PCC

GET Retrieve details for one custom rule

DEL Delete a custom rule from a booking

 

RESOURCE

Reservations

ENDPOINTS

POST Commit workbench

GET Retrieve a reservation

POST Cancel a reservation for GDS

POST Divide a reservation

 

RESOURCE

UpdatableItem

ENDPOINTS

POST Retrieve a list of updatable items for traveler/s on the reservation

Ticketing & Payment

RESOURCE

Payment

ENDPOINTS

POST Add form of payment

 

RESOURCE

PaymentOffer

ENDPOINTS

POST Add payment

POST Cancel payment when voiding/canceling ticket and retaining segments (NDC only)

 

RESOURCE

Receipt

ENDPOINTS

GET List all tickets on a reservation

POST Order cancel - voids a ticket or cancels a ticket or reservation for NDC only

 

RESOURCE

Ticket

ENDPOINTS

GET Retrieve a single ticket

PUT Void ticket for GDS

 

RESOURCE

Travelagency (ticket/travelagency)

ENDPOINTS

POST Add a travel agency corporate ID 

PUT Update a travel agency corporate ID

DEL Delete a travel agency corporate ID

POST Add a travel agency address

PUT Update a travel agency address

DEL Delete a travel agency address

 

 

GDS Exchanges

RESOURCE

Eligibility

ENDPOINTS

GET Verify exchange eligibility (GDS)

 

RESOURCE

ExchangeSearch

ENDPOINTS

POST Search for flights to exchange (GDS)

 

RESOURCE

FormOfPayment & Payments

ENDPOINTS

POST Exchange ticketing transactions

 

GDS Refunds

GDS refund functionality is not available in the JSON APIs.

NDC Air Modify and Exchanges

RESOURCE

Change

ENDPOINTS

POST Reshop air itinerary on NDC reservation or ticket for an exchange

 

RESOURCE

Reprice

ENDPOINTS

POST Reprice new offer for NDC reservation or ticket and add to workbench

 

RESOURCE

Modify

ENDPOINTS

POST Resell - commit exchange for NDC reservation or ticket

NDC Void/Cancel and Refunds

RESOURCE

AirOffer

ENDPOINTS

POST Refund quote when canceling and refunding an NDC ticket

 

RESOURCE

Receipt

ENDPOINTS

POST Order Cancel - void a ticket, or cancel a ticket or reservation for NDC only