OrderView RS


Data Model

Schemas

The service adheres to the IATA NDC OrderView schema version 17.2, with some modifications.

User Guidance - Response Definitions - Service Input Parameters

Input ParametersType

Optional/Mandatory

Request object

OrderViewRSM

<Document>

ElementsDetails

Optional/Mandatory

<Document>

NDC Message Document information

M

<Name>
Will be returned as  "BA"O

<Success>

ElementsDetails

Optional/Mandatory

<Success/>
The presence of the empty Success element explicitly indicates that the message succeededM

<Errors>

ElementsDetails

Optional/Mandatory

<Errors>
M
<Error>

BA error code and message

 Example: Card is not applicable for the customer's billing country and agent's location - please choose from the options provided in this response.

M
ShortText (Attribute)

PADIS Code - IATA definition from codeset 9845

Example: Form of payment missing or invalid for ticket/document

O
Code (Attribute)

PADIS message - IATA definition from codeset 9845

Example:466

O

<Warnings>

ElementsDetails

Optional/Mandatory

<Warnings>

A warning will be returned only when the flight purchase is successful but the seat purchase is failed.

O

<Warning>

BA warning message

Example: Unable to book seat

M
Type (Attribute)

PADIS Code - IATA definition from codeset 9845

Example: 309

O
ShortText (Attribute)

PADIS message - IATA definition from codeset 9845

Example:

Unfulfilled Paid Service
O

<Response>

ElementsDetails

Optional/Mandatory

<Response>
Query Results.M

<Order>

ElementsDetails

Optional/Mandatory

<Order>
This section contains details on all the elements in the booking- payment details, flight and seat etc.M
OrderID (Attribute)

Booking reference or PNR reference

Example: PPWZDF
M
Owner (Attribute)

BA

M
<BookingReferences>
This section contains the PNR reference for the bookingM
<ID>

PNR reference

Example: PPWZDF

M
<AirlineID>

Airline Code

Example: BA

M
<TotalOrderPrice>
Total price charged to the customerM
<SimpleCurrencyPrice>
Example: 8621.98M
Code (Attribute)

Currency Code

Example: GBP

M
<Payments>

(info)Note: This payment information applies to the entire Order.

O
<Payment>
Payment Processing detail.M
<Type>

The form of payment type.

Examples: Credit card, cash and e-voucher.

M
<Method>

Payment Method information.

M
<CashMethod>

Cash payment

M
<Amount>
Amount paid in Cash . Example: 567.95O
<Code=
Currency code. Example: USDO
<PaymentCardMethod>

Payment Card details.

M
<CardCode>

Credit card issuer code.

Example: VI

O
<TokenizedCardNumber>
Tokenized card numberO
<CardHolderName>
Name of credit cardholder. Example: JOHN SMITHO
<PaymentAddress>
PAYMENT ADDRESS.M
<Street>
Street. Examples: Main Street, 100 Main StreetO
<City>
City name. Example: TampaO
<PostalCode>
Postal code. Example: 11001O
<Country>
Country name or code. Example: USO
<Payer>
The person who has paid for the OrderO
<ContactInfoRefs>
Ref to Contact Information of the Order's Payer.O
<VoucherMethod>

Voucher payment details. This section is populated if the form of payment is e-voucher.

O

Refs (attribute)

All the passenger references within the OrderCreate request. Example: SH1, SH2

O

Number

A 13-digit e-voucher number E.g. 125-1234567890


<OrderItems>

M
<OrderItem>

This will be returned once for FlightItem and will be repeated to return each SeatItem

Example: If the request is for 2 ADT and 2 flights (LHRAMS and AMSLHR) and both passengers have bought seats on both flights then OrderItem will be repeated 4 times each containing a SeatItem and another OrderItem is returned with a FlightItem

M
OrderItem - Flight
OrderItemID (Attribute)

A unique ID for the flight order item

Example: KIS6N6-T2-BA035

M
<PriceDetail>

This section returns total, fare, and tax information along with the break down for the order item.

M
<TotalAmount>

M
<SimpleCurrencyPrice>

Total flight amount (fare and tax). 

Example:420.41

M
Code (Attribute)

Currency Code

Example:GBP

M
<BaseAmount>

 Fare amount. 

Example:196

M
Code (Attribute)

Currency Code

Example: GBP

M
<Taxes>
This section contains total and breakdown of tax for the order itemO
<Total>

Tax amount for the flight order item

Example:224.41

M
Code (Attribute)

Currency Code

Example: GBP

M
<Breakdown>
This section contains a breakdown of various tax elementsM
<Tax>
This section contains information on individual tax elementM
<Amount>

Value of this particular tax element

Example:104.5

M
Code (Attribute)

Currency Code

Example: GBP

M
<TaxCode>

Code for the tax element

Example: YQ

M
<Service>

This section contains the passenger reference, flight segment reference for flight items.

M
ServiceID (Attribute)

A unique ID for the service

Example:1

M
<PassengerRef>

Passenger tattoo reference associated with the flight order item

Example: T2

M
<SegmentRef>

Flight segment reference associated with the flight order item

Example: FS1

O
<TimeLimits>
O
<PaymentTimeLimit>

(info)This is the deadline by which a commitment to pay must be made for the confirmed items in an order as agreed with the airline.

This is also called as Ticket Time Limit, as tickets will only be issued once payment is made

O
<Timestamp=

Payment Time Limit or Ticket Time Limit

Example:

2016-09-05T22:59:00.000Z
O
<Penalty>
This section returns the rule references for fare rules for flight itemsM
refs (Attribute)

Reference for each fare rule which will be defined in the Penalty list.

Example: Rule1 Rule2 Rule3

M
OrderItem - Seat
OrderItemID (Attribute)

A unique ID for the seat order item

Example: KIS6N6-26D-T2-BA0035

M
<PriceDetail>
This section returns total seat price for the seat itemM
<TotalAmount>

M
<SimplecurrencyPrice>
Seat priceM
Code (Attribute)

Currency Code

Example: GBP

M
<BaseAmount>
Seat priceM
<Service>
This section contains the passenger reference, flight segment reference for seat items.M
ServiceID (Attribute)

A unique ID for the service

Example: Svc001

M
<PassengerRef>

Passenger tattoo reference associated with the seat order item
Example: T2

M
<SelectedSeat>
O
<Seat>
Seat row and column detailsM
<Row>

Seat row number
Example:31

M
<Column>

Seat column number
Example: B

M
<SegmentRef>

Reference to a flight on which the seat is booked

Example: FS1
M
<ServiceDefinitionRef>

Reference to the ServiceDefinition relating the Seat category assigned to the Passenger
Example: SEAT-T2-FS1

M
<TimeLimits>
O
<PaymentTimeLimit>

This is the deadline by which a commitment to pay must be made for the confirmed (held) seats in an order as agreed with the airline

O
Timestamp (Attribute)

Payment Time Limit
Example:

2016-09-05T22:59:00.000Z
O
OrderItem - Bag
OrderItemID (Attribute)

A unique ID for the seat order item

Example: KIS6N6-T2-FS1-213

M

<PriceDetail>

This section returns total price for the bag(s) item per passenger per Origin Destination

M

<TotalAmount>

 

M

<SimplecurrencyPrice>

Bag(s) price

M

Code (Attribute)

Currency Code

Example: GBP

M

<BaseAmount>

Bag(s) price

M

<Service>

This section contains the passenger reference & service definition reference for bag items.

M

ServiceID (Attribute)

A unique ID for the service

Example: Svc001

M

<PassengerRef>

Passenger reference associated with the bag order item
Example: T2

M

<ServiceDefinitionRef>

Reference to the ServiceDefinition relating the excess bag allowance added to the Passenger
Example: BAG-T2-FS1

M

<TicketDocInfos>

ElementsDetails

Optional/Mandatory

<TicketDocInfos>

M
<TicketDocInfo>
Ticket document information. This is a list and will be repeated for each eTicket/EMD number

Residual e-voucher EMDs will be displayed in this section as part of 
M
<TicketDocument>
Ticket document detailsM
<TicketDocNbr>

Ticket/EMD number. 
This number is comprised of airline code and serial number

Example: 125-8512563144

Where
125 = Airline code
8512563144 = Serial number

M
<Type>

Document type.

(info)IATA PADIS Code from codeset 1001

Possible values are T, J or Y

Where T = Ticket, J =  EMD-A (Associated) and Y = EMD-S (Standalone)

M
<NumberofBooklets>
Will always be returned as “1”M
<DateOfIssue>
Example: 2015-09-21M
<Remark>

This element returns the remarks for E-Voucher and residual E-Voucher.

E.g. BWC COVID19/NON-REF/TRAVEL MUST BE COMPLETED BY 30APR2022


<CouponInfo>

(info)For ETickets, for each flight segment CouponInfo will be returned.

(info)For EMDs, CouponInfo will be returned per ancillary per passenger

O
<CouponNumber>

ETicket or EMD coupon number

Example: 1
M
<FareBasisCode>

O
<Code>

Example: MLXNCGB

(info)FareBasisCode will be returned only for ETickets

M
<CouponValid>

This section will populate only for the bookings with residual E-Vouchers

This will return the expiry date by which customer has to consume the E-Voucher for future travel.

<EffectiveDatePeriod>
<Expiration>

The expiry date (YYYY-MM-DD) by which customer has to consume the E-Voucher for future travel.

Example: - 2022-04-30

<Status>

ETicket or EMD coupon status

(info)The status will be returned as defined in IATA Codeset 4405

Code       

Description

AL          

Airport control

B            

Flown/used

BD          

Boarded

CK          

Checked in

E

Exchanged/reissued

OPE       

Open

RF          

Refunded

V

Void

M
<SoldAirlineInfo>
(info)This section will be returned only for eticketsO
<DepartureDateTime>

O
DateTime (Attribute)

Example:

2016-09-08T13:10:00.000Z
O
<Departure>
Departure informationO
<AirportCode>

Departure airport IATA code

Example: LHR
M
<Date>

Local Departure date i.e. local to the departure location

Example: 2015-08-13
M
<Time>
Local Departure time i.e. local to the departure locationO
<AirportName>
Example: Heathrow (London)O
<Arrival>
Arrival informationO
<AirportCode>

Arrival airport IATA code

Example: AMS
M
<MarketingCarrier>
Marketing carrier informationO
<AirlineID>

Marketing carrier code

Example: BA
M
<FlightNumber>

Marketing flight number

Example: 1403
M
<InConnectionWithInfo>
(info)This section will be returned only for EMDsO
<InConnectionDocNbr>

The ETicket number to which this EMD is associated

Example: 1258540669475
O
<InConnectonCpnNbr>

The ETicket coupon number to which this EMD is associated

Example: 1
O
<ReasonForIssuance>

Reason for Issuance Information

This section will be returned only for EMDs

O
<RFIC>
The RFIC will be returned as defined in IATA Codeset 4183O
<Code>

EMD code returned by BA
Example: 0B5 for seats, 98B for e-voucher, 99I for residual voucher 

O
<Description>

The free-format text associated with the EMD
Example:

PREPAID SEAT CHARGE NON-INTERLINEABLE

O
<ReportingType>

Example: Airline

M
<Price>

This section displays the currency, total price, and email address reference of the document 

O

Refs (Attribute)

This element displays document email address reference 

O

<Total>

This element displays the price of the document 

M

<PassengerReference>

Reference to a passenger for whom the ETicket/EMD is associated

Example: T1
M

<DataLists>

XMLElementsDetails

Optional/Mandatory

<PassengerList>
<PassengerList>
List of all passengers to whom the OrderView is returnedO
<ContactList>
<ContactList>
List of contacts for passengersO
<BaggageAllowanceList>
<BaggageAllowanceList>

Baggage Allowance List 
O
<DisclosureList>
<DisclosureList>

Seating policy link, Terms and conditions link and general seating rules are returned here
O
<FlightSegmentList>
<FlightSegmentList>

Flight segment details to whom the seat map is returned
O
<FlightList>
<FlightList>
List of flights in the JourneyO
<OriginDestinationList>
<OriginDestinationList>
List of O&D's in the journeyO
<MediaList>
<MediaList>
List of URLs to manage the booking onlineO
<PenaltyList>
<PenaltyList>
Fare rules listO
<ServiceDefinitionList>
<ServiceDefinitionList>
Service definition list which has been offered.O

<Metadata>

XML

Elements

Details

Optional/Mandatory

<CurrencyMetadatas>
<CurrencyMetadatas>
Number of decimals applicable to the currency code used in the responseM
<AugmentationPoint>
<PaymentCardMetadatas>
<PaymentCardMetadatas>

Returns a list of applicable payment cards  along with the mandatory card information that should be provided when the payment card is used as a form of payment in OrderCreateRQ

If PaymentOptions is not returned, it means card payment is not applicable to the agent’s location (point of sale) and the customer’s billing country.

M
<AddressMetadatas>
<AddressMetadatas>

This section returns all Required Billing address information. 

M