Skip to main content

Understanding the Exchange Shopping Web Service (contd)

Ancillary Validation

Validation of associated EMDs can be requested with the following attribute:

…/PassengerInformation/PassengerWithPNR/DocumentNumber/@validateAssociatedEMDs= “true” or …/PassengerInformation/PassengerWithoutPNR/DocumentNumber/@validateAssociatedEMDs= “true”

Note: It is mandatory to include the document (ticket) number for the passenger whose air extras are to be validated.

Validation of additional EMDs that are not associated to the ticket can be requested with the following request elements:

…/PassengerInformation/PassengerWithPNR/ElectronicMiscellaneousDocumentNumber or …/PassengerInformation/PassengerWithoutPNR/ElectronicMiscellaneousDocumentNumber

Note: …ElectronicMiscellaneousDocumentNumber must be combined with

…/PassengerInformation/PassengerWithPNR/DocumentNumber/@validateAssociatedEMDs= “true” or …/PassengerInformation/PassengerWithoutPNR/DocumentNumber/@validateAssociatedEMDs= “true”

The details of the validated EMDs are returned in the following element in the exchange shopping response: /ExchangeShoppingRS/ValidateEMDForExchange

Each set of EMDs will be associated to a specific passenger by name and flight document number.

Elements and attributes that may be returned in the service response:

Element or Attribute Description Example ExchangeShopping Path
ValidateEMDForExchange Element used to return detailed information about associated EMDs N/A /ExchangeShoppingRS/ValidateEMDForExchange
@documentNumber Flight Document number associated to the set of EMDs 1231536365124 ExchangeShoppingRS/ValidateEMDForExchange/Passenger/@documentNumber
@firstName @lastName First and last name of the passenger ADAM JONES ExchangeShoppingRS/ValidateEMDForExchange/Passenger/@firstName @lastName
ElectronicMiscellaneousDocument Element providing details of the Air Extras N/A ExchangeShoppingRS/ValidateEMDForExchange/Passenger/ElectronicMiscellaneousDocument
@refundable Value indicating whether the document is refundable. Possible values are: Y - Yes N - No R - Re-use (Service Type is non-refundable, but the value may be reapplied towards a future purchase) Y ExchangeShoppingRS/ValidateEMDForExchange/Passenger/ElectronicMiscellaneousDocument/@refundable
@sequence The order sequence within the set 1 ExchangeShoppingRS/ValidateEMDForExchange/Passenger/ElectronicMiscellaneousDocument/@sequence
@type The type of the electronic miscellaneous document. Possible values can be: A - Associated S - Stand-alone. S ExchangeShoppingRS/ValidateEMDForExchange/Passenger/ElectronicMiscellaneousDocument/@type
Number EMD number 4531536365124 ExchangeShoppingRS/ValidateEMDForExchange/Passenger/ElectronicMiscellaneousDocument/Number
ReasonForIssue A primary single character code associated to the reason for issuance as defined by IATA. Possible values can be: A - Air Transportation B - Surface Transportation C - Baggage D - Financial Impact E - Airport Services F - Merchandise G - Inflight Services I - For Individual Airline use A ExchangeShoppingRS/ValidateEMDForExchange/Passenger/ElectronicMiscellaneousDocument/ReasonForIssue
@coupon Service coupon number 1 ExchangeShoppingRS/ValidateEMDForExchange/Passenger/ElectronicMiscellaneousDocument/ServiceCoupon/@coupon
@description Service coupon description Fee description /ExchangeShoppingRS/ValidateEMDForExchange/Passenger/ElectronicMiscellaneousDocument/ServiceCoupon/@description
UnusedAmount Amount of document or item that is not used 100.00 ExchangeShoppingRS/ValidateEMDForExchange/Passenger/ElectronicMiscellaneousDocument/UnusedAmount
TotalAmount Total amount of the document or item 200.00 ExchangeShoppingRS/ValidateEMDForExchange/Passenger/ElectronicMiscellaneousDocument/TotalAmount

Air Extras for new itinerary options

The Exchange Shopping response will include a list of all available Air Extras for each itinerary option, including cost and description for each one. Additionally, the response will include baggage allowance and cost.

The following elements and attributes can be used to request air extras for the new itinerary options:

Element or Attribute Description Example ExchangeShopping Path
AncillaryFees Element used to specify ancillary fees processing options N/A ExchangeShoppingRQ/TravelPreferences/AncillaryFees
@Enable Indicates if ancillary fee details should be included true ExchangeShoppingRQ/TravelPreferences/AncillaryFees/@Enable
@Summary Indicates if a summary list is requested true ExchangeShoppingRQ/TravelPreferences/AncillaryFees/@Summary
AncillaryFeeGroup Element used to request specific groups of ancillary fees N/A ExchangeShoppingRQ/TravelPreferences/AncillaryFees/AncillaryFeeGroup
@Code Type of fee group requested BG – Baggage IE – In-flight entertainment ML – Meals SA – Seats UN – Unaccompanied passenger ML ExchangeShoppingRQ/TravelPreferences/AncillaryFees/AncillaryFeeGroup/@Code
@Count Number of items requested 1 ExchangeShoppingRQ/TravelPreferences/AncillaryFees/AncillaryFeeGroup/@Count
Baggage Element used to specify baggage type and number of pieces N/A ExchangeShoppingRQ/TravelPreferences/Baggage
@RequestType Specifies baggage information type. "A" - allowance only "C" - allowance and charges "N" - no baggage information. A ExchangeShoppingRQ/TravelPreferences/Baggage/@RequestType
@Description Indicates whether baggage information text should be returned if applicable true ExchangeShoppingRQ/TravelPreferences/Baggage/@Description
RequestedPieces Allows specifying the number of bags to be returned in the response. Acceptable values range from 1 to 4 2 ExchangeShoppingRQ/TravelPreferences/Baggage/@RequestedPieces

The response payload will provide details on available Air Extras/baggage information associated to each of the shopping solutions and specific passenger.

The following elements and attributes may be returned in the service response:

Element or Attribute Description Example ExchangeShopping Path
TPA_Extensions Element used to return additional details N/A ExchangeShoppingRS/Solution/TPA_Extensions
@documentNumber Flight document number associated to the set of EMDs 1231536365124 ExchangeShoppingRS/Solution/TPA_Extensions/Passenger/@documentNumber
@firstName @lastName First and last name of the passenger ADAM JONES ExchangeShoppingRS/Solution/TPA_Extensions/Passenger/@firstName @lastName
AncillaryFeeGroups Element used to return ancillary fee details Does not repeat N/A ExchangeShoppingRS/Solution/TPA_Extensions/Passenger/AncillaryFeeGroups
@Message Message returned only when no ancillaries are found for a specific itinerary option No Ancillary Fees found ExchangeShoppingRS/Solution/TPA_Extensions/Passenger/AncillaryFeeGroups/@Message
AncillaryFeeGroup Element used to return details of specific ancillary fees group code Repeatable N/A ExchangeShoppingRS/Solution/TPA_Extensions/Passenger/AncillaryFeeGroups/AncillaryFeeGroup
@Code Fee group codes defined by ATPCO: “BG” – Baggage “IE” – In-flight entertainment “ML” – Meals “SA” – Seats “UN” – unaccompanied passenger IE ExchangeShoppingRS/Solution/TPA_Extensions/Passenger/AncillaryFeeGroups/AncillaryFeeGroup/@Code
@Name Group Name IN-FLIGHT ENTERTAINMENT ExchangeShoppingRS/Solution/TPA_Extensions/Passenger/AncillaryFeeGroups/AncillaryFeeGroup/@Name
AncillaryFeeItem Element used to return details of a single ancillary item N/A ExchangeShoppingRS/Solution/TPA_Extensions/Passenger/AncillaryFeeGroups/AncillaryFeeGroup/AncillaryFeeItem
@Amount Fee amount 10.00 ExchangeShoppingRS/Solution/TPA_Extensions/Passenger/AncillaryFeeGroups/AncillaryFeeGroup/AncillaryFeeItem/@Amount
@Description Fee description INTERNET ACCESS /ExchangeShoppingRS/Solution/TPA_Extensions/Passenger/AncillaryFeeGroups/AncillaryFeeGroup/AncillaryFeeItem/@Description
@OriginAirport Code for the origin airport LHR /ExchangeShoppingRS/Solution/TPA_Extensions/Passenger/AncillaryFeeGroups/AncillaryFeeGroup/AncillaryFeeItem/@OriginAirport
@DestinationAirport Code for the destination airport FRA /ExchangeShoppingRS/Solution/TPA_Extensions/Passenger/AncillaryFeeGroups/AncillaryFeeGroup/AncillaryFeeItem/@DestinationAirport
@Carrier Carrier code for the operating airline LH /ExchangeShoppingRS/Solution/TPA_Extensions/Passenger/AncillaryFeeGroups/AncillaryFeeGroup/AncillaryFeeItem/@Carrier
@PassengerCode Passenger Type Code ADT /ExchangeShoppingRS/Solution/TPA_Extensions/Passenger/AncillaryFeeGroups/AncillaryFeeGroup/AncillaryFeeItem/@PassengerCode
@Date Travel date on which ancillary fee applies (matches itinerary) Per segment 2018-12-25 /ExchangeShoppingRS/Solution/TPA_Extensions/Passenger/AncillaryFeeGroups/AncillaryFeeGroup/AncillaryFeeItem/@Date
@StartSegment Flight segment at which the fee application begins 1 /ExchangeShoppingRS/Solution/TPA_Extensions/Passenger/AncillaryFeeGroups/AncillaryFeeGroup/AncillaryFeeItem/@StartSegment
@EndSegment Flight segment at which the fee application ends 2 (could also be 1) /ExchangeShoppingRS/Solution/TPA_Extensions/Passenger/AncillaryFeeGroups/AncillaryFeeGroup/AncillaryFeeItem/@EndSegment
BaggageInformation Element used to return baggage information N/A /ExchangeShoppingRS/Solution/TPA_Extensions/Passenger/BaggageInformationList/BaggageInformation
@ProvisionType Indicates baggage information: “A” – checked baggage allowance “C” – day of check-in charges A /ExchangeShoppingRS/Solution/TPA_Extensions/Passenger/BaggageInformationList/BaggageInformation/@ProvisionType
@AirlineCode Indicates the carrier whose baggage provisions apply UA /ExchangeShoppingRS/Solution/TPA_Extensions/Passenger/BaggageInformationList/BaggageInformation/@AirlineCode
Segment @ID Segment ID for which the baggage provisions apply 1 /ExchangeShoppingRS/Solution/TPA_Extensions/Passenger/BaggageInformationList/BaggageInformation/Segment/@Id
Allowance Element used to return baggage allowance details N/A /ExchangeShoppingRS/Solution/TPA_Extensions/Passenger/BaggageInformationList/BaggageInformation/Allowance
@Pieces Number of pieces 1 /ExchangeShoppingRS/Solution/TPA_Extensions/Passenger/BaggageInformationList/BaggageInformation/Allowance/@Pieces
@Weight Weight limit 23 /ExchangeShoppingRS/Solution/TPA_Extensions/Passenger/BaggageInformationList/BaggageInformation/Allowance/@Weight
@Unit Units of weight limit KG /ExchangeShoppingRS/Solution/TPA_Extensions/Passenger/BaggageInformationList/BaggageInformation/Allowance/@Unit
@Description1 @Description2 Baggage text information. Can apply to Allowance and/or Charges element UP TO 50 POUNDS/23 KILOGRAMS /ExchangeShoppingRS/Solution/TPA_Extensions/Passenger/BaggageInformationList/BaggageInformation/Allowance/@Description1/@Description2
Charge Baggage charge information N/A /ExchangeShoppingRS/Solution/TPA_Extensions/Passenger/BaggageInformationList/BaggageInformation/Charge
@EquivalentAmount Baggage charge equivalent amount 100.00 /ExchangeShoppingRS/Solution/TPA_Extensions/Passenger/BaggageInformationList/BaggageInformation/Charge/@EquivalentAmount
@EquivalentCurrency Equivalent currency GBP /ExchangeShoppingRS/Solution/TPA_Extensions/Passenger/BaggageInformationList/BaggageInformation/Charge/@EquivalentCurrency
@FirstPiece First piece of baggage for which the specified charge information applies 1 /ExchangeShoppingRS/Solution/TPA_Extensions/Passenger/BaggageInformationList/BaggageInformation/Charge/@FirstPiece
@LastPiece Last piece of baggage for which the specified charge information applies 2 /ExchangeShoppingRS/Solution/TPA_Extensions/Passenger/BaggageInformationList/BaggageInformation/Charge/@LastPiece
@Description1 @Description2 Baggage text information. Can apply to Allowance and/or Charges element UP TO 50 POUNDS/23 KILOGRAMS /ExchangeShoppingRS/Solution/TPA_Extensions/Passenger/BaggageInformationList/BaggageInformation/Charge/@Description1 @Description2
@NoChargeNotAvailable Will be returned in the response whenever baggage information was requested but is not available. The response values may be: X – service not available F – no charge for the service (free), and no EMD is issued for the free service E – no charge for service (free), and an EMD is issued for the free service G – no charge for service (free), booking is not required and no EMD is issued for the free service H- no charge for the service (free), booking is not required, and an EMD is issued for the free service X /ExchangeShoppingRS/Solution/TPA_Extensions/Passenger/BaggageInformationList/BaggageInformation/Charge/@NoChargeNotAvailable