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.
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.
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:
The output data this service returns include:
Interface Design
Not supported
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:
The output data this service returns include:
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.
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
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.
Paste this URL into the SOAP address location.
WSDL Snippet Example
<service name=
"OrderRetrieveDistributionAdapter"
>
<port name=
"OrderRetrieveDistributionAdapterSoap11"
binding=
"tns:OrderRetrieveDistributionAdapterSoap11"
>
<soap:address location=
"[Paste the Test URL here]"
/>
</port>
</service>