Ancillary Servicing - Bags - RQ





 OrderChange - Ancillary Servicing - Bags - 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 delete the additional bag quantity.

M

<AcceptOffer>

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


Note: If bags do not exist then service attempt to add the bags in the booking. If bags exist, then service gives a warning message stating that bags are already present for the passenger. If the customer has already purchased 1 XSB and wants to purchase 1 more bag, then the original XSB should be cancelled and then purchase XSB for 2

M

<Offer>

Bag Offer selected by the Passenger for requesting an Order to be created.

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 ServiceList response.

M

Owner

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

M

ResponseID

Reference to unique servicelist session response ID, as provided in the previous ServiceList response.

M

<OfferItem>

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

M

OfferItemID

Reference to the OfferItemID of the selected bag OfferItem (contained in either a standard Offer or an a-la-carte Offer) returned in a previous servicelist response

M

<PassengerRefs>

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

M

<Payments>

Specify payment information

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

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

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

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

<StateProv>

State or province code

Examples: NY

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

<PostalCode>

Postal Code

Example: SW3 1XH

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

<CountryCode>

Billing country code (2 letter code)

Example: GB

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

<Surcharge>

Surcharge fee applicable for the payment card.

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

<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

O

<EffectiveExpireDate>

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

O

<Effective>

Specifies payment card start date

Example: 0812

Where 08 = Month

12 = Year

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

<Expiration>

Specifies payment card expiry date

Example: 0815

Where 08 = Month

15 = Year

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

<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

O

code (Attribute)

Currency code

 Example: GBP

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

O

If cash is used for bags purchase.

<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

ElementsDetails

Mandatory/
Optional

<Query>

 

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 delete the Ancillary details.

M

<Delete>
Function to accept the deletion of a bag OrderItem from the existing Order.M
<OrderItem>
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