Versions Compared

Old Version 21

changes.mady.by.user Sreejith S R

Saved on

compared with

New Version Current

changes.mady.by.user Sreejith S R

Saved on

Key

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

OfferPriceRQ

  • <OfferPriceRQ>

  • <Document>

  • <PointOfSale>

  • <Party>

  • <Parameters>

  • <Query>

  • <DataLists>

Version

(Attribute)

User Guidance

Input Parameters

Type

Mandatory/Optional

Request Object

OfferPriceRQ

M

<OfferPriceRQ>

XML Example for the following elements

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

Elements

Details

Mandatory/Optional

Code Block

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

<Name>

Name

Elements

CityCode

Zone (Attribute)

<Document>

XML Example for the following elements

Code Block
languagexml
<Document>
        <Name>NDC</Name>
        <ReferenceVersion>17.2</ReferenceVersion>
</Document>

Elements

Details

Mandatory/Optional

code

Document

<Document>

NDC Message Document information

M

Code Block

Document name will be always NDC

O

code

ReferenceVersion

< ReferenceVersion>

Will be NDC version

O

<PointOfSale>

XML Example for the following elements

Code Block
languagexml
<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>
Code Block

Details

Mandatory/Optional

code

PointOfSale

Point of Sale information.

M

Location

Point of sale location information.

code

O

CountryCode

Country Code

M

Code Block

Airport or City Code

M

code

RequestTime

Point Of Sale Timestamp value

 Example: 2017-01-13T13:59:38Z

MO

Code Block

Point of Sale timezone

 Example : UTC, CET

O

<Party>

XML Example for the following elements

Normal bookings/B2C bookings

Code Block
languagexml
<ns:Party>
    <ns:Sender>
        <ns:AgentUserSender>
            <ns:Name>GuestName>CHANNEL Website<NAME</ns:Name>
            <ns:AgentUserID>GuestAgentUserID>CHANNEL EN<CODE</ns:AgentUserID>
        </ns:AgentUserSender>
    </ns:Sender>
    <ns:Recipient>
        <ns:ORA_Recipient>
            <ns:AirlineID>V1<AirlineID>AIRLINE CODE</ns:AirlineID>
            <ns:Name>AirlineName>AIRLINE Name<NAME</ns:Name>
        </ns:ORA_Recipient>
    </ns:Recipient>
</ns:Party>

B2B login/travel agent login

Code Block
languagexml
<edis:Party>
    <edis:Sender>
        <edis:AgentUserSender>
            <edis:OtherIDs>
                <edis:OtherID Description = "Booking Channel ID">Channel>CHANNEL CodeCODE 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>AirlineAirlineID>AIRLINE code<CODE</edis:AirlineID>
            <edis:Name>AirlineName>AIRLINE name<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

MO

AgentUserID

User ID of the Agent

Info

AgentUserID

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

Example:

Code Block
languagexml
<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)

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

Example:

Code Block
languagexml
<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)

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

MO

<Parameters>

XML Example for the following elements

Code Block
languagexml
<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

<Offer>

Offer

codecode<OfferItemID><PassengerRefs><SeatSelection>

SeatSelection

<Column>

Column

List of all passengers with Passenger type code (PTC)

<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
languagexml
<ns:Query>
    <ns:Offer ResponseID="ID-Fb--rdQS6HFd4AHC9" Owner="V1AIRLINE 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="V1AIRLINE 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"V1" 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:Offer> <ns:Offer OfferID = "OO-eJxlzEsKgzAURuEVKfeRm9wMg1go.ECbgo7.-e-C2EEp9AzP4ONIxuosSimgnPWxF3Akl5Aj3eHY2hCU51IxvneMw7qs8wmVZNnxqigwsFiv0vHXYw1oWCM-npvTj6eY-jxVy3J7ExTZ.5hAF7-dKXM_" Owner = "V1" ResponseID = "ID-Fb--rdQS6HFd4AHC9">
    <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

Code Block

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

Note

OfferItem returned from an AirShoppingRS always be in a single separate Offer.

Info

M

Ancillary and Seat Offer should be repeated based on the SeatAvailabilityRQ and ServiceListRQ trigger.

ie, OfferItem returned in a single SeatAvailabilityRS/ServiceListRS will be in a single Offer. If the SeatAvailabilityRQ/ServiceListRQ is again triggered for a same itinerary, then selected OfferItem should be placed in a separate Offer.

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

Code Block
<OfferItemType>

Offer item type

M

Code Block
ResponseID (Attribute)

This is the ResponseID returned in AirShoppingRS

M

Code Block
<OrderItem>

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

M

Code Block
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

Note

In case of a Multiple Segment Itinerary, if ServiceListRQ/SeatAvailabilityRQ is Triggered for each segment separately, OfferID and OfferItemID details for Ancillary/XBAG/Seat should be placed in separate Offers for each segments. More Info

Tip

Mapping Logic:

Flight Fare offer : Flight Fare Offer selected from AirShoppingRS Xpath:/AirShoppingRS/OffersGroup/AirlineOffers/Offer/OfferID (Attribute)

Seat Map Offer: Seat Offer selected from SeatAvailabilityRS Xpath:/SeatAvailabilityRS/ALaCarteOffer/OfferID (Attribute)

Ancillary Offer: Ancillary/ Extra Baggage Offer selected from ServiceListRS Xpath: /ServiceListRS/ALaCarteOffer/OfferID (Attribute)

M

ResponseID (Attribute)

ResponseID value

Info

This response ID will be available in AirShoppingRS in future release.

Now dummy response value can be set in this attribute field.

Example: "tx-08-201-f7e19798-c640-48e4"

M

OfferItem

OfferItem selected by the Passenger for inclusion in the requested Order.

M

OfferItemID (Attribute)

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

Info

OfferItemID (Attribute)

M

Code Block

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

Tip

Mapping Logic:

Flight Fare offer : Flight Fare Offer selected from AirShoppingRS Xpath:/AirShoppingRS/OffersGroup/AirlineOffers/Offer/OfferItem/OfferItenID (Attribute)

Seat Map Offer: Seat Offer selected from SeatAvailabilityRS Xpath:/SeatAvailabilityRS/ALaCarteOffer/ALaCarteOfferItem/OfferItemID (Attribute)

Ancillary Offer: Ancillary/ Extra Baggage Offer selected from ServiceListRS Xpath: /ServiceListRS/ALaCarteOffer/ALaCarteOfferItem/OfferItemID (Attribute)

M

PassengerRefs

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

M

Code Block

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

MO

code

Row

<Row>

Row Number of the Selected Seat

M

Code Block

Column Number of the selected Seat

M

<DataLists>

XML

Elements

Details

Mandatory/Optional

Code Block
languagexml
<PassengerList>

PassengerList

Passenger data list definition/details.

M

Code Block
languagexml
<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

<PassengerList>

languagexml
<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
languagexml
<ns:Passenger PassengerID = "V1_PAX.1">

PassengerID

Uniquely identifies a Passenger within the context of one message.

Example:

V1_PAX.1, V1_PAX.2 ,V1_PAX.3

M

Code Block
languagexml
<ns:PTC>INF</ns:PTC>

PTC

Type code applying to the Passenger which typically drives pricing.

Example: ADT, CHD, INF

M