BaggageList 15.2 Live
New functionality:
(version: 2.30) In the Service element of the BaggageList response, there is now more information returned regarding the baggage service.
- Traveler: contains the passengers’ references the baggage service can be applied to.
- Detail: it’s the maximum quantity of baggages selectable for the service.
(version: 2.23) Example validation of the currency we sell with the point of sale currency. This information will be optional.
<Metadata>
<Other>
<OtherMetadata>
<CurrencyMetadatas>
<CurrencyMetadata MetadataKey="EUR">
<Decimals>2</Decimals>
</CurrencyMetadata>
</CurrencyMetadatas>
</OtherMetadata>
</Other>
</Metadata>
Message examples:
BaggageList.zip message examples
EndPoint:
- IATA NDC Schema Version 15.2: https://test.api.iberia.com/iberia/beta/ndc/BaggageAvailability/v1
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 baggage list:
- 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.
New or modify field
The various search parameters are described below:
NAME |
DESCRIPTION |
FORMAT |
ALLOWED VALUES |
MANDATORY FOR |
PrimaryLangID | Specifies preferred language by the agency | 2 alphabetic | any | |
Version |
The IATA version of the message |
numeric | any | Schema |
<PointOfSale> | ||||
Location / CountryCode |
Country code |
2 alpha |
NDC Mandatory if toggle feature for market validation is activated. | |
<Document> | Schema | |||
ReferenceVersion |
The IATA Schema version. |
numeric |
any |
|
<Party / Sender / TravelAgencySender> | Schema | |||
IATA_Number |
Sender IATA or Pseudo IATA number |
numeric |
7/8 numbers |
NDC Mandatory |
AgencyID |
Agency identification |
alphanumeric |
any |
Schema |
Name |
Agency name |
alphanumeric | any | |
<Party / Sender / TravelAgencySender / Contacts / Contact> | Mandatory for schema if 'Contacts' tag is indicated. | |||
EmailContact / Address | Email to contact the Agency | alphanumeric | any | Mandatory for schema if 'EmailContact' tag is indicated. |
PhoneContact / Application | Agency phone type | alphabetic |
|
|
PhoneContact / Number Attribute CountryCode |
Country code phone number to contact the Agency | alphanumeric | any | |
Name / Surname | Reference Agency contact surname | alphanumeric | any | Mandatory for schema if 'Name' tag is indicated. |
Name / Given | Reference Agency contact given | alphanumeric | any | |
<Travelers> | Schema | |||
Traveler / AnonymousTraveler / PTC |
Attribute Passenger Type Code |
PaxType (3 alpha) |
any |
Schema |
Traveler / AnonymousTraveler / PTC Attribute Quantity |
Quantity of this kind of passenger type | numeric | any, from 1 to 9 | |
<ShoppingResponseIDs> Presale | Schema | |||
ResponseID |
ResponseID of FlightPrice service |
alphanumeric |
any |
Schema |
AssociatedIDs | Offer Items | alphanumeric | Schema | |
<Query> Post-sale | Schema | |||
---|---|---|---|---|
OrderID | Order ID with mandatory attribute Owner | alphanumeric | the order id of an existing order which has been created, paid and ticketed | Schema |
<Metadata> | ||||
Other / OtherMetadata / CurrencyMetadatas / CurrencyMetadata / MetadataKey Attribute MetadataKey |
Type of currency | alphanumeric | any available currency | Mandatory for schema if 'Metadata' tag is indicated |
Other / OtherMetadata / CurrencyMetadatas / CurrencyMetadata / Decimals | Decimals of currency | numeric | any | Mandatory for schema if 'MetadataKey' tag is indicated |
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 VALUES |
---|---|---|---|
<ShoppingResponseIDs> | |||
ResponseID |
Id of the response | alphabetical | Any |
<Services> | |||
Service Attribute ObjectKey |
ObjectKey attribute contains the ID of the baggage service | alphanumerical | Any |
<Services / Service> | |||
ServiceID Attribute Owner |
ID of the baggage service Owner attribute shows owner airline ID of the service. |
alphabetical | Any |
Name | Name of the baggage service | alphabetical | Any |
Encoding / RFIC / Code | RFIC Code | number | Any |
Encoding / Code | Code of the service | alpha | Any |
Descriptions / Description / Text | Description of the baggage service | alphabetical | Any |
Price / Total Attribute Code |
Price of the baggage Code attribute shows currency code of the baggage service. |
number | Any |
Associations / Travaler / TravelerReferences | References to every passenger that applies to the service | alphanumerical | Any |
Associations / Flight / SegmentReferences | Segment referentes with format flight number and flight date | alphanumerical | Any |
Detail / ServiceItemQuantityRules / MaximumQuantity |
Maximun allowed quantity of the service per passenger If there are several passengers, the maximum general figure is expressed, that is, the one allowed for the passenger with the most services, without necessarily meaning that all others may request that number of services. |
number | Any |
<Datalists> | |||
AnonymousTravelerList / AnonymousTraveler Attribute ObjectKey |
Anonymous Passenger key | alphanumerical | Any |
AnonymousTravelerList / AnonymousTraveler/ PTC | Anonymous Passenger code | alphabetical | Passenger Types |
RecognizedTravelerList / RecognizedTraveler Attribute ObjectKey |
Recognized Passenger key | alphanumerical | Any |
RecognizedTravelerList / RecognizedTraveler / PTC | Recognized Passenger Code | alphabetical | Passenger Types |
RecognizedTravelerList / RecognizedTraveler / Name / Surname | Surname of recognized passenger | alphabetical | Any |
RecognizedTravelerList / RecognizedTraveler / Name / Given | Name of recognized passenger | alphabetical | Any |
RecognizedTravelerList / RecognizedTraveler / FQTVs / AirlineID | Id of the airline | alphabetical | Any |
RecognizedTravelerList / RecognizedTraveler / FQTVs / Account / Number | Number of frecuent flyer | numeric | Any |
<CheckedBagAllowanceList> | |||
CheckedBagAllowance Attribute refs Attribute ListKey |
Checked baggage allowed for the service mentioned in "refs" attribute. | alphanumerical | Any |
<CheckedBagAllowanceList / CheckedBagAllowance / PieceAllowance> | |||
ApplicableParty | Type of party | alphabetical | Any |
TotalQuantity | Quantity of ApplicableParty | number | number |
PieceMeasurements Attribute Quantity |
Quantity of pieces | number | number |
PieceMeasurements / PieceWeightAllowance / MaximumWeight / Value | Maximum weight for pieces quantity | number | number |
PieceMeasurements / PieceWeightAllowance / MaximumWeight / UOM |
Weight unit
|
alphabetical | Any |
PieceMeasurements / PieceDimensionAllowance / DimensionUOM |
Unit of measurement
|
alphabetical | Any |
PieceMeasurements / PieceDimensionAllowance / MaxLinear |
Maximum measure
|
number | number |
PieceMeasurements / PieceDimensionAllowance / MinLinear | Minimum measure | number | number |
<FlightSegmentList> | |||
FlightSegment Attribute SegmentKey |
Flight Segment Code containing FlightId and date | alphanumerical | Any |
<FlightSegment / Departure> | |||
AirportCode | IATA Airport Code | alphabetical | Any |
Date | Departure Date | Date | yyyy-MM-dd |
Time | Departure Time | Time | hh:mm |
AirportName | Full Airport Name | alphabetical | Any |
Terminal / Name | Terminal name or number. Real world name for terminal | alphabetical/numerical | Any |
<FlightSegment / Arrival> |
|||
AirportCode | IATA Airport Code | alphabetical | Any |
Date | Departure Date | Date | yyyy-MM-dd |
Time | Departure Time | Time | hh:mm |
AirportName | Full Airport Name | alphabetical | Any |
ChangeOfDay | Shows how many days after departure date flight will arrive. | numerical | number |
Terminal / Name | Terminal name or number. Real world name for terminal | alphabetical/numerical | Any |
<FlightSegment / MarketingCarrier> | |||
AirlineID | IATA airline code | alphabetical | Airline ID (IB, AA, I2...) |
Name | Full Airline name. | alphabetical | Any |
FlightNumber | The flight number | numerical | number |
<FlightSegment / OperatingCarrier> |
|||
AirlineID | IATA airline code | alphabetical | Airline ID (IB, AA, I2...) |
Name | Full Airline name. | alphabetical | Any |
FlightNumber | The flight number | numerical | number |
Disclosure / Description / Text | Text showing the disclosure | alphabetical | Any |
<FlightSegment / Equipment> | |||
AircraftCode | Aircraft Code | numerical | Any |
Name | Full Aircraft model name | alphabetical | Any |
<FlightSegment / FlightDetail (only first segment)> | |||
FlightDuration / Value | Time Flight Duration | Date | PT'hh'H'mm'M |
<FlightList> | |||
Flight Attribute FlightKey |
Id for the flight | alphanumerical | Any |
<FlightList / Flight> | |||
Journey / Time | Time for the journey | Date | Any |
SegmentReferences | Id referencing a FlightSegment | alphanumerical | Any |
<OriginDestinationList> | |||
OriginDestination Attribute OriginDestinationKey |
IATA Code referencing departure city and arrival city | alphabetical | Any |
OriginDestination / DepartureCode | IATA Code for Departure City | alphabetical | Any |
OriginDestination / ArrivalCode | IATA Code for Arrival City | alphabetical | Any |
OriginDestination / FlightReferences | Id Referencing a Flight. | alphanumerical | Any |
<MediaList> | |||
Media Attribute ListKey |
Id for the Media Item | alphabetical | Any |
Media / MediaLink | Http link referring to the Media Item | alphanumerical | Any |
Error Messages
NDC Standard allow errors and warnings to be returned inside an 200 OK response. Errors returned with 200 OK will always be controlled errors result of external limitations as "Max accepted non-infant passengers is 9".
BaggageList Presale
HTTP STATUS CODE |
EXAMPLE MESSAGE ERROR |
REASON |
795 | ShoppingResponseID invalid: incorrect or out-of-date | Shopping Response Invalid |
396 | Invalid ticket/document coupon status | Order without tickets |
396 | Invalid ticket/document coupon status | Order with some ticket in status distinct of OPEN FOR USE |
396 | Invalid ticket/document coupon status | Order with some ticket reissued |
BaggageList Post-Sale
HTTP STATUS CODE |
EXAMPLE MESSAGE ERROR |
REASON |
795 | ShoppingResponseID invalid: incorrect or out-of-date | Shopping Response Invalid |
396 | Invalid ticket/document coupon status | Order without tickets |
396 | Invalid ticket/document coupon status | Order with some ticket in status distinct of OPEN FOR USE |
396 | Invalid ticket/document coupon status | Order with some ticket reissued |