Reservation Retrieve API Reference

Top-level object for reservation details.

Generally includes the Identifier, Offer, Traveler, and ReservationDisplaySequence objects. Depending on the information in the reservation, may include Receipt, ReservationComment, PrimaryContact, and CustomAuxiliarySegment.

Key value pairs:

notificationDate: For held bookings, date by which the booking must be ticketed or the offer expires. HH:MM format (e.g., "notificationDate": "2023-07-11",). GDS only; not supported for NDC.

Identifier for Reservation object. Key value pairs:

authority: Returns the value Travelport.

value: Internal system-generated identifier.

Array. Each instance returns details about one offer on the reservation.

Key value pairs:

id: Internal short id for the offer.

For air, an offer could be the flight/s, seats, or a paid ancillary. Additional instances of Offer are returned by default if the booking includes hotel and/or car segments. The hotel and/or car segments must have been booked with the JSON Hotel APIs or JSON Car APIs (full release pending), or a terminal program. See the Multi-Content Booking Guide (Air, Hotel, Car).

For objects see the tables below for Offer object - Air, Offer object - Hotel, and Offer object - Car.

Array. One instance for each unique traveler on the reservation.

See Traveler objects table below.

Returned if form of payment has been added to this booking.

See FormOfPayment table below.

Returned if payment has been made for an offer in this booking.

See Payment table below.

Array. Returns confirmation details, including the booking locator code. May return multiple instances with @type values ReceiptConfirmation (for booking confirmations) or ReceiptPayment (for ticketed bookings).

See Receipt objects table below.

Any remarks added to the reservation.

See ReservationComment table below.

Any travel agency details added to the reservation. See Travel Agency Details.

Returned for a group booking, which are bookings with 10 or more passengers. Key value pairs:

unallocatedPlaces: totalGroupPlaces minus the number of passengers currently on booking.

totalGroupPlaces: Total number of passengers allowed on this booking.

id: Internal system-generated short id.

Includes the following objects:

Identifier: Standard object identifier with authority (usually Travelport) and value (system-generated identifiers).

GroupName: Name assigned to the group booking.

Creating group bookings is not supported in the JSON APIs and must be created with a separate program.

Show Example Group object

   "Group": {
    "@type": "Group",
    "unallocatedPlaces": 8,
    "totalGroupPlaces": 11,
    "id": "group_1",
    "Identifier": {
     "authority": "Travelport",
     "value": "b12f085a-c10c-4faa-bd02-aee0985d1522"
    },
    "GroupName": "PARISREUNION"
   },

Returned for special service requirements. Currently returned only for fare family brand codes that apply the SSR BFFF.

See SpecialService table below.

Any primary contact details for the reservation.

See PrimaryContact table below.

Returns any auxiliary segments on a booking. Auxiliary segments can include air taxi, cars, hotels, surface transportation, and tours. TUR (tour) or SUR (surface) segments are commonly used for rail content, but can be used for other ground transportation such as taxis, surface transportation and tours. This content cannot be booked in the JSON APIs but is returned in the reservation retrieve when booked through another Travelport platform or an external provider.

Includes the following objects:

Identifier:Standard Travelport internal identifier with authority and value.

SegmentType: Either TUR for tour or SUR for surface.

StatusCode: Status code for booking.

Quantity: Amount of this segment on the booking.

Location: Pickup location code.

Date: Start date of segment.

CustomText: Any custom text.

SupplierCode: Two-character provider/vendor code. May be returned as ZZ, the generic vendor code for a service provider in the Travelport system.

Show Example CustomAuxiliarySegment object

  {
     "@type": "CustomAuxiliarySegment",
     "id": "customAuxiliarySegment_1",
     "Identifier": {
      "authority": "Travelport",
      "value": "27222aa9-e49f-4b14-96b6-7ebfaac75f8b"
     },
     "SegmentType": "TUR",
     "StatusCode": "BK",
     "Quantity": 1,
     "Location": "RNO",
     "Date": "2024-11-26",
     "CustomText": "CF-08291647",
     "SupplierCode": "ZZ"
    }, 

Returned to provide the chronological (by date) order of all offers on the booking. If a booking includes car and/or hotel segments along with air segments, includes those offers. Returned for all reservations even if hotel/car content is not on the booking. See Multi-Content Booking Guide (Air, Hotel, Car) for more details.

Includes DisplaySequence object. May include AuxiliaryDisplaySequence.

One instance for each air, hotel, or car offer on the booking. Includes the following:

displaySequence: The segment number in the system. A value of 1 indicates this offer occurs first in the itinerary, 2 second, etc.

OfferRef: System-generated offer id for that offer; corresponds to the value in Offer/id.

ProductRef: System-generated product id that product; corresponds to the value in Offer/Product/id. Each hotel and car segment is returned as a single product. For air, each leg of the air itinerary is a single product. For example, a round-trip flight booking has two instances of DisplaySequence, each with a separate ProductRef value.

Sequence: Returned for air segments; the flight sequence number in the itinerary.

Array. Each instance returns details about one offer on the reservation. An offer could be flight/s on the itinerary, seats, or a paid ancillary.

Key value pair:

id: Internal short identifier for the offer.

Includes Identifier, ContentSource, Product, Price, TermsAndConditionsFull.

A seats offer returns seats details in the following:

id: Seat offer ID.

Product: Seat product details:

Ancillary: Includes FlightRef, which returns a flight identifier for the flight on which this seat is assigned.

SeatAssignment: The number of the selected seat for the flight in FlightRef.

Identifier for this offer in the following key value pairs; note that GDS offers return the value Travelport in authority while NDC offers return the carrier code of the issuing NDC carrier:

authority: Source of information.

value: Unique system-generated identifier.

String. Indicates whether the offer is from GDS or NDC. Supported values:

• GDS: The offer is from the Travelport GDS, as identified by the value Travelport in Identifier/authority (see preceding row).

• NDC: The offer is from the NDC carrier identified in Identifier/authority (see preceding row).

Array. Each instance returns details for one product on this offer. In the JSON APIs, for air, a product is one leg of the air itinerary, or it could be for seats or a paid ancillary. See Product table below.

Array. One instance for each product id.

Key value pairs:

totalDuration: Total time length of the segment in hours (H) and minutes (M).

id: Product id.

Includes Identifier, FlightSegment, and PassengerFlight objects.

Identifier information for this instance of Product.

authority: Source of information.

value: Unique system-generated identifier.

Array. One instance for each segment in the product.

Key value pairs:

id: Internal system-assigned short id for this segment.

sequence: Order of the sequence; e.g., 1 for the first segment on the leg.

boundFlightsInd: Boolean variable indicating segments are married/bound. When returned true, indicates the flight segments in a single or double connection must be sold together. When true, the indicator is returned for all leading segments on one leg of the flight, and not returned for the last segment of the bound flight leg journey, indicating where the bound flights end. For example, if an O&D pair has 3 flight segments, boundFlightsInd is returned for the first two segments on that leg. If the segments are not bound, boundFlightsInd is false and not returned. GDS only; not returned for NDC.

Includes Flight object.

Array. One instance for each flight in the product.

Key value pairs:

duration: Time of the flight in hours (H) and minutes (M).

carrier: Airline carrier.

number: Flight number.

operatingCarrier: When the carrier has filed a codeshare operating carrier for the flight, the IATA code for that codeshare carrier.

operatingCarrierName: Name of the marketing operating carrier.

equipment: Equipment model. Note that TRN, TRS, and BUS equipment codes indicate ground transportation.

id: id for internal flight reference number, also used in products and offers.

subjectToGovernmentApproval: Returned with value of true when an airline has filed in its schedule that availability for a specific flight is subject to government approval. GDS only, not supported for NDC. Returned only in the Search API response.

Identifier: Standard Travelport Identifier object with authority and value.

Includes Flight, Departure, and Arrival objects.

Departure details. Key value pairs are the location, date, time, and terminal of departure.

Arrival details. Key value pairs are the location, date, time, and terminal of arrival.

Returned if the flight has a technical stop but does not incur a change in flight number.

Key value pairs:

arrivalFlightDuration: Length in hours and minutes of the flight arriving at the stop.

departureFlightDuration: Length in hours and minutes of the flight departing the stop.

duration: Length in hours and minutes on the ground of the intermediate stop.

equipment: Equipment model, if there is a change of equipment during the stop.

arrivalDate: Arrival date for stop.

departureDate: Departure date of stop.

arrivalTime: Arrival time for stop.

departureTime: Departure time for stop.

arrivalTerminal: Arrival terminal for stop.

departureTerminal: Departure terminal for stop.

value: The code for the airport where the intermediate stop occurs.

Returns PTC and class/fare information for each PTC. One instance per PTC.

Key value pairs:

passengerQuantity: Number of passengers in that PTC from the request.

passengerTypeCode: The PTC code.

Includes the FlightProduct object.

Key value pairs:

segmentSequence: Order of the corresponding flight in the sequence.

classOfService: Class of service code.

cabin: Cabin class.

fareBasisCode: Fare basis code for the flight.

fareType: Indicates the fare type. Possible values are AirlinePrivateFare, AgencyPrivateFare, PublicFare, or NetFare (net fares are not supported for NDC).

TicketDesignator: String. NDC only.

Tour: String for tour code. NDC only.

TC note: Last 2 added per emails from Ana Meijia quiroz as supported for NDC, no definitions given.

Returns price details for the instance of Offer in which it is returned. Key value pair:

id: Short system-generated id for this price.

Includes Base, TotalTaxes, TotalFees, TotalPrice, CurrencyCode, and PriceBreakdown objects.

The currency in which the price is returned. Unless changed in the request, the currency is the default associated with your provisioned PCC from Travelport.

Key value pairs:

decimalPlace: Number of decimal places in the currency.

value: Currency code value.

Number. Base price for all passengers with this PTC before taxes and fees.

Number. Sum of all taxes for this price.

Sum of all fees in this price.

Array. Price breakdown by PTC, one instance returned for each PTC type. Amounts returned apply to one passenger with the PTC in this instance.

Key value pairs:

quantity: Number of passengers in that PTC.

requestedPassengerType The PTC to which the PriceBreakdown applies.

Includes the Amount object. For GDS may return FiledAmount, FareCalculation, and/or Commission per below. For NDC may return Discount per below.

Includes CurrencyCode (same as listed above), Base, Taxes, Fees, and Total objects.

Base cost for one passenger of this PTC type.

Includes TotalTaxes (sum of all individual taxes) and an array of Tax objects for individual taxes.

Sum total of all taxes for one passenger of this PTC type.

Array of Tax objects for individual taxes.

Key value pairs:

currencyCode: Currency code in which the value is returned.

taxCode: Code for the tax.

exemptInd: Returned if a tax was marked exempt in the Search, AirPrice, or Add Offer request with the TaxExemption pricing modifer. GDS only; not supported for NDC.

value: Amount of the tax. Returned as 0 if a tax was marked as exempt with TaxExemption per above.

description: Short summary of the tax. Note that descriptions are not returned for tax codes YQ and YR, which are fees charged by airlines and not government-imposed taxes.

Provides breakdown of fees, if applicable. Includes TotalFees object to return sum of any fees for that PTC. May include array of Fee objects to break down individual fees.

Array for individual fees, if applicable.

Key value pairs:

feeCode: The code for the fee, such as OB for OB fees.

description: Any description for that fee code.

text: The amount of the fee.

Total of base cost and all fees and taxes for one passenger of this PTC type.

Returned only in Reservation Retrieve to identify the traveler associated with this instance of PriceBreakdown in case of multiple offers on the booking.

Net ticket data (NTD) is returned in the AirPrice, AirReservation, Exchange Search, and Reservation Retrieve responses for any fare that has a private fare component (fareType is AgencyPrivateFare). When NTD is returned, TermsAndConditionsFuill includes FareGuaranteePolicy to return the fare calculation indicator for the fare.

When NTD is returned, PriceBreakdown may include NetBaseAmount.

Key value pairs:

currencyCode: Code for the currency in which this amount is returned.

decimalPlace: Number of decimal places in the currency.

value: Base amount.

Returned when the origin currency is not the same as the PCC currency to show the currency in which the base fare has been filed. The fare returned in PriceBreakdown/Amount (above) is the equivalent currency in the PCC currency.

Key value pairs:

currencyCode: Code for the currency in which the base fare was filed.

decimalPlace: Number of decimal places in the currency.

value: Amount of the base fare.

For each PTC, when available, FareCalculation returns the fare calculation ladder for all public and private fare types filed by an agency or an airline. Returned as a string with unlimited bytes.

Surcharges is returned in the Search response if surcharges apply to this offer.

Includes the following:

approximateInd: Surcharge amounts are approximate if true.

TotalSurcharges: Monetary amount of surcharge total, up to 4 decimal places.

Includes Surcharge object.

Returned in Surcharges.

Key value pairs:

currencyCode: Currency code surcharges are returned in.

purpose: Possible values:

decimalPlace: Number of decimal places in currency.

value: Amount of surcharge.

Any commission filed by an airline in a CAT35 fare is returned in PriceBreakdownAir/Commission. The amount is either a percent of the fare component (@type CommissionPercent and the Percent object) or an amount (@type CommissionAmount with Amount @value).

Provides applicable terms and conditions for air offers.

Key value pairs:

secureFlightPassengerDataRequiredInd: Returned only when true to indicate the airline requires additional passenger data for one or more travelers to complete the reservation per Secure Flight Passenger Data requirements. Returned for both GDS and NDC in AirPrice; returned only for GDS in Reservation Retrieve.

May include ExpiryDate, TextBlock, BaggageAllowance, ValidatingAirline, TicketingAgency, PaymentTimeLimit, TourCodes, FareRuleInfo, and Penalties objects.

The date and time the offer will expire and no longer be valid. 

Includes TextFormatted object.

Array. Returns free text terms and conditions.

The local (per the point of sale) date and time by which the offer must be ticketed. Not returned for a ticketed booking.

Array. If returned by the carrier, details about a specific type of baggage, or if a baggage embargo is in effect.

The baggage allowance is displayed by baggage type with associated conditions (max pieces, weight, and unit of weight) and charges (fee with currency code), if applicable.

Key value pairs, returned as available:

url: Link to additional baggage policy information.

passengerTypeCodes: PTC/s to which this baggage allowance applies.

SegmentSequenceList: Segment/s on which this baggage allowance applies.

baggageType: Type of baggage to which this allowance applies. Possible values are FirstCheckedBag, SecondCheckedBag, AdditionalBags, CarryOn, BaggageEmbargo.

May include BaggageItem.

As returned by the carrier, baggage allowance details.

Key value pairs:

quantity: The number of baggage items allowed. Not returned for baggage allowances provided in kilograms (BaggageItem/Measurement/unit = Kilograms.)

The following baggage indicators are returned as applicable in AirPrice with Air Offer 25.11.53 and later, and in AirReservation 25.11.59 and later if the Reservation Retrieve request sends detailViewInd and viewBaggageDetailInd as true:

includedInOfferPrice: String. Possible values:

• Yes: Baggage is included in the price.

• No: Baggage is not included in the price; available for an additional charge.

• Unknown: Unknown if baggage is included in the price.

soldByPieceInd: Boolean. Returned only if true. Indicates baggage allowance is by piece, such as one, two, or three pieces.

soldByWeightInd: Boolean. Returned only if true. Indicates the baggage is allowed by weight, either kilograms or pounds, such as 50 pounds or 35 kilograms.

Depending on the information returned by the carrier, may include the Measurement, BaggageFee, Text objects.

For paid baggage, cost for this item of baggage:

code: Currency code for cost.

approximateInd: Boolean; true indicates the charge is approximate, false indicates the charge is an exact price.

value: Cost of baggage in currency code above.

Text string providing measurements for the allowed baggage dimension; for example, UPTO50LB/23KG AND UPTO62LI/158LCM.

Measurement details for BaggageItem as applicable and available.

Key value pairs:

measurementType: Type of measurement specified, such as weight, height, width, etc.

unit: Unit in which measurement is specified, such as Kilograms, Inches, Centimeters, etc.

value: The number of units allowed for this measurement type.

Net ticket data (NTD) is returned in the AirPrice, AirReservation, Exchange Search, and Reservation Retrieve responses for any fare that has a private fare component (fareType is AgencyPrivateFare). When NTD is returned, TermsAndConditionsFuill includes FareGuaranteePolicy to return the fare calculation indicator for the fare.

Includes Code object.

Key value pairs:

value: Quote type; 1 byte and alpha only from A to Z.

• A: Airline Private Fares are autopriced. Guaranteed quote with a fare that was filed with a fare distributor (ATPCO, SITA, etc.).

• B: Built (Manual Fare) on Galileo.

• C: Computer generated, not guaranteed. (Used when YY sectors are included or there is a ticket time limit within hours after reservation is made.)

• G: Computer generated and guaranteed quote (autopriced by Galileo).

• H: Host Airline. The filed fare was created as a result of the Claim PNR type function which transfers data from an airline system to Galileo for ticketing purposes.

• I: Invalidated. Caused by a change to the flight segments contained in the filed fare.

• M: Manipulated (manual fare). For example, pricing modifier(s) may have been used, such as ManualFareAdjustment. Not guaranteed.

• N: Outside of IATA Europe, the guarantee policy is 'guaranteed at time of ticket issue '. (When a 'G' status is not ticketed by midnight local time of the CRT location where the fare was originally stored, the status indicator changes to N and is not guaranteed.)

• P: Agency private fare. Not guaranteed. For example, if an airline private fare was manipulated such as if a pricing modifier was used. Agency private fares and airline private fares are autopriced in the same fare quote. Airline private fares are autopriced but have an 'hours' code for ticket time limit after reservation.

• R: Restored (after ticket was issued).

• T: Ticketed (used in the historical record to indicate ticketed).

• U: Un-ticketable. Applies when there is insufficient or corrupted data.

• X: Expired filed fare, not guaranteed.

• Z: Agency private fare was used with no rules override. Guaranteed.

Top level object. includes ValidatingAirline.

String. The code for the carrier on which the ticket is issued.

If TicketingPCC was sent in an AirPrice request to override the default ticketing agency, TicketingAgency returns the PCC of the overriding agency. Not returned if no override request was made.

GDS only; not supported for NDC. Includes Code and ProductRef objects.

PCC of the overriding or default ticket agency.

Product references to which this ticketing agency PCC applies.

If PricingPCC was sent in an AirPrice request to override the default pricing agency, PricingAgency returns the PCC of the overriding agency. Not returned if no override request was made.

GDS only; not supported for NDC. Includes Code object.

PCC of any overriding pricing agency.

Returned in the Reservation Retrieve if requested with the fareRuleType query parameter. Returns fare rules in an array of objects in FareRuleInfo.

Key value pairs:

flightsRefs: Identifies the flight/s to which the fare rule applies.

May include TextFareRule objects.

Array. Returns the name and text of the rule itself:

name: The name of the rule.

value: The freeform text of the rule.

Returns change and cancel penalties for this set of terms and conditions. For GDS, Penalties returns CAT16 penalty details; NDC penalty rules are not necessarily filed in a specific category (CAT).

Includes the PassengerTypeCodes object and either or both the Change and Cancel objects.

Returned in Penalties object with type ChangePermitted if a change is permitted after booking.

Key value pairs:

penaltyTypes: Type of penalty that applies to change. Supported values:

• BeforeDeparture

• AfterDeparture

• Anytime

• NoShow

• Minimum

• Maximum

• ExchangeRequired

• ExchangeNotRequired

Includes PenaltyAppliesTo and Penalty objects.

Returned in Penalties object with type CancelPermitted if a cancellation is permitted after booking.

Key value pairs:

penaltyTypes: Type of penalty that applies to cancellation. Supported values:

• BeforeDeparture

• AfterDeparture

• Anytime

• NoShow

• Minimum

• Maximum

• ExchangeRequired

• ExchangeNotRequired

Includes PenaltyAppliesTo and Penalty objects.

Returned in Change and Cancel objects to specify what the change or cancel penalty applies to. Supported values:

• OneWay

• RoundTrip

• PerTicket

• PerCoupon

• PerDirectionOfTravel

Returns ProductRefs, PenaltyAppliesTo, Penalty objects.

Returned in Change and Cancel objects to specify either a percentage or amount for a change or cancel penalty.

Penalty @type PenaltyPercent returns the following:

Percent: Percent of fare charged for the penalty.

Penalty @type PenaltyAmount returns the following:

Amount: Amount of penalty fee:

code: Currency code for the penalty.

minorUnit: Minor unit places of currency.

value. Amount of penalty in the currency code above.

Array. Each instance returns details about one offer on the reservation.

Key value pairs:

id: Internal short id for this offer.

Includes Identifier, Product, Price, and TermsAndConditionsFull objects.

Identifier for this offer with the following key value pairs:

authority: Source of information.

value: Unique system-generated identifier.

Array. One instance for each product on the booking. Hotel content is returned with @type ProductHospitality.

Key value pairs:

bookingCode: Hotel booking code.

propertyName: Name of property offering this product. .

guests: Number of guests on reservation.

adaCompliant: Yes/No for ADA compliance.

id: System-assigned product id.

Includes Identifier, Quantity, PropertyKey, RoomType, Email, DateRange, TravelerContact, PropertyAddress, and Telephone objects.

Identifier information for this instance of Product.

authority: Source of information.

value: Unique system-generated identifier.

Number of rooms in Product.

Property code details in the following key value pairs:

chainCode: Chain code for the property

propertyCode: Property code for the property.

Room type detail. Key value pairs:

numberOfUnits: The number of rooms combined to create this room type.

reqdGuaranteeType: Denotes the form of guarantee for this room.

Includes the RoomCharacteristics, Description, and RoomAmenity objects.

Room details. Key value pairs:

category: Category of the room.

smokingAllowed: Yes or No indicator for smoking.

wifiIncluded: Yes or No indicator for wifi.

nonSmokingInd: true or false indicator for non-smoking.

Includes BedConfiguration object.

Configuration of bed(s) in room. Key value pairs:

quantity: Number of beds in the room.

size: Size of bed(s) in the room.

bedType: Bed type values as follows:

• FUTON 200
• KING 58
• QUEEN 86
• TWIN 113
• TATAMI 202
• SOFA 102
• ROLLAWAY 91
• MURPHY 201
• CRIB 26
• WATERBED 195
• FULL 249
• ROUND 250

Room description. Key value pairs:

value: String for room description text (e.g. Save 15 Pct Off Studio King Suite Full Breakfast:Free WiFi:32in TV).

Email address for hotel contact.

Check-in and -out dates.

Key value pairs:

start: Check-in date in YYYY-MM-DD format.

end: Check-out date in YYYY-MM-DD format.

Contact details.

Address of the property in standard AddressLine, City, StateProv, Country, Postal Code objects.

Standard telephone object.

Price details for the hotel offer.

Includes CurrencyCode, Base, TotalPrice, and PriceBreakdown objects.

Currency code for this price.

decimalPlace: Number of decimal places in this currency.

codeAuthority: Currency code.

Number. The base cost of the hotel offer per night before any taxes and fees.

Number. The total price of the hotel offer for all nights and including any taxes and fees.

Hotel segment price breakdown. The objects and information returned can vary by provider and location.

Key value pairs:

roomPricingType: String. Pricing type, such as Per night or Per stay.or per stay.

priceChangesDuringStayInd: Boolean. If true the rate changes during the stay.

ratePlanCode: Any negotiated rate code/s returned.

If roomPricingType = Per night, the amounts in PriceBreakdown apply to a nightly rate, and the NightlyRate object is returned:

NightlyRate: Number of nights per stay in nights.

If roomPricingType = Per stay, the amounts in PriceBreakdown apply to the entire hotel stay, and Description is returned:

Description: A rate description text string, e.g., Advance Purchase-Ro-Free WiFi.

Amount for hotel segment.

approximateInd: Boolean; true indicates this is a calculated value; false indicates this is the value returned by the property.

CurrencyCode: Same as above.

TotalRate: Total for hotel segment, either per night or per stay per above.

Terms and conditions for this offer.

Depening on available information, may include CustomerLoyalty, TextBlock, Guarantee, CancelPenalty, AcceptedCreditCard, Description, DepositPolicy, and/or RatePaymentInfo objects.

Customer loyalty / frequent traveler program details. Key value pairs:

• supplierType: Type of customer loyalty program such as hotel.

• value: customer loyalty number value.

Any applicable terms and conditions text information.

The terms and conditions applicable to that CatalogOffering.

Includes the following attribute:

Includes Guarantee, CancelPenalty, AcceptedCreditCard, Description, MealsIncluded, and ProductRateCode Info objects.

If sent by the provider, Guarantee indicates whether payment is required to hold the room. Key value pairs:

• code: Any guarantee code.

• type: Type of guarantee. Possible values include:

  • GuaranteeRequired: A credit card number is required for reservation but will not be charged.

  • DepositRequired: A deposit is charged to a credit card to make a reservation.

  • PrepayRequired: The entire amount for the stay is charged to the credit card to make a reservation. This amount is usually nonrefundable.

Cancellation penalty details.

Includes Deadline and HotelPenalty objects.

Cancellation penalty deadline details including attribute:

Includes SpecificDate, Time, and Refundable.

Details on cancellation penalty. Key value pairs:

• specific: Date in YYYY-MM-DD format.

• duration: Duration from start date.

• durationUnit: Duration measurement unit in elapsed time or day of the week. Possible values include:

• Minutes
• Hours
• Days
• Months
• SUN
• MON
• TUES
• WED
• THU
• FRI
• SAT

The deadline time in 24-hour HH:MM:SS format.

Cancellation penalty as either an amount or percentage.

Array. One instance for each accepted credit cards. Key value pair:

• value: Two-character code of credit card type.

Text strings for room and rate descriptions.

The following meal indicators are returned as true if applicable:

• breakfastInd
• lunchInd
• dinnerInd

Top-level object. 

Includes RateCodeInfo.

Rate code information. Key value pairs:

• value: The negotiated rate plan code.

• rateName: Name of the rate plan.

• rateID: ID of the rate plan associated with the negotiated rate plan code.

• rateCategory: OTA rate category code. Possible values include:

  • Military
  • Convention
  • Credential
  • Weekly
  • Association
  • All
  • FamilyPlan
  • Club
  • Monthly
  • RackGeneral
  • FullInclusive
  • Promotional
  • Government
  • Industry/TravelAgentRate
  • PrePaid
  • Weekend
  • Corporate
  • Mutli-DayPackage
  • Tour
  • Employee
  • MultLevel/Negotiated/Secure
  • Package
  • Other
  • Leisure
  • VIP
  • SeniorCitizen

Deposit policy details.

Array. Each instance returns details about one offer on the reservation.

Key value pairs:

id: Internal short id for this offer.

Includes Identifier, Product, and Price objects. May include TermsAndConditionsFull.

Identifier for this offer with the following key value pairs:

authority: Source of information.

value: Unique system-generated identifier.

Array. One instance for each product on the booking. Car content is returned with @type ProductVehicle.

Key value pairs:

id: System-assigned product id.

Includes Identifier, Quantity, and Vehicle objects.

Identifier information for this instance of Product.

authority: Source of information.

value: Unique system-generated identifier.

Number of cars in Product.

Vehicle details in the following key value pairs:

doorCount: Text string for door type and count.

airConditioningInd: Boolean indicator for air conditioning; true indicates car has air conditioning.

Includes VehicleMakeModel, TransmissionTypeCode, VehicleCategoryCode, FuelTypeCode, VehicleSizeCode, and VehicleDateLocation objects.

Vehicle make and model codes:

code: Code for this vehicle make and model.

vendorCode: Code for make and model used by vendor.

Vehicle transmission type details:

codeContext: Source of value, usually ACRISS.

value: Code for vehicle fuel type.

Vehicle category details:

codeContext: Source of value, usually ACRISS.

value: Code for vehicle fuel type.

Vehicle fuel type details:

codeContext: Source of value, usually ACRISS.

value: Code for vehicle fuel type.

Vehicle category details:

codeContext: Source of value, usually ACRISS.

value: Code for vehicle size.

Pickup and dropoff details. Includes RentalPickup and RentalReturn objects.

Details about the rental pickup.

date: Vehicle pickup date in YYYY-MM-DD format.

time: Vehicle pickup time in HH:MM:SS format.

Includes VendorLocation.

Vendor location pickup details including rentalLocationNumber, rentalLocationName, and code (the IATA three-letter airport code or a 6-character location code, e.g., FRAT01).

Details about the rental dropoff.

date: Vehicle dropoff date in YYYY-MM-DD format.

time: Vehicle dropoff time in HH:MM:SS format.

VendorLocation: Vendor location dropoff details including rentalLocationNumber, rentalLocationName, and code (the IATA three-letter airport code or a 6-character location code, e.g., FRAT01).

Price of car offer.

Includes CurrencyCode and PriceBreakdown objects.

Currency code for this price.

decimalPlace: Number of decimal places in this currency.

value: Currency code.

Vehicle price breakdown. Objects and data returned may vary by vendor and location.

Includes RateDistance, ApproximateRate, and RateQualifier objects.

Rate costs by distance:

allowance: Returned when distance is limited with this rate; the number of distance units allowed in this rate.

unlimitedDistanceInd: Returned if true to indicate unlimited distance is allowed.

distanceUnits: Units of the distance allowed, such as Miles or Kilometers.

ratePeriod: Duration in which the allowance can be used.

Returned if vehicle rate is approximate. Includes BaseRate.

Base vehicle rate if approximate. Key value pairs:

code: Currency code base rate is returned in value.

approximateInd: Returned as true if base rate is approximate.

value: Approximate amount of base rate.

String for rate qualifier.

Any rate code applicable to this rental. Includes RateCodeInfo.

Array. Returns one instance for each passenger on the reservation. Includes all traveler information sent in the Add Traveler request and certain additional traveler details sent in Remarks. Some traveler details can also be added as part of Reservation Modify.

Key value pairs:

passengerTypeCode: The PTC code.

birthDate: Passenger date of birth in YYYY-MM-DD format.

gender: Returned if minimum secure flight information was sent. Supported values are Male, Female, Unknown.

id: Short system-generated traveler id.

Includes Identifier. May include PersonName, Address, Telephone, Email, CustomerLoyalty, and TravelDocument.

System-generated traveler reference details.

Key value pairs:

authority: Source of information.

value: Unique system-generated identifier.

Returned only if a seat or seats were booked for this traveler.

Includes TravelerRef, OfferRef, ProductRef, and ConfirmationStatusEnum.

Id for the traveler for this seat offer; also in Traveler/id.

Id for the seat offer; also in Offer/id.

Id for the product offer; also in Offer/Product/id.

Returned if Form Of Payment (FOP) has been added to the booking. Always returned if the itinerary has been ticketed.

Key value pairs:

id: User-assigned custom ID sent with the Add Form of Payment request.

Includes Identifier object.

Payment details if Payment has been added. Always returned if the itinerary has been ticketed.

Key value pairs:

id: User-assigned custom ID sent with the Add Payment request.

User-assigned value sent with the Add Payment request.

System-generated identifier values for this payment.

Key value pairs:

authority: Source of information.

value: Unique system-generated identifier.

Payment amount details.

Key value pairs:

code: Code of currency in which payment was made.

minorUnit: The smallest unit of currency for the currency in code. For example; the smallest denomination in USD is the cent, which is 1/100 of a USD, and the minor unit value is 2. Not all currencies have a minor unit.

value: Amount of the payment made.

Top level object to identify the form of payment to which this payment was charged.

Includes FormOfPaymentRef and Identifier.

Array. Each instance represents the status of one reservation.

Instances of Receipt @type ReceiptConfirmationapply to the booking.

Includes Identifier and Confirmation.

Internal system-generated identifier for this receipt confirmation.

Key value pairs:

authority: Source of information.

value: Unique system-generated identifier.

Returned for all reservations both before and after ticketing.

Confirmation details.

Includes Locator. May include OfferStatus.

The reservation locator code issued for this booking. All bookings return this unique alphanumeric identifier. Must be sent in several other transactions.

Key value pairs:

source: The issuer of this locator code, either Travelport or the carrier code.

creationdate: Booking date of the reservation in local time.

value: The reservation locator code.

Returns segment confirmation details.

Array. Each instance applies to one traveler on one ticket.

Instances of Receipt @type ReceiptPaymentapply to the ticket and are returned only after an itinerary has been ticketed.

Key value pairs:

dateTime: Date and time stamp when receipt issued.

id: Internal identifier for receipt.

Includes ReceiptRef, Identifier, OfferRef, PaymentIdentifier, and Document objects.

Internal Identifier for receipt.

System-generated internal Identifier for receipt. Key value pairs:

authority: Returns the value Travelport.

value: Internal system-generated identifier for the response.

Array. String/s with the offer reference id to which this receipt applies.

Identifier for the payment used for the ticket. This is the user-assigned value sent in Add Payment.

Array. Top level object for ticket details for one passenger. Key value pairs:

historicInd: Boolean. Returned for exchanged tickets to indicates ticket has been exchanged. 

Notes on Document @type values

Any EMDs are returned with a Document @type value of either DocumentEMD for open EMDs or DocumentEMDRefund for refunded EMDs, plus the EMD number (in Number object), the traveler to which that EMD applies (in TravelerIdentiferRef), the amount (Amount), and a description of the EMD in EMDDescription.

If the ticket has been exchanged, the previous (exchanged) tickets are returned with Document @type DocumentTicketExchange. The newly issued tickets are returned with Document @type DocumentTicket.

The Document @type value DocumentMCO returns the MCO number for any exchanged ticket that has an MCO associated with it. (An MCO (miscellaneous change order) is created for any exchanged ticket that has residual value remaining after the exchange.)

The following Document @type values indicate a ticket status.

Ticket number.

Identifier for traveler on ticket. Key value pairs:

passengerTypeCode: PTC of passenger.

id: Short traveler identifer.

value: System-generated traveler identifier.

Details on ticket price in the following standard model objects:

CurrencyCode: Currency code amounts are returned in.

Base: Base price before taxes and fees.

Taxes: Includes TotalTaxes to sum all taxes and an array of Tax objects for individual taxes.

Total: Total price for this passenger.

PCC that issued the ticket.

Returned for specific SSRs (special service requirements). Currently returned only for fare family brand codes that apply the SSR BFFF.

Key value pairs:

id: System-generated id for this requirement.

For SSR BFFF, includes Identifier, AppliesTo, Status, TravelerIdentifierRef, SSRCode, FreeText, and Quantity objects.

Show Example SpecialService object for SSRCode BFFF

            "SpecialService": [
                {
                    "@type": "SpecialServiceRequirement",
                    "id": "SpecialService_1",
                    "Identifier": {
                        "authority": "Travelport",
                        "value": "eabe7fdd-86f3-4c0f-8c2c-425312716ba0"
                    },
                    "AppliesTo": {
                        "@type": "AppliesToOfferProductSegment",
                        "OfferIdentifier": {
                            "offerRef": "offer_1"
                        },
                        "ProductIdentifier": {
                            "productRef": "product_1"
                        },
                        "SegmentSequenceList": [
                            1
                        ]
                    },
                    "Status": {
                        "value": "Confirmed"
                    },
                    "TravelerIdentifier": {
                        "TravelerRef": "travelerRefId_1",
                        "Identifier": {
                            "authority": "Travelport",
                            "value": "1e3ca199-9b77-45b3-b16f-e4dd05d5d99a"
                        }
                    },
                    "SSRCode": "BFFF",
                    "FreeText": "AV/CLASSIC",
                    "Quantity": 1
                },
                {
                    "@type": "SpecialServiceRequirement",
                    "id": "SpecialService_4",
                    "Identifier": {
                        "authority": "Travelport",
                        "value": "7776a4bd-a1ab-48b9-97ed-200972b48620"
                    },
                    "AppliesTo": {
                        "@type": "AppliesToOfferProductSegment",
                        "OfferIdentifier": {
                            "offerRef": "offer_1"
                        },
                        "ProductIdentifier": {
                            "productRef": "product_2"
                        },
                        "SegmentSequenceList": [
                            2
                        ]
                    },
                    "Status": {
                        "value": "Confirmed"
                    },
                    "TravelerIdentifier": {
                        "TravelerRef": "travelerRefId_2",
                        "Identifier": {
                            "authority": "Travelport",
                            "value": "31dade09-2fb9-4dce-9a9f-8db05463d0fa"
                        }
                    },
                    "SSRCode": "BFFF",
                    "FreeText": "AV/CLASSIC",
                    "Quantity": 1
                }
            ],

Standard Travelport identifier for this special service in the following key value pairs:

authority: Source of information.

value: Unique system-generated identifier.

The offer, product, and/or segment this special service requirement applies to. Includes OfferIdentifier, ProductIdentifier, and SegmentSequenceList objects.

Key value pairs:

value: String. Supplier-provided text for the status of the special service.

Identifiers for the traveler this special service requirement applies to. Includes TravelerRef and Identifier objects.

Text value of SSR code.

String. Supplier-provided text describing the special service.

If OSI, notepad, vendor, or itinerary remarks were added during the reservation workflow, those comments are returned by default in ReservationComment. Comments from carriers may also be returned in ReservationComment per the example below.

Note the following:

• Notepad and OSI remarks are returned with a value of Agency in ReservationComment/commentSource.

• Vendor comments are returned with a value of Supplier in ReservationComment/commentSource.

• For ticketless carriers the value Ticketless is returned in Comment/name.

Key value pairs:

commentSource: Source of the comment.

shareWith: Indicates other recipients of comment.

Includes Comment object.

Show Example ReservationComment

    "ReservationComment": [
    {
    "@type": "ReservationComment",
    "commentSource": "Supplier",
    "shareWithSupplier": [
        "NK"
    ],
    "Comment": [
        {
        "name": "Ticketless",
        "value": "VIXXXXXXXXXXXX5550/D0422/RAMA SARAVANA"
        },
        {
        "name": "Ticketless",
        "value": "ADTK1GTONK ON/BEFORE 20JUN 1023Z OTHERWISE WILL BE XLD"
        },
        {
        "name": "Ticketless",
        "value": "MOST FARES EXCL GOV FARES REQUIRE TKT WITHIN 24 HRS"
        },
        ]
      }
    ],

Primary contact details.

Key value pairs:

• shareWith: Indicates other recipients of comment.
• id: Custom id for the contact details.

If flight amenities were requested (includeFlightAmenitiesInd=true), the response returns ReferenceLIstAmenity to list all available amenities across all flights.

Array. One instance for each specific amenity.

Key value pairs:

id:Travelport-assigned amenity id used for cross-referencing by each flight with this amenity.

Includes Category and Text objects.

String. The flight amenity category.

Flight amenity categories are as follows and may include the following data as provided by ATPCO:

• Aircraft: cabin pressure, model and type

• Beverage: alcoholic and non-alcoholic beverages and whether available for a fee or free; highlights premium beverages in business/first

• Entertainment: passenger entertainment options

• Flight: airline flight schedules and equipment types with the associated amenities ID for each carrier

• Food: food per flight and flight cabin and whether available for a fee or free; food is classified as breakfast, lunch, dinner, snacks, and light meals, and as premium when available in business/first

• Layout: seating layout such as classic layouts to premium cabin configurations

• Power: availability of AC power outlets, USB ports, or both

• Seat: physical seat type for every sub fleet in every cabin of the aircraft, including legroom, pitch, width, flatness and type. Note that seat metrics are returned in centimeters because the default language is English.

• WiFi: availability, type, coverage, rollout, performance, and whether available free or for a fee