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.
This method Is intended for booking of tickets and seats on the flight.
On the stages of booking, the flight segments should be distributed is as follows:
OreginDestination=slice, Flight=segment
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:
- Book - Returns PNR locator, one for all passengers and Ticket Time Limits
The flight contains 2 slice OVB->KUF and KUF->OVB (in the request there will be 2 block OreginDestination) where:
slice OVB->KUF consists of 2 segments of the OVB->DME; DME ->KUF, then the first block OreginDestination describing slice OVB->KUF, will consist of 2 blocks of the Flight, one will describe the segment, OVB->DME, and the second DME->KUF.
For slice KUF->OVB is the same.
Each of the slices may consist of any number of segments (depending on the number of transfers in).
The logic is always the same, the slice to be written as OreginDestination, inside it writable segments through Flight.
Table of contents
tocStandard booking flow — reservation of chosen solution from search results. Includes passengers and itinerary information.
Corporate Program boooking flow — reservation of chosen solution from search results (сonsidering corporate code for discount or cashback). Includes Agent/Corporate client and itinerary information. Corporate Program booking flow is available only for S7.
Table of contents
| 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 | S7 Agent API 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 | Corporate Program credentials | Available only for Corporate Program with discount scenario or Corporate Program with cashback scenario. 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 |
Samples
2ADT+1CHD+1INF+Domestic+RT+DIRECT | v0.52 | book operation
| Include Page | ||||
|---|---|---|---|---|
|
OW+1xADT+Direct+S7 flight | v0.52 | book operation
| Include Page | ||||
|---|---|---|---|---|
|
Corporate Program | v0.52 | book operation
Check out
operation overview, their main purpose and use cases
references with detailed explanation of input&output parameters and possible errors
other samples
| Expand | |||||
|---|---|---|---|---|---|
| |||||
|
| Expand | |||||
|---|---|---|---|---|---|
| |||||
|
OW+1xADT+Direct+S7 flight+FQTV | v0.52 | book operation
| Include Page | ||||
|---|---|---|---|---|
|
Subsidised fare+OW+1xSRC+Direct | v0.52 | book operation
| Include Page | ||||
|---|---|---|---|---|
|
Subsidised fare+RT+1xYTR+1CHD+1INF+Transfer | v0.52 | book operation
| Include Page | ||||
|---|---|---|---|---|
|
1ADT+1INF with a seat+Domestic+OW+DIRECT | v0.52 | book operation
| Include Page | ||||
|---|---|---|---|---|
|
ВПД МВД 1ADT+1CHD+1INF+Domestic+OW+DIRECT+Public fares | v0.52 | book operation
| Include Page | ||||
|---|---|---|---|---|
|
ВПД МВД 1ADT+1CHD+1INF+Domestic+OW+DIRECT+YFLOW with 10% discount | v0.52 | book operation
| Include Page | ||||
|---|---|---|---|---|
|
ВПД МВД 1ADT+1CHD+1INF+Domestic+OW+DIRECT+MM02 fare | v0.52 | book operation
| Include Page | ||||
|---|---|---|---|---|
|
ВПД МО 1ADT+1CHD+1INF+Domestic+OW+DIRECT | v0.52 | book operation
| Include Page | ||||
|---|---|---|---|---|
|
ВПД МВД 1ADT+1CHD+1INF+Domestic+OW+DIRECT+M fare | v0.52 | book operation
| Include Page | ||||
|---|---|---|---|---|
|
1CHD+Domestic+OW+DIRECT | v0.52 | book operation
| Include Page | ||||
|---|---|---|---|---|
|