Booking Management API

Get Booking

Display booking

To ensure successful booking retrieval, the request should contain the below information:

Add confirmationId (PNR Locator or Order Id) in the Get Booking request:

Display booking and validate surname

To ensure successful booking retrieval with surname validation, the request should contain the below information:

1. Add confirmationId (PNR Locator or Order Id) in the Get Booking Request.
2. Add surname in the Get Booking Request.

Note: The API will validate if the surname matches the data in the reservation before retrieving it.

Display selected elements of the booking

To ensure successful booking retrieval with a limited number of elements in the response, the request should contain the below information:

1. Add confirmationId (PNR Locator or Order Id) in the Get Booking Request.
2. Add the returnOnly element in the Get Booking Request with the selected list of elements you want to retrieve.

Note: The full list of possible returnOnly values can be found in the OpenAPI specification under the Reference Documentation tab.

Create Booking

Create booking for NDC content type (Order)

To ensure a successful booking, pass a valid offerID, selectedOfferItems, and the traveler id returned by the Offer Price API.

The successful booking will contain a booking reference with a confirmationId (PNR Locator) and a normalized view of the reservation will be provided in the API response.

Create booking for ATPCO content

Note: By following this step, you can also request to have the booking priced and its price validated against the desired pricing.

Pass valid traveler information and the full details of each flight:

The successful booking will contain a booking reference with a confirmationId (PNR Locator) and a normalized view of the reservation will be provided in the API response.

Create booking for hotel content

To ensure a successful booking, pass a valid bookingKey returned by the Hotel Price Check API.

The successful booking will contain a booking reference with a confirmationId (PNR Locator) and a normalized view of the reservation will be provided in the API response.

Create booking for hotel content, while using traveler profiles

To ensure a successful booking, pass a valid bookingKey returned by the Hotel Price Check API.

The successful booking will contain a booking reference with a confirmationId (PNR Locator) and a normalized view of the reservation will be provided in the API response.

Create booking for ancillaries (ATPCO)

To ensure a successful booking, pass valid ancillary details returned by the Get Ancillary Offers API.

The successful booking will contain a booking reference with a confirmationId (PNR Locator) and a normalized view of the reservation will be provided in the API response.

Create booking for car content

To ensure a successful booking, pass a valid bookingKey returned by the Vehicle Price Check API.

The successful booking will contain a booking reference with a confirmationId (PNR Locator) and a normalized view of the reservation will be provided in the API response.

Cancel Booking

A few examples of using Cancel Booking are mentioned below. Additional examples can be found in the OpenAPI specification under the Reference Documentation tab and the Help tab.

Cancel specific flight/hotels/cars

To ensure the successful cancellation of specific flights/hotels/cars, your request should contain the below information:

1. Add confirmationId (PNR Locator or Order Id).
2. Add the list of cars/flights/hotels:
   • itemId can be retrieved from GetBookingResponse.(flights|cars|hotels).itemId or GetReservationRS/Reservation/PassengerReservation/Segments/Segment/Product/@id.
     {
       "confirmationId": "XXXXXX",
       "cars": [
         {
           "itemId": 1
         }
       ],
       "flights": [
         {
           "itemId": 2
         }
       ],
       "hotels": [
         {
           "itemId": 12
         }
       ]
     }

Cancel whole reservation

To ensure the successful cancellation of an entire reservation, your request should contain the below information:

1. Add confirmationId (PNR Locator or Order Id).
2. Add and set the cancelAll flag to true ("cancelAll": true).
   {
     "confirmationId": "XXXXXX",
     "cancelAll": true
   }

Cancel whole reservation and sign change with specific entry

To ensure the successful cancellation of an entire reservation and signature with the desired entry, your request should contain the below information:

1. Add confirmationId (PNR Locator or Order Id).
2. Add and set the cancelAll flag to true ("cancelAll": true).
3. Add receivedFrom.
   {
     "confirmationId": "XXXXXX",
     "cancelAll": true,
     "receivedFrom": "DOE"
   }

Cancel specific segments by ID or sequence

To ensure the successful cancellation of specific flights/hotels/cars, your request should contain the below information:

1. Add confirmationId (PNR Locator or Order Id).
2. Add the list of segments:
   • id can be retrieved from GetBookingResponse.flights(cars/hotels).itemId or GetReservationRS/Reservation/PassengerReservation/Segments/Segment/Product/@id.
   • sequence can be retrieved from GetReservationRS/Reservation/PassengerReservation/Segments/Segment/Product/@sequence
     {
       "confirmationId": "XXXXXX",
       "segments": [
         {
           "id": 1,
           "sequence": 2
         }
       ]
     }

Cancel and retrieve booking

To ensure the successful cancellation of, and to retrieve the state of the booking after cancellation, your request should contain the below information:

1. Add confirmationId (PNR Locator or Order Id).
2. Add and set the retrieveBooking flag to true ("retrieveBooking": true).
   {
     "confirmationId": "XXXXXX",
     "retrieveBooking": true,
     "flights": [
       {
         "itemId": 2
       }
     ]
   }

Cancel with "allow partial cancel" error policy

To ensure a successful cancellation with the option to allow a partial cancellation (continue with processing in the event of an error), your request should contain the below information:

1. Add confirmationId (PNR Locator or Order Id).
2. Add and set the errorHandlingPolicy flag to ALLOW_PARTIAL_CANCEL ("errorHandlingPolicy": "ALLOW_PARTIAL_CANCEL").
   {
     "confirmationId": "XXXXXX",
     "errorHandlingPolicy": "ALLOW_PARTIAL_CANCEL",
     "flights": [
       {
         "itemId": 2
       }
     ],
     "hotels": [
       {
         "itemId": 12
       }
     ]
   }

Cancel whole reservation and void corresponding tickets

To ensure the successful cancellation of a complete reservation, the request should contain the below information:

1. Add confirmationId (PNR Locator or Order Id).
2. Add and set the cancelAll flag to true ("cancelAll": "true").
3. Add and set flightTicketOperation to VOID ("flightTicketOperation": "VOID").
   {
     "confirmationId": "XXXXXX",
     "cancelAll": true,
     "flightTicketOperation": "VOID"
   }

Cancel whole reservation and refund corresponding tickets

To ensure the successful cancellation of a complete reservation, the request should contain the below information:

1. Add confirmationId (PNR Locator or Order Id).
2. Add and set the cancelAll flag to true ("cancelAll": "true").
3. Add and set flightTicketOperation to REFUND ("flightTicketOperation": "REFUND").
   {
     "confirmationId": "XXXXXX",
     "cancelAll": true,
     "flightTicketOperation": "REFUND"
   }

Cancel specific flight and void corresponding tickets

To ensure the successful cancellation of a specific flight within a complete reservation, the request should contain the below information:

1. Add confirmationId (PNR Locator or Order Id).
2. Add the list of flights:
   • itemId can be retrieved from GetBookingResponse.(flights|cars|hotels).itemId or
   • GetReservationRS/Reservation/PassengerReservation/Segments/Segment/Product/@id.
3. Add and set flightTicketOperation to VOID ("flightTicketOperation": "VOID").
   {
     "confirmationId": "XXXXXX",
     "flightTicketOperation": "VOID",
     "flights": [
       {
         "itemId": 2
       }
     ]
   }

Cancel specific flight and refund corresponding tickets

To ensure the successful cancellation of a specific flight within a complete reservation, the request should contain the below information:

1. Add confirmationId (PNR Locator or Order Id).
2. Add the list of flights:
   • itemId can be retrieved from GetBookingResponse.(flights|cars|hotels).itemId or GetReservationRS/Reservation/PassengerReservation/Segments/Segment/Product/@id.
3. Add and set flightTicketOperation to REFUND ("flightTicketOperation": "REFUND").
   {
     "confirmationId": "XXXXXX",
     "flightTicketOperation": "REFUND",
     "flights": [
       {
         "itemId": 2
       }
     ]
   }

Cancel whole reservation and take action on tickets (NDC)

To ensure the successful cancellation of a complete reservation and take action on the tickets (void or refund), the request should contain the below information:

1. Add confirmationId (PNR Locator or Order Id).
2. Add the offerItemId:
   • offerItemId can be retrieved from CheckTicketsResponse.cancelOffer.offerItemId or
   • /v1/offers/reshop/cancelOrder form response.reshopOffers.offerId.
3. Add offerItemId ("offerItemId": "cb7778589bcbklg7tkkp8sdo50").
   {
     "confirmationId": "XXXXXX",
     "offerItemId": "cb7778589bcbklg7tkkp8sdo50"
   }

Void Flight Tickets

A few examples of using Void Flight Tickets are mentioned below. Additional examples can be found in the OpenAPI specification under the Reference Documentation tab and the Help tab.

Cancel single electronic document with "allow partial cancel" error policy

To ensure the successful cancellation of the document, the request should contain the below information:

1. Add tickets (13 digit electronic document number) or confirmationId (PNR Locator or Order Id).
2. Add and set the errorHandlingPolicy flag to ALLOW_PARTIAL_CANCEL ("errorHandlingPolicy": "ALLOW_PARTIAL_CANCEL").
   {
     "tickets": [
       "6071237616558"
     ],
     "errorHandlingPolicy": "ALLOW_PARTIAL_CANCEL"  
   }

The electronic document was voided and the reservation was updated:

TKT/TIME LIMIT                                                  
  1.T-06AUG-AB12*A12                                            
  2.TE 6071237616558-AT ABC/D AB12*A12 0427/06AUG*              
    TV 6071237616558-AT  *VOID* AB12*A12 0428/06AUG*E           

Cancel multiple electronic document with "halt on error" error policy

To ensure the successful cancellation of the document, the request should contain the below information:

1. Add tickets (13 digit electronic document number).
2. Add and set the errorHandlingPolicy flag to HALT_ON_ERROR ("errorHandlingPolicy": "HALT_ON_ERROR").
   {
     "tickets": [
       "6071237616558",
       "6074567616559",
       "6077897616560"
     ],
     "errorHandlingPolicy": "ALLOW_PARTIAL_CANCEL"  
   }

The electronic documents were voided and the reservation was updated:

TKT/TIME LIMIT                                                  
  1.T-06AUG-AB12*A12                                            
  2.TE 6071237616558-AT ABC/D AB12*A12 0427/06AUG*   
  3.TE 6074567616559-AT ABC/D AB12*A12 0427/06AUG* 
  4.TE 6077897616560-AT ABC/D AB12*A12 0427/06AUG* 
    TV 6071237616558-AT  *VOID* AB12*A12 0429/06AUG*E    
    TV 6074567616559-AT  *VOID* AB12*A12 0429/06AUG*E   
    TV 6077897616560-AT  *VOID* AB12*A12 0429/06AUG*E   

Check Flight Tickets

A few examples of using Check Flight Tickets are mentioned below. Additional examples can be found in the OpenAPI specification under the Reference Documentation tab and the Help tab.

Check single electronic document with additional refund qualifier

To ensure the successful validation of the document, the request should contain the below information:

1. Add tickets (13 digit electronic document number) or confirmationId (PNR Locator or Order Id).
2. Add and define the refundQualifiers as required. For example, you can override the cancel fee by setting overrideCancelFee ("overrideCancelFee": "100.00").
   {
     "tickets": [
       {
         "number": "0017489825123",
         "refundQualifiers": {
           "overrideCancelFee": "100.00"
         }
       }
     ]
   }

The API will now check voidability and refundability. For the refund flow, the refund qualifiers will be applied:

Check multiple electronic documents with different refund qualifiers

To ensure the successful validation of the document, the request should contain the below information:

1. Add tickets (13 digit electronic document number).
2. Add and define the refundQualifiers as required for each ticket.
   {
       "tickets": [
           {
               "number": "0017489825123",
               "refundQualifiers": {
                   "overrideCancelFee": "100.00"
               }
           },
           {
               "number": "017489825124",
               "refundQualifiers": {
                   "overrideTaxes": [
                       {
                           "taxCode": "XF",
                           "taxAmount": "5.00",
                           "airportTaxBreakdowns": [
                               {
                                   "taxAmount": "5.5",
                                   "airportCode": "DFW"
                               }
                           ]
                       },
                       {
                           "taxCode": "SQ",
                           "taxAmount": "15.00"
                       }
                   ],
                   "waiverCode": "123456789ABCDEF*"
               }
           }
       ]
   }

The electronic documents were validated and the refund options priced:

Refund Flight Tickets

An example of using Refund Flight Tickets is mentioned below. Additional examples can be found in the OpenAPI specification under the Reference Documentation tab and the Help tab.

Refund single electronic document without refund qualifiers

To ensure the successful refund of the document, the request should contain the below information:

1. Add tickets (13 digit electronic document number) or confirmationId (PNR Locator or Order Id).
2. Add and set the errorHandlingPolicy flag to HALT_ON_ERROR ("errorHandlingPolicy": "HALT_ON_ERROR").
   {
       "tickets": [
           {
               "number": "6077531704032"
           }
       ],
       "errorHandlingPolicy": "HALT_ON_ERROR"
   }

The API will now check for refundability. For a successful validation and refund, the API will return the refundTotals per ticket:

Ticket was refunded:

ELECTRONIC TICKET RECORD                          CRS CODE:0011
INV:                  CUST:                          PNR:ABCDEF
TKT:6077531704032     ISSUED:02FEB21   PCC:G7RE   IATA:9998999
NAME:PIPPEN/SCOTTY                                             
FORM OF PAYMENT                        FCI: 0                  
1    CASH                                                      
CPN  A/L  FLT  CLS DATE   BRDOFF  TIME  ST F/B             STAT
1    EY   2     Y  10JUN  FRAAUH 1120A  OK YLF1DE          RFND
                                NVB:10JUN   NVA:10JUN   BAG:35K

and the booking was updated accordingly:

TKT/TIME LIMIT
  1.T-02FEB-G7RE*AWX
  2.TE 6077531704032-AT PIPPE/S G7RE*AWX 0321/02FEB*
  3.TE 6077531704033-AT JORDA/M G7RE*AWX 0321/02FEB*
  4.TR 6077531704032-AT PIPPE/S G7RE*AWX 0438/02FEB*I