Ancillary Servicing - Seats - RQ





 OrderChange - Ancillary Servicing - Seats - RQ

Data Model

Data model to follow

Data Model - OrderItems

Data model to follow

Schemas

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

User Guidance - Request Definitions - Service Input Parameters

Input ParametersType

Mandatory/
Optional

Request objectOrderChangeRQM


<OrderChangeRQ>

ElementsDetails

Mandatory/
Optional

Version (Attribute)

Specify NDC schema message version. Always pass 17.2

M
PrimaryLangID (Attribute)

Specifies the agent’s preferred language. Service response will be returned in this language
Example: EN

O
AltLangID (Attribute)

Specifies the preferred language in which the mail to be sent. eTicket receipt email and any other communication emails from BA will be sent in this language

O

<Document>

ElementsDetails

Mandatory/
Optional

<Document>
NDC Message Document informationM
<Name>
Document name will be always "BA"O

<Party>

ElementsDetails

Mandatory/
Optional

<Party>
»Party & Sender DefinitionM

<Query>

ElementsDetails

Mandatory/
Optional

<Query>
Core Service Price query parameters.M
<OrderID>

Booking reference or PNR reference
Example: YOMH3W

M
Owner (Attribute)

Specifies the owner of the booking

Example: BA

M

<OrderServicing>

Function to add or update or delete the ancillary details.

M

<AcceptOffer>

Function to accept a new OfferItem and adding it to the existing order.

Note: If the seat does not exist then service attempt to add the seat in the booking. If seat exists, then the service attempts to update the existing seat in the booking.

M

<Offer>

Offer selected by the Passenger for requesting an Order to be created. Multiple Offers can be requested at the same time, each of which could originate from different shopping responses (each with their own responseIDs).

M

OfferID (attribute)

Reference to the OfferID of the selected Offer (either a standard Offer or an a-la-carte Offer) returned in a previous shopping response.

M

Owner

Designator of Airline that owns/ assigned these IDs. Examples: BA

M

ResponseID

Reference to unique shopping session response ID, as provided in the airline's previous shopping response.

M

<OfferItem>

Reference to unique shopping session response ID, as provided in the airline's previous shopping response.

M

OfferItemID

Any document which may be used to identify a person or verify aspects of a person's personal identity.

M

<PassengerRefs>

Reference to passenger(s) for which this OfferItem and selected Services (in case of Service Bundles) applies.

M

<SeatSelection>

Selection of specific seat location, as provided in seat availability response.

M

<Row>

Seat row number. Example: 2

M

<Column>

Seat column to identify a particular seat position on an aircraft

M

ElementsDetails

Mandatory/
Optional

<Query>

Core Service Price query parameters.

M

<OrderID>

Booking reference or PNR reference
Example: YOMH3W

M

Owner (Attribute)

Specifies the owner of the booking

Example: BA

M

<Payments>

Payment information

M

<Payment>

Payment detail, including association(s).

M

<Type>

The form of payment type. Examples: Credit Card, Cash.

M

<Method>

Payment Form Details.

M

<Payments>

Specify payment information

Note: Though this is optional element in NDC schema, it must be passed in the request to confirm the booking.

O

<Payment>

BA accepts one card form of payment per booking

M

<Type>

The form of payment type. Examples: Credit Card, Cash.

IATA definition from codeset 9888

The code can be one of the following from the table depends on the form of payment being used

Code       

Description

CC          

Card

CA            

Cash

M

<CardNumber>

Example: 41111111111111111

Note: Though this is optional in NDC schema, it must be specified if it was returned as a mandatory in OrderViewRS (returned as part of error when payment card passed in OrderChangeRQ is not applicable)

O

<SeriesCode>

This is the verification digits printed on the card following the embossed number. This may also accommodate the customer identification/batch number (CID), card verification value (CVV2), card validation code number (CVC2) on credit card.

Example: 123

Note: Though this is optional in NDC schema, it must be specified if it was returned as a mandatory in OrderViewRS (returned as part of error when payment card passed in OrderChangeRQ is not applicable)

O

<CardHolderName>

The Card holder's name

Example: Mr Test Smith

If the payer is one of the passengers then the passenger name passed here must be the same as what was defined in <PassengerList>. 

Note: Though this is optional in NDC schema, it must be specified if it was returned as a mandatory in OrderViewRS (returned as part of error when payment card passed in OrderChangeRQ is not applicable)

O

<CardHolderBillingAddress>

Specifies the payment card address or Billing address

Note: This must be specified if it was returned as a mandatory in OrderViewRS (returned as part of error when payment card passed in OrderChangeRQ is not applicable)

M

<Street>

This is a list and can be repeated twice to specify 2 Streets

Example:

< Street1>1234 Main Street</Address>

<Street2>Pontes Avenue</Address>

Note: Specify only Street 1 if Street 1 was mandatory and specify  both Street 1 and 2 if both Street 1 and Street 2 were returned as mandatory in OrderViewRS (returned as part of error when payment card passed in OrderChangeRQ is not applicable)

O

<CityName>

3 letter City Code

Example: NYC or LON

Note: This must be specified if it was returned as a mandatory in OrderViewRS (returned as part of error when payment card passed in OrderChangeRQ is not applicable)

M

<StateProv>

State or province code

Examples: NY

Note: This must be specified if it was returned as a mandatory in OrderViewRS (returned as part of error when payment card passed in OrderChangeRQ is not applicable)

M

<PostalCode>

Postal Code

Example: SW3 1XH

Note: This must be specified if it was returned as a mandatory in OrderViewRS (returned as part of error when payment card passed in OrderChangeRQ is not applicable)

M

<CountryCode>

Billing country code (2 letter code)

Example: GB

Note: This must be specified if it was returned as a mandatory in OrderViewRS (returned as part of error when payment card passed in OrderChangeRQ is not applicable)

M

<Surcharge>

Surcharge fee applicable for the payment card.

Note: This must be specified if it was returned as a mandatory in OrderViewRS (returned as part of error when payment card passed in OrderChangeRQ is not applicable)

M

<Amount>

Provide total surcharge amount for all passengers that were returned in the SeatAvailability response.

Example: 5

M

Code (Attribute)

Currency code

 Example: GBP

This should be the same as what was returned in the OrderViewRS

Note: This is an optional attribute in NDC schema but for calling BA services this must be passed

M

<EffectiveExpireDate>

Payment Card Effective and/ or Expiration date(s).

O

<Effective>

Specifies payment card start date

Example: 0812

Where 08 = Month

12 = Year

Note: This must be specified if it was returned as a mandatory in OrderViewRS (returned as part of error when payment card passed in OrderChangeRQ is not applicable)

O

<Expiration>

Specifies payment card expiry date

Example: 0815

Where 08 = Month

15 = Year

Note: This must be specified if it was returned as a mandatory in OrderViewRS (returned as part of error when payment card passed in OrderChangeRQ is not applicable)

O

<Amount>

Total amount payable by Card. This should include a card surcharge as well for card payment

Example: 500.55

Note: This is an optional attribute in NDC schema but for calling BA services this must be passed

M

code (Attribute)

Currency code

 Example: GBP

Note: This is an optional attribute in NDC schema but for calling BA services this must be passed

M

<OrderItemID>

Seat OrderItemIDs for which the amount need to be paid.

M

ElementsDetailsMandatory/
Optional
<Query>

Core Service Price query parameters.

M

<OrderID>

Booking reference or PNR reference


Example: YOMH3W

M

Owner (Attribute)

Specifies the owner of the booking

Example: BA

M

<Payments>

Specify payment information

Note: Though this is optional element in NDC schema, it must be passed in the request to confirm the booking.

O

<Payment>

BA accepts one card form of payment per booking

M

<Type>

The form of payment type. Examples: Credit Card, Cash.

IATA definition from codeset 9888

The code can be one of the following from the table depends on the form of payment being used

Code       

Description

CC          

Card

CA            

Cash

M

<Method>


M

CashInd (Attribute)

This should always be “True” for cash payment.

M

<Amount>

Total amount payable by Cash. 

Example: 500.55

Note: This is an optional attribute in NDC schema but for calling BA services this must be passed

M

Code (Attribute)

Currency code

Example: GBP

Note: This is an optional attribute in NDC schema but for calling BA services this must be passed

M

<OrderItemID>

Seat OrderItemIDs for which the amount need to be paid.

M

ElementsDetailsOptional/
Mandatory
<Query>

Core Service Price query parameters.

M

<OrderID>

Booking reference or PNR reference


Example: YOMH3W

M

Owner (Attribute)

Specifies the owner of the booking

Example: BA

M

<OrderServicing>

Function to Add or Update or Delete the Ancillary Details.

M

<AcceptOffer>

Function to accept a new OfferItem and adding it to the existing Order

Note: If the seat does not exist then service attempt to add the seat in the booking. If seat exists, then service attempts to update the existing seat in the booking.

M

<Offer>

Offer selected by the Passenger for requesting an Order to be created. Multiple Offers can be requested at the same time, each of which could originate from different shopping responses (each with their own ResponseIDs).

M

OfferID (attribute)

Reference to the OfferID of the selected Offer (either a standard Offer or an a-la-carte Offer) returned in a previous shopping response.

M

Owner

Designator of Airline that owns/ assigned these IDs. Examples: BA

M

ResponseID

Reference to unique shopping session response ID, as provided in the airline's previous shopping response.

M

<OfferItem>

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

M

OfferItemID

Any document which may be used to identify a person or verify aspects of a person's personal identity.

M

<PassengerRefs>

Reference to the passenger(s) for which this OfferItem and selected Services (in case of Service Bundles) applies.

M

<SeatSelection>

Selection of specific seat location, as provided in seat availability response.

M

<Row>

Seat row number. Example: 2

M

<Column>

Seat column to identify a particular seat position on an aircraft

M

<Payments>

Specify payment information

Note: Though this is an optional element in NDC schema, it must be passed in the request to confirm the booking.

M

<Payment>

BA accepts one card form of payment per booking

M

<Type>

The form of payment type. Examples: Credit Card, Cash.

IATA definition from codeset 9888

The code can be one of the following from the table depends on the form of payment is used


Code       


Description

CC          

Card

CA            

Cash

M

<Method>


M

CashInd (Attribute)

This should always be “True” for cash payment.

M

<Amount>

Total amount payable by Cash. 

Example: 500.55

Note: This is an optional attribute in NDC schema but for calling BA services this must be passed

M

Code (Attribute)

Currency code

 Example: GBP

Note: This is an optional attribute in NDC schema but for calling BA services this must be passed

M

<OrderItemID>

Seat OrderItemIDs for which the amount need to be paid.

M

ElementDetailsOptional/
Mandatory
<Query>

Core Service Price query parameters.

M

<OrderID>

Booking reference or PNR reference


Example: YOMH3W

M

Owner (Attribute)

Specifies the owner of the booking

Example: BA

M

<OrderServicing>

Function to Add or Update or Delete the Ancillary Details.

M

<Delete>

Function to accept the deletion of an OrderItem from the existing Order.

M

<OrderItemID>

Seat Order Items which need deletion.

M

<DataLists>

ElementsDetails

Mandatory/
Optional

<PassengerList>

Passenger data list definition.

Note:

  • It is required to pass all passenger details for whom bags are getting added in the booking.
  • PTC, Title, Name, surname is required in the request.
  • Passenger or third-party payer is referenced through <ContactInfoRef> element in the request.
O
<ContactList>

List of contacts for passengers & payers.

Note: 

  • The passenger or third-party payer who is paying for the seats is passed in this list.
  • If the third party is the payer then their email address, title, name, and surname are required in the request.
  • Passenger email id details to send a confirmation email on additional bag purchase and cancellation are provided in this list.
  • Postal address provided in OrderChangeRQ-->ContactList as part of adding passport information will be added to the PNR if the destination is US.

O