AirShoppingRS

User Guidance - Service Response Parameters

Input Parameter

Type

Optional/Mandatory

Response Object

AirShoppingRS

M

<Document>

XML Example for the following elements

Elements

Details

Optional/Mandatory

<Document>

NDC Message Document information

M

<Name>

Should always be NDC

O

<ReferenceVersion>

Should be NDC version

O

<Success>

XML

Elements

Details

Optional/Mandatory

Success

The presence of the empty Success element explicitly indicates that the message succeeded

M

<OffersGroup>

XML Example for the following elements

Elements

Details

Optional/Mandatory

OffersGroup

Offers Grouped by Airline Supplier.

M

AirlineOffers

This returns each offer with the total offer price, total price per passenger type, base fare and tax per passenger type along with the price class and flights applicable to the offer. This also returns the calendar offers if specified in the request.

M

<Offer>

Offer

List of offers for the requested date. Each offer will be ordered by the lowest price first

M

OfferID (Attribute)

A unique offer id

M

Owner (Attribute)

will be always set to "AIRLINECODE"

M

OfferItem

This will be repeated to return the price per passenger type.

Example: If you have 2 x ADT, 2 x CHD and 2 x INF then this should be repeated three times. One for ADT, one for CHD and one for INF

M

OfferItemID (Attribute)

A unique offer item id

M

TotalPriceDetail

Total price for all the passengers of this passenger type

Example: If you have 2 x ADT, then the TotalPrice would be equal to 2 x (Price per ADT)

M

TotalAmount

Total price amount.

M

DetailCurrencyPrice

Give total and breakdown details

M

Service

This returns the service this OfferItem is entitled to. It will repeat per Origin Destination.

M

ServiceID (Attribute)

A unique service id

Example: V1_SRVC.1560995803074

M

PassengerRefs

This returns the passenger references for all the passengers for who the service applies to.

Each reference is separated by a space.

Example: V1_PAX.1 V1_PAX.2

Each passenger reference should be detailed in PassengerList under DataLists

M

FlightRefs

This returns all the flight references which are part of this service.

Each reference is separated by a space.

Example: V1_FL.1560995803082

Each Flight reference should be detailed in FlightList under DataLists

M

FareDetail

This returns the price detail applicable to flights & passenger type respectively applicable to this OfferItem along with the fare component.

M

PassengerRefs

Applicable passenger references.

Each reference is separated by a space.

Example: V1_PAX.1 V1_PAX.2

M

Price

Price returned per passenger type with the total price, fare and total tax

M

TotalAmount

Total amount (Base fare plus Tax) per passenger type for the offer

M

DetailCurrencyPrice

Give total and breakdown details

M

BaseAmount

Base fare per passenger type for the itinerary

M

Code (Attribute)

Currency Code

Example: GBP

M

Surcharges

Total surcharge per passenger type

O

Total

Sub-total of all Surcharges.

Example: 523.12

O

Code (Attribute)

Currency Code

Example: GBP

M

Taxes

Total tax per passenger type

O

Total

Sub-total of all taxes.

Example: 523.12

O

Code (Attribute)

Currency Code

Example: GBP

M

Breakdown

A collection of detailed taxes.

O

Tax

Example: V1_TAXREFS.1549609206465

M

Amount

Represents the Specific tax amount.

Example: 30

M

TaxCode

Represents the Specific tax code.

Example: BP

O

Description

Represents the Specific tax description.

Example: International Passenger Service Charge

O

FareComponent

This will repeat for each Origin and Destination . This will have TotalAmount, Baseamount,surhcarges,taxes

M

FareBasis

This will have fare basis code . This will have refernces to the FareDetailAugPoint and FareComponentAugPoint in the Metadata

M

SegmentRefs

This returns references to all the segments applicable per PriceClassRef

M

PriceClassRef

This returns PriceClass reference for the flights applicable to the OfferItem

Each PriceClass reference is detailed in PriceClassList under DataLists

M

PricedCalendar

Calendar based Offer Price

O

PriceCalendarDate

Price calendar date

M

TotalPrice

The total price for all Travelers associated

with this offer.

M

PTC

Passenger Type Code

M

<BaggageAllowance>

BaggageAllowance

This block contains references to the Baggage Allowance characteristics (no. of pieces / weight / dimensions, etc) included in the Flight services for one or more Passengers.

O

XML Example for the following elements

FlightRefs

Reference to FlightIDs in DataLists

M

PassengerRefs

Reference to PassengerIDs in DataLists

M

BaggageAllowanceRef

Reference to BaggageAllowanceIDs in DataLists

M

<DataLists>

XML

Elements

Details

Optional/Mandatory

<PassengerList>

PassengerList

List all the passengers with details as received in AirShoppingRQ

M

XML Example for the following elements

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

PassengerID (Attribute)

Uniquely identifies a Passenger within the context of one message.

M

PTC

Type code applying to the Passenger which typically drives pricing

Example:. ADT, CHD, etc

M

<DisclosureList>

DisclosureList

Airline and Offer Disclosures. (Marketing information)

M

XML Example for the following elements

Disclosures

Disclosure Description or Link.

M

ListKey (Attribute)

Globally unique id for this Data List instance.

M

Description

Plain Text or Rich Media Disclosure Description(s)

M

ObjectKey (Attribute)

Object globally unique Instance ID.

O

<FlightSegmentList>

FlightSegmentList

Flight segment List details for the requested itinerary

M

FlightSegment

Flight segment Details

M

XML Example for the following elements

SegmentKey (Attribute)

A globally unique identifier for this Flight Segment instance.

M

ElectronicTicketInd (Attribute)

When true, an electronic ticket may be issued.

O

Departure

Departure (origin) Airport, Date and Time information. (en, description)

M

AirportCode

Airport or a city code. Use a three letter location identifier assigned according to the IATA Resolution 763. Refer to IATA Airline Coding Directory . Example: TPA

M

Date

Departure date. Example: 2017-01-13 Encoding Scheme: ISO 8601 Date Format (YYYY-MM-DD)

M

Time

Departure time. Example: 09:15 Encoding Scheme: ISO 8601 Military/ 24 Hour Format (HH:MM)

O

Terminal Information

Terminal information will be present under the Departure and Arrival tags only if the terminal information is available in the flight

O

Arrival

Arrival (destination) Airport, Date and Time information.

M

AirportCode

Airport or a city code. Use a three letter location identifier assigned according to the IATA Resolution 763. Refer to IATA Airline Coding Directory . Example: TPA

M

Date

Arrival date. Example: 2017-01-13 Encoding Scheme: ISO 8601 Date Format (YYYY-MM-DD)

O

Time

Arrival time. Example: 09:15 Encoding Scheme: ISO 8601 Military/ 24 Hour Format (HH:MM)

O

MarketingCarrier

Marketing Carrier information

M

AirlineID

A two-character alpha-numeric code assigned according to the IATA Resolution 762 or a three-letter airline designator assigned by ICAO. Refer to IATA Airline Coding Directory .

M

FlightNumber

Flight Number. Example: 1234, or OPEN, or ARNK

M

Equipment

Aircraft Equipment.

M

AircraftCode

The IATA aircraft type 3 character code; use SSIM Appendix A. Example:318.

M

AirlineEquipCode

Airline-specific aircraft equipment code. Example: 737-800

O

ClassOfService

Class of Service. Example: T

M

Code

Class of Service Code

M

SeatsLeft (Attribute)

Inidcates how many seats are still available in this class of service.

O

MarketingName

Cabin Class Marketing Name

O

CabinDesignator (Attribute)

Designator code for the cabin

O

FlightDetail

Flight Details.

O

FlightDuration

Flight Duration with application.

M

Stops

Flight Stop Quantity and Location(s).

O

StopQuantity

Stop Quantity. Example: 1

O

<FlightList>

FlightList

Flight List for the requested itinerary

M

XML Example for the following elements

Flight

Journey information describing the travel between an airport/city where travel commences and an airport/city where travel ultimately terminates. A journey may be comprised of one or more segments. Note: This node will be renamed to journey in future releases.

M

FlightKey (Attribute)

A globally unique identifier for this Flight instance.

O

Journey

Flight journey information.

O

Time

Total Journey Time. Example: PT7H45M (7 hours and 45 minutes) Note: Total journey time includes the combined air time, connection time and/ or stop information for all specified flight segments

O

SegmentReferences

Association to multiple Flight Segment instance(s). Example: segment1 segment2 Note: Flight Slice On and Off Board Points may also be specified.

M

<PriceClassList>

PriceClassList

List of Price class for the requested itinerary

M

XML Example for the following elements

PriceClass

Price/Fare Class details

M

PriceClassID (Attribute)

Unique ID referring to the PriceClassRef in Fare Details

O

Name

Price Class Name

Eg: SUNECO

M

FareBasisCode

FareBasisCode Details

M

Code

FareBasis Code

M

ClassOfService

Class of Service Details

M

refs (Attribute)

Object association(s) between this object and any other object or metadata instance(s)

O

Code

Class of Service Code

Example: A

M

SeatsLeft (Attribute)

Inidcates how many seats are still available in this class of service.

O

MarketingName

Cabin Class Marketing Name.

M

CabinDesignator (Attribute)

Designator Code of the Cabin

O

<OriginDestinationList>

OriginDestinationList

List of Origin and Destination for the requested itinerary

M

XML Example for the following elements

OriginDestination

Origin/ Destination information. Contains a list of all Flight element that are part of that OD.

M

OriginDestinationKey

A globally unique identifier for this OriginDestination instance.

O

DepartureCode

Departure (origin) Airport Code.

M

ArrivalCode

Airport or a city code. Use a three letter location identifier assigned according to the IATA Resolution 763. Refer to IATA Airline Coding Directory .

Example: TPA

M

FlightReferences

Association to multiple Flight instance(s). Example: flight1 flight2 Note: Flight Slice On and Off Board Points may also be specified.

M

OnPoint (Attribute)

Flight slice on point.

O

OffPoint (Attribute)

Flight slice off point.

O

<BaggageAllowanceList>

BaggageAllowanceList

Baggage Allowance detail. Use BaggageCategory to specify which of the two.

M

XML Example for the following elements

BaggageAllowance

Checked or Carry-On Baggage Allowance detail. Use BaggageCategory to specify which of the two.

M

BaggageAllowanceID (Attribute)

Unique ID for Baggage Reference

M

BaggageCategory

Baggage Category.

Example: Checked

M

WeightAllowance

Baggage Weight Allowance with application information

M

ApplicableParty

Baggage weight restriction application. Examples: Party, Traveler Note: Party applies to all Travelers.

O

MaximumWeight

Maximum Weight and Unit Details

M

Value

Maximum Weight Value

M

UOM

Unit Of Measure

M

<ServiceDefinitionList>

ServiceDefinitionList

Description and characteristics of a Service

O

ServiceDefinition

Service Definition

M

ServiceDefinitionID

(Attribute)

A unique Service ID that has been returned in the Shopping results, and identifies an airline service item (ie a product or a service) that can be separately delivered and uniquely described by an airline.

M

Owner

(Attribute)

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

O

Name

Service name.

Example: Classic Bundle

M

ServiceBundle

Included Child ancillaries of the Bundled Ancillary

O

ServiceDefinitionRef

Reference to further Service Definitions which form part of this Service Bundle

M

Encoding

Service Codes and Reason for Issuance.

O

RFIC

Reason For Issuance Code

Example: A (Air Transportation) C (Baggage) E (Airport Services) F (Merchandise) G (In-flight Services) Refer to PADIS Codeset for data element 4183

M

Code

Service code.

Example: XLEG (Extra Leg Room Seat, implementer encoding) XBAG (Extra Bag, implementer encoding). Used in conjunction with SubCode (Associated Reason For Issuance SubCode)

O

SubCode

Associated Reason For Issuance Sub Code. Examples: 0CC (First Checked Bag) 0B1 (In-flight Entertainment) 0BX (Lounge) 0B3 (Meal/ Beverage) 0B5 (Pre-reserved Seat Assignment) 0G6 (Priority Boarding)

O

Descriptions

SERVICE Description. Note: Supports plain text, multimedia and code and link references

M

Description

Service Description detail.

M

Text

Description value

O

Application

Description Application.

Example: SEAT 3B, Discount 15P

O

<MetaData>

XML

Elements

Details

Optional/Mandatory

CurrencyMetadatas

This returns the number of decimals applicable for the currency code returned in the response

M

OfferMetadatas

This will contain fare type and fare details under FareDetailAugPoint and FareComponentAugPoint.

This also includes OfferMetadataAugPoint which is used during Dynamic Pricing

M

FareDetailAugPoint

Which gives the details about Fare ID, Fare Level and Fare Type of the fare available for the each fare components in AirShoppingRS/AirlineOffers/Offer/OfferItem/FareDetail.

M

FareComponentAugPoint

Which gives the Fare amount details such as Base Fare, Display fare and Discount of  each fare components in AirShoppingRS/AirlineOffers/Offer/OfferItem/FareDetail.

M

PriceMetadatas

This will have tax codes under TaxDetailAugPoint

M