OrderRetrieve Overview




 OrderRetrieve

VersionReason for ChangeRelease StatusPre-Live DateLive Date
1.0Book with Confidence - Return voucher validity and remark
  
0.9Book with Confidence - E-voucher as form of payment (See Release Notes 14-07-20 and 21-07-20)  
0.8View booking Refunded with voucher option (under Booking with Confidence policy) (See Release notes)  
0.7OrderRetrieve Version 2 – To return disruption handling planned cancellation actions (See Release notes)

 

 
0.6Error Handling Auto Cancelled Bookings (See Release Note
0.5Cabin Name Change (See Release Note) This will be released as a soft release. We will notify you about our Sandbox testing environment for this feature. Relative updates in PriceListClass, DisclosureList, FlightSegmentList and SeatAvailabilityRS  
0.4Split Booking - Adding optional associate booking references in the response (See Release notes)  
0.3OrderRetrieve Version 2 – To return disruption handling actions (See Release notes) 
0.2Short Sell
0.1Long Sell

 Introduction

The OrderRetrieve Webservice provides IATA Accredited Travel Agents, new retailers, and Service Providers the ability to retrieve the order.

This service returns the order details along with ETicket and EMD details.

 OrderRetrieve Webservice

This service returns the order details. This service can only be used on existing bookings, and may only be accessed by the agent who created the booking. If the agent went through a 3rd party provider to create the initial booking (GDS or service provider), it is also mandatory to go through this provider in order to access the booking. If the above conditions are not met, the service will return an error and prevent access.

Interface Design

This web service is called with the following inputs:

  • OrderID (Booking reference or PNR reference)

The output data this service returns include:

  • OrderID (Booking reference or PNR reference)
  • Booking references of the associate PNRs 
  • Passenger details along with their loyalty details
  • Gender, if it is present in the booking
  • Immigration details
  • Flight details
  • Seat details
  • Total Order Price – This is the sum of fare and tax for all passengers in the booking along with seat price, bag price, meal price for all passengers in the booking
  • Price for the itinerary (base fare, tax, and total price) per passenger along with fare rules
  • Tax breakdown along with nature code and description
  • Payment Time Limit (Ticket Time Limit), if applicable
  • Bag details
  • Special needs and disability assistance details
  • Advanced Passenger Information System (APIS) details
  • Contact Details (both personal and emergency)
  • Meal details
  • A link to ba.com manage my booking
  • eticket details with passenger association
  • Electronic Miscellaneous Document (EMD) details with passenger association
  • Fare rules for the itinerary
  • Total Baggage Allowance
  • SellerFollowUpAction if booking has any disrupted flight and OrderRetrieve Version 2 call has been made to retrieve the booking 
  • A link to disruption guidelines if booking has any disrupted flight and OrderRetrieve Version 2 call has been made to retrieve the booking 



 Mandatory Headers

If you have PRE-LIVE access for 16.1, then you will automatically be able to build to 17.2 using the PRE-LIVE environment.

In order to access our API, you will need to pass the following two headers for each call.

 Web Service URLs

 General Usage Guidelines

The OrderRetrieve Service

General