Hahn Air NDC 2017.2 API – AirShoppingRQ

AirShoppingRQ definition


Expand all
Collapse all

 

AirShoppingRQ

Attributes

ParameterTypeOptionalDescriptionExample
PrimaryLangIDStringY

Primary language. Service response will be returned in this language. Two-letter language code.

Currently only EN is supported.

EN
VersionStringNNDC schema message version. Always use 17.2.17.2

Elements

ParameterTypeOptionalDescriptionExample
PointOfSalePointOfSaleYOptional element for setting the request time stamp.-
DocumentDocumentNNDC Message information.-
PartyPartyNNDC Message sender information.-
CoreQueryCoreQueryNContains all mandatory AirShoppingRQ information.-
QualifierQualifierYContains baggage preferences.
PreferencePreferenceY

Contains preferences to:

include and/or exclude airlines

request offers with specific cabin

-
DataListsDataListsNContains the passengers list (type and number).-

AirShoppingRQ.PointOfSale

Elements

ParameterTypeOptionalDescriptionExample
RequestTimeDate/timeY

Date and time of the request. Date and time are separated by T.

2019-10-12T08:30:57

AirShoppingRQ.Document

Elements

ParameterTypeOptionalDescriptionExample
NameStringY

Message name given by sender. Will be overwritten by default name in response.

eeBook NDC 2017.2 API WS Gateway
ReferenceVersionStringYDocument reference version.WS 2017.2

AirShoppingRQ.Party

Elements

ParameterTypeOptionalDescriptionExample
SenderSenderN

Information about the request sender.

-
ParticipantsParticipantsYSet this if coming from aggregator.-
RecipientRecipientYContains ORA information.-
AirShoppingRQ.Party.Participants

Elements

ParameterTypeOptionalDescriptionExample
ParticipantParticipantY

Set this element if request is coming through an aggregator.

-
AirShoppingRQ.Party.Participants.Participant

Elements

ParameterTypeOptionalDescriptionExample
AggregatorParticipantAggregatorParticipantN

Used for aggregator participants.

-

Attributes on element AggregatorParticipant

ParameterTypeOptionalDescriptionExample
SequenceNumberStringN

Unique number for participant.

1
AirShoppingRQ.Party.Participants.Participant.AggregatorParticipant

Elements

ParameterTypeOptionalDescriptionExample
AggregatorIDStringN

Aggregator ID.

1241242
AirShoppingRQ.Party.Recipient

Elements

ParameterTypeOptionalDescriptionExample
ORA_RecipientORA_RecipientN

ORA code.

-
AirShoppingRQ.Party.Recipient.ORA_Recipient

Elements

ParameterTypeOptionalDescriptionExample
AirlineIDStringN

ORA code.

HR
AirShoppingRQ.Party.Sender

Elements

ParameterTypeOptionalDescriptionExample
TravelAgencySenderTravelAgencySenderN

Information about the sending agency.

-
AirShoppingRQ.Party.Sender.TravelAgencySender

Elements

ParameterTypeOptionalDescriptionExample
AgencyIDStringN

Agency's ID - IATA or non-IATA number.

IATA agencies - add leading zero(s) if needed to have 8 digits

Non-IATA agencies - the leading character should be N, followed by leading zero(s) if needed to have 8 characters in total

87654321

AirShoppingRQ.CoreQuery

Elements

ParameterTypeOptionalDescriptionExample
OriginDestinationsOriginDestinationsN

Origin and destination details.

-
AirShoppingRQ.CoreQuery.OriginDestinations

Elements

ParameterTypeOptionalDescriptionExample
OriginDestinationOriginDestinationN

Origin and destination details per leg. For return flight use two such elements.

-
AirShoppingRQ.CoreQuery.OriginDestinations.OriginDestination

Elements

ParameterTypeOptionalDescriptionExample
DepartureDepartureN

Departure airport and date information.

-
ArrivalArrivalNArrival airport information.-
AirShoppingRQ.CoreQuery.OriginDestinations.OriginDestination.Departure

Elements

ParameterTypeOptionalDescriptionExample
AirportCodeStringN

Can be airport code or airport city for departure.

FRA
DateStringNDeparture date. Has to be YYYY-MM-DD2019-04-26
AirShoppingRQ.CoreQuery.OriginDestinations.OriginDestination.Arrival

Elements

ParameterTypeOptionalDescriptionExample
AirportCodeStringN

Can be airport code or airport city for destination.

FRA

AirShoppingRQ.Qualifier

Elements

ParameterTypeOptionalDescriptionExample
BaggagePricingQualifierBaggagePricingQualifierN

Contains the baggage preference element.

-
AirShoppingRQ.Qualifier.BaggagePricingQualifier

Elements

ParameterTypeOptionalDescriptionExample
BaggageOptionStringN

Baggage preference option code. Currently only code 3 is supported.

If set only offers containing free checked baggage will be returned. 

If any other value is set the preference is ignored.

3

AirShoppingRQ.Preference

Elements

ParameterTypeOptionalDescriptionExample
AirlinePreferencesAirlinePreferencesY

List of all airline preferences.

-
CabinPreferencesCabinPreferencesYContains the cabin preference details. If multiple cabin preferences are set, only the first one in the list is used.-
AirShoppingRQ.Preference.AirlinePreferences

Elements

ParameterTypeOptionalDescriptionExample
AirlineAirlineN

Defines single airline to be included or excluded from the response. Multiple elements can be added. Max number of elements is 200.

-

Attributes on element Airline

ParameterTypeOptionalDescriptionExample
PreferencesLevelStringN

Excluding a POA which is processing the request will result in a error response.

Possible values:

Required - airline has to be included in the response

Exclude - airline has to be excluded from the response

It is not possible to mix values of PreferencesLevel in the same Request. If multiple airlines are sent in the AirlinePreferences, they should all have the same PreferencesLevel.

Exclude
AirShoppingRQ.Preference.AirlinePreferences.Airline

Elements

ParameterTypeOptionalDescriptionExample
AirlineIDStringN

Two letter airline code to be included or excluded from the response.

HR
AirShoppingRQ.Preference.CabinPreferences

Elements

ParameterTypeOptionalDescriptionExample
CabinTypeCabinTypeN

Defines the cabin preference which is expected to be returned in the response. Only one cabin preference can be sent in the request.

-
AirShoppingRQ.Preference.CabinPreferences.CabinType

Elements

ParameterTypeOptionalDescriptionExample
CodeStringN

CabinType code which defines the preferred cabin to be returned. Possible values are:

1 - First

2 - Business

3 - Economy

4 - Premium Economy

5 - Economy

6 - Economy

7 - any cabin, no preference

2

AirShoppingRQ.DataLists

Elements

ParameterTypeOptionalDescriptionExample
PassengerListPassengerListN

List of all passenger type codes for which the request is built.

-
AirShoppingRQ.DataLists.PassengerLists

Elements

ParameterTypeOptionalDescriptionExample
PassengerPassengerN

Single passenger details. For each passenger in the request a separate element has to be added.

Min number of ADT: 1

Max number of ADT+CHD: 9

INF not yet supported

-
AirShoppingRQ.DataLists.PassengerLists.Passenger

Attributes

ParameterTypeOptionalDescriptionExample
PassengerIDStringN

Unique passenger reference.

Cannot contain :, @, $, %, &, /, +, ,, ;, whitespace characters or different parenthesis, cannot begin with a number, dot or minus character although they can appear later.

Limited to 50 characters.

PAX1

pax-1

ADT_01

Elements

ParameterTypeOptionalDescriptionExample
PTCStringN

Passenger type code.

Possible values: ADT, CHD

INF not yet supported

ADT
InfantRefStringYPassengerID reference for the infant passenger. Each infant has to be referenced in the adult passenger. Infant can be referenced only once.PAX2

AirShoppingRQ samples

1. AirShoppingRQ - 1 ADT - One Way / No Preferences
<soap-env:Envelope xmlns:soap-env="http://schemas.xmlsoap.org/soap/envelope/">
    <soap-env:Header/>
    <soap-env:Body>
        <AirShoppingRQ xmlns="http://www.iata.org/IATA/EDIST/2017.2" Version="2017.2">
            <Document>
                <Name>eeBook NDC 2017.2 API WS Gateway</Name>
                <ReferenceVersion>WS 2017.2</ReferenceVersion>
            </Document>
            <Party>
                <Sender>
                    <TravelAgencySender>
                        <AgencyID>11111111</AgencyID>
                    </TravelAgencySender>
                </Sender>
                <Participants>
                    <Participant>
                        <AggregatorParticipant SequenceNumber="1">
                            <AggregatorID>N9999999</AggregatorID>
                        </AggregatorParticipant>
                    </Participant>
                </Participants>
                <Recipient>
                    <ORA_Recipient>
                        <AirlineID>HR</AirlineID>
                    </ORA_Recipient>
                </Recipient>
            </Party>
            <CoreQuery>
                <OriginDestinations>
                    <OriginDestination>
                        <Departure>
                            <AirportCode>ABJ</AirportCode>
                            <Date>2022-04-20</Date>
                        </Departure>
                        <Arrival>
                            <AirportCode>DSS</AirportCode>
                        </Arrival>
                    </OriginDestination>
                </OriginDestinations>
            </CoreQuery>
            <DataLists>
                <PassengerList>
                    <Passenger PassengerID="pax-1">
                        <PTC>ADT</PTC>
                    </Passenger>
                </PassengerList>
            </DataLists>
        </AirShoppingRQ>
    </soap-env:Body>
</soap-env:Envelope>
2. AirShoppingRQ - 1 ADT - Round Trip / Include Baggage Preference
<soap-env:Envelope xmlns:soap-env="http://schemas.xmlsoap.org/soap/envelope/">
    <soap-env:Header/>
    <soap-env:Body>
        <AirShoppingRQ xmlns="http://www.iata.org/IATA/EDIST/2017.2" Version="2017.2">
            <Document>
                <Name>eeBook NDC 2017.2 API WS Gateway</Name>
                <ReferenceVersion>WS 2017.2</ReferenceVersion>
            </Document>
            <Party>
                <Sender>
                    <TravelAgencySender>
                        <AgencyID>22222222</AgencyID>
                    </TravelAgencySender>
                </Sender>
                <Recipient>
                    <ORA_Recipient>
                        <AirlineID>HR</AirlineID>
                    </ORA_Recipient>
                </Recipient>
            </Party>
            <CoreQuery>
                <OriginDestinations>
                    <OriginDestination>
                        <Departure>
                            <AirportCode>NBO</AirportCode>
                            <Date>2022-04-22</Date>
                        </Departure>
                        <Arrival>
                            <AirportCode>ZNZ</AirportCode>
                        </Arrival>
                    </OriginDestination>
                    <OriginDestination>
                        <Departure>
                            <AirportCode>ZNZ</AirportCode>
                            <Date>2022-04-29</Date>
                        </Departure>
                        <Arrival>
                            <AirportCode>NBO</AirportCode>
                        </Arrival>
                    </OriginDestination>
                </OriginDestinations>
            </CoreQuery>
            <Qualifier>
                <BaggagePricingQualifier>
                    <BaggageOption>3</BaggageOption>
                </BaggagePricingQualifier>
            </Qualifier>
            <DataLists>
                <PassengerList>
                    <Passenger PassengerID="pax-1">
                        <PTC>ADT</PTC>
                    </Passenger>
                </PassengerList>
            </DataLists>
        </AirShoppingRQ>
    </soap-env:Body>
</soap-env:Envelope>
3. AirShoppingRQ - 2 ADT - One Way / Include Airline Preference
<soap-env:Envelope xmlns:soap-env="http://schemas.xmlsoap.org/soap/envelope/">
    <soap-env:Header/>
    <soap-env:Body>
        <AirShoppingRQ xmlns="http://www.iata.org/IATA/EDIST/2017.2" Version="2017.2">
            <Document>
                <Name>eeBook NDC 2017.2 API WS Gateway</Name>
                <ReferenceVersion>WS 2017.2</ReferenceVersion>
            </Document>
            <Party>
                <Sender>
                    <TravelAgencySender>
                        <AgencyID>N1234567</AgencyID>
                    </TravelAgencySender>
                </Sender>
                <Participants>
                    <Participant>
                        <AggregatorParticipant SequenceNumber="1">
                            <AggregatorID>N9999999</AggregatorID>
                        </AggregatorParticipant>
                    </Participant>
                </Participants>
                <Recipient>
                    <ORA_Recipient>
                        <AirlineID>HR</AirlineID>
                    </ORA_Recipient>
                </Recipient>
            </Party>
            <CoreQuery>
                <OriginDestinations>
                    <OriginDestination>
                        <Departure>
                            <AirportCode>NBO</AirportCode>
                            <Date>2022-04-23</Date>
                        </Departure>
                        <Arrival>
                            <AirportCode>ZNZ</AirportCode>
                        </Arrival>
                    </OriginDestination>
                </OriginDestinations>
            </CoreQuery>
            <Preference>
                <AirlinePreferences>
                    <Airline PreferencesLevel="Required">
                        <AirlineID>H1</AirlineID>
                    </Airline>
                    <Airline PreferencesLevel="Required">
                        <AirlineID>PW</AirlineID>
                    </Airline>
                </AirlinePreferences>
            </Preference>
            <DataLists>
                <PassengerList>
                    <Passenger PassengerID="pax-1">
                        <PTC>ADT</PTC>
                    </Passenger>
                    <Passenger PassengerID="pax-2">
                        <PTC>ADT</PTC>
                    </Passenger>
                </PassengerList>
            </DataLists>
        </AirShoppingRQ>
    </soap-env:Body>
</soap-env:Envelope>
4. AirShoppingRQ - 2 ADT - Round Trip / Exclude Airline Preference
<soap-env:Envelope xmlns:soap-env="http://schemas.xmlsoap.org/soap/envelope/">
    <soap-env:Header/>
    <soap-env:Body>
        <AirShoppingRQ xmlns="http://www.iata.org/IATA/EDIST/2017.2" Version="2017.2">
            <Document>
                <Name>eeBook NDC 2017.2 API WS Gateway</Name>
                <ReferenceVersion>WS 2017.2</ReferenceVersion>
            </Document>
            <Party>
                <Sender>
                    <TravelAgencySender>
                        <AgencyID>11111111</AgencyID>
                    </TravelAgencySender>
                </Sender>
                <Participants>
                    <Participant>
                        <AggregatorParticipant SequenceNumber="1">
                            <AggregatorID>N9999999</AggregatorID>
                        </AggregatorParticipant>
                    </Participant>
                </Participants>
                <Recipient>
                    <ORA_Recipient>
                        <AirlineID>HR</AirlineID>
                    </ORA_Recipient>
                </Recipient>
            </Party>
            <CoreQuery>
                <OriginDestinations>
                    <OriginDestination>
                        <Departure>
                            <AirportCode>ZRH</AirportCode>
                            <Date>2022-04-24</Date>
                        </Departure>
                        <Arrival>
                            <AirportCode>SPU</AirportCode>
                        </Arrival>
                    </OriginDestination>
                    <OriginDestination>
                        <Departure>
                            <AirportCode>SPU</AirportCode>
                            <Date>2022-05-01</Date>
                        </Departure>
                        <Arrival>
                            <AirportCode>ZRH</AirportCode>
                        </Arrival>
                    </OriginDestination>
                </OriginDestinations>
            </CoreQuery>
            <Preference>
                <AirlinePreferences>
                    <Airline PreferencesLevel="Exclude">
                        <AirlineID>H1</AirlineID>
                    </Airline>
                    <Airline PreferencesLevel="Exclude">
                        <AirlineID>X1</AirlineID>
                    </Airline>
                </AirlinePreferences>
            </Preference>
            <DataLists>
                <PassengerList>
                    <Passenger PassengerID="pax-1">
                        <PTC>ADT</PTC>
                    </Passenger>
                    <Passenger PassengerID="pax-2">
                        <PTC>ADT</PTC>
                    </Passenger>
                </PassengerList>
            </DataLists>
        </AirShoppingRQ>
    </soap-env:Body>
</soap-env:Envelope>
5. AirShoppingRQ - 2 ADT & 2 CHD - One Way / Business Cabin Preference
<soap-env:Envelope xmlns:soap-env="http://schemas.xmlsoap.org/soap/envelope/">
    <soap-env:Header/>
    <soap-env:Body>
        <AirShoppingRQ xmlns="http://www.iata.org/IATA/EDIST/2017.2" Version="2017.2">
            <Document>
                <Name>eeBook NDC 2017.2 API WS Gateway</Name>
                <ReferenceVersion>WS 2017.2</ReferenceVersion>
            </Document>
            <Party>
                <Sender>
                    <TravelAgencySender>
                        <AgencyID>N1234567</AgencyID>
                    </TravelAgencySender>
                </Sender>
                <Recipient>
                    <ORA_Recipient>
                        <AirlineID>HR</AirlineID>
                    </ORA_Recipient>
                </Recipient>
            </Party>
            <CoreQuery>
                <OriginDestinations>
                    <OriginDestination>
                        <Departure>
                            <AirportCode>NBO</AirportCode>
                            <Date>2022-04-25</Date>
                        </Departure>
                        <Arrival>
                            <AirportCode>ADD</AirportCode>
                        </Arrival>
                    </OriginDestination>
                </OriginDestinations>
            </CoreQuery>
            <Preference>
                <CabinPreferences>
                    <CabinType>
                        <Code>2</Code>
                    </CabinType>
                </CabinPreferences>
            </Preference>
            <DataLists>
                <PassengerList>
                    <Passenger PassengerID="pax-1">
                        <PTC>ADT</PTC>
                    </Passenger>
                    <Passenger PassengerID="pax-2">
                        <PTC>ADT</PTC>
                    </Passenger>
                    <Passenger PassengerID="pax-3">
                        <PTC>CHD</PTC>
                    </Passenger>
                    <Passenger PassengerID="pax-4">
                        <PTC>CHD</PTC>
                    </Passenger>
                </PassengerList>
            </DataLists>
        </AirShoppingRQ>
    </soap-env:Body>
</soap-env:Envelope>
6. AirShoppingRQ - 2 ADT & 2 CHD - Round Trip / Include Baggage, Include Airline & Economy Cabin Preferences
<soap-env:Envelope xmlns:soap-env="http://schemas.xmlsoap.org/soap/envelope/">
    <soap-env:Header/>
    <soap-env:Body>
        <AirShoppingRQ xmlns="http://www.iata.org/IATA/EDIST/2017.2" Version="2017.2">
            <Document>
                <Name>eeBook NDC 2017.2 API WS Gateway</Name>
                <ReferenceVersion>WS 2017.2</ReferenceVersion>
            </Document>
            <Party>
                <Sender>
                    <TravelAgencySender>
                        <AgencyID>22222222</AgencyID>
                    </TravelAgencySender>
                </Sender>
                <Recipient>
                    <ORA_Recipient>
                        <AirlineID>HR</AirlineID>
                    </ORA_Recipient>
                </Recipient>
            </Party>
            <CoreQuery>
                <OriginDestinations>
                    <OriginDestination>
                        <Departure>
                            <AirportCode>ZRH</AirportCode>
                            <Date>2022-04-26</Date>
                        </Departure>
                        <Arrival>
                            <AirportCode>SPU</AirportCode>
                        </Arrival>
                    </OriginDestination>
                    <OriginDestination>
                        <Departure>
                            <AirportCode>SPU</AirportCode>
                            <Date>2022-05-03</Date>
                        </Departure>
                        <Arrival>
                            <AirportCode>ZRH</AirportCode>
                        </Arrival>
                    </OriginDestination>
                </OriginDestinations>
            </CoreQuery>
            <Qualifier>
                <BaggagePricingQualifier>
                    <BaggageOption>3</BaggageOption>
                </BaggagePricingQualifier>
            </Qualifier>
            <Preference>
                <AirlinePreferences>
                    <Airline PreferencesLevel="Required">
                        <AirlineID>OU</AirlineID>
                    </Airline>
                </AirlinePreferences>
                <CabinPreferences>
                    <CabinType>
                        <Code>5</Code>
                    </CabinType>
                </CabinPreferences>
            </Preference>
            <DataLists>
                <PassengerList>
                    <Passenger PassengerID="pax-1">
                        <PTC>ADT</PTC>
                    </Passenger>
                    <Passenger PassengerID="pax-2">
                        <PTC>ADT</PTC>
                    </Passenger>
                    <Passenger PassengerID="pax-3">
                        <PTC>CHD</PTC>
                    </Passenger>
                    <Passenger PassengerID="pax-4">
                        <PTC>CHD</PTC>
                    </Passenger>
                </PassengerList>
            </DataLists>
        </AirShoppingRQ>
    </soap-env:Body>
</soap-env:Envelope>