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 3^rd 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.

The OrderRetrieve  service call returns the actions available to agents if booking is impacted due to disruption. The service also returns the media link of disruption guidelines that are applicable on a booking which is impacted due to disruption.

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 is impacted due to disruption and OrderRetrieve call has been made to retrieve the booking.
• A link to disruption guidelines if booking is impacted due to disruption and OrderRetrieve call has been made to retrieve the booking. 

 

Interface Design

The OrderRetrieve service can be used to retrieve the bookings that are refunded with voucher option under BWC policy. This will return the Voucher value present in the booking that can be used to pay the future travel. The tickets will be returned with expiry date, which represent the date by which customer should consume the ticket for future travel.

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)
• Passenger details
• Remark with Total Voucher value of itinerary for all the passenger in the booking
• Total Order Price – This is the sum of voucher values and any ancillary EMD (that can be used for future travel) for all passengers in the booking
• Price of Travel voucher per passenger
• Tax breakdown along with nature code and description
• A link to  ba.com  manage my booking
• eticket details with coupon validity by which customer should consume the ticket for future travel
• Electronic Miscellaneous Document (EMD) details with passenger association
• Service Definition for TravelVoucher service

Note – There will be no flight details returned in the response as the booking is cancelled and there is no active flight present in the booking.

Not Supported – The service cannot return the voucher value for the partially used booking (part flown) which are refunded with voucher option. The service will return an error message if requested to view part flown booking which are refunded with voucher option.

Retrieves bookings with e-voucher and residual e-voucher.

As per the updated Book with Confidence policy, the validity of Future Travel Vouchers, E-Vouchers and Residual E-Vouchers are updated with the latest dates. Also, we return the remark text for the redemption of E-Vouchers and Residual E-Vouchers.

HttpHeaders

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

Client-key: Your 24-bit API connection key
SOAPAction: OrderRetrieve17_2_V1

 

Endpoints

LIVE	PRE-LIVE	BETA
https://api.ba.com/selling-distribution/OrderRetrieve/17.2/V2	https://test.api.ba.com/selling-distribution/OrderRetrieve/17.2/V2	https://test.api.ba.com/selling-distribution/sandbox/OrderRetrieve/17.2/V2

WSDL

https://test.api.ba.com/selling-distribution/OrderRetrieve/17.2/V2?WSDL

Please update your WSDL to point to the correct endpoint.

 

1. Copy the Test URL ie  https://test.api.ba.com/selling-distribution//OrderRetrieve/api/V2

2. Paste this URL into the SOAP address location.
   
   WSDL Snippet Example