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:

  1. Standard booking flow — reservation of chosen solution from search results. Includes passengers and itinerary information.

  2. 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

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.

(warning) Max 4 passengers for economy cabin, 2 - business in case of CodeShare or SPA flights (check glossary for flights types) 

/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

  • Segments (Flight) must be devided into slices (OriginDestination):

    • one OriginDestination for One Way trip;

    • two for Round Trip and more for MultiCity;

    • for Transfer Trip all segments included in one slice have to be pass in one OriginDestination;

    • for Transfer Trip segments with stopover between have to be divided into two OriginDestination.

    Check glossary for more info.

/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

OW+1xADT+Direct+S7 flight | v0.52 | book operation

Corporate Program | v0.52 | book operation

Check out

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
    <Header/>
    <Body>
        <OrderCreateRQ xmlns="http://www.iata.org/IATA/EDIST" Version="1.0">
            <Document/>
            <Party>
                <Sender>
                    <AgentUserSender>
                        <PseudoCity>S7AGN8224</PseudoCity>
                        <AgentUserID>Basic-Auth*</AgentUserID>
                    </AgentUserSender>
                </Sender>
            </Party>
            <Query>
                <Passengers>
                    <Passenger ObjectKey="SH1">
                        <PTC>ADT</PTC>
                        <Age>
                            <BirthDate>1985-05-03</BirthDate>
                        </Age>
                        <Name>
                            <Surname>Marko</Surname>
                            <Given>Cain</Given>
                            <Title>MR</Title>
                        </Name>
                        <Contacts>
                            <Contact>
                                <EmailContact>
                                    <Address>n.v.sokolova@s7.ru</Address>
                                </EmailContact>
                                <PhoneContact>
                                    <Number CountryCode="+7" AreaCode="926">3856999</Number>
                                </PhoneContact>
                            </Contact>
                        </Contacts>
                        <Gender>Male</Gender>
                        <PassengerIDInfo>
                            <PassengerDocument>
                                <Type>PP</Type>
                                <ID>1111111112</ID>
                                <BirthCountry>RU</BirthCountry>
                                <DateOfIssue>2013-10-22</DateOfIssue>
                                <DateOfExpiration>2027-10-22</DateOfExpiration>
                                <CountryOfResidence>RU</CountryOfResidence>
                            </PassengerDocument>
                        </PassengerIDInfo>
                    </Passenger>
                </Passengers>
                <OrderItems>
                    <ShoppingResponse>
                        <Owner>S7</Owner>
                        <ResponseID>UNKNOWN</ResponseID>
                        <Offers>
                            <Offer>
                                <OfferID Owner="S7">UNKNOWN</OfferID>
                                <OfferItems>
                                    <OfferItem>
                                        <OfferItemID Owner="S7">UNKNOWN</OfferItemID>
                                        <Passengers>
                                            <PassengerReference>SH1</PassengerReference>
                                        </Passengers>
                                        <ApplicableFlight>
                                            <FlightReferences>FL1</FlightReferences>
                                        </ApplicableFlight>
                                    </OfferItem>
                                </OfferItems>
                            </Offer>
                        </Offers>
                    </ShoppingResponse>
                    <OfferItem>
                        <OfferItemID Owner="S7">UNKNOWN</OfferItemID>
                        <OfferItemType>
                            <DetailedFlightItem>
                                <OriginDestination>
                                    <Flight>
                                        <SegmentKey>FL1</SegmentKey>
                                        <Departure>
                                            <AirportCode>OVB</AirportCode>
                                            <Date>2025-02-13</Date>
                                            <Time>02:30</Time>
                                        </Departure>
                                        <Arrival>
                                            <AirportCode>KJA</AirportCode>
                                            <Date>2025-02-13</Date>
                                            <Time>03:50</Time>
                                        </Arrival>
                                        <MarketingCarrier>
                                            <AirlineID>S7</AirlineID>
                                            <FlightNumber>5309</FlightNumber>
                                        </MarketingCarrier>
                                        <OperatingCarrier>
                                            <AirlineID>S7</AirlineID>
                                            <FlightNumber>5309</FlightNumber>
                                        </OperatingCarrier>
                                        <ClassOfService>
                                            <Code>Y</Code>
                                        </ClassOfService>
                                    </Flight>
                                </OriginDestination>                           
                            </DetailedFlightItem>
                        </OfferItemType>
                    </OfferItem>
                </OrderItems>
                <DataLists>
                     <InstructionsList>
                        <Instruction ListKey="CC">
                            <SpecialBookingInstruction>
                                <Code>QY124656</Code>
                                <Definition>12251</Definition>
                            </SpecialBookingInstruction>
                        </Instruction>
                    </InstructionsList>
                </DataLists>
            </Query>
        </OrderCreateRQ>
    </Body>
</Envelope>


<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:Envelope xmlns:ns2="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns3="http://www.iata.org/IATA/EDIST">
    <ns2:Body>
        <ns3:OrderViewRS Version="">
            <ns3:Document>
                <ns3:Name>1.0</ns3:Name>
            </ns3:Document>
            <ns3:Success/>
            <ns3:Response>
                <ns3:OrderViewProcessing/>
                <ns3:Passengers>
                    <ns3:Passenger ObjectKey="SH4">
                        <ns3:PTC Quantity="1">ADT</ns3:PTC>
                        <ns3:Age>
                            <ns3:BirthDate>1985-05-03</ns3:BirthDate>
                        </ns3:Age>
                        <ns3:Name>
                            <ns3:Surname>MARKO</ns3:Surname>
                            <ns3:Given>CAIN</ns3:Given>
                            <ns3:Title>MR</ns3:Title>
                            <ns3:Middle/>
                        </ns3:Name>
                        <ns3:Contacts>
                            <ns3:Contact>
                                <ns3:EmailContact>
                                    <ns3:Address>n.v.sokolova@s7.ru</ns3:Address>
                                </ns3:EmailContact>
                                <ns3:PhoneContact>
                                    <ns3:Number CountryCode="7">9263856999</ns3:Number>
                                </ns3:PhoneContact>
                            </ns3:Contact>
                        </ns3:Contacts>
                        <ns3:Gender>Male</ns3:Gender>
                        <ns3:PassengerIDInfo>
                            <ns3:PassengerDocument>
                                <ns3:Type>PP</ns3:Type>
                                <ns3:ID>1111111112</ns3:ID>
                                <ns3:BirthCountry>RU</ns3:BirthCountry>
                                <ns3:DateOfExpiration>2027-10-22</ns3:DateOfExpiration>
                                <ns3:CountryOfResidence>RU</ns3:CountryOfResidence>
                            </ns3:PassengerDocument>
                        </ns3:PassengerIDInfo>
                    </ns3:Passenger>
                </ns3:Passengers>
                <ns3:Order>
                    <ns3:OrderID Owner="S7">1</ns3:OrderID>
                    <ns3:BookingReferences>
                        <ns3:BookingReference>
                            <ns3:ID>MZTCNM</ns3:ID>
                            <ns3:AirlineID>S7</ns3:AirlineID>
                        </ns3:BookingReference>
                    </ns3:BookingReferences>
                    <ns3:TimeLimits>
                        <ns3:PaymentTimeLimit DateTime="2025-01-19T13:41:00"/>
                    </ns3:TimeLimits>
                    <ns3:OrderItems>
                        <ns3:OrderItem>
                            <ns3:FlightItem>
                                <ns3:OriginDestination>
                                    <ns3:Flight>
                                        <ns3:SegmentKey>FL1</ns3:SegmentKey>
                                        <ns3:Status>
                                            <ns3:StatusCode>
                                                <ns3:Code>HK</ns3:Code>
                                            </ns3:StatusCode>
                                        </ns3:Status>
                                        <ns3:Departure>
                                            <ns3:AirportCode>OVB</ns3:AirportCode>
                                            <ns3:Date>2025-02-13</ns3:Date>
                                            <ns3:Time>02:30</ns3:Time>
                                        </ns3:Departure>
                                        <ns3:Arrival>
                                            <ns3:AirportCode>KJA</ns3:AirportCode>
                                            <ns3:Date>2025-02-13</ns3:Date>
                                            <ns3:Time>03:50</ns3:Time>
                                        </ns3:Arrival>
                                        <ns3:MarketingCarrier>
                                            <ns3:AirlineID>S7</ns3:AirlineID>
                                            <ns3:FlightNumber>5309</ns3:FlightNumber>
                                        </ns3:MarketingCarrier>
                                        <ns3:OperatingCarrier>
                                            <ns3:AirlineID>S7</ns3:AirlineID>
                                            <ns3:FlightNumber>5309</ns3:FlightNumber>
                                        </ns3:OperatingCarrier>
                                        <ns3:CabinType>
                                            <ns3:Code>Y</ns3:Code>
                                        </ns3:CabinType>
                                        <ns3:ClassOfService>
                                            <ns3:Code>Y</ns3:Code>
                                        </ns3:ClassOfService>
                                    </ns3:Flight>
                                </ns3:OriginDestination>
                            </ns3:FlightItem>
                            <ns3:Associations>
                                <ns3:Passengers>
                                    <ns3:PassengerReferences>SH4</ns3:PassengerReferences>
                                </ns3:Passengers>
                            </ns3:Associations>
                        </ns3:OrderItem>
                    </ns3:OrderItems>
                </ns3:Order>
                <ns3:Metadata>
                    <ns3:Other>
                        <ns3:OtherMetadata>
                            <ns3:CountryMetadatas>
                                <ns3:CountryMetadata MetadataKey="CM1">
                                    <ns3:AugmentationPoint>
                                        <ns3:AugPoint Owner="OVB">
                                            <ns4:value xmlns:ns4="##other" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:nil="true"/>
                                        </ns3:AugPoint>
                                    </ns3:AugmentationPoint>
                                </ns3:CountryMetadata>
                            </ns3:CountryMetadatas>
                        </ns3:OtherMetadata>
                    </ns3:Other>
                </ns3:Metadata>
            </ns3:Response>
        </ns3:OrderViewRS>
    </ns2:Body>
</ns2:Envelope>



OW+1xADT+Direct+S7 flight+FQTV | v0.52 | book operation

Subsidised fare+OW+1xSRC+Direct | v0.52 | book operation

Subsidised fare+RT+1xYTR+1CHD+1INF+Transfer | v0.52 | book operation

1ADT+1INF with a seat+Domestic+OW+DIRECT | v0.52 | book operation

ВПД МВД 1ADT+1CHD+1INF+Domestic+OW+DIRECT+Public fares | v0.52 | book operation

ВПД МВД 1ADT+1CHD+1INF+Domestic+OW+DIRECT+YFLOW with 10% discount | v0.52 | book operation

ВПД МВД 1ADT+1CHD+1INF+Domestic+OW+DIRECT+MM02 fare | v0.52 | book operation

ВПД МО 1ADT+1CHD+1INF+Domestic+OW+DIRECT | v0.52 | book operation

ВПД МВД 1ADT+1CHD+1INF+Domestic+OW+DIRECT+M fare | v0.52 | book operation

1CHD+Domestic+OW+DIRECT | v0.52 | book operation