Book operation makes a reservation of chosen solution for one or more passengers and returns PNR locator with passengers, itinerary information and Ticket Time Limits in XML.
Use cases
The following list of cases supported by the Shopping API and provides their required inputs as well as a list of common inputs used with that case:
- Standard booking flow — reservation of chosen solution from search results. Includes passengers and itinerary information.
- 3D agreement boooking flow — reservation of chosen solution from search results (сonsidering corporate discount). Includes Agent/Corporate client and itinerary information.
Table of contents
Request (OrderCreateRQ)
Required inputs
| # | Name | Format/Reference | xPath |
|---|---|---|---|
| 1 | Block of access parameters | Use credentials that you received from our technical support. Check out Quick Start for how to get it and References for more details | /Envelope/Body/OrderCreateRQ/Party/Sender/AgentUserSender |
| 2 | Passenger information | This element contains information about passengers: name, surname, date of birth, contacts, passport data, etc. | /Envelope/Body/OrderCreateRQ/Query/Passengers/Passenger |
| 3 | Passengers and flight segments references | Includes reference elements connecting passengers with the appropriate flights | /Envelope/Body/OrderCreateRQ/Query/OrderItems/ShoppingResponse |
| 4 | Itinerary information | Solution from Search method RS | /Envelope/Body/OrderCreateRQ/Query/OrderItems/OfferItem/DetailedFlightItem |
Optional parameters
| # | Name | Format/Reference | xPath |
|---|---|---|---|
| 1 | Seats information | Contains the list of seats with a price | /Envelope/Body/OrderCreateRQ/Query/OrderItems/DataLists/SeatList/Seats |
| 2 | Ticketing Time Limit | Booking cancelation datetime in case of tickets are not issued. By default calculated by S7 rules. | /Envelope/Body/OrderCreateRQ/Query/OrderItems/DataLists/ServiceList/Service[ServiceID][Name]TimeLimits/TicketingTimeLimits |
| 3 | 3D agreement credentials | Available only for scenario with 3D Agreement. Use credentials that you received from our technical support. Check out Quick Start for how to get those IDs | /Envelope/Body/OrderCreateRQ/Query/OrderItems/DataLists/InstructionsList/Instruction[@ListKey="CC"]/SpecialBookingInstruction |
Response (OrderViewRS)
| Name | Format/Reference | xPath | |
|---|---|---|---|
| 1 | Passengers information | This element contains information about passengers: name, surname, date of birth, contacts, passport data, etc. | /Envelope/Body/OrderViewRS/Response/Passengers/Passenger |
| 2 | Booking reservation number | PNR | /Envelope/Body/OrderViewRS/Response/Order/BookingReferences |
| 3 | Ticketing Time Limit | TTL | /Envelope/Body/OrderViewRS/Response/Order/TimeLimits/PaymentTimeLimit |
| 4 | Itinerary information | Itinerary information | /Envelope/Body/OrderViewRS/Response/Order/OrderItems |