Confirm Held Booking RS
OrderChange - Confirm Held Booking - OrderView RS
Data Model |
---|
Schemas |
---|
The service adheres to the IATA NDC OrderChange schema version 17.2, with some modifications. |
User Guidance - Response Definitions - Service Input Parameters | ||
Input Parameters | Type | Mandatory/Optional |
---|---|---|
Request object | OrderChangeRQ | M |
<Document> | ||
Elements | Details | Mandatory/Optional |
---|---|---|
<Document> | M | |
<Name> | Will be returned as “BA” | M |
<Success> | ||
Elements | Details | Mandatory/Optional |
---|---|---|
<Success/> | The presence of the empty Success element explicitly indicates that the message succeeded | M |
<Errors> | ||
Elements | Details | Mandatory/Optional |
---|---|---|
<Errors> | Error(s) that prevented message processing | M |
<Error> | BA Error message | M |
ShortText (Attribute) | PADIS Code - IATA definition from codeset 9845 | O |
Code (Attribute) | PADIS message - IATA definition from codeset 9845 | O |
<Response> | ||
Elements | Details | Mandatory/Optional |
---|---|---|
<Response> | Query Results. | M |
<Order> | ||
Elements | Details | Mandatory/Optional |
---|---|---|
<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 booking | M |
<ID> | PNR reference | M |
<AirlineID> | Airline Code Example: BA | M |
<TotalOrderPrice> | The total amount charged to the customer | M |
<SimpleCurrencyPrice> | Example: 8621.98 | M |
Code (Attribute) | Currency Code Example: GBP | M |
<Payments> |
| O |
<Payment> | Payment Processing detail. | M |
<Type> | The form of payment type. Examples: Credit Card, Cash. Miscellaneous – for e-vouchers. | M |
<Method> | Payment Method information. | M |
<CashMethod> | Cash payment | M |
<Amount> |
| M |
Code (Attribute) | Currency code. Example: USD | O |
<VoucherMethod> | When E-Voucher is used as form of payment | M |
Refs (Attribute) | Reference of all the passengers in booking as voucher payment is currently applicable for all the passengers present in the booking | M |
<Number> | E-Voucher number used for redemption | M |
<PaymentCardMethod> | Payment Card details. | M |
<CardCode> | Credit card issuer code. Example: VI | O |
<MaskedCardNumber> | Concealed credit card number, Example: xxxxxxxxxxxx9922 | O |
<CardHolderName> | Name of credit card holder. Example: JOHN SMITH | O |
<PaymentAddress> | PAYMENT ADDRESS. | M |
<Street> | Street. Examples: Main Street, 100 Main Street | O |
<City> | City name. Example: Tampa | O |
<PostalCode> | Postal code. Example: 11001 | O |
<Country> | Country name or code. Example: US | O |
<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 an SeatItem and another OrderItem is returned with a FlightItem | M |
OrderItem - Flight | ||
OrderItemID (Attribute) | A unique ID for the flight order item Example: PPWZDF-T2-S1S2 | 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 item | O |
<Total> | Tax amount for the order item Example:224.41 | M |
Code (Attribute) | Currency Code Example: GBP | M |
<Breakdown> | This section contains a breakdown of various tax elements | M |
<Tax> | This section contains information on individual tax element | M |
<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 |
<Description> | Description of the tax element Example: Carrier imposed charge | O |
<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: BA0007. | O |
<Penalty> | This section returns the rule references for fare rules for flight items | M |
refs (Attribute) | Reference for each fare rule which will be defined in PenaltyList. Example: Rule 1 Rule 2 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 item | M |
<TotalAmount> | M | |
<SimplecurrencyPrice> | Seat price | M |
Code (Attribute) | Currency Code Example: GBP | M |
<BaseAmount> | Seat price | M |
<Service> | This section contains the passenger reference, flight segment reference for seat items. | M |
ServiceID (Attribute) | A unique ID for the service Example:1 | M |
<PassengerRef> | Passenger tattoo reference associated with the seat order item Example: T2 | M |
<SelectedSeat> | O | |
<Seat> | Seat row and column details | M |
<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: BA035 | M |
<ServiceDefinitionRef> | Reference to the ServiceDefinition relating the Seat category assigned to the Passenger Example: SEAT-T2-BA0007 | M |
<TicketDocInfos> | ||||||||||||||||||||
Elements | Details | Mandatory/Optional | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
<TicketDocInfos> | M | |||||||||||||||||||
<TicketDocInfo> | Ticket document information. This is a list and will be repeated for each eTicket/EMD number | M | ||||||||||||||||||
<TicketDocument> | Ticket document details | M | ||||||||||||||||||
<TicketDocNbr> | Ticket/EMD number. Example: 125-8512563144 Where | M | ||||||||||||||||||
<Type> | Document type.
Possible values are T J Y Where T = Ticket J = EMD-A (Associated) Y = EMD-S (Standalone) | M | ||||||||||||||||||
<NumberofBooklets> | Will always be returned as “1” | M | ||||||||||||||||||
<DateOfIssue> | Example: 2015-09-21 | M | ||||||||||||||||||
<CouponInfo> |
| O | ||||||||||||||||||
<CouponNumber> | ETicket or EMD coupon number Example: 1 | M | ||||||||||||||||||
<FareBasisCode> | O | |||||||||||||||||||
<Code> | Example: MLXNCGB
| M | ||||||||||||||||||
<Status> | ETicket or EMD coupon status
| M | ||||||||||||||||||
<SoldAirlineInfo> | ![]() | O | ||||||||||||||||||
<DepartureDateTime> | O | |||||||||||||||||||
DateTime (Attribute) | Example: 2016-09-08T13:10:00.000Z | O | ||||||||||||||||||
<Departure> | Departure information | O | ||||||||||||||||||
<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 location | O | ||||||||||||||||||
<AirportName> | Example: Heathrow (London) | O | ||||||||||||||||||
<Arrival> | Arrival information | O | ||||||||||||||||||
<AirportCode> | Arrival airport IATA code Example: AMS | M | ||||||||||||||||||
<MarketingCarrier> | Marketing carrier information | O | ||||||||||||||||||
<AirlineID> | Marketing carrier code Example: BA | M | ||||||||||||||||||
<FlightNumber> | Marketing flight number Example: 1403 | M | ||||||||||||||||||
<AddlBaggageInfo> | O | |||||||||||||||||||
<AllowableBag> | O | |||||||||||||||||||
Number (Attribute) | O | |||||||||||||||||||
<InConnectionWithInfo> | ![]() | O | ||||||||||||||||||
<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 4183 | O | ||||||||||||||||||
<Code> | EMD code returned by BA Example: 0B5 for seats
| O | ||||||||||||||||||
<Description> | Free format text associated with the EMD Example: PREPAID SEAT CHARGE NON-INTERLINEABLE | O | ||||||||||||||||||
<ReportingType> | For billing and settlement purposes, each time a travel agent requests an airline to perform an action on a document (Issuance, Refund, Exchange), he needs to know how to reconcile this action: via BSP, via ARC, directly done by the ORA, etc. Example: Airline | M | ||||||||||||||||||
<PassengerReference> | Reference to a passenger for whom the ETicket/EMD is associated Example: T1 | M |
<DataLists> | ||
Elements | Details | Mandatory/Optional |
---|---|---|
<PassengerList> | List of all passengers to whom the orderview is returned | O |
<ContactList> | List of contacts for passengers | O |
<DisclosureList> | Seating policy link, Terms and conditions link and general seating rules are returned here | O |
<FlightSegmentList> | Flight segment details to whom the seat map is returned | O |
<FlightList> | List of flights in the Journey | O |
<OriginDestinationList> | List of O&D's in the journey | O |
<MediaList> | List of URLs to manage the booking online | O |
<PenaltyList> | Fare rules list | O |
<ServiceDefinitionList> | Service definition list which has been offered. | O |
<Metadata> | ||
Elements | Details | Mandatory/Optional |
---|---|---|
<CurrencyMetadatas> | Number of decimals applicable to the currency code used in the response | M |
<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 OrderChangeRQ If PaymentOptions 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> | This section returns all Required Billing address information. | M |