User Guidance

Input Parameters

Type

Mandatory/Optional

Request Object

OfferPriceRQ

M

<OfferPriceRQ>

XML Example for the following elements

Code Block

language	xml

<OfferPriceRQ Version="17.2" xmlns="http://www.iata.org/IATA/EDIST">

Elements

Details

Mandatory/Optional

Version (Attribute)

Specify NDC schema message version. Always pass 17.2

Note: This is a mandatory attribute in NDC schema. The service will not validate what is being passed in this attribute

M

<Document>

XML Example for the following elements

Code Block

language	xml

<Document>
        <Name>NDC</Name>
        <ReferenceVersion>17.2</ReferenceVersion>
</Document>

Elements

Details

Mandatory/Optional

Document

NDC Message Document information

M

Name

Document name will be always NDC

O

ReferenceVersion

Will be NDC version

O

<PointOfSale>

XML Example for the following elements

Code Block

language	xml

<ns:PointOfSale>
    <ns:Location>
        <ns:CountryCode>IT</ns:CountryCode>
        <ns:CityCode>ROM</ns:CityCode>
    </ns:Location>
    <ns:RequestTime Zone = "CET">2019-01-28T07:01:00</ns:RequestTime>
</ns:PointOfSale>

Elements

Details

Mandatory/Optional

Location

Point of sale location information.

CountryCode

Country Code

M

CityCode

Airport or City Code

M

RequestTime

Point Of Sale Timestamp value
Example: 2017-01-13T13:59:38Z

M

Zone

Point of Sale timezone
Example : UTC, CET

O

<Party>

XML Example for the following elements

Normal bookings/B2C bookings

Code Block

language	xml

<ns:Party>
    <ns:Sender>
        <ns:AgentUserSender>
            <ns:Name>CHANNEL NAME</ns:Name>
            <ns:AgentUserID>CHANNEL CODE</ns:AgentUserID>
        </ns:AgentUserSender>
    </ns:Sender>
    <ns:Recipient>
        <ns:ORA_Recipient>
            <ns:AirlineID>AIRLINE CODE</ns:AirlineID>
            <ns:Name>AIRLINE NAME</ns:Name>
        </ns:ORA_Recipient>
    </ns:Recipient>
</ns:Party>

B2B login/travel agent login

Code Block

language	xml

<edis:Party>
    <edis:Sender>
        <edis:AgentUserSender>
            <edis:OtherIDs>
                <edis:OtherID Description = "Booking Channel ID">CHANNEL CODE given by IBS</edis:OtherID>
            </edis:OtherIDs>
            <edis:AgentUserID Owner = "Agency code">Agent id</edis:AgentUserID>
        </edis:AgentUserSender>
    </edis:Sender>
    <edis:Recipient>
        <edis:ORA_Recipient>
            <edis:AirlineID>AIRLINE CODE</edis:AirlineID>
            <edis:Name>AIRLINE NAME</edis:Name>
        </edis:ORA_Recipient>
    </edis:Recipient>
</edis:Party>

Elements

Details

Mandatory/Optional

Party

Party & Sender Definition

M

Sender

Message Sender information.

M

AgentUserSender

Agent User Sender Details

M

Name

Agency Seller Name

M

AgentUserID

User ID of the Agent

Info

AgentUserID

In case of B2C bookings, AgentUserID holds the channel code.

Example:

Code Block

language	xml

<ns:AgentUserID>CHANNELXXX</ns:AgentUserID>

M

Owner (Attribute)

Airline designator or CRS code of the owner/ assigner of the Offer ID, typically used for offer ordering purposes.

Info

Owner (Attribute)

Owner value in In case of a Travel Agent booking, Owner value will be the Agency Code.

Example:

Code Block

language	xml

<edis:AgentUserID Owner = "TravelDestiny">TravelAgent1</edis:AgentUserID>

O

OtherIDs

Additional Agency (Seller) identification

O

OtherID

Other Identifier

M

Description (Attribute)

Other identification description.

Info

Description (Attribute)

Description value in In case of a Travel Agent Booking, Description value will be “Booking Channel ID”

M

Recipient

Named Message Recipient.

M

ORA_Recipient

SUPPLIER: ORA (Offer Originating Airline) Recipient.

M

AirlineID

Airline ID

M

Name

Airline Name

M

<Parameters>

XML Example for the following elements

Code Block

language	xml

<ns:Parameters>
    <ns:CurrCodes>
        <ns:FiledInCurrency>
            <ns:CurrCode>EUR</ns:CurrCode>
        </ns:FiledInCurrency>
    </ns:CurrCodes>
</ns:Parameters>

Elements

Details

Mandatory/Optional

Parameters

Parameters that influence overall message results.

M

CurrCodes

Requested search processing and results currency information.

O

FiledInCurrency

Currency detail

M

CurrCode

Currency Code
Example : USD

M

...

">

<Query>

XML Example for the following elements

Following examples includes the Offers for Flight Fare Offers, Seat Offers , SSR Offers and Extra Baggage Offers.

Code Block

language	xml

<ns:Query>
    <ns:Offer ResponseID="ID-Fb--rdQS6HFd4AHC9" Owner="AIRLINE CODE" OfferID="OF1-eJxdzEEKgzAQBdATKfmTyWSydKHgplKNYFb--rdQS6HFd4AHC9GKGDRb4rQOQ6tE8pTNNNx4vAkFl-lVOe4rGyPcxLlVLgRDb7nD78mRV3JVn8cR-e-RxyP6fYQqvRaGE581JcM_">
        <ns:OfferItem OfferItemID="OF1_OI1-eJxdzEEKgzAQBdATKfmTyWSydKHgplKNYFb--rdQS6HFd4AHC9GKGDRb4rQOQ6tE8pTNNNx4vAkFl-lVOe4rGyPcxLlVLgRDb7nD78mRV3JVn8cR-e-RxyP6fYQqvRaGE581JcM_">
            <ns:PassengerRefs>V1_PAX.1 V1_PAX.4</ns:PassengerRefs>
        </ns:OfferItem>
        <ns:OfferItem OfferItemID="OF1_OI2-eJxdzEEKgzAQBdATKfmTyWSydKHgplKNYFb--rdQS6HFd4AHC9GKGDRb4rQOQ6tE8pTNNNx4vAkFl-lVOe4rGyPcxLlVLgRDb7nD78mRV3JVn8cR-e-RxyP6fYQqvRaGE581JcM_">
            <ns:PassengerRefs>V1_PAX.2</ns:PassengerRefs>
        </ns:OfferItem>
        <ns:OfferItem OfferItemID="OF1_OI3-eJxdzEEKgzAQBdATKfmTyWSydKHgplKNYFb--rdQS6HFd4AHC9GKGDRb4rQOQ6tE8pTNNNx4vAkFl-lVOe4rGyPcxLlVLgRDb7nD78mRV3JVn8cR-e-RxyP6fYQqvRaGE581JcM_">
            <ns:PassengerRefs>V1_PAX.3</ns:PassengerRefs>
        </ns:OfferItem>
    </ns:Offer>
    <ns:Offer OfferID="SO-eJx9zkEKwjAUBNATWfKn-cnPMtYWXNhijWBWc-9bmCBSdeEsB.Yx4kUQJQ7inTCVPG.JojGYKVwLH1di8EznJXO6b5zGdVkvhT2CRuMtsy4YtOtxkA8uslrpdGycBYXtnAAs4yy-niE0rxDsTTv35RkrVh..PKvNfs-5f17CG6R7AvtjPfI_"  Owner="AIRLINE CODE" ResponseID="ID-Fb--rdQS6HFd4AHC9">
        <ns:OfferItem OfferItemID="SO1_OI8-eJwVyDEOgCAMBdAbmbZAKSMibkpUTGT697.F.sbHyiyJk2clQ17mPDo4JIv2zQ-PAfGkGGVl1PtELW1v24CTaBJxdWSBwFmYCPQCSpYVDA__">
            <ns:PassengerRefs>V1_PAX.1</ns:PassengerRefs>
            <ns:SeatSelection>
                <ns:Row>4</ns:Row>
                <ns:Column>A</ns:Column>
            </ns:SeatSelection>
        </ns:OfferItem>
        <ns:OfferItem OfferItemID="SO1_OI11-eJwVyDEOgCAMBdAbmbZAKSMibkpUTGT697.F.sbHyiyJk2clQ17mPDo4JIv2zQ-PAfGkGGVl1PtELW1v24CTaBJxdWSBwFmYCPQCSpYVDA__">
            <ns:PassengerRefs>V1_PAX.2</ns:PassengerRefs>
            <ns:SeatSelection>
                <ns:Row>7</ns:Row>
                <ns:Column>A</ns:Column>
            </ns:SeatSelection>
        </ns:OfferItem>
        <ns:OfferItem OfferItemID="SO1_OI12-eJwVyDEOgCAMBdAbmbZAKSMibkpUTGT697.F.sbHyiyJk2clQ17mPDo4JIv2zQ-PAfGkGGVl1PtELW1v24CTaBJxdWSBwFmYCPQCSpYVDA__">
            <ns:PassengerRefs>V1_PAX.4</ns:PassengerRefs>
            <ns:SeatSelection>
                <ns:Row>8</ns:Row>
                <ns:Column>A</ns:Column>
            </ns:SeatSelection>
        </ns:OfferItem>
    </ns:Offer>
    <ns:Offer OfferID = "OO-eJxlzEsKgzAURuEVKfeRm9wMg1go.ECbgo7.-e-C2EEp9AzP4ONIxuosSimgnPWxF3Akl5Aj3eHY2hCU51IxvneMw7qs8wmVZNnxqigwsFiv0vHXYw1oWCM-npvTj6eY-jxVy3J7ExTZ.5hAF7-dKXM_" Owner="AIRLINE CODE" ResponseID = "ID-Fb--rdQS6HFd4AHC9">
        <ns:OfferItem OfferItemID = "OO337-eJw1ykkKgDAQBdETKd2dwWTZTiA4YBJBV--.tzAurOWj2JNjE1hstBFjv60gzWj4d0OdhT5lToqKoY6evnCfFQS67AXTlTANx35sD4x0LgbkAoUDi2uNgF5X2RrI">
            <ns:PassengerRefs>V1_PAX.1</ns:PassengerRefs>
        </ns:OfferItem>
        <ns:OfferItem OfferItemID = "OO337-eJw1ykkKgDAQBdETKd2dwWTZTiA4YBJBV--.tzAurOWj2JNjE1hstBFjv60gzWj4d0OdhT5lToqKoY6evnCfFQS67AXTlTANx35sD4x0LgbkAoUDi2uNgF5X2RrI">
            <ns:PassengerRefs>V1_PAX.2</ns:PassengerRefs>
        </ns:OfferItem>
        <ns:OfferItem OfferItemID = "OO337-eJw1ykkKgDAQBdETKd2dwWTZTiA4YBJBV--.tzAurOWj2JNjE1hstBFjv60gzWj4d0OdhT5lToqKoY6evnCfFQS67AXTlTANx35sD4x0LgbkAoUDi2uNgF5X2RrI">
            <ns:PassengerRefs>V1_PAX.3</ns:PassengerRefs>
        </ns:OfferItem>
        <ns:OfferItem OfferItemID = "BO280-eJw1ykEOQDAQRuETkZlpp63lEMQCQQWr--63oAtv.eVxIGWXWHwTIu7WRlB3oeLfHUUPe-KwGz5MZaQS7u0DgU1LRn-u6Lt1WecHTqI2CUeGQcGitRPQC1sNGtE_">
            <ns:PassengerRefs>V1_PAX.1</ns:PassengerRefs>
        </ns:OfferItem>
        <ns:OfferItem OfferItemID = "BO282-eJw1ykEOQDAQRuETkZlpp63lEMQCQQWr--63oAtv.eVxIGWXWHwTIu7WRlB3oeLfHUUPe-KwGz5MZaQS7u0DgU1LRn-u6Lt1WecHTqI2CUeGQcGitRPQC1sNGtE_">
            <ns:PassengerRefs>V1_PAX.2</ns:PassengerRefs>
        </ns:OfferItem>
        <ns:OfferItem OfferItemID = "BO286-eJw1ykEOQDAQRuETkZlpp63lEMQCQQWr--63oAtv.eVxIGWXWHwTIu7WRlB3oeLfHUUPe-KwGz5MZaQS7u0DgU1LRn-u6Lt1WecHTqI2CUeGQcGitRPQC1sNGtE_">
            <ns:PassengerRefs>V1_PAX.3</ns:PassengerRefs>
        </ns:OfferItem>
    </ns:Offer>
</ns:Query>

Elements

Details

Mandatory/Optional

Offer

To get a price quote using long sell, the client should use this tag to provide details.

M

Owner (Attribute)

Should be always set to Airline Code

M

OfferID (Attribute)

This is the OfferID returned in AirShoppingRS/SeatAvailabilityRS/ServiceListRS for the offer the customer wishes to book the flight or choose the seat.

M

OfferItemType

Offer item type

M

ResponseID (Attribute)

This is the ResponseID returned in AirShoppingRS

M

OrderItem

Info

OfferID (Attribute)

OfferID (Attribute) corresponds to Flight Fare Offer details will be passed from the AirShoppingRS.
OfferID (Attribute) corresponds to Seat Map Offer details will be passed from the SeatAvailabilityRS.
OfferID (Attribute) corresponds to Ancillaries and Baggage Offer details will be passed from ServiceListRS

M

OfferItemType

Offer item type

M

ResponseID (Attribute)

This is the ResponseID returned in AirShoppingRS

M

OrderItem

This will contain the OfferItem associated with Offer returned in AirShoppingRS/SeatAvailabilityRS/ServiceListRS .

M

OfferItemID (Attribute)

The client should pass the OfferItemID that is returned in AirShoppingRS/SeatAvailabilityRS/ServiceListRS for the selected offer

M

PassengerRefs

Should be a reference to Passenger (s) for the selected OfferItemID

M

SeatSelection

Should be a given if the

Info

OfferItemID (Attribute)

OfferItemID (Attribute) corresponds to Flight Fare Offer details will be passed from the AirShoppingRS of the selected offer.
OfferItemID (Attribute) corresponds to Seat Map Offer details will be passed from the SeatAvailabilityRS of the selected offer.
OfferItemID (Attribute) corresponds to Ancillaries and Baggage Offer details will be passed from ServiceListRS of the selected offer.

M

PassengerRefs

Should be a reference to Passenger (s) for the selected OfferItemID

M

SeatSelection

Should be a given if the passenger wish to select seats in the Selected Offer

M

Row

Row Number of the Selected Seat

M

Column

Column Number of the selected Seat

M

<DataLists>

XML

Elements

Details

Mandatory/Optional

Code Block

language	xml

<PassengerList>

PassengerList

Passenger data list definition/details.

M

Code Block

language	xml

<ns:PassengerList>
    <ns:Passenger PassengerID = "V1_PAX.1">
        <ns:PTC>ADT</ns:PTC>
    </ns:Passenger>
    <ns:Passenger PassengerID = "V1_PAX.2">
        <ns:PTC>ADT</ns:PTC>
    </ns:Passenger>
    <ns:Passenger PassengerID = "V1_PAX.3">
        <ns:PTC>CHD</ns:PTC>
    </ns:Passenger>
    <ns:Passenger PassengerID = "V1_PAX.4">
        <ns:PTC>CHD</ns:PTC>
    </ns:Passenger>
     <ns:Passenger PassengerID = "V1_PAX.5">
        <ns:PTC>INF</ns:PTC>
    </ns:Passenger>
</ns:PassengerList>

Code Block

language	xml

<ns:Passenger PassengerID = "V1_PAX.1">

Passenger

Any person except members of the crew carried or to be carried with the consent of the carrier, on board of any transport vehicle such as aircraft, train, bus, ship.

M

Code Block

language	xml

<ns:Passenger PassengerID = "V1_PAX.1">

PassengerID

Uniquely identifies a Passenger within the context of one message.

Example:

V1_PAX.1

Passenger

Any person except members of the crew carried or to be carried with the consent of the carrier, on board of any transport vehicle such as aircraft, train, bus, ship., V1_PAX.2 ,V1_PAX.3

M

Code Block

language	xml

<ns:PTC>INF</ns:PTC>

PTC

Type code applying to the Passenger which typically drives pricing (e.g. .

Example: ADT, CHD, etc).INF

O

Versions Compared

Old Version 31

New Version 32

Key

User Guidance

<OfferPriceRQ>

XML Example for the following elements

<Document>

XML Example for the following elements

<PointOfSale>

XML Example for the following elements

<Party>

XML Example for the following elements

<Parameters>

XML Example for the following elements

<Query>

XML Example for the following elements

<DataLists>

Page Comparison

Versions Compared

Old Version 31

New Version 32

Key

User Guidance

<OfferPriceRQ>

XML Example for the following elements

<Document>

XML Example for the following elements

<PointOfSale>

XML Example for the following elements

<Party>

XML Example for the following elements

<Parameters>

XML Example for the following elements

<Query>

XML Example for the following elements

<DataLists>