Introduction
The OrderCreate Webservice provides IATA Accredited Travel Agents, new retailers, and Service Providers the ability to book for flights and seats as per IATA NDC schema standards.
OrderCreate service can be invoked in 2 contexts:
Context 1 – Instant purchase:
The ability for clients to pay and confirm in the same transaction. The service accepts payment (card or cash aka BSP settlement or e-voucher), creates a booking and issues etickets. The service can also be used to purchase seats or bags , along with flights and issues EMD once the seat or bag purchase is successful. Both booking and document (ETicket and EMD) details are returned in the OrderViewRS along with the booking reference (PNR)
Context 2 – Hold booking:
The ability for clients to create a booking without making a payment. The service checks if the client is eligible to create a held booking and if eligible it creates a booking. Along with flights clients can also reserve seats (paid or frees seats) without paying for it. The service returns booking details in the OrderViewRS along with the booking reference (PNR). The service also returns Payment Time Limit (Ticket Time Limit). The client must pay for the booking using AirDocIssue Webservice before the time limit expires otherwise booking will automatically be cancelled.
Interface Design
Limitations
- The service supports the creation of public or private fare bookings, for parties of up to 9 passengers
- Multiple forms of payment are not supported, however, e-voucher and cash or e-voucher and card forms of payment are supported.
- The service can accept up to 6 Origin Destinations
- The following are examples of types of bookings that are not supported by the service (but this list is not exhaustive)
- All types of redemption bookings
- All group bookings
- Unaccompanied minors
- Booking with only young adult passengers, child or Infant
This web service is called with the following inputs:
- Price per pax type, list of flight segments and for each flight segment, the departure airport, arrival airport, carrier code, flight number and booking class (selling class)
- OfferItemIDs, OfferID and ShoppingResponseID are returned in the previous OfferPrice, SeatAvailability and ServiceList response for flights, seats & bags respectively
- Leisure Fare Type
- Seat details
- Baggage details or Baggage offers (Short sell)
- List of passengers and for each passenger
- Name details (surname, first name etc) and frequent flyer details (if available)
- Email address
- Phone details
- Address details
- APIS (immigration) information
- Payment details (card, cash or e-voucher)
The output data this service returns include:
- Booking reference (PNR)
- Offer Expiry Time Limit and Price Guarantee Time Limit
- Passenger details
- Passenger Type Code (PTC)
- First name
- Last name
- Middle name
- Title
- Date of birth, if it is present in the booking
- FQTV details, if it is present in the booking
- On Business details
- Gender, if it is present in the booking
- APIS (Immigration) Information
- Contact details
- Phone contact along with country code/ area code
- Address contact including country code
- Postal address (AddressAtDestination)
- Email contact
- Total Order Price – This is the sum of fare and tax for all passengers in the booking along with seat/bag price for all passengers in the booking.
- Tax breakdown along with nature code and description.
- For hold booking price for the itinerary (base fare, tax, and total price) per passenger.
- Seat price along with seat details per passenger per flight segment.
- Baggage Allowance per passenger per origin-destination if an additional bag is purchased
- Stop locations along with stop quantity.
- Flight segment details.
- Flight list along with associated flight segment references.
- Passenger Type Code (PTC)
- Origin and destination list.
- eTicket details per passenger.
- E-Voucher residual EMD detail
- EMD details per passenger.
- Manage my booking link
- Seating policy link, if passengers have purchased seats
- Seating terms and conditions link if passengers have purchased seats
- Warning message if seat purchase failed i.e create a booking without seats.
- Payment Time Limit for hold booking.
- Payment information (for instant purchase) with masked payment card details.
- Payer’s contact details, if payer is not a passenger.
- Error message along with the list of applicable payment cards if
- If the requested card is not applicable for the customer’s billing country and agent location
- If the requested card surcharge does match
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: OrderCreate17_2_V5
Endpoints
LIVE |
PRE-LIVE |
BETA |
https://api.ba.com/selling-distribution/OrderCreate/17.2/V5 |
https://test.api.ba.com/selling-distribution/OrderCreate/17.2/V5 |
https://test.api.ba.com/selling-distribution/sandbox/OrderCreate/17.2/V5 |
WSDL
https://api.ba.com/selling-distribution/OrderCreate/17.2/V5?WSDL
Please update your WSDL to point to the correct endpoint.
- Copy the Test URL ie
https://test.api.ba.com/selling-distribution/OrderCreate/api/V5
-
Paste this URL into the SOAP address location.
WSDL Snippet Example
<service name= "OrderCreateDistributionAdapter" >
<port name= "OrderCreateDistributionAdapterSoap11" binding= "tns:OrderCreateDistributionAdapterSoap11" >
<soap:address location= "[Paste the Test URL here]" />
</port>
</service> |