Table of contents:

Check out

Parameters

Access. 
/Envelope /Body /OrderCreateRQ /Party /Sender /AgentUserSender

(warning) Use credentials that you received from our technical support. Check out Quick Start for how to get it
#DescriptionMandMultDefaultRef/FormatxPathExample (only for S7)
1PseudoCity(tick)(error)

PseudoCity
<PseudoCity>S7AGN8224</PseudoCity>
2AgentUserID(tick)(error)
ConstantAgentUserID
<AgentUserID>test</AgentUserID>

Replace text 'test'  with the login from the authorization to the S7 Agent API service.


Corporate Program credentials. 
/Envelope /Body /OrderCreateRQ /Query /OrderItems /DataLists /InstructionsList /Instruction[@ListKey="CC"] /SpecialBookingInstruction

Available only for Corporate Program with discount scenario or Corporate Program with cashback scenario.

(warning) Use credentials that you received from our technical support. Check out Quick Start for how to get those IDs

#

Description

Mand

Mult

Default

Ref/Format

xPath

Example (only for S7)

1Client ID(tick) for Corporate Program case
(error) for other cases

(error)



Code

<Code>QUW0000</Code> or <Code>QY0000</Code>
2Agent ID(tick) for Corporate Program case
(error) for other cases		(error)

Definition
<Definition>12251</Definition>


Main. 
/Envelope /Body /OrderCreateRQ

#DescriptionMandMultDefaultRef/Format/DescxPathExample
1Version(tick)(error)(error)
@Version
<OrderCreateRQ Version="">
2Document(tick)(error)(error)
Document
<Document />
3Passengers information(tick)(tick)(error)

Passengers

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

Query /Passengers /Passenger
<Passenger ObjectKey="SH1">
4Offer information(tick)(error)(error)OfferQuery/OrderItems/ShoppingResponse
5Journey information(tick)(tick)(error)OriginDestinationOrderItems/OfferItem
6Accompanying adult booking reference     (error)   (error)       (error)

BookingReference

Query/BookingReferences/BookingReference


Passenger. 
/Envelope /Body /OrderCreateRQ /Query /Passengers /Passenger (Multiple).

#DescriptionMandMultDefaultRef/Format/DescxPathExample
1Passenger ID(tick)(error)(error)a-Z;1-9, but min 1 char.@ObjectKey
<Passenger ObjectKey="SH1">
2Passenger Type Code(tick)(error)(error)

  1. ADT

  2. CHD

  3. INF

  4. SRC
  5. YTR
  6. NTL
PTC
<PTC>ADT</PTC>
3Passenger Birth date(tick)(error)(error)

YYYY-MM-DD

Age /BirthDate
<Age>
  <BirthDate>1985-02-03</BirthDate>
</Age>
4Passenger Surname(tick)(error)(error)
Name /Surname
<Name>
  <Surname>Lem</Surname>
  <Given>Stanislav</Given>
  <Title>MR</Title> 
</Name>
5Passenger Name (tick)(error)(error)
Name /Given
<Name>
  <Surname>Lem</Surname>
  <Given>Stanislav</Given>
  <Title>MR</Title> 
</Name>
6Passenger Title(error)(error)(error)MR, MRS, MSName /Title
<Name>
  <Surname>Lem</Surname>
  <Given>Stanislav</Given>
  <Title>MR</Title> 
</Name>
7Passenger Email(tick) (if no phone number)(error)(error)
Contacts /Contact /EmailContact /Address
<EmailContact>
  <Address>v.ivanov@gmail.com</Address>
</EmailContact>
8Passenger phone number(tick) (if no email)(error)(error)
Contacts /Contact /PhoneContact /Number
<PhoneContact>
   <Number CountryCode="7" AreaCode="906">7770934</Number>
</PhoneContact>
9Phone number country code(tick)(error)(error)
Contacts /Contact /PhoneContact /Number@CountryCode
<PhoneContact>
   <Number CountryCode="7" AreaCode="906">7770934</Number>
</PhoneContact>
10Phone number area code(tick)(error)(error)
Contacts /Contact /PhoneContact /Number@AreaCode
<PhoneContact>
   <Number CountryCode="7" AreaCode="906">7770934</Number>
</PhoneContact>
11Airline code - S7 always(error)(error)(error)S7FQTVs /TravelerFQTV_Information /AirlineID
<FQTVs>
  <TravelerFQTV_Information>
    <AirlineID>S7</AirlineID>
    <Account>
      <Number>612966192</Number>
    </Account>
    <ProgramID>S7</ProgramID>
  </TravelerFQTV_Information>
</FQTVs>
12Loyalty card number(error)(error)(error)
FQTVs /TravelerFQTV_Information /Account /Number
<FQTVs>
  <TravelerFQTV_Information>
    <AirlineID>S7</AirlineID>
    <Account>
      <Number>612966192</Number>
    </Account>
    <ProgramID>S7</ProgramID>
  </TravelerFQTV_Information>
</FQTVs>
13Program ID - loyalty program owner code (Airline code)(error)(error)(error)
FQTVs /TravelerFQTV_Information /ProgramID
<FQTVs>
  <TravelerFQTV_Information>
    <AirlineID>S7</AirlineID>
    <Account>
      <Number>612966192</Number>
    </Account>
    <ProgramID>S7</ProgramID>
  </TravelerFQTV_Information>
</FQTVs>
14Passenger gender(error)(error)(error)
  • Male
  • Female
Gender
<Gender>Male</Gender>
15Passenger document type - PP always(tick)(error)PPPPPassengerIDInfo /PassengerDocument /Type
<Type>PP</Type>
16Passenger document number - any document is indicated, regardless of the fact that the type is always PP(tick)(error)(error)
PassengerIDInfo /PassengerDocument /ID
<ID>4510173564</ID>

<ID>adrt12345</ID>
17Passenger Birth сountry specified in the document(tick)(error)(error)Сountry codePassengerIDInfo /PassengerDocument /BirthCountry
<BirthCountry>RU</BirthCountry>
18Date of Issue specified in the document(tick)(error)(error)YYYY-MM-DDPassengerIDInfo /PassengerDocument /DateOfIssue
<DateOfIssue>2011-10-10</DateOfIssue>
19Date of expiration specified in the document (if not specified, you can specify the default date = current date + 1 year)(tick)(error)(error)YYYY-MM-DDPassengerIDInfo /PassengerDocument /DateOfExpiration
<DateOfExpiration>2021-10-10</DateOfExpiration>
20Passenger country of residence specified in the document(tick)(error)(error)Сountry codePassengerIDInfo /PassengerDocument /CountryOfResidence
<CountryOfResidence>RU</CountryOfResidence>

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

#DescriptionMandMultDefaultRef/Format/DescxPathExample
1Offer owner - S7 always(tick)(error)S7S7Owner
<Owner>S7</Owner>
2Constant(tick)(error)UNKNOWN

UNKNOWN

ResponseID
<ResponseID>UNKNOWN</ResponseID>
3Constant(tick)(error)UNKNOWN

UNKNOWN

Offers /Offer /OfferID
<OfferID Owner="S7">UNKNOWN</OfferID>
4Offer owner - S7 always(tick)(error)S7S7Offers /Offer /OfferID@Owner
<OfferID Owner="S7">UNKNOWN</OfferID>
5Constant(tick)(error)UNKNOWNUNKNOWNOffers /Offer /OfferItems /OfferItem /OfferItemID
<OfferItemID Owner="S7">UNKNOWN</OfferItemID>
6Offer owner - S7 always(tick)(error)S7S7Offers /Offer /OfferItems /OfferItem /OfferItemID@Owner
<OfferItemID Owner="S7">UNKNOWN</OfferItemID>
7Passengers references(tick)(tick)(error)
Offers /Offer /OfferItems /OfferItem /Passengers /PassengerReference
<PassengerReference>SH1 SH2</PassengerReference>
8Segments references(tick)(tick)(error)
Offers /Offer /OfferItems /OfferItem /ApplicableFlight /FlightReferences
<FlightReferences>FL1 FL2</FlightReferences>

OriginDestination. 
/Envelope /Body /OrderCreateRQ /Query /OrderItems /OfferItem /OfferItemType /DetailedFlightItem /OriginDestination (Multiple).

#DescriptionMandMultDefaultRef/Format/DescxPathExample
1Segment ID(tick)(error)(error)a-Z;1-9, but min 1 char.Flight /SegmentKey
<SegmentKey>FL1</SegmentKey>
2Departure IATA airport code(tick)(error)(error)

IATA airport code

Flight /Departure /AirportCode
<AirportCode>OVB</AirportCode>
3Departure date (local)(tick)(error)(error)

YYYY-MM-DD

Flight /Departure /Date
<Date>2019-07-06</Date>
4Departure time (local)(tick)(error)(error)HH:MMFlight /Departure /Time
<Time>06:40</Time>
5Departure terminal name(error)(error)(error)
Flight /Departure /Terminal /Name
<Name>1</Name>
6Arrival IATA airport code(tick)(error)(error)IATA airport codeFlight /Arrival /AirportCode
<AirportCode>LED</AirportCode>
7Arrival date (local)(tick)(error)(error)YYYY-MM-DDFlight /Arrival /Date
<Date>2019-07-06</Date>
8Arrival time (local)(tick)(error)(error)HH:MMFlight /Arrival /Time
<Time>16:35</Time>
9Arrival terminal name(error)(error)(error)
Flight /Arrival /Terminal /Name
<Name>D</Name>
10Marketing carrier IATA airline code(tick)(error)(error)IATA airline codeFlight /MarketingCarrier /AirlineID
<AirlineID>S7</AirlineID>
11Marketing carrier flight number(tick)(error)(error)
Flight /MarketingCarrier /FlightNumber
<FlightNumber>49</FlightNumber>
12Operating carrier IATA airline code(tick)(error)(error)IATA airline codeFlight /OperatingCarrier /AirlineID
<AirlineID>BA</AirlineID>
13Operating carrier flight number(tick)(error)(error)
Flight /OperatingCarrier /FlightNumber
<FlightNumber>430</FlightNumber>
14The required number of seats is equal to the number of passengers(error)(error)(error)NumberFlight /ClassOfService /Code /@SeatsLeft
<Code SeatsLeft="9">S</Code>
15Class of service code (RBD)(tick)(error)(error)LetterFlight /ClassOfService /Code
<Code SeatsLeft="2">Q</Code>

BookingReferences. 
/Envelope /Body /OrderCreateRQ /Query/BookingReferences/BookingReference

#DescriptionMandMultDefaultRef/Format/DescxPathExample
1Accompanying adult booking number(tick)(error)(error)
Type/Code<Code>UKIJGW</Code>
2ID(tick)(error)(tick)ANYID<ID>ANY</ID>
3Airline ID (tick)(error)(tick)S7AirlineID<AirlineID>S7</AirlineID>

 

  • No labels