User Guidance

Input Parameters

Type

Mandatory/Optional

Request Object

OrderViewRS

M

< OrderViewRS >

XML Example for the following elements

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

Elements

Details

Mandatory/Optional

Document

NDC Message Document information

M

Name

Document name will be always NDC

O

ReferenceVersion

Will be NDC version

O

<Party>

Elements

Details

Mandatory/Optional

Party

Party & Sender Definition

M

XML Example for the following elements

For (B2B) Travel Agent Orders:

For (B2C) Normal Orders:

Sender

Message Sender information

M

AgentUserSender

This specific data field to be used for Agent user Sender information

M

OtherIDs

Additional Agency (Seller) identification.

O

OtherID

Other identifier.

M

Description (Attribute)

Other identification description.

O

AgentUserID

Agent User ID.

M

Owner (Attribute)

Agency Code Details.

O

Participants

Message Participant(s).

O

Recipient

Named Message Recipient

O

ORA_Recipient

ORA (Offer Originating Airline) Recipient.

M

AirlineID

Airline Code

M

<Success>

Success

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

M

<Response>

Response

Query Results

M

<OrderViewProcessing/>

OrderViewProcessing

Transaction Processing Results

M

<Order>

Order

Order information.

This section contains details on all the elements in the booking- payment details, flight and seat etc.

M

OrderID

The airline-assigned unique Order ID/PNR number

M

BookingReferences

Booking Reference information to include Record Locator, Assigning Airling Identifier, etc

M

BookingReference

Booking Reference detail.

M

Type

Booking Reference Type.

Example: 6 (Passenger confirmation number) Encoding Scheme: IATA Padis Codeset - List for data element [1153] Reference Qualifier

O

ID

Existing Booking Reference ID

(PNR Number or RLOC)

M

AirlineID

Ailine ID

Example : 1A

M

OtherID

Channel or Tour Operator Code

Example: CHANNEL1 , TCK01

M

Name (Attribute)

Entity Name.

Example: ORDER CREATED CHANNEL , TOUR OPERATOR ID etc.

M

XML Example for the following elements

Example for BookingReferences for a GDS PNR:

Example for BookingReferences for a Tour Operator PNR:

Example for BookingReferences for a Normal PNR:

TotalOrderPrice

Total Order Price.

Example: 340 EUR

M

DetailCurrencyPrice

A (detailed) CURRENCY-based Price

M

Total

Total price amount

M

Code

Currency code

O

<Status>

M

StatusCode

OK if order is success

M

<Payments>

Payment details

O

Example for Timelimit Applied over PayLater PNR:

Payment

Payment Processing detail.

M

Amount

Payment Amount.

M

SimpleCurrencyPrice

Amount paid

M

Code (Attribute)

Currency Code

M

Method

Payment Method information.

M

PaymentCardMethod

Payment Card payment.

M

CardCode

Card Code

Example: VI for VISA

M

MaskedCardNumber

Masked card number

M

CardHolderName

CardHolderName

M

TimeLimits

Order-Level Time Limits in GMT.

O

PaymentTimeLimit

PaymentTimeLimit in GMT

O

<OrderItems>

Order Item Detail.

M

XML Example for the following elements

OrderItem Sample for Order Fare Details:

OrderItem Sample for Order SSR Details:

OrderItem Sample for Order Seat Details:

OrderItem

Order Item details.

M

OrderItemID

The airline-assigned unique Order Item ID

Example: V1_ORITM_PAX.36646_SEG.501

M

Owner

Airline code

M

PriceDetail

Price details

M

BaseAmount

BaseAmount

Example: 1000

M

Code

Currency code

Example: GBP

M

Surcharges

Applicable Surcharge Details

M

Surcharge

Surcharge price details

M

Total

Total surcharge amount

M

Taxes

Total tax price details

M

Total

Total tax amount

M

Service

This section contains the passenger reference & segment reference.

Example:

M

PassengerRef

Passenger reference

M

SegmentRef

Segment reference

M

ServiceDefinitionRef

Service reference in case of SSR/Bag

M

FareDetail

Fare details

M

FareComponent

Fare Component information with Price Breakdown.

M

Price

Fare , tax details, Discounts

M

BaseAmount

BaseAmount

M

Taxes

Taxes

M

Total

Total tax amount

M

Breakdown

Gives tax breakdown with tax codes, country codes and tax amounts

M

FareBasis

Fare basis details

M

FareBasisCode

Fare Basis Code Information.

M

Code

Fare basis code

Example: YOW

M

RBD

Selling or booking class code

Example: O

M

TicketDesig

Order Created Fare Basis Code

M

FareRules

Fare rules if any

M

SegmentRefs

Segment reference for the fare component referring to the Flight Segment Details in DataLists

M

<TicketDocInfos>

XML Example for the following elements

TicketDocInfo for Passenger Ticket:

TicketDocInfo for Passenger EMD :

TicketDocInfo

E-Ticket/document information.

M

TicketDocNbr

E-ticket number

Example: 0048448343449

M

Type

Coupon Type.

Example: Y (EMD-S Standalone) Encoding Scheme: IATA Padis Codeset - List for data element 1001 (Document/ Message Name, coded)

M

NumberofBooklets

The number of booklets issued.

Example: 1

M

DateOfIssue

Date of Issue.

Example: 2019-02-18Z

M

TicketingLocation

Airport or City Code.

Example: ROM

M

CouponInfo

Coupon information

M

CouponNumber

Applicable coupon number.

M

Status

Current status of the coupon.

M

SoldAirlineInfo

Date and time, flight number.

M

Departure

Departure airport code , date and timeM

M

Arrival

Arrival airport code , date and time

M

MarketingCarrier

Carrier info with airline code and flight number

M

PassengerReference

Passenger reference

M

<Datalists>

<PassengerList>

PassengerList

Passenger details

M

XML Example for the following elements

<ContactList>

ContactList

Contact information

M

XML Example for the following elements

ContactID (Attribute)

Uniquely Identifies a set of Contact Information, within the context of one message.

O

<BaggageAllowanceList>

BaggageAllowanceList

Baggage allowance details

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

O

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

<FlightSegmentList>

FlightSegmentList

Flight Segment details

M

XML Example for the following elements

FlightSegment

Flight Segment

M

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

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

FareBasisCode

Fare basis code.

Example: Y26CH

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 information

O

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)

O

SegmentReferences

Association to multiple Flight Segment instance(s).

Example: V1_SEG.501 V1_SEG.502

M

<OriginDestinationList>

OriginDestinationList

OriginDestinationList

O

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: V1_FL.503

O

<ServiceDefinitionList>

ServiceDefinitionList

Service definition list

M

XML Example for the following elements

ServiceDefinition

ServiceDefinition details

O

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

Name

Service name.

Example: Lounge Pass

M

Encoding

Service Codes and Reason for Issuance.

O

RFIC

Reason For Issuance Code

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

O

Code

Service code.

Examples: 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.

Examples: SEAT 3B, Discount 15P

O

<PriceClassList>

PriceClassList

Itinerary Fare Class details

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

Example: SUNECO

M

FareBasisCode

FareBasisCode Details

M

Code

FareBasis Code

M

ClassOfService

Class of Service Details

M

refs (Attribute)

Unique ID referring to the Segment ID in FlightSegmentList

M

Code

Class of Service Code

Example: A

M

MarketingName

Cabin Class Marketing Name.

M

CabinDesignator (Attribute)

Designator Code of the Cabin

O

<SeatDefinitionList>

SeatDefinitionList

Seat Definition List

O

XML Example for the following elements

SeatDefinition

Seat Information Details

O

SeatDefinitionID (Attribute)

Seat Information by Aircraft section

O

<InstructionsList>

InstructionsList

PNR Comments List

O

Instruction

Offer/ Order Instruction(s)

M

ListKey (Attribute)

Globally unique id for this Data List instance.

M

FreeFormTextInstruction

Free-text Instruction Remark(s).

M

Remark

Remark Text

Example for Remark Text

1) COMMENT_TYPE - Specify the Comment Type.

Example : MANIFEST_COMMENT

2) COMMENT_VALUE - Specify the Comment Value

Example : The PNR is manually repriced

3) COMMENT_ADDED_USER - Specify the Comment Added User name, Duty Code and Office Code

Example : USER1 ADMIN FRAAPT

M

Timestamp (Attribute)

Remark creation timestamp.

Example : 2020-11-30T08:57:43Z

M

XML Example for the following elements

<Metadata>

PassengerMetadata

Contain the ItineraryAmountDetailAugPoint

M

CurrencyMetadatas

Currency details

M

PriceMetadatas

Contain FareComponentAugPoint , TaxDetailAugPoint , FareDetailAugPoint

M