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

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

Price

POST Price request reference payload

POST Price request full payload

BrandFullInfo

POST Full brand pricing request after pricing

AirOffer

POST Standalone pricing (used in the Add Product booking workflow,)

Fares

POST Fare Display

Standalone Fare Rules

FareRule

POST Return standalone fare rules

Seats

Seat

POST Seat map

POST Standalone seat map

Book (book/airoffer)

POST Add seat assignment (seat book)

POST Seat cancel

Ancillaries & EMDs

AncillaryShop

POST Search for ancillaries

AncillaryPrice

POST Confirm ancillary pricing (NDC only)

Book (book/airoffer)

POST Add ancillary offer (ancillary book)

EMDs

GET Retrieve an EMD

PUT Void an EMD

Remarks & Service requests

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

PrimaryContacts

POST Add primary contact

DEL Delete primary contact

ReservationComments

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

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

SpecialServices

POST Add special service request (disability and meals)

DEL Delete special service request (meals only)

DocumentOverride

POST Add document override remarks

Accounting

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

Session

POST Create a workbench for new booking

POST Create a workbench for existing booking

GET Retrieve workbench details

DEL Discard workbench

AirOffer

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)

Traveler

POST Add traveler and traveler remarks to booking

PUT Modify traveler information after Updatable Items request

ClientProfile

POST Copy host profile to JSON

CustomRule

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

Reservations

POST Commit workbench

GET Retrieve a reservation

POST Cancel a reservation for GDS

POST Divide a reservation

UpdatableItem

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

Ticketing & Payment

Payment

POST Add form of payment

PaymentOffer

POST Add payment

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

Receipt

GET List all tickets on a reservation

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

Ticket

GET Retrieve a single GDS ticket

POST Retrieve a single NDC ticket

PUT Void ticket for GDS

Travelagency (ticket/travelagency)

POST Add a travel agency corporate ID

PUT Update a travel agency corporate ID

DEL Delete a travel agency corporate ID

GDS Exchanges

Eligibility

GET Verify exchange eligibility (GDS)

ExchangeSearch

POST Search for flights to exchange (GDS)

FormOfPayment & Payments

POST Exchange ticketing transactions

GDS Refunds

GDS refund functionality is not available in the JSON APIs.

NDC Air Modify and Exchanges

Change

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

Reprice

POST Reprice new offer when exchanging an NDC reservation or ticket

POST Reprice existing offer for NDC reservation (before or after price guarantee expires)

Modify

POST Resell - commit exchange for NDC reservation or ticket

NDC Void/Cancel and Refunds

AirOffer

POST Refund quote when canceling and refunding an NDC ticket

Receipt

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