SupplementsReservation
Method Goals
This method aims to add supplements (seats, baggage, etc) to a reservation done previously.
Request Format
Must contain the Itineraries returned in SupplementsRS and any of the possible ways to retrieve the provider booking (by locator, by email, etc.)
Response Format
The result returns an invoice with all the supplement charges.
Remarks
Not implemented by all suppliers
SupplementsReservationRQ Description
Element | Number | Type | Description |
---|---|---|---|
SupplementsReservationRQ | 1 | Root node. | |
Itineraries | 1 | Contains a list of Itineraries. | |
Itineraries/Itinerary | 1..n | Details of the Itinerary. | |
@id | 1 | Integer | Unique identifier of the Itinerary. |
@carrier | 1 | String | Validating carrier. |
@fareRef | 0..1 | String | Reference identifier to the original Fare. |
@hasObFees | 0..1 | Boolean | If true then there is an extra fee for using credit card. |
Itineraries/Itinerary/Conditions | 0..1 | Contains a list of Fare Conditions. | |
Itineraries/Itinerary/Conditions/ Condition |
1..n | Contains details of the Condition that applies to the condition. | |
@carrier | 0..1 | String | Carrier applying the condition. |
@code | 0..1 | String | Code of the condition. |
@id | 0..1 | String | Unique id of the condition. |
@language | 0..1 | String | Language in which the condition is written. ISO 3166-1 alpha-2 format lowercase. |
Itineraries/Itinerary/Conditions/ Condition/Text |
0..1 | Description of the condition. | |
Itineraries/Itinerary/Conditions/ Condition/Paragraph |
0..n | List of Sentences and titles. | |
@title | 0..1 | String | Title content. |
Itineraries/Itinerary/Conditions/ Condition/Paragraph/Sentence |
0..n | String | List of Sentences contents. |
Itineraries/Itinerary/Journeys | 1 | Contains a list of Journeys. | |
Itineraries/Itinerary/Journeys/Journey | 1..n | Contains details of the Journeys. | |
@id | 1 | Integer | Unique identifier of the Journey in scope. |
@duration | 0..1 | Integer | Duration of the Journey in minutes. |
@familyFare | 0..1 | String | Family fare name of the Journey. |
@checkinStart | 0..1 | Date | Checkin start date. Example: 2019-04-15T18:25:00 |
@checkinEnd | 0..1 | Date | Checkin end date. Example: 2019-04-15T18:25:00 |
Itineraries/Itinerary/Journeys/Journey/ Segments |
1 | Contains a list of Segments associated to the Journey. | |
Itineraries/Itinerary/Journeys/Journey/ Segments/Segment |
1..n | Contains details of the SegmentInfo. | |
@id | 1 | Integer | Unique SegmentInfo identifier. |
Itineraries/Itinerary/Journeys/Journey/ Segments/Segment/SegmentInfo |
1 | Contains information of the Segment. | |
@id | 1 | Integer | Unique identifier of the SegmentInfo. |
@transportationId | 1 | String | Unique Id of the transportation. |
@operatingCarrier | 1 | String | Company which operates the transportation. |
@marketingCarrier | 1 | String | Company which commercializes the transportation. |
@departureDate | 1 | Date | Departure date. Example: 2019-04-15T18:25:00 |
@arrivalDate | 1 | Date | Arrival date. Example: 2019-04-15T18:25:00 |
@transportationType | 0..1 | Transport type | Transport type |
@transportationName | 0..1 | String | Name of the transportation. |
@transportationCode | 0..1 | String | Code of the transportation. |
@departureTerminal | 0..1 | String | Departure terminal. |
@arrivalTerminal | 0..1 | String | Arrival terminal. |
@segmentDuration | 0..1 | Integer | Transport duration ( in minutes ). |
@segmentStatus | 0..1 | Segment Status type | Segment Status type |
@planeType | 0..1 | String | Plane type. Flights parameter. |
@maxCheckinDate | 0..1 | Date | Maximum date to make the check-in. Not filled from provider’s response |
@hasTechnicalStop | 0..1 | Boolean | If true, the segment has a technical stop. |
@electronicTicket | 0..1 | Boolean | If true, the segment uses a electronic ticket. |
@secureFlight | 0..1 | Boolean | If true, the provider requires extra information of the passengers. Flights parameter. |
Itineraries/Itinerary/Journeys/Journey/ Segments/Segment/OriginLoc |
1 | Origin location. | |
@code | 1 | String | Location code. |
@type | 0..1 | String | Type of station of the location |
@name | 0..1 | String | Location full name. |
@radius | 0..1 | Integer | Area radius from location. |
@cityCode | 0..1 | Boolean | If true, the field code indicates a city code, if false, it will indicate an airport code. |
Itineraries/Itinerary/Journeys/Journey/ Segments/Segment/OriginLoc/ AlternativeLocations |
0..1 | Contains a list of AlternativeLocations. | |
Itineraries/Itinerary/Journeys/Journey/ Segments/Segment/OriginLoc/ AlternativeLocations/AlternativeLocation |
1..n | Contains the information of the alternative location. | |
@code | 1 | String | Location code. |
@cityCode | 0..1 | Boolean | If true, the field code indicates a city code, if false, it will indicate an airport code. |
@name | 0..1 | String | Location long name. |
@type | 0..1 | String | Type of station of the location |
Itineraries/Itinerary/Journeys/Journey/ Segments/Segment/DestinationLoc |
1 | Destination location. | |
@code | 1 | String | Location code. |
@type | 0..1 | String | Type of station of the location |
@name | 0..1 | String | Location full name. |
@radius | 0..1 | Integer | Area radius from location. |
@cityCode | 0..1 | Boolean | If true, the field code indicates a city code, if false, it will indicate an airport code. |
Itineraries/Itinerary/Journeys/Journey/ Segments/Segment/ DestinationLoc/AlternativeLocations |
0..1 | Contains a list of AlternativeLocations. | |
Itineraries/Itinerary/Journeys/Journey/ Segments/Segment/ DestinationLoc/AlternativeLocations/ AlternativeLocation |
1..n | Contains the information of the alternative location. | |
@code | 1 | String | Location code. |
@cityCode | 0..1 | Boolean | If true, the field code indicates a city code, if false, it will indicate an airport code. |
@name | 0..1 | String | Location long name. |
@type | 0..1 | String | Type of station of the location |
Itineraries/Itinerary/Journeys/Journey/ Segments/Segment/TechnicalStops |
0..1 | Contains a list of TechnicalStops. | |
@totalTechnicalStops | 1 | Integer | Total number of TechnicalStops. |
Itineraries/Itinerary/Journeys/Journey/ Segments/Segment/TechnicalStops/ TechnicalStop |
0..n | Contains the details of the TechnicalStop. | |
@location | 1 | String | TechnicalStop location. |
@stopDate | 1 | Date | Approx. stop date and time. Example: 2019-04-15T18:25:00 |
@departureDate | 1 | Date | Approx. departure date and time. Example: 2019-04-15T18:25:00 |
Itineraries/Itinerary/Journeys/Journey/ Segments/Segment/SegmentClasses |
1 | Contains a list of SegmentClasses. | |
Itineraries/Itinerary/Journeys/Journey/ Segments/Segment/SegmentClasses/ SegmentClass |
1..n | Contains details of the SegmentClass. | |
@cabinClass | 1 | Cabin Class type | Cabin class type of the seat |
@paxRef | 1 | Integer | Passenger reference. |
@fareType | 1 | Fare type | Fare type |
@class | 0..1 | String | Fare class. |
@fareBasis | 0..1 | String | Identifier of the fare. |
@avail | 0..1 | Integer | Available seats remaining for this class (In flights, the maximum is 9). |
Itineraries/Itinerary/Journeys/Journey/ Segments/Segment/SegmentClasses/ SegmentClass/Modifiable |
0..1 | Contains the information of the modifiable fare. | |
@modifiable | 1 | Boolean | If true, the fare allows this modification. |
@Description | 0..1 | String | Modification description. |
@amount | 0..1 | Decimal | Modification amount. |
@currency | 0..1 | String | Modification currency. |
@amountType | 0..1 | Amount type | Modification amount type. |
Itineraries/Itinerary/Journeys/Journey/ Segments/Segment/SegmentClasses/ SegmentClass/CancellationPolicies |
0..1 | Contains a list of CancellationPolicies. | |
Itineraries/Itinerary/Journeys/Journey/ Segments/Segment/SegmentClasses/ SegmentClass/CancellationPolicies/ CancellationPolicy |
1..n | Contains details of the CancelationPolicy. | |
@refundable | 1 | Boolean | If true, the fare allows the refundation. |
@fromDate | 0..1 | Date | Date of the begining of the policy. Example: 2019-04-15T18:25:00 |
@amount | 0..1 | Decimal | Policy amount. |
@currency | 0..1 | String | Policy currency. |
@amountType | 0..1 | Amount type | Policy amount type |
Itineraries/Itinerary/Journeys/Journey/ Segments/Segment/ReservationTokens |
0..1 | Specific attribute used for each provider. | |
Itineraries/Itinerary/Journeys/Journey/ Segments/Segment/ReservationTokens/ Attribute |
1..n | Type of attribute. | |
@key | 1 | String | Contains the keyword/ Id to identify a parameter. |
@value | 1 | String | Contains the value of the parameter. |
Itineraries/Itinerary/Journeys/Journey/ Segments/Segment/CheckinInformation |
0..1 | Checkin information. | |
@openingTime | 0..1 | Date | Checkin opening time. Example: 2019-04-15T18:25:00 |
@closingTime | 0..1 | Date | Checkin closing time. Example: 2019-04-15T18:25:00 |
@estimatedCheckinTime | 0..1 | Date | Estimated checkin time. |
Itineraries/Itinerary/Journeys/Journey/ Segments/Segment/CheckinInformation/ Status |
0..1 | Status checkin information. | |
@isAvailable | 0..1 | Boolean | If true, the cheking is available. |
@direction | 0..1 | String | Direction of the journey about to checkin. |
@status | 0..1 | String | Status of the checkin. |
Itineraries/Itinerary/AmountBreakdown | 1 | Breakdown of the fare amount. | |
@currency | 1 | String | Currency code of the fare. |
@totalAmount | 1 | Decimal | Total amount. with taxes and other charges included. |
@notCommissionableAmount | 0..1 | Decimal | Total amount that can not be commissioned. |
@commission | 0..1 | Decimal | Commission. |
Itineraries/Itinerary/AmountBreakdown/ ChargeBreakdowns |
0..1 | Contains a list of breakdown amounts ( taxes, mandatory charges.. ). | |
Itineraries/Itinerary/AmountBreakdown/ ChargeBreakdowns/ChargeBreakdown |
1..n | Contains details of the BreakdownAmount. | |
@amount | 1 | Decimal | Charge amount. |
@type | 0..1 | Type of charge. | Type of charge. |
@included | 0..1 | Boolean | If true, the charge is included to the total fare amount. |
Itineraries/Itinerary/AmountBreakdown/ ChargeBreakdowns/ChargeBreakdown /Concept |
0..1 | Contains details of the charge. | |
@id | 0..1 | String | Unique id of the Concept. |
@language | 0..1 | String | Language. ISO 3166-1 alpha-2 format lowercase. |
@carrier | 0..1 | String | Carrier. |
@code | 0..1 | String | Concept code. |
Itineraries/Itinerary/AmountBreakdown/ ChargeBreakDowns/ChargeBreakdown /Concept/Text |
0..1 | String | Remarks. |
Itineraries/Itinerary/AmountBreakdown/ ChargeBreakDowns/ChargeBreakdown /Concept/Paragraph |
0..n | Contains a list of Sentences and titles. | |
@title | 0..1 | String | Title. |
Itineraries/Itinerary/AmountBreakdown/ ChargeBreakDowns/ChargeBreakdown/ Concept/Paragraph/Sentence |
0..n | String | Sentence. |
Itineraries/Itinerary/AmountBreakdown/ PaxBreakdown |
1 | Contains a list of breakdown amounts for each passenger ( ADT amount, etc. ). | |
Itineraries/Itinerary/AmountBreakdown/ PaxBreakdowns/PaxBreakdown |
1..n | Contains details of breakdown amounts for each passenger. | |
@paxType | 1 | Passenger type | Passenger type |
@amount | 1 | Decimal | Total amount, with taxes included, associated to the passenger. |
@taxes | 1 | Decimal | If they exist, taxes are applied for this passenger type. |
@taxesDU | 0..1 | Decimal | DU taxes. |
@fees | 0..1 | Decimal | Fees. |
Itineraries/Itinerary/AmountBreakdown/ PaxBreakdowns/PaxBreakdown/ Taxes |
0..1 | Contains a list of Taxes. | |
Itineraries/Itinerary/AmountBreakdown/ PaxBreakdowns/PaxBreakdown/ Taxes/Tax |
1..n | Code and amount of each tax. | |
@code | 1 | String | Code. |
@amount | 1 | Decimal | Amount. |
Itineraries/Itinerary/PaxConfigurations | 1 | Contains a list of PaxConfiguration. | |
Itineraries/Itinerary/PaxConfigurations/ PaxConfiguration |
1..n | Contains details of PaxConfiguration. | |
@id | 1 | Integer | Unique identifier of the PaxConfiguration. |
@paxRef | 1 | Integer | Reference to the passenger Id from the request. |
@paxType | 1 | Passenger type | Passenger type based on the age of the passenger. |
@age | 0..1 | Integer | Age of the passenger. |
@nationality | 0..1 | String | Nationality of the passenger. |
Itineraries/Itinerary/PaxConfigurations/ PaxConfiguration/AppliedBonuses |
0..1 | Applied discounts. | |
@resident | 0..1 | Resident discount type | Resident discount type. |
@largeFamily | 0..1 | Large Family discount type | Large family discount type |
@discountCardCode | 0..1 | String | Discount card code. |
@discountCard | 0..1 | Discount Card type | Discount card type. |
Itineraries/Itinerary/PaxConfigurations/ PaxConfiguration/AppliedBonuses/ DiscountCards |
0..1 | Contains a list of DiscountCards. | |
Itineraries/Itinerary/PaxConfigurations/ PaxConfiguration/AppliedBonuses/ DiscountCards/DiscountCard |
1..n | DiscountCard details. | |
@type | 1 | Discount Card type | Discount card type. |
@code | 0..1 | String | Discount card code. |
@id | 0..1 | String | Unique identifier of discound card. |
Itineraries/Itinerary/PaxConfigurations/ PaxConfiguration/AppliedBonuses/ PaxTypeCodes |
0..1 | Contains a list of PaxTypeCodes. | |
Itineraries/Itinerary/PaxConfigurations/ PaxConfiguration/AppliedBonuses/ PaxTypeCodes/PaxTypeCode |
1..n | Contains the code type of the passenger. | |
@code | 1 | String | Code type of the passenger. |
Passengers | 1 | Contains a list of Passengers. | |
Passengers/Passenger | 1..n | Contains information of the Passenger. | |
@id | 1 | Integer | Unique identifier of the passenger. |
@title | 1 | Title type | Title type |
@name | 1 | String | Name of the Passenger. |
@surname | 1 | String | Surname/s of the Passenger. |
@bithDate | 1 | Date | Date of birth. Example: 2019-04-15T18:25:00 |
@codeDCO | 0..1 | Integer | Consolidate document number. |
@documentType | 0..1 | Document type | Document type. |
@documentId | 0..1 | String | Unique identifier of the documentation. |
@documentExpiration | 0..1 | Date | Expiration date of the documentation. Example: 2019-04-15T18:25:00 |
@documentExpedition | 0..1 | Date | Expedition date of the documentation. Example: 2019-04-15T18:25:00 |
@nationality | 0..1 | String | Nationality. ISO 3166-1 Alpha-2 Code |
@gender | 0..1 | Char | Gender. |
@language | 0..1 | String | Language. ISO 3166-1 alpha-2 format lowercase. |
Passengers/Passenger/PaxBonusDetails | 0..1 | Contains details of the Passenger bonus. | |
Passengers/Passenger/PaxBonusDetails/ AppliedBonuses |
0..1 | Contains details of the applied bonus. | |
@resident | 0..1 | Resident discount type | Resident discount type. |
@largeFamily | 0..1 | Large Family discount type | Large family discount type |
@discountCardCode | 0..1 | String | Discount card code. |
@discountCard | 0..1 | Discount Card type | Discount card type. |
Passengers/Passenger/PaxBonusDetails/ AppliedBonuses/DiscountCards |
0..1 | Contains a list of DiscountCards. | |
Passengers/Passenger/PaxBonusDetails/ AppliedBonuses/DiscountCards/ DiscountCard |
1..n | DiscountCard details. | |
@type | 1 | Discount Card type | Discount card type. |
@code | 0..1 | String | Discount card code. |
@id | 0..1 | String | Unique identifier of discound card. |
Passengers/Passenger/PaxBonusDetails/ AppliedBonuses/PaxTypeCodes |
0..1 | Contains a list of PaxTypeCodes. | |
Passengers/Passenger/PaxBonusDetails/ AppliedBonuses/PaxTypeCodes/ PaxTypeCode |
1..n | Contains the code type of the passenger. | |
@code | 1 | String | Code type of the passenger. |
Passengers/Passenger/PaxBonusDetails/ ResidentCityCode |
0..1 | String | If required, city code for the Spanish Resident discount (070407, PALMA DE MALLORCA). |
Passengers/Passenger/PaxBonusDetails/ LargeFamilyId |
0..1 | String | Spanish family id. |
Passengers/Passenger/PaxBonusDetails/ LargeFamilyCityCode |
0..1 | String | City code for the Spanish Family discount (070407, Islas Baleares). |
Passengers/Passenger/PaxBonusDetails/ ResidentCertificateId |
0..1 | String | Resident certification number. |
Passengers/Passenger/PaxBonusDetails/ DetailName |
0..1 | Passenger name expanded (more details). | |
Passengers/Passenger/PaxBonusDetails/ DetailName/name |
0..1 | String | Name. |
Passengers/Passenger/PaxBonusDetails/ DetailName/firstSurname |
0..1 | String | First surname. |
Passengers/Passenger/PaxBonusDetails/ DetailName/secondSurname |
0..1 | String | Second surname. |
Passengers/Passenger/PaxTickets | 0..1 | Contains a list of PaxTickets. | |
Passengers/Passenger/PaxTickets/PaxTicket | 1..n | Contains the details of the tickets relative to the passenger and the status of the applied bonuses. | |
@ticketNum | 1 | String | Unique id of the ticket. |
@ticketRef | 0..1 | String | Reference to a Ticket id. |
Passengers/Passenger/PaxTickets/ PaxTicket/DiscountStates |
0..1 | Contains a list of discount information status. | |
Passengers/Passenger/PaxTickets/ PaxTicket/DiscountStates/DiscountState |
1..n | Information of the applied bonuses. | |
@type | 1 | Discount type | Discount type |
@status | 1 | Discount status type | Discount status |
@numAttempts | 0..1 | String | Number of retry attempts for spanish resident validation. |
@code | 0..1 | String | Discount/Bonus associated code provided by the supplier. |
Passengers/Passenger/SpecialPetitions | 1 | Contains information of the bags, seats or other supplements requested by the passenger. | |
Passengers/Passenger/SpecialPetitions/ NumSuitcases |
0..1 | Number of bags requested by the passenger. | |
Passengers/Passenger/SpecialPetitions/ PaxBaggageInfos |
0..1 | Contains a list of PaxBaggageInfo. | |
Passengers/Passenger/SpecialPetitions/ PaxBaggageInfos/PaxBaggageInfo |
1..n | Specifies the luggage of the passenger. | |
@type | 1 | Baggage type | Baggage type |
@id | 1 | String | Baggage id. |
@code | 1 | String | Bag code. |
@weight | 0..1 | String | Weight. |
@reservationToken | 0..1 | String | Weight. |
@quantity | 0..1 | Decimal | Quantity. |
Passengers/Passenger/SpecialPetitions/ PaxBaggageInfos/PaxBaggageInfo/ References |
0..1 | Segment and Passenger references. | |
Passengers/Passenger/SpecialPetitions/ PaxBaggageInfos/PaxBaggageInfo/ References/SegmentReferences |
0..1 | Contains a list of segment references for the Baggage Type. | |
Passengers/Passenger/SpecialPetitions/ PaxBaggageInfos/PaxBaggageInfo/ References/SegmentReferences/ SegmentReference |
1..n | Segment reference. | |
@itineraryRef | 1 | Integer | Unique identifier of the Itinerary. |
@journeyRef | 1 | Integer | Unique identifier of the Journey. |
@segmentRef | 1 | Integer | Unique identifier of the Segment. |
Passengers/Passenger/SpecialPetitions/ PaxBaggageInfos/PaxBaggageInfo/ References/PaxReferences |
0..1 | Contains a list of passenger references for the Baggage Type. | |
Passengers/Passenger/SpecialPetitions/ PaxBaggageInfos/PaxBaggageInfo/ References/PaxReferences/ PaxReference |
1..n | Passenger reference. | |
@paxRef | 1 | String | Reference to the passenger. |
Passengers/Passenger/SpecialPetitions/ Optionals |
0..1 | Contains a list of supplements (food, pets, etc. Used also for baggage). | |
Passengers/Passenger/SpecialPetitions/ Optionals/Optional |
1..n | Optional element information for the reservation. | |
@id | 1 | String | Optional id. |
@type | 1 | Optional Element type | Optional element type |
@specialSupplementType | 1 | Special Supplement type | Special supplement type |
@code | 1 | String | Code. |
@quantity | 0..1 | Decimal | Quantity. |
@carrier | 0..1 | String | Carrier. |
@text | 0..1 | String | Free text. |
@reservationToken | 0..1 | String | Reservation token. |
@length | 0..1 | Decimal | Length. |
@width | 0..1 | Decimal | Width. |
@height | 0..1 | Decimal | Height. |
@weight | 0..1 | Decimal | Weight. |
@ownTransportation | 0..1 | Boolean | If true, the supplement includes own transportation cage. |
Passengers/Passenger/SpecialPetitions/ Optionals/Optional/ References |
0..1 | Segment and Passenger references. | |
Passengers/Passenger/SpecialPetitions/ Optionals/Optional/ References/SegmentReferences |
0..1 | Contains a list of segment references for the Optional. | |
Passengers/Passenger/SpecialPetitions/ Optionals/Optional/ References/SegmentReferences/ SegmentReference |
1..n | Segment reference. | |
@itineraryRef | 1 | Integer | Unique identifier of the Itinerary. |
@journeyRef | 1 | Integer | Unique identifier of the Journey. |
@segmentRef | 1 | Integer | Unique identifier of the Segment. |
Passengers/Passenger/SpecialPetitions/ Optionals/Optional/ References/PaxReferences |
0..1 | Contains a list of passenger references for the Optional. | |
Passengers/Passenger/SpecialPetitions/ Optionals/Optional/ References/PaxReferences/ PaxReference |
1..n | Passenger reference. | |
@paxRef | 1 | String | Reference to the passenger. |
Passengers/Passenger/SpecialPetitions/ Optionals/Optional/ Charge |
0..1 | Charge details of the optional. | |
@currency | 1 | String | Currency. |
@fixAmount | 0..1 | Decimal | Total fixed amount. |
@appliesFixAmount | 0..1 | Amount Applies To Type | The fixes amount application |
@minFixAmount | 0..1 | Decimal | Minimal fixed amount. |
@maxFixAmount | 0..1 | Decimal | Maximal fixed amount. |
@minAmountPercentage | 0..1 | Decimal | Minimal percentage amount. |
@maxAmountPercentage | 0..1 | Decimal | Maximal percentage amount. |
@percentage | 0..1 | Decimal | Total percentage amount. |
@percentageApplied | 0..1 | Amount Applies To type | The percentage amount application. |
Passengers/Passenger/SpecialPetitions/ Seating |
0..1 | Seating availability. | |
Passengers/Passenger/SpecialPetitions/ Seating/BlockRules |
0..1 | Contains a list of Block Rules. | |
Passengers/Passenger/SpecialPetitions/ Seating/BlockRules/BlockRule |
1..n | Block Rules. | |
Passengers/Passenger/SpecialPetitions/ Seating/BlockRules/BlockRule/References |
1 | References for the Block Rule. | |
Passengers/Passenger/SpecialPetitions/ Seating/BlockRules/BlockRule/References/ BlockReferences |
1 | Contains a list of references to block elements. | |
Passengers/Passenger/SpecialPetitions/ Seating/BlockRules/BlockRule/References/ BlockReferences/BlockReference |
1..n | Block element reference. | |
@blockTypeRef | 1 | Block Type | Block type: CABIN (The entire cabin of the plane). |
@blockRef | 1 | Integer | Block reference. |
Passengers/Passenger/SpecialPetitions/ Seating/BlockRules/BlockRule/References/ SegmentReferences |
0..1 | Contains a list of segment references for the Block Rule. | |
Passengers/Passenger/SpecialPetitions/ Seating/BlockRules/BlockRule/References/ SegmentReferences/SegmentReference |
1..n | Segment reference. | |
@itineraryRef | 1 | Integer | Unique identifier of the Itinerary. |
@journeyRef | 1 | Integer | Unique identifier of the Journey. |
@segmentRef | 1 | Integer | Unique identifier of the Segment. |
Passengers/Passenger/SpecialPetitions/ Seating/BlockRules/BlockRule/References/ PaxReferences |
0..1 | Contains a list of passenger references for the Special Supplement. | |
Passengers/Passenger/SpecialPetitions/ Seating/BlockRules/BlockRule/References/ PaxReferences/PaxReference |
1..n | Passenger reference. | |
@paxRef | 1 | String | Reference to the passenger. |
Passengers/Passenger/SpecialPetitions/ Seating/BlockRules/BlockRule/BlockPrice |
0..1 | Price element. | |
Passengers/Passenger/SpecialPetitions/ Seating/BlockRules/BlockRule/BlockPrice/ Amount |
0..1 | Amount by type. | |
@currency | 1 | String | Currency code of the amount. |
@amount | 1 | Decimal | Amount. |
@amountType | 0..1 | Amount type | Amount type. |
Passengers/Passenger/SpecialPetitions/ Seating/Blocks |
1 | Contains a list of seating blocks. | |
Passengers/Passenger/SpecialPetitions/ Seating/Blocks/Block |
1..n | Seating details. | |
@type | 1 | Block Type | Block type: CABIN (The entire cabin of the plane). |
@id | 1 | Integer | Unique id. |
Passengers/Passenger/SpecialPetitions/ Seating/Blocks/Block/References/ SegmentReferences |
1 | Contains a list of segment references for the Block. | |
Passengers/Passenger/SpecialPetitions/ Seating/Blocks/Block/References/ SegmentReferences/SegmentReference |
1..n | Segment reference. | |
@itineraryRef | 1 | Integer | Unique identifier of the Itinerary. |
@journeyRef | 1 | Integer | Unique identifier of the Journey. |
@segmentRef | 1 | Integer | Unique identifier of the Segment. |
Passengers/Passenger/SpecialPetitions/ Seating/Blocks/Block/Blocks |
1 | Contains a list of row blocks. | |
Passengers/Passenger/SpecialPetitions/ Seating/Blocks/Block/Blocks/Block |
1..n | Row block. | |
@type | 1 | Block Type | Block type: ROW |
@id | 1 | Integer | Unique row id. |
@number | 1 | Integer | Row number in the cabin. |
Passengers/Passenger/SpecialPetitions/ Seating/Blocks/Block/Blocks/Block/ Blocks |
1 | Contains a list of seat blocks. | |
Passengers/Passenger/SpecialPetitions/ Seating/Blocks/Block/Blocks/Block/ Blocks/Block |
1..n | Seat block. | |
@type | 1 | Block Type | Block type: SEAT. |
@id | 1 | Integer | Unique seat id. |
@number | 1 | String | Seat identifier. |
@token | 0..1 | String | Reservation seat token. |
Passengers/Passenger/SpecialPetitions/ Seating/Blocks/Block/Blocks/Block/ Blocks/Block/Availability |
0..1 | Availability of the seat. | |
@isAvailable | 1 | Boolean | Indicates whether the seat is available. |
Passengers/Passenger/SpecialPetitions/ Seating/Blocks/Block/Blocks/Block/ Blocks/Block/BlockAttributes |
0..1 | Contains a list of Seat attributes. | |
Passengers/Passenger/SpecialPetitions/ Seating/Blocks/Block/Blocks/Block/ Blocks/Block/BlockAttributes/ BlockAttribute |
1..n | Seat attribute. | |
@type | 1 | Block Attribute Type | Block Attribute type |
Client | 0..1 | Contains client’s information. | |
@name | 1 | String | Name. |
@surname | 1 | String | SurName. |
1 | String | eMail address. | |
@countryPrefix | 1 | String | Country telephone prefix. |
@telephone | 1 | String | Telephone number. |
@mobilephone | 1 | String | Mobile number. |
@fax | 0..1 | String | Fax. |
@passengerType | 0..1 | Title type | Title type |
Client/Address | 1 | Contains the client’s address. | |
@zipCode | 1 | String | Zip code. |
@countryCode | 1 | String | Country code. |
Client/Address/Street | 1 | String | Contains the street name of the address. |
Client/Address/City | 1 | String | Contains the locality. |
PaymentInfo | 0..1 | Contains the information of the payment. | |
@paymentType | 1 | Payment type | Payment type. |
PaymentInfo/PaymentDatas | 0..1 | Contains a list of payment data. | |
PaymentInfo/PaymentDatas/ PaymentData |
1..n | Contains details of the payment data. | |
@paymentType | 1 | Payment type | Payment type. |
PaymentInfo/PaymentDatas/ PaymentData/CardInfo |
1 | Contains details of the debit/credit card. | |
@provType | 1 | String | Card type (provider format, for instance MC -> MasterCard). Each provider configuration indicates the available card type formats. |
@number | 1 | String | Card number. |
@expirationMonth | 1 | String | Expiration month. |
@expirationYear | 1 | String | Expiration year. |
@holder | 0..1 | String | Holder. |
@cvv | 0..1 | String | Verification code. |
PaymentInfo/PaymentDatas/ PaymentData/InstalmentsNumber |
0..1 | Number of instalments. | |
PaymentInfo/PaymentDatas/ PaymentData/Amount |
0..1 | Contains a list of Amount. | |
PaymentInfo/PaymentDatas/ PaymentData/Amount/ Amount |
1..n | Amount by type. It is used to specify for example the Service Fees associated to a credit card. | |
@currency | 1 | String | Currency. |
@amount | 1 | Decimal | Amount. |
@amountType | 0..1 | Amount type | Amount Type. |
Locators | 0..1 | Contains a list of locators. | |
Locators/Locator | 1..n | Contains details of the locator. | |
Locators/Locator/Id | 1 | String | Unique identifier of the locator. |
Locators/Locator/Type | 1 | Locator type | The locator’s type |
0..1 | String | Client’s email. | |
DeltaPrice | 0..1 | Decimal | Maximum amount increasement allowed between valuation and reservation. |
SupplementsReservationRS Description
Element | Number | Type | Description |
---|---|---|---|
SupplementsReservationRS | 1 | Root node. | |
Locators | 0..n | Contains details of the locator. | |
Locator/Id | 1 | String | Unique identifier of the locator. |
Locator/Type | 1 | Locator type | The locator’s type |
Tickets | 0..1 | Contains a list of tickets associated to the booking. | |
Tickets/Ticket | 1..n | Contains the details of the ticket. | |
@ticketNum | 1 | String | Ticket number. |
@type | 1 | Ticket type | Ticket type |
@status | 1 | Ticket Status type | Ticket Status type |
@id | 0..1 | Integer | Unique identifier of the ticket. |
@paxName | 0..1 | String | Passenger name. |
@paxType | 0..1 | Passenger type | Passenger type based on the age of the passenger. |
@url | 0..1 | String | Url. |
Tickets/Ticket/PNRLoc | 0..1 | Provider Locator associated to a Booking. | |
@code | 1 | String | Locator code. |
Invoice | 1 | Detailed pricing information. | |
@carrier | 0..1 | String | Fare carrier. |
@agencyCode | 0..1 | String | Agency code. |
@instalmentsNumber | 0..1 | Integer | Number of instalments in which the amount will be charged to the credit card. |
@lastTicketingDateUTC | 0..1 | Date | Maximum date allowed to make the ticket emission (in UTC format if filled) Example: 2019-04-15T18:25:00+04:00 |
Invoice/AmountBreakdown | 1 | Breakdown of the fare amount. | |
@currency | 1 | String | Currency code of the fare. |
@totalAmount | 1 | Decimal | Total amount. with taxes and other charges included. |
@notCommissionableAmount | 0..1 | Decimal | Total amount that can not be commissioned. |
@commission | 0..1 | Decimal | Commission. |
Invoice/AmountBreakdown/ ChargeBreakdowns |
1 | Contains a list of breakdown amounts ( taxes, mandatory charges.. ). | |
Invoice/AmountBreakdown/ ChargeBreakdowns/ ChargeBreakdown |
1..n | Contains details of the BreakdownAmount. | |
@amount | 1 | Decimal | Charge amount. |
@type | 0..1 | Type of charge. | Type of charge. |
@included | 0..1 | Boolean | If true, the charge is included to the total fare amount. |
Invoice/AmountBreakdown/ ChargeBreakdowns/ ChargeBreakdown/Concept |
0..1 | Contains details of the charge. | |
@id | 0..1 | String | Unique id of the Concept. |
@language | 0..1 | String | Language. ISO 3166-1 alpha-2 format lowercase. |
@carrier | 0..1 | String | Carrier. |
@code | 0..1 | String | Concept code. |
Invoice/AmountBreakdown/ ChargeBreakDowns/ ChargeBreakdown/Concept/Text |
0..1 | String | Remarks |
Invoice/AmountBreakdown/ ChargeBreakDowns/ ChargeBreakdown/Concept/Paragraph |
0..n | Contains a list of Sentences and titles. | |
@title | 0..1 | String | Title. |
Invoice/AmountBreakdown/ ChargeBreakDowns/ ChargeBreakdown/Concept/Paragraph/ Sentence |
0..n | String | Sentence |