ServiceList 17.2

Functional Description

ServiceList API returns a catalogue of baggage items for the selected Offer or Order.

Bags can be purchased as part of the Shopping flow following the OfferPrice, or as part of a servicing flow after the initial Order has been created.

However, Bags cannot be pre-booked/purchased unless the Order has been paid for in full and ticketed.

NDC Servicing operations for corporate will only validate that travel agency indicated in the request is the same as generated the order. If corporateID is present in the request, it will only be checked when the order has been generated with corporateID.

Functionality/ Use / Examples → Complete Flow (All RQ/RS)

Functionality

Use

Examples → Complete Flow (All RQ/RS)


Pre-Sale

The pre-sale ServiceList service allows us to see the price for bags for a flight before the creation of the Order,

In this way we can select those baggage services that we want to include when creating the Order.

  • ServiceList - Round Trip - Pre-Sale.zip
  • ServiceList - 1 ADT 1 CHD 1 INF - Pre-Sale.zip
  • ServiceList - Corporates - Pre-Sale.zip
  • Download Examples
Post-Sale The post-sale ServiceList service allows us to see the price for bags for a flight after the creation of the Order, 

In this way, we can select those baggage services that we want to add to a previously created Order.

  • ServiceList - Post-Sale.zip
  • ServiceList - Corporates - Post-Sale.zip
  • Dowload Examples

 

Legend

(plus) New or modify field

 

HTTP Headers

api_key Your unique key used to authorise access to the API. Mandatory:Yes

Request Body

We provide two different methods to request the ServiceList:

  • Presale: Needs a previous AirShopping for returning an offer and a price breakdown.
  • Post-sale: Needs a previously created and full paid Order. Including extra data it will return the baggage catalogue for the ordered flight.

The various search parameters are described below:

NAME

DESCRIPTION

FORMAT

ALLOWED VALUES

MANDATORY FOR
PrimaryLangID Two character ISO Language Code, for the agent’s preferred language. This is for error messages and some other data such as legal waivers. 2 Alphabetic
  • EN
  • ES

Version The IATA version of the message Numeric Any Schema
<PointOfSale>
Location / CountryCode Country code 2 Alphabetical List of Countries If toggle feature for market validation is activated.
<Document> Schema
ReferenceVersion The IATA Schema version. Numeric Any
<Party / Sender> Only for Real IATA Schema
TravelAgencySender / IATA_Number

Sender unique identifier such as:

IATA number (if you have one)

TIDs number  (recommended if you do not have an IATA)

Numeric 7/8 Numbers NDC Mandatory
<Party / Sender> Only for Pseudo IATA Schema
TravelAgencySender / OtherIDs / OtherID Pseudo IATA (assigned by Iberia) Numeric 7/8 Numbers NDC Mandatory
<Party> Schema
Sender / TravelAgencySender / Name Agency Name Alphanumeric Any
Sender / TravelAgencySender / Contacts / Contact / EmailContact / Address Email to contact the Agency Alphanumeric Any Mandatory for schema if 'EmailContact' tag is indicated.
Sender / TravelAgencySender / Contacts / Contact / PhoneContact / Application Agency phone type Alphabetical
  • Business
  • Mobile

Sender / TravelAgencySender / Contacts / Contact / PhoneContact / Number Phone number to contact the Agency Numeric Any
Sender / TravelAgencySender / Contacts / Contact / Name / Surname Reference Agency contact surname Alphanumeric Any
Sender / TravelAgencySender / Contacts / Contact / Name / Given Reference Agency contact name Alphanumeric Any Mandatory for schema if 'Name' tag is indicated.
Sender / TravelAgencySender / AgencyID Id for the Agency Alphanumeric Any Schema
Participants / Participant / AggregatorParticipant / AggregatorID

Participant / Aggregator unique identifier:

IATA number (if you have one)

TIDs number  (recommended if you do not have an IATA)

Pseudo IATA(assigned by Iberia)

7 Numeric 7 Numbers Mandatory for schema if 'Participants' tag is indicated.
<Party> (With Corporates) Schema
Sender / CorporateSender / ID ID for the Corporate Alphanumeric Any NDC Mandatory
Participants / Participant / TravelAgencyParticipant / Name Agency Name Alphanumeric Any
Participants / Participant / TravelAgencyParticipant / Contacts / Contact / EmailContact / Address Email to contact the Agency Alphanumeric Any Mandatory for schema if 'EmailContact' tag is indicated.
Participants / Participant / TravelAgencyParticipant / Contacts / Contact / PhoneContact / Application Agency phone type Alphabetical Any
Participants / Participant / TravelAgencyParticipant / Contacts / Contact / PhoneContact / Number Phone number to contact the Agency Numeric Any
Participants / Participant / TravelAgencyParticipant / Contacts / Contact / Name / Surname Reference Agency contact surname Alphanumeric Any
Participants / Participant / TravelAgencyParticipant / Contacts / Contact / Name / Given Reference Agency contact name Alphanumeric Any Mandatory for schema if 'Name' tag is indicated.
Participants / Participant / TravelAgencyParticipant / IATA_Number

Sender unique identifier such as:

IATA number (if you have one)

TIDs number  (recommended if you do not have an IATA)

Numeric 7/8 Numbers NDC Mandatory
Participants / Participant / TravelAgencyParticipant / AgencyID Id for the Agency Alphanumeric Any Schema
Participants / Participant / AggregatorParticipant / AggregatorID

Participant / Aggregator unique identifier:

IATA number (if you have one)

TIDs number  (recommended if you do not have an IATA)

Pseudo IATA(assigned by Iberia)

7 Numeric 7 Numbers Mandatory for schema if 'Participants' tag is indicated.
<ShoppingResponseID>  Pre-sale
ResponseID ResponseID of OfferPrice service Alphanumeric Any Schema
<Query> Post-sale
OrderID Order ID with mandatory attribute Owner Alphanumeric The order id of an existing order which has been created, paid and ticketed Schema
<Query / Offers> Pre-sale
Offer / OfferID Id for the offer Alphanumeric Any Schema
Offer / OfferItemIDs / OfferItemID Id for the offer item Alphanumeric Any Schema
<Metadata>

Other / OtherMetadata / CurrencyMetadatas / CurrencyMetadata

Attribute

MetadataKey

Type of currency Alphabetical Any available currency for the defined market Mandatory for schema if 'Metadata' tag is indicated
Other / OtherMetadata / CurrencyMetadatas / CurrencyMetadata / Decimals Decimals of currency Numeric Any

 

Response Body

The response filters by currency in both pre-sale and post-sale methods. In case the currency does not match with:

  • Pre-sale: with the currency in the offer.
  • Post-sale: with the currency in the order.

NAME

DESCRIPTION

FORMAT

ALLOWED VALUESNullable
<Document>
ReferenceVersion The IATA version of the message Numeric Any False
<ShoppingResponseID>
ResponseID Id of the response Alphanumeric Any False
<ALaCarteOffer>

ALaCarteOffer

Attribute

OfferID

Id of the Offer Alphanumeric Any False
OfferExpirationDateTime Date of expiration for the offer Alphanumeric Any False
<ALaCarteOffer / ALaCarteOfferItem>

ALaCarteOfferItem

Attribute

OfferItemID

Id of the OfferItem Alphanumeric Any False
Eligibility / PassengerRefs Passenger Identifier Alphanumeric Any False
Eligibility / SegmentRefs Segment Identifier Alphanumeric Any False
UnitPriceDetail / TotalAmount / SimpleCurrencyPrice Unitary price for the offer Numeric Any False

Service

Attribute

ServiceID

Id of the Service Alphanumeric Any False
Service / ServiceDefinitionRef Service Identifier Alphanumeric Any False
<DataLists / PassengerList>

Passenger

Attribute

PassengerID

Passenger Identifier Alphanumeric Any False
Passenger / PTC Attribute Passenger Type Code PaxType (3 Alphabetical) Type of Passengers False
<DataLists / FlightSegmentList>

FlightSegment

Attribute

SegmentKey

Id for the segment Alphanumeric Any False
Departure / AirportCode IATA 3 character code for the departure city/airport/station 3 Alphanumeric Any False
Departure / Date Date of departure Date yyyy-MM-dd False
Departure / Time Time of departure Hour HH:mm False
Departure / AirportName Name of the departure city/airport/station Alphanumeric Any False
Departure / Terminal / Name Name of the departure terminal at city/airport/station Alphanumeric Any False
Arrival / AirportCode IATA 3 character code for the arrival city/airport/station 3 Alphanumeric Any False
Arrival / Date Date of arrival Date yyyy-MM-dd False
Arrival / Time Time of departure Hour HH:mm False
Arrival / ChangeOfDay Number of days to change Numeric Any False
Arrival / AirportName Name of the arrival at city/airport/station Alphanumeric Any False
Arrival / Terminal / Name Name of the arrival terminal at city/airport/station Alphanumeric Any False
MarketingCarrier / AirlineID Id for the airline that markets the flight Alphanumeric Any False
MarketingCarrier / Name Name for the airline that markets the flight Alphanumeric Any False
MarketingCarrier / FlightNumber Number for the flight Numeric Any False
OperatingCarrier / AirlineID Id for the airline that operates the flight Alphanumeric Any False
OperatingCarrier / Name Name for the airline that operates the flight Alphanumeric Any False
OperatingCarrier / FlightNumber Number for the flight Numeric Any False
OperatingCarrier / Disclosures / Description / Text Description of the airline Alphanumeric Any False
Equipment / AircraftCode Code of the aircraft that operates the flight Alphanumeric Any False
Equipment / Name Name of the aircraft that operates the flight Alphanumeric Any False
FlightDetail / FlightDuration / Value Duration of the flight Alphanumeric Any False
<DataLists / MediaList>

Media

Attribute

ListKey

Id for the Media Item Alphanumeric Any False
Media / MediaLink Http link referring to the Media Item Alphanumeric Any False
<DataLists / ServiceDefinitionList>

ServiceDefinition

Attribute

ServiceDefinitionID

Id for the service definition Alphanumeric Any False
ServiceDefinition / Name Name of the service Alphanumeric Any False
ServiceDefinition / ServiceBundle / ServiceDefinitionRef References to services that includes Alphanumeric Any references to services that includes False
ServiceDefinition / Descriptions / Description / Text Description of the service Alphanumeric Any False
ServiceDefinition / Detail / ServiceCombinations / Combination / Rule Rules that applies to service Alphanumeric Any False
ServiceDefinition / Detail / ServiceCombinations / Combination / ServiceReference Reference for the service that is affected by rule Alphanumeric Any False
ServiceDefinition / Detail / ServiceItemQuantityRules / MaximumQuantity Maximun quantity of service Numeric Any False