Submit Search

JSON APIs Full Workflow with Optional Steps

The following diagram shows all required API requests in the JSON API workflow plus several optional steps.

Each box in the diagram represents one API call in the workflow.

Some of these steps can take place at other points in the workflow; see these guides for support details:

See All Book and Ticketing Workflows for all booking A confirmed reservation with the carrier. A held booking is a reservation that has not yet been ticketed. The terms booking and reservation are interchangeable. options.
Fare Rules can be requested after Search, after Price, or for an existing reservation.
Seats and ancillaries can be added either during booking or ticketing, or in a separate workbench session, per the Seats and Ancillaries guides.
Comments and special service requests can be added either in the initial booking flow or in a post-commit Refers to the state of a booking after the booking is created, which happens after the initial booking workbench is commited and the reservation locator code issued. session.
Form of payment for GDS Global Distribution System. A GDS aggregates and distributes air, hotel, and car rental content such as schedules, fares, and upsells. In the JSON APIs, GDS content is distributed from Travelport. can be added during either initial booking or ticketing. Form of payment for NDC New Distribution Capability, an XML standard for exchanging data that supports airlines in distributing their content directly to online travel agencies. See the NDC Guide. can be added at ticketing.

Related Content:JSON APIs Required Full Workflow, JSON APIs Guide, Air Shopping Guide, Booking Guide, Seats Guide, Ticketing Guide

Note that the above JSON APIs workflow uses reference payload In the JSON APIs, an API call that sends identifers referring to a previous response for the itinerary to be shopped, priced, added, etc. instead of full itinerary details. requests, which send identifiers to select an offer In the JSON Search APIs, an offer is a product available at a specific price under a set of terms and conditions. An offer includes the flight or connecting flights for one leg of the itinerary, plus a service level that includes the cabin class and any fare codes that may apply. At booking, the selected offer from the Search response - including the flight/s, service level, price, terms and conditions, and brand if applicable - is converted into a single Offer object that is subsequently returned for that booking. from previous JSON API responses. Optionally, you can send the AirPrice full payload request and omit the Search request, or send an Add Offer full payload request and omit the Search and AirPrice requests. This allows you to source your flights outside the JSON APIs and skip these steps of the JSON workflow.

Paid ancillaries such as seats or baggage require a separate payment, which issues an EMD

Electronic miscellaneous document (EMD); issued for a paid seat, ancillary, or any other paid service after successful payment. See the Ancillary and EMD Guide.. This payment can be added during booking or later. If payment is sent for both the ancillary

Any paid optional service filed for a flight. Industry examples include paid seats, paid baggage, carbon offsets, pet transport fees, and unaccompanied minor charges. See the Ancillary and EMD Guide for supported ancillaries. and the offer, both an EMD and ticket/s are issued. Or, you can send payment for only the ancillary and issue only the EMD at commit

API call that ends a workbench session, finalizing all changes and requests in that session. Depending on the workbench transactions, the commit workbench request may create a reservation, issue a ticket or EMD, exchange tickets, or modify a reservation..

The alternate Add Product workflow allows you to start with booking and skip search. See JSON APIs Required Full Workflow. GDS only; not supported for NDC.