Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Book operation makes a reservation of chosen solution for one or more passengers and returns PNR locator with passengers and , itinerary information in 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. Book - Returns PNR locator, one for all passengers and Ticket Time Limits.Standard booking flow — reservation of chosen solution from search results. Includes passengers and itinerary information.
  2. 3D agreement boooking flow - reservation of — reservation of chosen solution from search results (сonsidering corporate discount). Includes Agent/Corporate client and itinerary information.

Table of contents

Table of Contents

Request (OrderCreateRQ)

Book

Anchorstandard bookstandard book

Standard booking

Required inputs

#NameFormat/ReferencexPath
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
2Passenger information

This element contains information about passengers: name, surname, date of birth, contacts, passport data, etc.

/Envelope/Body/OrderCreateRQ/Query/Passengers/Passenger

3Passengers and flight segments references

Includes reference elements connecting passengers with the appropriate flights

/Envelope/Body/OrderCreateRQ/Query/OrderItems/ShoppingResponse

4Itinerary informationSolution from Search method RS

/Envelope/Body/OrderCreateRQ/Query/OrderItems/OfferItem/DetailedFlightItem

Optional parameters

#NameFormat/ReferencexPath
1

Additional Information

/Envelope/Body/OrderCreateRQ/Query/OrderItems/DataLists2

Seats information

This element must contain Contains the list of seats with the a price/Envelope/Body/OrderCreateRQ/Query/OrderItems/DataLists/SeatList/Seats3
2

TTL

Ticketing Time Limit

Booking cancelation datetime in case of tickets are not issued.

By default calculated by S7 rules

TTL is calculated in 2 ways, automatically and added manually by the user:
  • For automatic TTL, the field is not specified or the entire TimeLimits element is deleted
  • During manual input use the TTL specified by the user

    .

    /Envelope/Body/OrderCreateRQ/Query/OrderItems/DataLists/ServiceList/Service[ServiceID][Name]TimeLimits/TicketingTimeLimits
    3

    3D agreement

    boooking 

    credentials

    Available only for scenario with 3D AgreementUse credentials that you received from our technical support. Check out Quick Start for how to get those IDs/
    Required inputs
    //Code918
    #NameFormat/ReferencexPath
    1

    Client ID code

    QUW1725

    Envelope/Body/OrderCreateRQ/Query/OrderItems/DataLists/InstructionsList/Instruction[@ListKey="CC"]/SpecialBookingInstruction2

    Agent ID code

    Response (OrderViewRS)


    NameFormat/ReferencexPath
    1Passengers information

    This element contains information about passengers: name, surname, date of birth, contacts, passport data, etc.

    /Envelope/Body/OrderViewRS/Response/Passengers/Passenger

    2Booking reservation numberPNR/Envelope/Body
    /OrderCreateRQ/Query/OrderItems/DataLists/InstructionsList/Instruction[@ListKey="CC"]/SpecialBookingInstruction/Definition
    Note
    iconfalse

    (lightbulb) Other Required inputs like described in Standard booking

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

    /OrderViewRS/Response/Order/BookingReferences
    3Ticketing Time LimitTTL/Envelope/Body/OrderViewRS/Response/Order/TimeLimits/PaymentTimeLimit
    4Itinerary informationItinerary information/Envelope/Body/OrderViewRS/Response/Order/OrderItems

    Samples

    Children Display
    styleh3
    pagebook operation | Samples
    excerptTyperich content
    The logic is always the same, the slice to be written as OreginDestination, inside it writable segments through Flight.