# Document History

Endpoint: POST /documents/history
Version: 11.35.2
Security: bearerAuth

## Header parameters:

  - `TraceId` (string)
    Identifier used to correlate Air API invocations across a multi-call business flows.

  - `XAUTH_TRAVELPORT_ACCESSGROUP` (string)
    Identifies the Travelport access group with which the caller is associated

  - `travelportPlusSessionIdentifier` (string)
    travelportPlusSessionIdentifier used to maintain an established agency session

  - `TVP-PCC-Core` (string)
    Allows user to pass PCC instead of Access Group ID

## Request fields (application/json):

  - `locator` (string)
    For GDS locator max length is 6.
    Example: ZXG25P

  - `documentNumbers` (array)

  - `documentNumbers.number` (string, required)
    The document number.
    Example: 0019900123456

  - `documentNumbers.numberOfConjunctiveTickets` (integer)
    Example: 2

  - `documentNumbers.documentType` (string, required)
    Enum: "TKT", "EMD", "MCO", "INV", "TASF"

## Response 200 fields (application/json):

  - `DocumentHistoryResponse` (object)
    Full document history display of a ticket or invoice.

  - `DocumentHistoryResponse.documentHistories` (array)

  - `DocumentHistoryResponse.documentHistories.number` (object)
    The document number with the type of document

  - `DocumentHistoryResponse.documentHistories.number.number` (string, required)
    The document number.
    Example: 0019900123456

  - `DocumentHistoryResponse.documentHistories.number.numberOfConjunctiveTickets` (integer)
    Example: 2

  - `DocumentHistoryResponse.documentHistories.number.documentType` (string, required)
    Enum: "TKT", "EMD", "MCO", "INV", "TASF"

  - `DocumentHistoryResponse.documentHistories.issueDateTimeUTC` (string)
    The issue date time of the document in GMT.
    Example: 2025-05-11T15:30:00Z

  - `DocumentHistoryResponse.documentHistories.issuingGTID` (string)
    The issuing terminal ID.
    Example: CCCDBA

  - `DocumentHistoryResponse.documentHistories.issuingAgent` (string)
    The document issuing agent initials.
    Example: TW

  - `DocumentHistoryResponse.documentHistories.issuingPseudoCityCode` (string)
    The document issuing pseudo city code.
    Example: XS4

  - `DocumentHistoryResponse.documentHistories.issuingIATA` (string)
    The document issuing IATA number.
    Example: 99999992

  - `DocumentHistoryResponse.documentHistories.issuingAgencyName` (string)
    The name of the issuing agency.
    Example: ABC Travel

  - `DocumentHistoryResponse.documentHistories.issuingAgencyLocation` (string)
    The city location of the issuing agency.
    Example: AMS

  - `DocumentHistoryResponse.documentHistories.countryCode` (string)
    ISO Code of a Country.
    Example: GB

  - `DocumentHistoryResponse.documentHistories.travelportLocator` (object)
    Locator information for the reservation. Contains the locator (PNR or external locator) or cancellation number for the reservation, order, or offer.

  - `DocumentHistoryResponse.documentHistories.travelportLocator.value` (string)
    Reference number for locatorType.  
Booking.com returns a PIN number along with the confirmation number for each sold hotel segment. If the agent/traveler needs to reconcile the booking with Booking.com, Booking.com requires both the PIN number and confirmation number to locate the segment in their system.
    Example: ZXG25P

  - `DocumentHistoryResponse.documentHistories.travelportLocator.locatorType` (string)
    Specifies the type of reservation ID
Travelport - Confirmation number; PNR locator Agency - IATA Number Booking.com - Confirmation number; PIN number
In Document History, may return the content source (e.g. GDS or NDC)
    Example: Confirmation Number

  - `DocumentHistoryResponse.documentHistories.travelportLocator.source` (string)
    Content source. Typically a two-character Supplier code that indicates the source system which generated the resid.  
For Hotels, if source matches chain code, the offer is directly with the supplier. If source is 'BO', the offer is with Booking.com.
    Example: 1G

  - `DocumentHistoryResponse.documentHistories.travelportLocator.sourceContext` (string)
    Specifies the context of the source. Either Travelport, Agency, or Supplier.
    Example: Travelport

  - `DocumentHistoryResponse.documentHistories.travelportLocator.otaType` (string)
    Used for codes
    Example: 14.UIT

  - `DocumentHistoryResponse.documentHistories.travelportLocator.creationDate` (string)
    Date created in Travelport or supplier system in YYYY-MM-DD format.
    Example: 2026-03-01

  - `DocumentHistoryResponse.documentHistories.travelportLocator.lastUpdated` (string)
    The date and time stamp the Reservation was last updated.
    Example: 2026-08-07T12:12:00Z

  - `DocumentHistoryResponse.documentHistories.orderID` (string)
    The NDC Order ID.
    Example: AB081H5MRTUA7

  - `DocumentHistoryResponse.documentHistories.name` (string)
    The name of the traveler the document is issued for
    Example: SMITH/JOHNMR

  - `DocumentHistoryResponse.documentHistories.passengerTypeCode` (string)
    Passenger type code
    Example: CHD

  - `DocumentHistoryResponse.documentHistories.passengerComments` (object)
    Comments object to relay free text information  
In ProductAncillary.Ancillary this is used to expose when additional comments are required to book the ancillary.  
In BuildAncillaryOffersFromCatalogOfferings this is used to pass additional ancillary text required to book the ancillary.  
In Traveler this is used to send custom freeform traveler name remarks, such as a unique identifier for a given traveler. Not supported for addition/deletion in Traveler Modify.

  - `DocumentHistoryResponse.documentHistories.passengerComments.@type` (string)
    Example: Comments

  - `DocumentHistoryResponse.documentHistories.passengerComments.Comment` (array)

  - `DocumentHistoryResponse.documentHistories.passengerComments.Comment.value` (string)
    Actual text.
May be restricted based on the type of comment. Ex:
- Notepad remarks: limited to 87 characters.
- Traveler name remarks: limited to 33 characters, only spaces and hyphens allowed for special characters.
    Example: Additional comments

  - `DocumentHistoryResponse.documentHistories.passengerComments.Comment.id` (string)
    Local identifier within a given message for this object.
    Example: comment_1

  - `DocumentHistoryResponse.documentHistories.passengerComments.Comment.name` (string)
    Title of comment or type of remark.
    Example: Comment name

  - `DocumentHistoryResponse.documentHistories.passengerComments.Comment.language` (string)
    Language code using ISO-639 standard
    Example: EN

  - `DocumentHistoryResponse.documentHistories.pricingDateTimeUTC` (string)
    The pricing date and time stamp in UTC.
    Example: 2025-05-23

  - `DocumentHistoryResponse.documentHistories.pricingPseudoCityCode` (string)
    The pseudo city code that the price was created.
    Example: XS4

  - `DocumentHistoryResponse.documentHistories.platingAirline` (string)
    The plating airline code of the document.
    Example: BA

  - `DocumentHistoryResponse.documentHistories.agentEnteredDetails` (object)
    Agency entered details that are submitted at time of pricing or ticketing

  - `DocumentHistoryResponse.documentHistories.agentEnteredDetails.fareQuoteModifierString` (array)
    Array of modifiers applied at the time of pricing

  - `DocumentHistoryResponse.documentHistories.agentEnteredDetails.ticketModifierString` (array)
    Array of modifiers applied at the time of ticketing

  - `DocumentHistoryResponse.documentHistories.formOfPayment` (array)
    Array of form of payments related to this document.

  - `DocumentHistoryResponse.documentHistories.formOfPayment.formOfPaymentType` (string)
    Example: CREDIT

  - `DocumentHistoryResponse.documentHistories.formOfPayment.paymentCard` (object)
    Payment Card details.

  - `DocumentHistoryResponse.documentHistories.formOfPayment.paymentCard.cardCode` (string)
    The Payment Card Code.
    Example: VI

  - `DocumentHistoryResponse.documentHistories.formOfPayment.paymentCard.cardNumber` (string)
    The payment card number masked.
    Example: 4929XXXXXXXXX123

  - `DocumentHistoryResponse.documentHistories.formOfPayment.paymentCard.cardExpiryDate` (string)
    The payment card expiry date. MMYY format.
    Example: 0525

  - `DocumentHistoryResponse.documentHistories.formOfPayment.paymentCard.cardAuthorizationCode` (string)
    The payment card authorization.
    Example: 123A45

  - `DocumentHistoryResponse.documentHistories.formOfPayment.amount` (number)
    The total amount charged to this form of payment.
    Example: 500

  - `DocumentHistoryResponse.documentHistories.formOfPayment.formOfPaymentText` (string)
    Free text information associated to the form of payment.
    Example: NONREF

  - `DocumentHistoryResponse.documentHistories.ticketSegments` (array)
    Flight information in ticket coupons.

  - `DocumentHistoryResponse.documentHistories.ticketSegments.@type` (string)
    Example: TicketSegment

  - `DocumentHistoryResponse.documentHistories.ticketSegments.sequence` (integer)
    The sequence of the coupon within the ticket
    Example: 1

  - `DocumentHistoryResponse.documentHistories.ticketSegments.ClassOfService` (string)
    The booking class of service. segment
    Example: Y

  - `DocumentHistoryResponse.documentHistories.ticketSegments.FareBasisCode` (string)
    The Fare Basis code for this ticket segment.
    Example: YEE1Y

  - `DocumentHistoryResponse.documentHistories.ticketSegments.Status` (string)
    Enum: "CheckedIn", "Closed", "Exchanged", "InfoOnly", "Lifted/Boarded", "OpenForUse", "OtherAirlineControl", "Void", "Refund", "Suspended", "Unavailable", "Used"

  - `DocumentHistoryResponse.documentHistories.ticketSegments.Carrier` (string, required)
    The marketing carrier of the flight on this ticket segment.
    Example: DL

  - `DocumentHistoryResponse.documentHistories.ticketSegments.Number` (string, required)
    The flight number.
    Example: 2490

  - `DocumentHistoryResponse.documentHistories.ticketSegments.Departure` (object, required)
    Departure details for a given leg.

  - `DocumentHistoryResponse.documentHistories.ticketSegments.Departure.@type` (string, required)
    Discriminator classes Departure or DepartureDetail
    Example: DepartureDetail

  - `DocumentHistoryResponse.documentHistories.ticketSegments.Departure.location` (string, required)
    IATA code for departure airport or city for this leg of the itinerary.
    Example: AMS

  - `DocumentHistoryResponse.documentHistories.ticketSegments.Departure.date` (string, required)
    Departure date in YYYY-MM-DD format.
    Example: 0011-10-17

  - `DocumentHistoryResponse.documentHistories.ticketSegments.Departure.time` (string, required)
    Departure date in HH:mm:ss (24-hour format).
    Example: 04:45:00

  - `DocumentHistoryResponse.documentHistories.ticketSegments.Arrival` (object, required)

  - `DocumentHistoryResponse.documentHistories.ticketSegments.Arrival.@type` (string, required)
    Discriminator classes Arrival or ArrivalDetail
    Example: ArrivalDetail

  - `DocumentHistoryResponse.documentHistories.ticketSegments.Arrival.location` (string, required)
    IATA code for arrival airport or city for this leg of the itinerary.
    Example: MAD

  - `DocumentHistoryResponse.documentHistories.ticketSegments.Arrival.date` (string, required)
    Arrival date in YYYY-MM-DD format.
    Example: 0011-10-17

  - `DocumentHistoryResponse.documentHistories.ticketSegments.Arrival.time` (string)
    Arrival date in HH:mm:ss (24-hour format).
    Example: 04:45:00

  - `DocumentHistoryResponse.documentHistories.ticketSegments.FlightStatusCode` (string, required)
    A status code indicates the status of an air segment
    Example: HK

  - `DocumentHistoryResponse.documentHistories.ticketSegments.ValidDateRange` (object)
    Specifies the begin and end date of an event, such as check-in and check-out dates.

  - `DocumentHistoryResponse.documentHistories.ticketSegments.ValidDateRange.start` (string, required)
    Specifies the start date for an event, such as a booking or check-in date in YYYY-MM-DD format.
    Example: 2026-03-03

  - `DocumentHistoryResponse.documentHistories.ticketSegments.ValidDateRange.end` (string, required)
    Specifies the end date an event, such as a booking or check-out date in YYYY-MM-DD format.
    Example: 2026-03-03

  - `DocumentHistoryResponse.documentHistories.ticketSegments.TicketBaggage` (object, required)

  - `DocumentHistoryResponse.documentHistories.ticketSegments.TicketBaggage.@type` (string)
    Example: TicketBaggage

  - `DocumentHistoryResponse.documentHistories.ticketSegments.TicketBaggage.quantity` (integer)
    How many baggage allowed
    Example: 2

  - `DocumentHistoryResponse.documentHistories.ticketSegments.TicketBaggage.Measurement` (array)
    The total dimensions  of baggage

  - `DocumentHistoryResponse.documentHistories.ticketSegments.TicketBaggage.Measurement.value` (number)
    Example: 2.22

  - `DocumentHistoryResponse.documentHistories.ticketSegments.TicketBaggage.Measurement.measurementType` (string)
    The type of measurement such as width, height, weight
    Enum: "Width", "Height", "Depth", "Weight", "OverallDimension"

  - `DocumentHistoryResponse.documentHistories.ticketSegments.TicketBaggage.Measurement.unit` (string)
    The unit of measure in a code format. Refer to OpenTravel Code List Unit of Measure Code (UOM).
    Enum: "Miles", "Kilometers", "Meters", "Millimeters", "Centimeters", "Yards", "Feet", "Inches", "Pixels", "Block", "Megabytes", "Gigabytes", "Square feet", "Square meters", "Pounds", "Kilograms", "Square inch", "Square yard", "Acre", "Square millimeter", "Square centimeter", "Hectare", "Ounce", "Gram", "Gallons", "Liters", "Kilowatts", "Cubic meters"

  - `DocumentHistoryResponse.documentHistories.ticketSegments.TicketBaggage.soldByPieceInd` (boolean)
    If true, the baggage item is sold as a piece allowance. Weight restrictions may also apply.

  - `DocumentHistoryResponse.documentHistories.ticketSegments.TicketBaggage.soldByWeightInd` (boolean)
    If true, the baggage item is sold as a weight allowance. Number of item restrictions may also apply.

  - `DocumentHistoryResponse.documentHistories.ticketSegments.connectionInd` (boolean)
    If true, the ticketSegment is a connecting segment
    Example: true

  - `DocumentHistoryResponse.documentHistories.documentDetail` (object)
    Price used on this document

  - `DocumentHistoryResponse.documentHistories.documentDetail.documentPricingDetail` (object)
    Detailed pricing information of the document.

  - `DocumentHistoryResponse.documentHistories.documentDetail.documentPricingDetail.currencyCode` (object)
    Currency codes are the three-letter alphabetic codes that represent the various currencies used throughout the world.  
Unless changed in the request, the currency is the default associated with your provisioned PCC from Travelport.  
For Hotel: SourceCurrency is based on the location of the hotel and used for all rates in the response. TargetCurrency is the currency code sent in the request in requestedCurrency.

  - `DocumentHistoryResponse.documentHistories.documentDetail.documentPricingDetail.currencyCode.value` (string)
    An ISO 4217 currency code.
    Example: USD

  - `DocumentHistoryResponse.documentHistories.documentDetail.documentPricingDetail.currencyCode.codeAuthority` (string)
    Currency code authority
    Example: ISO 4217

  - `DocumentHistoryResponse.documentHistories.documentDetail.documentPricingDetail.currencyCode.decimalPlace` (integer)
    Number of decimal places for the currency.
    Example: 4

  - `DocumentHistoryResponse.documentHistories.documentDetail.documentPricingDetail.currencyCode.decimalAuthority` (string)
    Currency code decimal authority
    Example: ISO 4217

  - `DocumentHistoryResponse.documentHistories.documentDetail.documentPricingDetail.filedBaseAmount` (object)
    A monetary amount, up to 4 decimal places. Decimal place must be included.

  - `DocumentHistoryResponse.documentHistories.documentDetail.documentPricingDetail.filedBaseAmount.value` (number)
    The amount of a given currency.
    Example: 124.56

  - `DocumentHistoryResponse.documentHistories.documentDetail.documentPricingDetail.filedBaseAmount.code` (string)
    An ISO 4217 alpha character code (3 characters) that specifies a money unit.
    Example: USD

  - `DocumentHistoryResponse.documentHistories.documentDetail.documentPricingDetail.filedBaseAmount.minorUnit` (integer)
    Minor units are a mechanism for expressing the relationship between a major currency unit and its corresponding minor currency unit.  
It is the smallest unit of a given currency. 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.
    Example: 2

  - `DocumentHistoryResponse.documentHistories.documentDetail.documentPricingDetail.filedBaseAmount.currencySource` (string)
    The system requesting or returning the currency code specified in the attribute
    Enum: "Supplier", "Charged", "Requested"

  - `DocumentHistoryResponse.documentHistories.documentDetail.documentPricingDetail.filedBaseAmount.approximateInd` (boolean)
    If true, the currency amount has been converted from the original amount.  
For Air Exchange Eligibility, returned only if a currency is converted. If returned, the value is always true, indicating that the fee is approximate because of currency conversion.  
For Hotel Availability and Rules, true indicates this is a calculated value; false indicates this is the value returned by the property.
    Example: true

  - `DocumentHistoryResponse.documentHistories.documentDetail.documentPricingDetail.base` (number)
    The base fare excluding any taxes or fees.
    Example: 750

  - `DocumentHistoryResponse.documentHistories.documentDetail.documentPricingDetail.totalTaxes` (number)
    Total amount of all taxes.
    Example: 50

  - `DocumentHistoryResponse.documentHistories.documentDetail.documentPricingDetail.totalDocumentPrice` (number)
    Total of base plus totalTaxes. OB fees are not included in totalDocumentPrice.
    Example: 850

  - `DocumentHistoryResponse.documentHistories.documentDetail.documentPricingDetail.totalFees` (number)
    Total amount of all fees.
    Example: 50

  - `DocumentHistoryResponse.documentHistories.documentDetail.documentPricingDetail.totalChargePrice` (number)
    Total of base, totalTaxes and totalFees.
    Example: 900

  - `DocumentHistoryResponse.documentHistories.documentDetail.documentPricingDetail.totalAdditionalCollection` (number)
    Additional Collection amount charged on the exchanged document.
    Example: 250

  - `DocumentHistoryResponse.documentHistories.documentDetail.documentPricingDetail.totalForfeitAmount` (number)
    The total amount that has been forfeited after an exchange of documents when a residual amount has not been refunded.
    Example: 25

  - `DocumentHistoryResponse.documentHistories.documentDetail.documentPricingDetail.taxBreakdown` (array)
    Individual tax breakdown and description.

  - `DocumentHistoryResponse.documentHistories.documentDetail.documentPricingDetail.taxBreakdown.@type` (string, required)
    Discriminator class is TaxesDetail
    Example: TaxesDetail

  - `DocumentHistoryResponse.documentHistories.documentDetail.documentPricingDetail.taxBreakdown.TotalTaxes` (number)
    A monetary amount, representing the total of all taxes included in this offer. Supports up to 4 decimal places; decimal place must be included.
    Example: 330.1

  - `DocumentHistoryResponse.documentHistories.documentDetail.documentPricingDetail.taxBreakdown.TaxInfo` (array)
    Returned for TripChange APIS only.

  - `DocumentHistoryResponse.documentHistories.documentDetail.documentPricingDetail.taxBreakdown.TaxInfo.@type` (string)
    Example: TaxInfo

  - `DocumentHistoryResponse.documentHistories.documentDetail.documentPricingDetail.taxBreakdown.TaxInfo.TaxCode` (string, required)
    The tax code
    Example: XF

  - `DocumentHistoryResponse.documentHistories.documentDetail.documentPricingDetail.taxBreakdown.TaxInfo.Amount` (number, required)
    The amount of the tax applied

  - `DocumentHistoryResponse.documentHistories.documentDetail.documentPricingDetail.taxBreakdown.TaxInfo.TaxBreakdown` (array, required)
    The breakdown of the tax for this tax code

  - `DocumentHistoryResponse.documentHistories.documentDetail.documentPricingDetail.paidTaxBreakdown` (array)
    Array of paid taxes.

  - `DocumentHistoryResponse.documentHistories.documentDetail.documentPricingDetail.feeBreakdown` (array)
    Array of individual fees.

  - `DocumentHistoryResponse.documentHistories.documentDetail.documentPricingDetail.feeBreakdown.@type` (string)

  - `DocumentHistoryResponse.documentHistories.documentDetail.documentPricingDetail.feeBreakdown.feeCode` (string)
    For Hotel, the Hotel provider's explanation of the fee; can be returned either as a code or as text.  
For Air, the code for the fee, such as 'OB' for OB fees.
    Example: 1011

  - `DocumentHistoryResponse.documentHistories.documentDetail.documentPricingDetail.feeBreakdown.reportingAuthority` (string)
    Not used. Identifies the reporting authority.
    Example: OPRA

  - `DocumentHistoryResponse.documentHistories.documentDetail.documentPricingDetail.feeBreakdown.purpose` (string)
    Not used. Fee purpose
    Example: Service charge

  - `DocumentHistoryResponse.documentHistories.documentDetail.documentPricingDetail.feeBreakdown.description` (string)
    Any description or text explanation of the charge.
    Example: Resort Fee

  - `DocumentHistoryResponse.documentHistories.documentDetail.documentPricingDetail.feeBreakdown.feeApplication` (string)
    Application values (such as the application of a fee) like per person or per room.
    Enum: "PerPerson", "PerRoom", "PerAccommodation", "PerHouse", "PerApartment", "PerAdult", "PerChild"

  - `DocumentHistoryResponse.documentHistories.documentDetail.documentPricingDetail.feeBreakdown.feeFrequency` (string)
    The frequency of a fee such as per night or per stay.
    Enum: "PerNight", "PerDay", "PerStay", "PerWeek", "RoundTrip", "OneWay"

  - `DocumentHistoryResponse.documentHistories.documentDetail.documentPricingDetail.feeBreakdown.FeeAmountOrPercent` (object, required)
    Defines whether the fee is charged as an amount or percentage.

  - `DocumentHistoryResponse.documentHistories.documentDetail.documentPricingDetail.feeBreakdown.FeeAmountOrPercent.@type` (string, required)
    Discriminator. Child classes FeeAmountOrPercentAmount or FeeAmountOrPercentPercent

  - `DocumentHistoryResponse.documentHistories.documentDetail.documentPricingDetail.feeBreakdown.FeeAmountOrPercent.application` (string)
    Type of commission
    Enum: "Full", "Partial", "Non-paying", "No-show", "Adjustment", "Commissionable"

  - `DocumentHistoryResponse.documentHistories.documentDetail.documentPricingDetail.feeBreakdown.Tax` (array)

  - `DocumentHistoryResponse.documentHistories.documentDetail.documentPricingDetail.feeBreakdown.Tax.value` (number)
    Amount of the tax. Returned as 0 if a tax was marked as exempt with TaxExemption.
    Example: 12.2

  - `DocumentHistoryResponse.documentHistories.documentDetail.documentPricingDetail.feeBreakdown.Tax.currencyCode` (string)
    A ISO 4217 currency code associated to the value.
    Example: USD

  - `DocumentHistoryResponse.documentHistories.documentDetail.documentPricingDetail.feeBreakdown.Tax.taxCode` (string)
    Code for the tax.  
For Hotels this is the OTA code.
    Example: XF2

  - `DocumentHistoryResponse.documentHistories.documentDetail.documentPricingDetail.feeBreakdown.Tax.reportingAuthority` (string)
    Identifies the reporting authority such as airport code for XF taxes
    Example: JFK1

  - `DocumentHistoryResponse.documentHistories.documentDetail.documentPricingDetail.feeBreakdown.Tax.purpose` (string)
    Supplier returned description of tax.
    Example: Fuel surcharge

  - `DocumentHistoryResponse.documentHistories.documentDetail.documentPricingDetail.feeBreakdown.Tax.description` (string)
    Short summary of the tax.  
In Air workflows this is returned only for NDC.  
Note that descriptions are not returned for tax codes YQ and YR, which are fees charged by airlines and not government-imposed taxes.  
For Hotels this is the OTA tax description.
    Example: Lodging tax

  - `DocumentHistoryResponse.documentHistories.documentDetail.documentPricingDetail.feeBreakdown.Tax.includedInBase` (string)
    Yes , No , Unknown
    Enum: "Yes", "No", "Unknown"

  - `DocumentHistoryResponse.documentHistories.documentDetail.documentPricingDetail.feeBreakdown.Tax.codeAuthority` (string)
    Not used. Currency Code Authority
    Example: ISO

  - `DocumentHistoryResponse.documentHistories.documentDetail.documentPricingDetail.feeBreakdown.Tax.decimalPlace` (integer)
    Permitted number of decimals. Associated to the currency value.
    Example: 2

  - `DocumentHistoryResponse.documentHistories.documentDetail.documentPricingDetail.feeBreakdown.Tax.decimalAuthority` (string)
    Not used. Currency decimal authority
    Example: ISO

  - `DocumentHistoryResponse.documentHistories.documentDetail.documentPricingDetail.feeBreakdown.Tax.exemptInd` (boolean)
    GDS only; not supported for NDC.  
Returned if a tax was marked exempt in a prior request with the TaxExemption pricing modifer.  
If true, this tax is exempt"
    Example: true

  - `DocumentHistoryResponse.documentHistories.documentDetail.documentPricingDetail.feeBreakdown.Tax.nonRefundableInd` (boolean)
    If true, the tax is non refundable. This indicator is only supported for exchange search and exchange price quote transactions.
    Example: true

  - `DocumentHistoryResponse.documentHistories.documentDetail.documentPricingDetail.feeBreakdown.Tax.excludedFromTotalPriceInd` (boolean)
    Returned in Hotel APIs when a tax is not included in the TotalPrice. Default behavior is for taxes to be included in TotalPrice.
    Example: true

  - `DocumentHistoryResponse.documentHistories.documentDetail.documentPricingDetail.feeBreakdown.includedinBaseInd` (boolean)
    If true, indicates the fee is included in Base Price.

  - `DocumentHistoryResponse.documentHistories.documentDetail.documentPricingDetail.feeBreakdown.includedInTotalPriceInd` (boolean)
    If true, indicates the fee is included in Total Price. Default behavior is for fees not to be included in TotalPrice.

  - `DocumentHistoryResponse.documentHistories.documentDetail.documentPricingDetail.feeBreakdown.collectionMethod` (string)
    List of change fee method
    Enum: "EMD", "MCO", "Tax", "Unknown"

  - `DocumentHistoryResponse.documentHistories.documentDetail.documentPricingDetail.fareCalculation` (object)
    Details on how the fare has been constructed.

  - `DocumentHistoryResponse.documentHistories.documentDetail.documentPricingDetail.fareCalculation.fareCalculationString` (string)
    The linear fare calculation string.
    Example: LON BA X/SIN SYD R250.00BA X/SIN BA LON R250.00END

  - `DocumentHistoryResponse.documentHistories.documentDetail.documentPricingDetail.fareCalculation.rateOfExchange` (number)
    The exchange rate applied.
    Example: 0.1234568

  - `DocumentHistoryResponse.documentHistories.documentDetail.documentPricingDetail.fareCalculation.pricingIndicator` (string)
    The pricing code indicates how the fare is priced. e.g. manual or automated. The pricing indicator determines when the fare is valid for the Travelport fare guarantee policy.
    Example: G

  - `DocumentHistoryResponse.documentHistories.documentDetail.documentPricingDetail.commissionAmount` (number)
    The amount of commission applied to this document.
    Example: 25

  - `DocumentHistoryResponse.documentHistories.documentDetail.documentPricingDetail.commissionPercent` (number)
    The percentage of commission override applied to the document.
    Example: 10.25

  - `DocumentHistoryResponse.documentHistories.documentDetail.documentPricingDetail.restrictions` (array)
    Array of restrictions/endorsements.

  - `DocumentHistoryResponse.documentHistories.documentDetail.documentPricingDetail.tourCode` (string)
    The tour code applied.
    Example: SUMMERSUN

  - `DocumentHistoryResponse.documentHistories.documentDetail.voidDetail` (object)
    Detail information on a document that has been voided

  - `DocumentHistoryResponse.documentHistories.documentDetail.voidDetail.voidDateTimeUTC` (string)
    The date time the document was voided in GMT.
    Example: 2025-05-11T15:30:00Z

  - `DocumentHistoryResponse.documentHistories.documentDetail.voidDetail.source` (string)
    Example: 1G

  - `DocumentHistoryResponse.documentHistories.documentDetail.voidDetail.pseudoCityCode` (string)
    Example: XS4

  - `DocumentHistoryResponse.documentHistories.documentDetail.voidDetail.voidingAgent` (string)
    The voiding agent initials.
    Example: TW

  - `DocumentHistoryResponse.documentHistories.documentDetail.voidDetail.sacCode` (string)
    The settlement authorization code for this transaction
    Example: 123SZ7RAS4GRR

  - `DocumentHistoryResponse.documentHistories.documentDetail.refundDetail` (object)
    Detail information on a refunded document

  - `DocumentHistoryResponse.documentHistories.documentDetail.refundDetail.refundDateTimeUTC` (string)
    The date time the document was voided in GMT.
    Example: 2025-05-11T15:30:00Z

  - `DocumentHistoryResponse.documentHistories.documentDetail.refundDetail.source` (string)
    Example: 1G

  - `DocumentHistoryResponse.documentHistories.documentDetail.refundDetail.pseudoCityCode` (string)
    Example: XS4

  - `DocumentHistoryResponse.documentHistories.documentDetail.refundDetail.refundingAgent` (string)
    The voiding agent initials.
    Example: TW

  - `DocumentHistoryResponse.documentHistories.documentDetail.refundDetail.sacCode` (string)
    The settlement authorization code for this transaction
    Example: 123SZ7RAS4GRR

  - `DocumentHistoryResponse.documentHistories.documentDetail.refundDetail.refundCategory` (string)
    Enum: "Full", "Partial", "Automated", "NonReportable"

  - `DocumentHistoryResponse.documentHistories.documentDetail.refundDetail.refundAmount` (object)
    Refund amount breakdown

  - `DocumentHistoryResponse.documentHistories.documentDetail.refundDetail.refundAmount.currencyCode` (string)
    3 letter currency code as defined by ISO-4217.
    Example: EUR

  - `DocumentHistoryResponse.documentHistories.documentDetail.refundDetail.refundAmount.base` (number)
    The base refund amount exclusive of taxes and fees.
    Example: 400

  - `DocumentHistoryResponse.documentHistories.documentDetail.refundDetail.refundAmount.totalTaxes` (number)
    Total amount of tax refunded.
    Example: 75

  - `DocumentHistoryResponse.documentHistories.documentDetail.refundDetail.refundAmount.totalRefund` (number)
    Total refund amount.
    Example: 475

  - `DocumentHistoryResponse.documentHistories.documentDetail.refundDetail.refundAmount.refundTaxBreakdown` (array)
    Array of individual taxes.

  - `DocumentHistoryResponse.documentHistories.documentDetail.refundDetail.refundAmount.cashAmountUsed` (number)
    Total cash amount used.
    Example: 475

  - `DocumentHistoryResponse.documentHistories.documentDetail.refundDetail.refundAmount.creditAmountUsed` (number)
    Total credit amount used.
    Example: 475

  - `DocumentHistoryResponse.documentHistories.documentDetail.refundDetail.refundAmount.refundFormOfPayment` (array)
    The form of payment used for the refund including the amount refunded.

  - `DocumentHistoryResponse.documentHistories.documentDetail.refundDetail.refundAmount.refundWaiverCode` (object)
    A code assigned by an airline to support waiver of fees or ticket value as a result of disruption to the passenger. Waiver code can be passed during the refund by document process (BuildFromOfferList). Select the type of fee that is to be waivered in the waiver type field. Also passed as a FormOfPayment.

  - `DocumentHistoryResponse.documentHistories.documentDetail.refundDetail.refundAmount.refundWaiverCode.value` (string)

  - `DocumentHistoryResponse.documentHistories.documentDetail.refundDetail.refundAmount.refundWaiverCode.reasonCode` (integer)
    A code assigned to identify the reason for disruption
    Example: 2

  - `DocumentHistoryResponse.documentHistories.documentDetail.refundDetail.refundAmount.refundWaiverCode.waiverType` (string)
    List of waiver types.
    Enum: "ChangePenalty", "PriceDifference", "ChangePenaltyAndPriceDifference", "RefundPenalty", "NameChangePenalty"

  - `DocumentHistoryResponse.documentHistories.documentDetail.refundDetail.refundAmount.refundCommissionAmount` (number)
    The amount of commission applied to the refunded ticket.
    Example: 40

  - `DocumentHistoryResponse.documentHistories.documentDetail.refundDetail.refundAmount.refundCommissionPercent` (integer)
    The percentage of commission override applied to the refunded ticket.
    Example: 9

  - `DocumentHistoryResponse.documentHistories.mcoDetail` (object)
    MCO detail information

  - `DocumentHistoryResponse.documentHistories.mcoDetail.issuedFor` (string)
    MCO issued for.
    Example: Residual Value

  - `DocumentHistoryResponse.documentHistories.mcoDetail.reasonForIssuanceCode` (string)
    MCO reason for issuance code.
    Example: K

  - `DocumentHistoryResponse.documentHistories.mcoDetail.issuedAt` (string)
    MCO issuance IATA location code.
    Example: LON

  - `DocumentHistoryResponse.documentHistories.mcoDetail.comment` (array)

  - `DocumentHistoryResponse.documentHistories.relatedDocument` (object)
    The related ticket or invoice number.

  - `DocumentHistoryResponse.documentHistories.associatedDocument` (object)
    The associated EMD or MCO number.

  - `DocumentHistoryResponse.documentHistories.exchanges` (object)
    Details of documents that have been exchanged for this document.

  - `DocumentHistoryResponse.documentHistories.exchanges.exchangedFor` (object)

  - `DocumentHistoryResponse.documentHistories.exchanges.exchangedFor.value` (string)

  - `DocumentHistoryResponse.documentHistories.exchanges.exchangedFor.issuingCity` (string)

  - `DocumentHistoryResponse.documentHistories.exchanges.exchangedFor.issueDate` (string)

  - `DocumentHistoryResponse.documentHistories.exchanges.exchangedFor.agencyCodeIATA` (string)

  - `DocumentHistoryResponse.documentHistories.exchanges.exchangedFor.documentType` (string)
    Document type like EMD, MCO
    Enum: "EMD", "MCO", "Ticket", "TASF", "Invoice"

  - `DocumentHistoryResponse.documentHistories.exchanges.previousIssue` (array)
    Array of previous issued documents.

  - `DocumentHistoryResponse.@type` (string)
    Example: response

  - `DocumentHistoryResponse.transactionId` (string)
    A unique system-generated (128 bit GUID format) transaction/tracking id for a single request and response (i.e. for a single transaction) used for internal tracking and troubleshooting.  
Also known as E2ETrackingId.  
Not returned in all Hotel API responses.
    Example: 49f58f5f-c443-43b4-9f5d-be405fd00a01

  - `DocumentHistoryResponse.traceId` (string)
    Used in hospitality workflows to provide a unique transaction or tracking id for a single request and response.  
For Air Eligibility, returned if a custom trace ID was sent in the request header.  
For Hotel Rules, returned if a custom trace ID was sent in the request header.
    Example: TraceID_123456

  - `DocumentHistoryResponse.correlationId` (string)
    Identifier used to correlate hotel API invocations across a multi-call business flows.

  - `DocumentHistoryResponse.reservationStatus` (string)
    Status of reservation or offer completion.
    Enum: "Success", "Fail", "Partial", "Pending", "OnHold", "Retry", "Other"

  - `DocumentHistoryResponse.Result` (object)
    Returns the error and/or warning message information, if applicable.

  - `DocumentHistoryResponse.Result.@type` (string)
    Discriminator class Result only
    Example: Result

  - `DocumentHistoryResponse.Result.status` (string)
    The status of an error or warning
    Enum: "Not processed", "Incomplete", "Complete", "Unknown"

  - `DocumentHistoryResponse.Result.Error` (array)
    A list of error information returned at the provider level for a response.

  - `DocumentHistoryResponse.Result.Error.@type` (string, required)
    Discriminator classes Error or ErrorDetail
    Example: ErrorDetail

  - `DocumentHistoryResponse.Result.Error.StatusCode` (integer)
    Http standard response code
    Example: 200

  - `DocumentHistoryResponse.Result.Error.Message` (string)
    The Travelport standardized error or warning message
    Example: No flights found.

  - `DocumentHistoryResponse.Result.Error.NameValuePair` (array)

  - `DocumentHistoryResponse.Result.Error.NameValuePair.value` (string)
    Text directly related to name description, providing more detail. May have character restrictions based on remark type (e.g. Free Text limitations: 84 characters, alphanumeric and some special characters).
    Example: Sunday

  - `DocumentHistoryResponse.Result.Error.NameValuePair.id` (string)
    Optional internally referenced id
    Example: 6

  - `DocumentHistoryResponse.Result.Error.NameValuePair.name` (string, required)
    Key, categorizing the type of remark or error.
    Example: Day1

  - `DocumentHistoryResponse.Result.Warning` (array)
    A list of warning information returned at the provider level for a response.

  - `DocumentHistoryResponse.Result.Warning.@type` (string, required)
    Discriminator classes Warning or WarningDetail
    Example: WarningDetail

  - `DocumentHistoryResponse.Result.Warning.StatusCode` (integer)
    Http standard response code
    Example: 200

  - `DocumentHistoryResponse.Result.Warning.Message` (string)
    The Travelport standardized error or warning message
    Example: Customer Loyalty could not be applied.

  - `DocumentHistoryResponse.Result.Warning.NameValuePair` (array)

  - `DocumentHistoryResponse.Identifier` (object)
    A globally unique identifier key often used to reference a given option (such as Pricing, Booking, Rules, or additional workflows) or to retrieve information (such as Hotel pagination).

  - `DocumentHistoryResponse.Identifier.value` (string)
    Unique offer identifier that can be sent in subsequent payload requests to reference this offer.
When used for reference flight calls, the CatalogProductOfferingsIdentifier will be the transaction identifier from the Search, Next Leg Search, or Flight Specific Search response in CatalogProductOfferings/Identifier/value.
If you choose to pull the CatalogProductOfferingsIdentifier from the Price response instead (OfferListResponse/Identifier/value), either full or reference payload, please note for subsequent Add Offer requests you must remove the _PC appended to the end of the value in the AirPrice response (e.g., change value: '93d2091d-3d04-48ab-8091-6ae1525f02ea_PC' to value: '93d2091d-3d04-48ab-8091-6ae1525f02ea').
When building an AirPrice or Add Offer reference payload request:
- Look for the CatalogProductOfferingIdentifier (ex: o1) in a Search response at CatalogProductOfferings/CatalogProductOffering/id or a Price response at OfferListResponse/OfferID/id.
- Look for the ProductIdentifier (ex: p0) in a Search response at CatalogProductOfferings/CatalogProductOffering/ProductBrandOptions/ProductBrandOffering/Product/productRef or from a Price response at OfferListResponse/OfferID/Product/id.

When returned from a Workbench, this value is the workbench identifier that must be sent in all subsequent requests for this workbench session.
When returned from Air Exchange Eligibility, value is the ticket number sent with the eligibility request.
When used specifically for form of payment, the value will begin with the characters 'FOP'. Similarly, the OfferIdentifier associated will begin with the character 'O'.
For Hotel Create Reservation (Reference Payload), send the value from the Availability response in CatalogOffering/id or the value from SearchComplete returned in propertyItems/lowestPublicAvailableRate/rateKey/value.
Results from Hotel Availability and Hotel SearchComplete are stored in the cache for 30 minutes. If the offers expire before booking, you must send a new request.
    Example: A0656EFF-FAF4-456F-B061-0161008D7C4E

  - `DocumentHistoryResponse.Identifier.authority` (string)
    Name of the supplier system that created this identifier - the source of information.  
For AirPrice, please note that GDS offers return the value 'Travelport' in authority while NDC offers return the carrier code of the issuing NDC carrier.  
When returned from Air Exchange Eligibility, authority is always 'Travelport' as the transaction issuer.  
For Hotels, authority indicates which supplier returned the lowest available rate for that property: either 'TVPT' (Travelport) or 'BKNG' (booking.com). Booking.com access requires additional provisioning and a direct agreement with the supplier. Authority is not returned if the property is closed or returns an error.  
For Hotel Create Reservation (Full Payload) and Sync Reservation send the value from the Availability response in CatalogOffering/Identifier/authority for the instance you want to book.
    Example: TVPT

  - `DocumentHistoryResponse.NextSteps` (object)
    Container for the steps that describe actions that may be taken on the containing object.  
Not applicable for an Eligibility or Exchange response.

  - `DocumentHistoryResponse.NextSteps.baseURI` (string, required)
    The base portion of the URI in order to shorten the uris in the individual steps

  - `DocumentHistoryResponse.NextSteps.id` (string)
    Optional internally referenced id
    Example: 5

  - `DocumentHistoryResponse.NextSteps.NextStep` (array, required)

  - `DocumentHistoryResponse.NextSteps.NextStep.value` (string)
    Example: www.resourcelocation.com

  - `DocumentHistoryResponse.NextSteps.NextStep.id` (string)
    Identifier for the Next Step
    Example: 2

  - `DocumentHistoryResponse.NextSteps.NextStep.action` (string, required)
    The action this next step is intended to achieve
    Example: cancel

  - `DocumentHistoryResponse.NextSteps.NextStep.method` (string, required)
    Describes the set of potential methods that can be taken after an operation.
    Enum: "GET", "DELETE", "PUT", "POST"

  - `DocumentHistoryResponse.NextSteps.NextStep.description` (string)
    Additional clarification for the next step
    Example: remove offer from the order

  - `DocumentHistoryResponse.ReferenceList` (array)

  - `DocumentHistoryResponse.ReferenceList.@type` (string, required)
    Discriminator
- Air Search child classes are ReferenceListAmenity, ReferenceListBrand, ReferenceListFlight, ReferenceListProduct, ReferenceListTermsAndConditions, and ReferenceListUniversalProductAttribute.
- Air Price child classes are ReferenceListAmenity and ReferenceListBrand.
- FareRules child class is ReferenceListFlight.
- Search Ancillaries child class is ReferenceListFlight.
- Seat Map child class is ReferenceListSeatingChart.
- Hotel Availability child class is ReferenceListPropertyDates.
- Reservation and Reservation Workbench child classes are ReferenceListAmenity, ReferenceListBrand, and ReferenceListUniversalProductAttribute.
- Exchange Search child classes are ReferenceListBrand, ReferenceListFlight, and ReferenceListExchangedPrice.
- Reservation Receipt child classes are ReferenceListOffer and ReferenceListTraveler.
- Book_Traveler child class is ReferenceListTraveler.
    Example: ReferenceListFlight

  - `DocumentHistoryResponse.ReferenceList.id` (string)
    Uniquely identifies for the Reference List

  - `DocumentHistoryResponse.CurrencyRateConversion` (array)

  - `DocumentHistoryResponse.CurrencyRateConversion.@type` (string)

  - `DocumentHistoryResponse.CurrencyRateConversion.ConversionRate` (object, required)
    Conversion rate of SourceCurrency value to TargetCurrency value. This value can be used to calculate, independently of the API, conversion for the rates in the response. The response does not convert any amounts.

  - `DocumentHistoryResponse.CurrencyRateConversion.ConversionRate.value` (number)

  - `DocumentHistoryResponse.CurrencyRateConversion.ConversionRate.rateAuthority` (string)
    Contextual rate authority
    Example: ISO 4217

  - `DocumentHistoryResponse.CurrencyRateConversion.ConversionRate.rateAsOf` (string)
    Rate as of
    Example: 2026-08-07T12:12:00Z

  - `DocumentHistoryResponse.Pagination` (object)
    Pagination object used when result sets span across a number of pages.

  - `DocumentHistoryResponse.Pagination.@type` (string, required)
    Example: Pagination

  - `DocumentHistoryResponse.Pagination.page` (integer, required)
    The current page number of the full result set
    Example: 1

  - `DocumentHistoryResponse.Pagination.pageSize` (integer, required)
    The total number of items on this page
    Example: 20

  - `DocumentHistoryResponse.Pagination.totalPages` (integer, required)
    The total number of pages in this result set
    Example: 5

  - `DocumentHistoryResponse.Pagination.totalItems` (integer, required)
    The total number of pages in this result set
    Example: 100

## Response 400 fields (application/json):

  - `ErrorResponse` (object)
    Base common error response

  - `ErrorResponse.@type` (string)
    Example: response

  - `ErrorResponse.transactionId` (string)
    A unique system-generated (128 bit GUID format) transaction/tracking id for a single request and response (i.e. for a single transaction) used for internal tracking and troubleshooting.  
Also known as E2ETrackingId.  
Not returned in all Hotel API responses.
    Example: 49f58f5f-c443-43b4-9f5d-be405fd00a01

  - `ErrorResponse.traceId` (string)
    Used in hospitality workflows to provide a unique transaction or tracking id for a single request and response.  
For Air Eligibility, returned if a custom trace ID was sent in the request header.  
For Hotel Rules, returned if a custom trace ID was sent in the request header.
    Example: TraceID_123456

  - `ErrorResponse.correlationId` (string)
    Identifier used to correlate hotel API invocations across a multi-call business flows.

  - `ErrorResponse.reservationStatus` (string)
    Status of reservation or offer completion.
    Enum: "Success", "Fail", "Partial", "Pending", "OnHold", "Retry", "Other"

  - `ErrorResponse.Result` (object)
    Returns the error and/or warning message information, if applicable.

  - `ErrorResponse.Result.@type` (string)
    Discriminator class Result only
    Example: Result

  - `ErrorResponse.Result.status` (string)
    The status of an error or warning
    Enum: "Not processed", "Incomplete", "Complete", "Unknown"

  - `ErrorResponse.Result.Error` (array)
    A list of error information returned at the provider level for a response.

  - `ErrorResponse.Result.Error.@type` (string, required)
    Discriminator classes Error or ErrorDetail
    Example: ErrorDetail

  - `ErrorResponse.Result.Error.StatusCode` (integer)
    Http standard response code
    Example: 200

  - `ErrorResponse.Result.Error.Message` (string)
    The Travelport standardized error or warning message
    Example: No flights found.

  - `ErrorResponse.Result.Error.NameValuePair` (array)

  - `ErrorResponse.Result.Error.NameValuePair.value` (string)
    Text directly related to name description, providing more detail. May have character restrictions based on remark type (e.g. Free Text limitations: 84 characters, alphanumeric and some special characters).
    Example: Sunday

  - `ErrorResponse.Result.Error.NameValuePair.id` (string)
    Optional internally referenced id
    Example: 6

  - `ErrorResponse.Result.Error.NameValuePair.name` (string, required)
    Key, categorizing the type of remark or error.
    Example: Day1

  - `ErrorResponse.Result.Warning` (array)
    A list of warning information returned at the provider level for a response.

  - `ErrorResponse.Result.Warning.@type` (string, required)
    Discriminator classes Warning or WarningDetail
    Example: WarningDetail

  - `ErrorResponse.Result.Warning.StatusCode` (integer)
    Http standard response code
    Example: 200

  - `ErrorResponse.Result.Warning.Message` (string)
    The Travelport standardized error or warning message
    Example: Customer Loyalty could not be applied.

  - `ErrorResponse.Result.Warning.NameValuePair` (array)

  - `ErrorResponse.Identifier` (object)
    A globally unique identifier key often used to reference a given option (such as Pricing, Booking, Rules, or additional workflows) or to retrieve information (such as Hotel pagination).

  - `ErrorResponse.Identifier.value` (string)
    Unique offer identifier that can be sent in subsequent payload requests to reference this offer.
When used for reference flight calls, the CatalogProductOfferingsIdentifier will be the transaction identifier from the Search, Next Leg Search, or Flight Specific Search response in CatalogProductOfferings/Identifier/value.
If you choose to pull the CatalogProductOfferingsIdentifier from the Price response instead (OfferListResponse/Identifier/value), either full or reference payload, please note for subsequent Add Offer requests you must remove the _PC appended to the end of the value in the AirPrice response (e.g., change value: '93d2091d-3d04-48ab-8091-6ae1525f02ea_PC' to value: '93d2091d-3d04-48ab-8091-6ae1525f02ea').
When building an AirPrice or Add Offer reference payload request:
- Look for the CatalogProductOfferingIdentifier (ex: o1) in a Search response at CatalogProductOfferings/CatalogProductOffering/id or a Price response at OfferListResponse/OfferID/id.
- Look for the ProductIdentifier (ex: p0) in a Search response at CatalogProductOfferings/CatalogProductOffering/ProductBrandOptions/ProductBrandOffering/Product/productRef or from a Price response at OfferListResponse/OfferID/Product/id.

When returned from a Workbench, this value is the workbench identifier that must be sent in all subsequent requests for this workbench session.
When returned from Air Exchange Eligibility, value is the ticket number sent with the eligibility request.
When used specifically for form of payment, the value will begin with the characters 'FOP'. Similarly, the OfferIdentifier associated will begin with the character 'O'.
For Hotel Create Reservation (Reference Payload), send the value from the Availability response in CatalogOffering/id or the value from SearchComplete returned in propertyItems/lowestPublicAvailableRate/rateKey/value.
Results from Hotel Availability and Hotel SearchComplete are stored in the cache for 30 minutes. If the offers expire before booking, you must send a new request.
    Example: A0656EFF-FAF4-456F-B061-0161008D7C4E

  - `ErrorResponse.Identifier.authority` (string)
    Name of the supplier system that created this identifier - the source of information.  
For AirPrice, please note that GDS offers return the value 'Travelport' in authority while NDC offers return the carrier code of the issuing NDC carrier.  
When returned from Air Exchange Eligibility, authority is always 'Travelport' as the transaction issuer.  
For Hotels, authority indicates which supplier returned the lowest available rate for that property: either 'TVPT' (Travelport) or 'BKNG' (booking.com). Booking.com access requires additional provisioning and a direct agreement with the supplier. Authority is not returned if the property is closed or returns an error.  
For Hotel Create Reservation (Full Payload) and Sync Reservation send the value from the Availability response in CatalogOffering/Identifier/authority for the instance you want to book.
    Example: TVPT

  - `ErrorResponse.NextSteps` (object)
    Container for the steps that describe actions that may be taken on the containing object.  
Not applicable for an Eligibility or Exchange response.

  - `ErrorResponse.NextSteps.baseURI` (string, required)
    The base portion of the URI in order to shorten the uris in the individual steps

  - `ErrorResponse.NextSteps.id` (string)
    Optional internally referenced id
    Example: 5

  - `ErrorResponse.NextSteps.NextStep` (array, required)

  - `ErrorResponse.NextSteps.NextStep.value` (string)
    Example: www.resourcelocation.com

  - `ErrorResponse.NextSteps.NextStep.id` (string)
    Identifier for the Next Step
    Example: 2

  - `ErrorResponse.NextSteps.NextStep.action` (string, required)
    The action this next step is intended to achieve
    Example: cancel

  - `ErrorResponse.NextSteps.NextStep.method` (string, required)
    Describes the set of potential methods that can be taken after an operation.
    Enum: "GET", "DELETE", "PUT", "POST"

  - `ErrorResponse.NextSteps.NextStep.description` (string)
    Additional clarification for the next step
    Example: remove offer from the order

  - `ErrorResponse.ReferenceList` (array)

  - `ErrorResponse.ReferenceList.@type` (string, required)
    Discriminator
- Air Search child classes are ReferenceListAmenity, ReferenceListBrand, ReferenceListFlight, ReferenceListProduct, ReferenceListTermsAndConditions, and ReferenceListUniversalProductAttribute.
- Air Price child classes are ReferenceListAmenity and ReferenceListBrand.
- FareRules child class is ReferenceListFlight.
- Search Ancillaries child class is ReferenceListFlight.
- Seat Map child class is ReferenceListSeatingChart.
- Hotel Availability child class is ReferenceListPropertyDates.
- Reservation and Reservation Workbench child classes are ReferenceListAmenity, ReferenceListBrand, and ReferenceListUniversalProductAttribute.
- Exchange Search child classes are ReferenceListBrand, ReferenceListFlight, and ReferenceListExchangedPrice.
- Reservation Receipt child classes are ReferenceListOffer and ReferenceListTraveler.
- Book_Traveler child class is ReferenceListTraveler.
    Example: ReferenceListFlight

  - `ErrorResponse.ReferenceList.id` (string)
    Uniquely identifies for the Reference List

  - `ErrorResponse.CurrencyRateConversion` (array)

  - `ErrorResponse.CurrencyRateConversion.@type` (string)

  - `ErrorResponse.CurrencyRateConversion.SourceCurrency` (object, required)
    Currency codes are the three-letter alphabetic codes that represent the various currencies used throughout the world.  
Unless changed in the request, the currency is the default associated with your provisioned PCC from Travelport.  
For Hotel: SourceCurrency is based on the location of the hotel and used for all rates in the response. TargetCurrency is the currency code sent in the request in requestedCurrency.

  - `ErrorResponse.CurrencyRateConversion.SourceCurrency.value` (string)
    An ISO 4217 currency code.
    Example: USD

  - `ErrorResponse.CurrencyRateConversion.SourceCurrency.codeAuthority` (string)
    Currency code authority
    Example: ISO 4217

  - `ErrorResponse.CurrencyRateConversion.SourceCurrency.decimalPlace` (integer)
    Number of decimal places for the currency.
    Example: 4

  - `ErrorResponse.CurrencyRateConversion.SourceCurrency.decimalAuthority` (string)
    Currency code decimal authority
    Example: ISO 4217

  - `ErrorResponse.CurrencyRateConversion.ConversionRate` (object, required)
    Conversion rate of SourceCurrency value to TargetCurrency value. This value can be used to calculate, independently of the API, conversion for the rates in the response. The response does not convert any amounts.

  - `ErrorResponse.CurrencyRateConversion.ConversionRate.value` (number)

  - `ErrorResponse.CurrencyRateConversion.ConversionRate.rateAuthority` (string)
    Contextual rate authority
    Example: ISO 4217

  - `ErrorResponse.CurrencyRateConversion.ConversionRate.rateAsOf` (string)
    Rate as of
    Example: 2026-08-07T12:12:00Z

  - `ErrorResponse.Pagination` (object)
    Pagination object used when result sets span across a number of pages.

  - `ErrorResponse.Pagination.@type` (string, required)
    Example: Pagination

  - `ErrorResponse.Pagination.page` (integer, required)
    The current page number of the full result set
    Example: 1

  - `ErrorResponse.Pagination.pageSize` (integer, required)
    The total number of items on this page
    Example: 20

  - `ErrorResponse.Pagination.totalPages` (integer, required)
    The total number of pages in this result set
    Example: 5

  - `ErrorResponse.Pagination.totalItems` (integer, required)
    The total number of pages in this result set
    Example: 100

## Response 401 fields (application/json):

  - `ErrorResponse` (object)
    Base common error response

  - `ErrorResponse.@type` (string)
    Example: response

  - `ErrorResponse.transactionId` (string)
    A unique system-generated (128 bit GUID format) transaction/tracking id for a single request and response (i.e. for a single transaction) used for internal tracking and troubleshooting.  
Also known as E2ETrackingId.  
Not returned in all Hotel API responses.
    Example: 49f58f5f-c443-43b4-9f5d-be405fd00a01

  - `ErrorResponse.traceId` (string)
    Used in hospitality workflows to provide a unique transaction or tracking id for a single request and response.  
For Air Eligibility, returned if a custom trace ID was sent in the request header.  
For Hotel Rules, returned if a custom trace ID was sent in the request header.
    Example: TraceID_123456

  - `ErrorResponse.correlationId` (string)
    Identifier used to correlate hotel API invocations across a multi-call business flows.

  - `ErrorResponse.reservationStatus` (string)
    Status of reservation or offer completion.
    Enum: "Success", "Fail", "Partial", "Pending", "OnHold", "Retry", "Other"

  - `ErrorResponse.Result` (object)
    Returns the error and/or warning message information, if applicable.

  - `ErrorResponse.Result.@type` (string)
    Discriminator class Result only
    Example: Result

  - `ErrorResponse.Result.status` (string)
    The status of an error or warning
    Enum: "Not processed", "Incomplete", "Complete", "Unknown"

  - `ErrorResponse.Result.Error` (array)
    A list of error information returned at the provider level for a response.

  - `ErrorResponse.Result.Error.@type` (string, required)
    Discriminator classes Error or ErrorDetail
    Example: ErrorDetail

  - `ErrorResponse.Result.Error.StatusCode` (integer)
    Http standard response code
    Example: 200

  - `ErrorResponse.Result.Error.Message` (string)
    The Travelport standardized error or warning message
    Example: No flights found.

  - `ErrorResponse.Result.Error.NameValuePair` (array)

  - `ErrorResponse.Result.Error.NameValuePair.value` (string)
    Text directly related to name description, providing more detail. May have character restrictions based on remark type (e.g. Free Text limitations: 84 characters, alphanumeric and some special characters).
    Example: Sunday

  - `ErrorResponse.Result.Error.NameValuePair.id` (string)
    Optional internally referenced id
    Example: 6

  - `ErrorResponse.Result.Error.NameValuePair.name` (string, required)
    Key, categorizing the type of remark or error.
    Example: Day1

  - `ErrorResponse.Result.Warning` (array)
    A list of warning information returned at the provider level for a response.

  - `ErrorResponse.Result.Warning.@type` (string, required)
    Discriminator classes Warning or WarningDetail
    Example: WarningDetail

  - `ErrorResponse.Result.Warning.StatusCode` (integer)
    Http standard response code
    Example: 200

  - `ErrorResponse.Result.Warning.Message` (string)
    The Travelport standardized error or warning message
    Example: Customer Loyalty could not be applied.

  - `ErrorResponse.Result.Warning.NameValuePair` (array)

  - `ErrorResponse.Identifier` (object)
    A globally unique identifier key often used to reference a given option (such as Pricing, Booking, Rules, or additional workflows) or to retrieve information (such as Hotel pagination).

  - `ErrorResponse.Identifier.value` (string)
    Unique offer identifier that can be sent in subsequent payload requests to reference this offer.
When used for reference flight calls, the CatalogProductOfferingsIdentifier will be the transaction identifier from the Search, Next Leg Search, or Flight Specific Search response in CatalogProductOfferings/Identifier/value.
If you choose to pull the CatalogProductOfferingsIdentifier from the Price response instead (OfferListResponse/Identifier/value), either full or reference payload, please note for subsequent Add Offer requests you must remove the _PC appended to the end of the value in the AirPrice response (e.g., change value: '93d2091d-3d04-48ab-8091-6ae1525f02ea_PC' to value: '93d2091d-3d04-48ab-8091-6ae1525f02ea').
When building an AirPrice or Add Offer reference payload request:
- Look for the CatalogProductOfferingIdentifier (ex: o1) in a Search response at CatalogProductOfferings/CatalogProductOffering/id or a Price response at OfferListResponse/OfferID/id.
- Look for the ProductIdentifier (ex: p0) in a Search response at CatalogProductOfferings/CatalogProductOffering/ProductBrandOptions/ProductBrandOffering/Product/productRef or from a Price response at OfferListResponse/OfferID/Product/id.

When returned from a Workbench, this value is the workbench identifier that must be sent in all subsequent requests for this workbench session.
When returned from Air Exchange Eligibility, value is the ticket number sent with the eligibility request.
When used specifically for form of payment, the value will begin with the characters 'FOP'. Similarly, the OfferIdentifier associated will begin with the character 'O'.
For Hotel Create Reservation (Reference Payload), send the value from the Availability response in CatalogOffering/id or the value from SearchComplete returned in propertyItems/lowestPublicAvailableRate/rateKey/value.
Results from Hotel Availability and Hotel SearchComplete are stored in the cache for 30 minutes. If the offers expire before booking, you must send a new request.
    Example: A0656EFF-FAF4-456F-B061-0161008D7C4E

  - `ErrorResponse.Identifier.authority` (string)
    Name of the supplier system that created this identifier - the source of information.  
For AirPrice, please note that GDS offers return the value 'Travelport' in authority while NDC offers return the carrier code of the issuing NDC carrier.  
When returned from Air Exchange Eligibility, authority is always 'Travelport' as the transaction issuer.  
For Hotels, authority indicates which supplier returned the lowest available rate for that property: either 'TVPT' (Travelport) or 'BKNG' (booking.com). Booking.com access requires additional provisioning and a direct agreement with the supplier. Authority is not returned if the property is closed or returns an error.  
For Hotel Create Reservation (Full Payload) and Sync Reservation send the value from the Availability response in CatalogOffering/Identifier/authority for the instance you want to book.
    Example: TVPT

  - `ErrorResponse.NextSteps` (object)
    Container for the steps that describe actions that may be taken on the containing object.  
Not applicable for an Eligibility or Exchange response.

  - `ErrorResponse.NextSteps.baseURI` (string, required)
    The base portion of the URI in order to shorten the uris in the individual steps

  - `ErrorResponse.NextSteps.id` (string)
    Optional internally referenced id
    Example: 5

  - `ErrorResponse.NextSteps.NextStep` (array, required)

  - `ErrorResponse.NextSteps.NextStep.value` (string)
    Example: www.resourcelocation.com

  - `ErrorResponse.NextSteps.NextStep.id` (string)
    Identifier for the Next Step
    Example: 2

  - `ErrorResponse.NextSteps.NextStep.action` (string, required)
    The action this next step is intended to achieve
    Example: cancel

  - `ErrorResponse.NextSteps.NextStep.method` (string, required)
    Describes the set of potential methods that can be taken after an operation.
    Enum: "GET", "DELETE", "PUT", "POST"

  - `ErrorResponse.NextSteps.NextStep.description` (string)
    Additional clarification for the next step
    Example: remove offer from the order

  - `ErrorResponse.ReferenceList` (array)

  - `ErrorResponse.ReferenceList.@type` (string, required)
    Discriminator
- Air Search child classes are ReferenceListAmenity, ReferenceListBrand, ReferenceListFlight, ReferenceListProduct, ReferenceListTermsAndConditions, and ReferenceListUniversalProductAttribute.
- Air Price child classes are ReferenceListAmenity and ReferenceListBrand.
- FareRules child class is ReferenceListFlight.
- Search Ancillaries child class is ReferenceListFlight.
- Seat Map child class is ReferenceListSeatingChart.
- Hotel Availability child class is ReferenceListPropertyDates.
- Reservation and Reservation Workbench child classes are ReferenceListAmenity, ReferenceListBrand, and ReferenceListUniversalProductAttribute.
- Exchange Search child classes are ReferenceListBrand, ReferenceListFlight, and ReferenceListExchangedPrice.
- Reservation Receipt child classes are ReferenceListOffer and ReferenceListTraveler.
- Book_Traveler child class is ReferenceListTraveler.
    Example: ReferenceListFlight

  - `ErrorResponse.ReferenceList.id` (string)
    Uniquely identifies for the Reference List

  - `ErrorResponse.CurrencyRateConversion` (array)

  - `ErrorResponse.CurrencyRateConversion.@type` (string)

  - `ErrorResponse.CurrencyRateConversion.SourceCurrency` (object, required)
    Currency codes are the three-letter alphabetic codes that represent the various currencies used throughout the world.  
Unless changed in the request, the currency is the default associated with your provisioned PCC from Travelport.  
For Hotel: SourceCurrency is based on the location of the hotel and used for all rates in the response. TargetCurrency is the currency code sent in the request in requestedCurrency.

  - `ErrorResponse.CurrencyRateConversion.SourceCurrency.value` (string)
    An ISO 4217 currency code.
    Example: USD

  - `ErrorResponse.CurrencyRateConversion.SourceCurrency.codeAuthority` (string)
    Currency code authority
    Example: ISO 4217

  - `ErrorResponse.CurrencyRateConversion.SourceCurrency.decimalPlace` (integer)
    Number of decimal places for the currency.
    Example: 4

  - `ErrorResponse.CurrencyRateConversion.SourceCurrency.decimalAuthority` (string)
    Currency code decimal authority
    Example: ISO 4217

  - `ErrorResponse.CurrencyRateConversion.ConversionRate` (object, required)
    Conversion rate of SourceCurrency value to TargetCurrency value. This value can be used to calculate, independently of the API, conversion for the rates in the response. The response does not convert any amounts.

  - `ErrorResponse.CurrencyRateConversion.ConversionRate.value` (number)

  - `ErrorResponse.CurrencyRateConversion.ConversionRate.rateAuthority` (string)
    Contextual rate authority
    Example: ISO 4217

  - `ErrorResponse.CurrencyRateConversion.ConversionRate.rateAsOf` (string)
    Rate as of
    Example: 2026-08-07T12:12:00Z

  - `ErrorResponse.Pagination` (object)
    Pagination object used when result sets span across a number of pages.

  - `ErrorResponse.Pagination.@type` (string, required)
    Example: Pagination

  - `ErrorResponse.Pagination.page` (integer, required)
    The current page number of the full result set
    Example: 1

  - `ErrorResponse.Pagination.pageSize` (integer, required)
    The total number of items on this page
    Example: 20

  - `ErrorResponse.Pagination.totalPages` (integer, required)
    The total number of pages in this result set
    Example: 5

  - `ErrorResponse.Pagination.totalItems` (integer, required)
    The total number of pages in this result set
    Example: 100

## Response 402 fields (application/json):

  - `ErrorResponse` (object)
    Base common error response

  - `ErrorResponse.@type` (string)
    Example: response

  - `ErrorResponse.transactionId` (string)
    A unique system-generated (128 bit GUID format) transaction/tracking id for a single request and response (i.e. for a single transaction) used for internal tracking and troubleshooting.  
Also known as E2ETrackingId.  
Not returned in all Hotel API responses.
    Example: 49f58f5f-c443-43b4-9f5d-be405fd00a01

  - `ErrorResponse.traceId` (string)
    Used in hospitality workflows to provide a unique transaction or tracking id for a single request and response.  
For Air Eligibility, returned if a custom trace ID was sent in the request header.  
For Hotel Rules, returned if a custom trace ID was sent in the request header.
    Example: TraceID_123456

  - `ErrorResponse.correlationId` (string)
    Identifier used to correlate hotel API invocations across a multi-call business flows.

  - `ErrorResponse.reservationStatus` (string)
    Status of reservation or offer completion.
    Enum: "Success", "Fail", "Partial", "Pending", "OnHold", "Retry", "Other"

  - `ErrorResponse.Result` (object)
    Returns the error and/or warning message information, if applicable.

  - `ErrorResponse.Result.@type` (string)
    Discriminator class Result only
    Example: Result

  - `ErrorResponse.Result.status` (string)
    The status of an error or warning
    Enum: "Not processed", "Incomplete", "Complete", "Unknown"

  - `ErrorResponse.Result.Error` (array)
    A list of error information returned at the provider level for a response.

  - `ErrorResponse.Result.Error.@type` (string, required)
    Discriminator classes Error or ErrorDetail
    Example: ErrorDetail

  - `ErrorResponse.Result.Error.StatusCode` (integer)
    Http standard response code
    Example: 200

  - `ErrorResponse.Result.Error.Message` (string)
    The Travelport standardized error or warning message
    Example: No flights found.

  - `ErrorResponse.Result.Error.NameValuePair` (array)

  - `ErrorResponse.Result.Error.NameValuePair.value` (string)
    Text directly related to name description, providing more detail. May have character restrictions based on remark type (e.g. Free Text limitations: 84 characters, alphanumeric and some special characters).
    Example: Sunday

  - `ErrorResponse.Result.Error.NameValuePair.id` (string)
    Optional internally referenced id
    Example: 6

  - `ErrorResponse.Result.Error.NameValuePair.name` (string, required)
    Key, categorizing the type of remark or error.
    Example: Day1

  - `ErrorResponse.Result.Warning` (array)
    A list of warning information returned at the provider level for a response.

  - `ErrorResponse.Result.Warning.@type` (string, required)
    Discriminator classes Warning or WarningDetail
    Example: WarningDetail

  - `ErrorResponse.Result.Warning.StatusCode` (integer)
    Http standard response code
    Example: 200

  - `ErrorResponse.Result.Warning.Message` (string)
    The Travelport standardized error or warning message
    Example: Customer Loyalty could not be applied.

  - `ErrorResponse.Result.Warning.NameValuePair` (array)

  - `ErrorResponse.Identifier` (object)
    A globally unique identifier key often used to reference a given option (such as Pricing, Booking, Rules, or additional workflows) or to retrieve information (such as Hotel pagination).

  - `ErrorResponse.Identifier.value` (string)
    Unique offer identifier that can be sent in subsequent payload requests to reference this offer.
When used for reference flight calls, the CatalogProductOfferingsIdentifier will be the transaction identifier from the Search, Next Leg Search, or Flight Specific Search response in CatalogProductOfferings/Identifier/value.
If you choose to pull the CatalogProductOfferingsIdentifier from the Price response instead (OfferListResponse/Identifier/value), either full or reference payload, please note for subsequent Add Offer requests you must remove the _PC appended to the end of the value in the AirPrice response (e.g., change value: '93d2091d-3d04-48ab-8091-6ae1525f02ea_PC' to value: '93d2091d-3d04-48ab-8091-6ae1525f02ea').
When building an AirPrice or Add Offer reference payload request:
- Look for the CatalogProductOfferingIdentifier (ex: o1) in a Search response at CatalogProductOfferings/CatalogProductOffering/id or a Price response at OfferListResponse/OfferID/id.
- Look for the ProductIdentifier (ex: p0) in a Search response at CatalogProductOfferings/CatalogProductOffering/ProductBrandOptions/ProductBrandOffering/Product/productRef or from a Price response at OfferListResponse/OfferID/Product/id.

When returned from a Workbench, this value is the workbench identifier that must be sent in all subsequent requests for this workbench session.
When returned from Air Exchange Eligibility, value is the ticket number sent with the eligibility request.
When used specifically for form of payment, the value will begin with the characters 'FOP'. Similarly, the OfferIdentifier associated will begin with the character 'O'.
For Hotel Create Reservation (Reference Payload), send the value from the Availability response in CatalogOffering/id or the value from SearchComplete returned in propertyItems/lowestPublicAvailableRate/rateKey/value.
Results from Hotel Availability and Hotel SearchComplete are stored in the cache for 30 minutes. If the offers expire before booking, you must send a new request.
    Example: A0656EFF-FAF4-456F-B061-0161008D7C4E

  - `ErrorResponse.Identifier.authority` (string)
    Name of the supplier system that created this identifier - the source of information.  
For AirPrice, please note that GDS offers return the value 'Travelport' in authority while NDC offers return the carrier code of the issuing NDC carrier.  
When returned from Air Exchange Eligibility, authority is always 'Travelport' as the transaction issuer.  
For Hotels, authority indicates which supplier returned the lowest available rate for that property: either 'TVPT' (Travelport) or 'BKNG' (booking.com). Booking.com access requires additional provisioning and a direct agreement with the supplier. Authority is not returned if the property is closed or returns an error.  
For Hotel Create Reservation (Full Payload) and Sync Reservation send the value from the Availability response in CatalogOffering/Identifier/authority for the instance you want to book.
    Example: TVPT

  - `ErrorResponse.NextSteps` (object)
    Container for the steps that describe actions that may be taken on the containing object.  
Not applicable for an Eligibility or Exchange response.

  - `ErrorResponse.NextSteps.baseURI` (string, required)
    The base portion of the URI in order to shorten the uris in the individual steps

  - `ErrorResponse.NextSteps.id` (string)
    Optional internally referenced id
    Example: 5

  - `ErrorResponse.NextSteps.NextStep` (array, required)

  - `ErrorResponse.NextSteps.NextStep.value` (string)
    Example: www.resourcelocation.com

  - `ErrorResponse.NextSteps.NextStep.id` (string)
    Identifier for the Next Step
    Example: 2

  - `ErrorResponse.NextSteps.NextStep.action` (string, required)
    The action this next step is intended to achieve
    Example: cancel

  - `ErrorResponse.NextSteps.NextStep.method` (string, required)
    Describes the set of potential methods that can be taken after an operation.
    Enum: "GET", "DELETE", "PUT", "POST"

  - `ErrorResponse.NextSteps.NextStep.description` (string)
    Additional clarification for the next step
    Example: remove offer from the order

  - `ErrorResponse.ReferenceList` (array)

  - `ErrorResponse.ReferenceList.@type` (string, required)
    Discriminator
- Air Search child classes are ReferenceListAmenity, ReferenceListBrand, ReferenceListFlight, ReferenceListProduct, ReferenceListTermsAndConditions, and ReferenceListUniversalProductAttribute.
- Air Price child classes are ReferenceListAmenity and ReferenceListBrand.
- FareRules child class is ReferenceListFlight.
- Search Ancillaries child class is ReferenceListFlight.
- Seat Map child class is ReferenceListSeatingChart.
- Hotel Availability child class is ReferenceListPropertyDates.
- Reservation and Reservation Workbench child classes are ReferenceListAmenity, ReferenceListBrand, and ReferenceListUniversalProductAttribute.
- Exchange Search child classes are ReferenceListBrand, ReferenceListFlight, and ReferenceListExchangedPrice.
- Reservation Receipt child classes are ReferenceListOffer and ReferenceListTraveler.
- Book_Traveler child class is ReferenceListTraveler.
    Example: ReferenceListFlight

  - `ErrorResponse.ReferenceList.id` (string)
    Uniquely identifies for the Reference List

  - `ErrorResponse.CurrencyRateConversion` (array)

  - `ErrorResponse.CurrencyRateConversion.@type` (string)

  - `ErrorResponse.CurrencyRateConversion.SourceCurrency` (object, required)
    Currency codes are the three-letter alphabetic codes that represent the various currencies used throughout the world.  
Unless changed in the request, the currency is the default associated with your provisioned PCC from Travelport.  
For Hotel: SourceCurrency is based on the location of the hotel and used for all rates in the response. TargetCurrency is the currency code sent in the request in requestedCurrency.

  - `ErrorResponse.CurrencyRateConversion.SourceCurrency.value` (string)
    An ISO 4217 currency code.
    Example: USD

  - `ErrorResponse.CurrencyRateConversion.SourceCurrency.codeAuthority` (string)
    Currency code authority
    Example: ISO 4217

  - `ErrorResponse.CurrencyRateConversion.SourceCurrency.decimalPlace` (integer)
    Number of decimal places for the currency.
    Example: 4

  - `ErrorResponse.CurrencyRateConversion.SourceCurrency.decimalAuthority` (string)
    Currency code decimal authority
    Example: ISO 4217

  - `ErrorResponse.CurrencyRateConversion.ConversionRate` (object, required)
    Conversion rate of SourceCurrency value to TargetCurrency value. This value can be used to calculate, independently of the API, conversion for the rates in the response. The response does not convert any amounts.

  - `ErrorResponse.CurrencyRateConversion.ConversionRate.value` (number)

  - `ErrorResponse.CurrencyRateConversion.ConversionRate.rateAuthority` (string)
    Contextual rate authority
    Example: ISO 4217

  - `ErrorResponse.CurrencyRateConversion.ConversionRate.rateAsOf` (string)
    Rate as of
    Example: 2026-08-07T12:12:00Z

  - `ErrorResponse.Pagination` (object)
    Pagination object used when result sets span across a number of pages.

  - `ErrorResponse.Pagination.@type` (string, required)
    Example: Pagination

  - `ErrorResponse.Pagination.page` (integer, required)
    The current page number of the full result set
    Example: 1

  - `ErrorResponse.Pagination.pageSize` (integer, required)
    The total number of items on this page
    Example: 20

  - `ErrorResponse.Pagination.totalPages` (integer, required)
    The total number of pages in this result set
    Example: 5

  - `ErrorResponse.Pagination.totalItems` (integer, required)
    The total number of pages in this result set
    Example: 100

## Response 403 fields (application/json):

  - `ErrorResponse` (object)
    Base common error response

  - `ErrorResponse.@type` (string)
    Example: response

  - `ErrorResponse.transactionId` (string)
    A unique system-generated (128 bit GUID format) transaction/tracking id for a single request and response (i.e. for a single transaction) used for internal tracking and troubleshooting.  
Also known as E2ETrackingId.  
Not returned in all Hotel API responses.
    Example: 49f58f5f-c443-43b4-9f5d-be405fd00a01

  - `ErrorResponse.traceId` (string)
    Used in hospitality workflows to provide a unique transaction or tracking id for a single request and response.  
For Air Eligibility, returned if a custom trace ID was sent in the request header.  
For Hotel Rules, returned if a custom trace ID was sent in the request header.
    Example: TraceID_123456

  - `ErrorResponse.correlationId` (string)
    Identifier used to correlate hotel API invocations across a multi-call business flows.

  - `ErrorResponse.reservationStatus` (string)
    Status of reservation or offer completion.
    Enum: "Success", "Fail", "Partial", "Pending", "OnHold", "Retry", "Other"

  - `ErrorResponse.Result` (object)
    Returns the error and/or warning message information, if applicable.

  - `ErrorResponse.Result.@type` (string)
    Discriminator class Result only
    Example: Result

  - `ErrorResponse.Result.status` (string)
    The status of an error or warning
    Enum: "Not processed", "Incomplete", "Complete", "Unknown"

  - `ErrorResponse.Result.Error` (array)
    A list of error information returned at the provider level for a response.

  - `ErrorResponse.Result.Error.@type` (string, required)
    Discriminator classes Error or ErrorDetail
    Example: ErrorDetail

  - `ErrorResponse.Result.Error.StatusCode` (integer)
    Http standard response code
    Example: 200

  - `ErrorResponse.Result.Error.Message` (string)
    The Travelport standardized error or warning message
    Example: No flights found.

  - `ErrorResponse.Result.Error.NameValuePair` (array)

  - `ErrorResponse.Result.Error.NameValuePair.value` (string)
    Text directly related to name description, providing more detail. May have character restrictions based on remark type (e.g. Free Text limitations: 84 characters, alphanumeric and some special characters).
    Example: Sunday

  - `ErrorResponse.Result.Error.NameValuePair.id` (string)
    Optional internally referenced id
    Example: 6

  - `ErrorResponse.Result.Error.NameValuePair.name` (string, required)
    Key, categorizing the type of remark or error.
    Example: Day1

  - `ErrorResponse.Result.Warning` (array)
    A list of warning information returned at the provider level for a response.

  - `ErrorResponse.Result.Warning.@type` (string, required)
    Discriminator classes Warning or WarningDetail
    Example: WarningDetail

  - `ErrorResponse.Result.Warning.StatusCode` (integer)
    Http standard response code
    Example: 200

  - `ErrorResponse.Result.Warning.Message` (string)
    The Travelport standardized error or warning message
    Example: Customer Loyalty could not be applied.

  - `ErrorResponse.Result.Warning.NameValuePair` (array)

  - `ErrorResponse.Identifier` (object)
    A globally unique identifier key often used to reference a given option (such as Pricing, Booking, Rules, or additional workflows) or to retrieve information (such as Hotel pagination).

  - `ErrorResponse.Identifier.value` (string)
    Unique offer identifier that can be sent in subsequent payload requests to reference this offer.
When used for reference flight calls, the CatalogProductOfferingsIdentifier will be the transaction identifier from the Search, Next Leg Search, or Flight Specific Search response in CatalogProductOfferings/Identifier/value.
If you choose to pull the CatalogProductOfferingsIdentifier from the Price response instead (OfferListResponse/Identifier/value), either full or reference payload, please note for subsequent Add Offer requests you must remove the _PC appended to the end of the value in the AirPrice response (e.g., change value: '93d2091d-3d04-48ab-8091-6ae1525f02ea_PC' to value: '93d2091d-3d04-48ab-8091-6ae1525f02ea').
When building an AirPrice or Add Offer reference payload request:
- Look for the CatalogProductOfferingIdentifier (ex: o1) in a Search response at CatalogProductOfferings/CatalogProductOffering/id or a Price response at OfferListResponse/OfferID/id.
- Look for the ProductIdentifier (ex: p0) in a Search response at CatalogProductOfferings/CatalogProductOffering/ProductBrandOptions/ProductBrandOffering/Product/productRef or from a Price response at OfferListResponse/OfferID/Product/id.

When returned from a Workbench, this value is the workbench identifier that must be sent in all subsequent requests for this workbench session.
When returned from Air Exchange Eligibility, value is the ticket number sent with the eligibility request.
When used specifically for form of payment, the value will begin with the characters 'FOP'. Similarly, the OfferIdentifier associated will begin with the character 'O'.
For Hotel Create Reservation (Reference Payload), send the value from the Availability response in CatalogOffering/id or the value from SearchComplete returned in propertyItems/lowestPublicAvailableRate/rateKey/value.
Results from Hotel Availability and Hotel SearchComplete are stored in the cache for 30 minutes. If the offers expire before booking, you must send a new request.
    Example: A0656EFF-FAF4-456F-B061-0161008D7C4E

  - `ErrorResponse.Identifier.authority` (string)
    Name of the supplier system that created this identifier - the source of information.  
For AirPrice, please note that GDS offers return the value 'Travelport' in authority while NDC offers return the carrier code of the issuing NDC carrier.  
When returned from Air Exchange Eligibility, authority is always 'Travelport' as the transaction issuer.  
For Hotels, authority indicates which supplier returned the lowest available rate for that property: either 'TVPT' (Travelport) or 'BKNG' (booking.com). Booking.com access requires additional provisioning and a direct agreement with the supplier. Authority is not returned if the property is closed or returns an error.  
For Hotel Create Reservation (Full Payload) and Sync Reservation send the value from the Availability response in CatalogOffering/Identifier/authority for the instance you want to book.
    Example: TVPT

  - `ErrorResponse.NextSteps` (object)
    Container for the steps that describe actions that may be taken on the containing object.  
Not applicable for an Eligibility or Exchange response.

  - `ErrorResponse.NextSteps.baseURI` (string, required)
    The base portion of the URI in order to shorten the uris in the individual steps

  - `ErrorResponse.NextSteps.id` (string)
    Optional internally referenced id
    Example: 5

  - `ErrorResponse.NextSteps.NextStep` (array, required)

  - `ErrorResponse.NextSteps.NextStep.value` (string)
    Example: www.resourcelocation.com

  - `ErrorResponse.NextSteps.NextStep.id` (string)
    Identifier for the Next Step
    Example: 2

  - `ErrorResponse.NextSteps.NextStep.action` (string, required)
    The action this next step is intended to achieve
    Example: cancel

  - `ErrorResponse.NextSteps.NextStep.method` (string, required)
    Describes the set of potential methods that can be taken after an operation.
    Enum: "GET", "DELETE", "PUT", "POST"

  - `ErrorResponse.NextSteps.NextStep.description` (string)
    Additional clarification for the next step
    Example: remove offer from the order

  - `ErrorResponse.ReferenceList` (array)

  - `ErrorResponse.ReferenceList.@type` (string, required)
    Discriminator
- Air Search child classes are ReferenceListAmenity, ReferenceListBrand, ReferenceListFlight, ReferenceListProduct, ReferenceListTermsAndConditions, and ReferenceListUniversalProductAttribute.
- Air Price child classes are ReferenceListAmenity and ReferenceListBrand.
- FareRules child class is ReferenceListFlight.
- Search Ancillaries child class is ReferenceListFlight.
- Seat Map child class is ReferenceListSeatingChart.
- Hotel Availability child class is ReferenceListPropertyDates.
- Reservation and Reservation Workbench child classes are ReferenceListAmenity, ReferenceListBrand, and ReferenceListUniversalProductAttribute.
- Exchange Search child classes are ReferenceListBrand, ReferenceListFlight, and ReferenceListExchangedPrice.
- Reservation Receipt child classes are ReferenceListOffer and ReferenceListTraveler.
- Book_Traveler child class is ReferenceListTraveler.
    Example: ReferenceListFlight

  - `ErrorResponse.ReferenceList.id` (string)
    Uniquely identifies for the Reference List

  - `ErrorResponse.CurrencyRateConversion` (array)

  - `ErrorResponse.CurrencyRateConversion.@type` (string)

  - `ErrorResponse.CurrencyRateConversion.SourceCurrency` (object, required)
    Currency codes are the three-letter alphabetic codes that represent the various currencies used throughout the world.  
Unless changed in the request, the currency is the default associated with your provisioned PCC from Travelport.  
For Hotel: SourceCurrency is based on the location of the hotel and used for all rates in the response. TargetCurrency is the currency code sent in the request in requestedCurrency.

  - `ErrorResponse.CurrencyRateConversion.SourceCurrency.value` (string)
    An ISO 4217 currency code.
    Example: USD

  - `ErrorResponse.CurrencyRateConversion.SourceCurrency.codeAuthority` (string)
    Currency code authority
    Example: ISO 4217

  - `ErrorResponse.CurrencyRateConversion.SourceCurrency.decimalPlace` (integer)
    Number of decimal places for the currency.
    Example: 4

  - `ErrorResponse.CurrencyRateConversion.SourceCurrency.decimalAuthority` (string)
    Currency code decimal authority
    Example: ISO 4217

  - `ErrorResponse.CurrencyRateConversion.ConversionRate` (object, required)
    Conversion rate of SourceCurrency value to TargetCurrency value. This value can be used to calculate, independently of the API, conversion for the rates in the response. The response does not convert any amounts.

  - `ErrorResponse.CurrencyRateConversion.ConversionRate.value` (number)

  - `ErrorResponse.CurrencyRateConversion.ConversionRate.rateAuthority` (string)
    Contextual rate authority
    Example: ISO 4217

  - `ErrorResponse.CurrencyRateConversion.ConversionRate.rateAsOf` (string)
    Rate as of
    Example: 2026-08-07T12:12:00Z

  - `ErrorResponse.Pagination` (object)
    Pagination object used when result sets span across a number of pages.

  - `ErrorResponse.Pagination.@type` (string, required)
    Example: Pagination

  - `ErrorResponse.Pagination.page` (integer, required)
    The current page number of the full result set
    Example: 1

  - `ErrorResponse.Pagination.pageSize` (integer, required)
    The total number of items on this page
    Example: 20

  - `ErrorResponse.Pagination.totalPages` (integer, required)
    The total number of pages in this result set
    Example: 5

  - `ErrorResponse.Pagination.totalItems` (integer, required)
    The total number of pages in this result set
    Example: 100

## Response 404 fields (application/json):

  - `ErrorResponse` (object)
    Base common error response

  - `ErrorResponse.@type` (string)
    Example: response

  - `ErrorResponse.transactionId` (string)
    A unique system-generated (128 bit GUID format) transaction/tracking id for a single request and response (i.e. for a single transaction) used for internal tracking and troubleshooting.  
Also known as E2ETrackingId.  
Not returned in all Hotel API responses.
    Example: 49f58f5f-c443-43b4-9f5d-be405fd00a01

  - `ErrorResponse.traceId` (string)
    Used in hospitality workflows to provide a unique transaction or tracking id for a single request and response.  
For Air Eligibility, returned if a custom trace ID was sent in the request header.  
For Hotel Rules, returned if a custom trace ID was sent in the request header.
    Example: TraceID_123456

  - `ErrorResponse.correlationId` (string)
    Identifier used to correlate hotel API invocations across a multi-call business flows.

  - `ErrorResponse.reservationStatus` (string)
    Status of reservation or offer completion.
    Enum: "Success", "Fail", "Partial", "Pending", "OnHold", "Retry", "Other"

  - `ErrorResponse.Result` (object)
    Returns the error and/or warning message information, if applicable.

  - `ErrorResponse.Result.@type` (string)
    Discriminator class Result only
    Example: Result

  - `ErrorResponse.Result.status` (string)
    The status of an error or warning
    Enum: "Not processed", "Incomplete", "Complete", "Unknown"

  - `ErrorResponse.Result.Error` (array)
    A list of error information returned at the provider level for a response.

  - `ErrorResponse.Result.Error.@type` (string, required)
    Discriminator classes Error or ErrorDetail
    Example: ErrorDetail

  - `ErrorResponse.Result.Error.StatusCode` (integer)
    Http standard response code
    Example: 200

  - `ErrorResponse.Result.Error.Message` (string)
    The Travelport standardized error or warning message
    Example: No flights found.

  - `ErrorResponse.Result.Error.NameValuePair` (array)

  - `ErrorResponse.Result.Error.NameValuePair.value` (string)
    Text directly related to name description, providing more detail. May have character restrictions based on remark type (e.g. Free Text limitations: 84 characters, alphanumeric and some special characters).
    Example: Sunday

  - `ErrorResponse.Result.Error.NameValuePair.id` (string)
    Optional internally referenced id
    Example: 6

  - `ErrorResponse.Result.Error.NameValuePair.name` (string, required)
    Key, categorizing the type of remark or error.
    Example: Day1

  - `ErrorResponse.Result.Warning` (array)
    A list of warning information returned at the provider level for a response.

  - `ErrorResponse.Result.Warning.@type` (string, required)
    Discriminator classes Warning or WarningDetail
    Example: WarningDetail

  - `ErrorResponse.Result.Warning.StatusCode` (integer)
    Http standard response code
    Example: 200

  - `ErrorResponse.Result.Warning.Message` (string)
    The Travelport standardized error or warning message
    Example: Customer Loyalty could not be applied.

  - `ErrorResponse.Result.Warning.NameValuePair` (array)

  - `ErrorResponse.Identifier` (object)
    A globally unique identifier key often used to reference a given option (such as Pricing, Booking, Rules, or additional workflows) or to retrieve information (such as Hotel pagination).

  - `ErrorResponse.Identifier.value` (string)
    Unique offer identifier that can be sent in subsequent payload requests to reference this offer.
When used for reference flight calls, the CatalogProductOfferingsIdentifier will be the transaction identifier from the Search, Next Leg Search, or Flight Specific Search response in CatalogProductOfferings/Identifier/value.
If you choose to pull the CatalogProductOfferingsIdentifier from the Price response instead (OfferListResponse/Identifier/value), either full or reference payload, please note for subsequent Add Offer requests you must remove the _PC appended to the end of the value in the AirPrice response (e.g., change value: '93d2091d-3d04-48ab-8091-6ae1525f02ea_PC' to value: '93d2091d-3d04-48ab-8091-6ae1525f02ea').
When building an AirPrice or Add Offer reference payload request:
- Look for the CatalogProductOfferingIdentifier (ex: o1) in a Search response at CatalogProductOfferings/CatalogProductOffering/id or a Price response at OfferListResponse/OfferID/id.
- Look for the ProductIdentifier (ex: p0) in a Search response at CatalogProductOfferings/CatalogProductOffering/ProductBrandOptions/ProductBrandOffering/Product/productRef or from a Price response at OfferListResponse/OfferID/Product/id.

When returned from a Workbench, this value is the workbench identifier that must be sent in all subsequent requests for this workbench session.
When returned from Air Exchange Eligibility, value is the ticket number sent with the eligibility request.
When used specifically for form of payment, the value will begin with the characters 'FOP'. Similarly, the OfferIdentifier associated will begin with the character 'O'.
For Hotel Create Reservation (Reference Payload), send the value from the Availability response in CatalogOffering/id or the value from SearchComplete returned in propertyItems/lowestPublicAvailableRate/rateKey/value.
Results from Hotel Availability and Hotel SearchComplete are stored in the cache for 30 minutes. If the offers expire before booking, you must send a new request.
    Example: A0656EFF-FAF4-456F-B061-0161008D7C4E

  - `ErrorResponse.Identifier.authority` (string)
    Name of the supplier system that created this identifier - the source of information.  
For AirPrice, please note that GDS offers return the value 'Travelport' in authority while NDC offers return the carrier code of the issuing NDC carrier.  
When returned from Air Exchange Eligibility, authority is always 'Travelport' as the transaction issuer.  
For Hotels, authority indicates which supplier returned the lowest available rate for that property: either 'TVPT' (Travelport) or 'BKNG' (booking.com). Booking.com access requires additional provisioning and a direct agreement with the supplier. Authority is not returned if the property is closed or returns an error.  
For Hotel Create Reservation (Full Payload) and Sync Reservation send the value from the Availability response in CatalogOffering/Identifier/authority for the instance you want to book.
    Example: TVPT

  - `ErrorResponse.NextSteps` (object)
    Container for the steps that describe actions that may be taken on the containing object.  
Not applicable for an Eligibility or Exchange response.

  - `ErrorResponse.NextSteps.baseURI` (string, required)
    The base portion of the URI in order to shorten the uris in the individual steps

  - `ErrorResponse.NextSteps.id` (string)
    Optional internally referenced id
    Example: 5

  - `ErrorResponse.NextSteps.NextStep` (array, required)

  - `ErrorResponse.NextSteps.NextStep.value` (string)
    Example: www.resourcelocation.com

  - `ErrorResponse.NextSteps.NextStep.id` (string)
    Identifier for the Next Step
    Example: 2

  - `ErrorResponse.NextSteps.NextStep.action` (string, required)
    The action this next step is intended to achieve
    Example: cancel

  - `ErrorResponse.NextSteps.NextStep.method` (string, required)
    Describes the set of potential methods that can be taken after an operation.
    Enum: "GET", "DELETE", "PUT", "POST"

  - `ErrorResponse.NextSteps.NextStep.description` (string)
    Additional clarification for the next step
    Example: remove offer from the order

  - `ErrorResponse.ReferenceList` (array)

  - `ErrorResponse.ReferenceList.@type` (string, required)
    Discriminator
- Air Search child classes are ReferenceListAmenity, ReferenceListBrand, ReferenceListFlight, ReferenceListProduct, ReferenceListTermsAndConditions, and ReferenceListUniversalProductAttribute.
- Air Price child classes are ReferenceListAmenity and ReferenceListBrand.
- FareRules child class is ReferenceListFlight.
- Search Ancillaries child class is ReferenceListFlight.
- Seat Map child class is ReferenceListSeatingChart.
- Hotel Availability child class is ReferenceListPropertyDates.
- Reservation and Reservation Workbench child classes are ReferenceListAmenity, ReferenceListBrand, and ReferenceListUniversalProductAttribute.
- Exchange Search child classes are ReferenceListBrand, ReferenceListFlight, and ReferenceListExchangedPrice.
- Reservation Receipt child classes are ReferenceListOffer and ReferenceListTraveler.
- Book_Traveler child class is ReferenceListTraveler.
    Example: ReferenceListFlight

  - `ErrorResponse.ReferenceList.id` (string)
    Uniquely identifies for the Reference List

  - `ErrorResponse.CurrencyRateConversion` (array)

  - `ErrorResponse.CurrencyRateConversion.@type` (string)

  - `ErrorResponse.CurrencyRateConversion.SourceCurrency` (object, required)
    Currency codes are the three-letter alphabetic codes that represent the various currencies used throughout the world.  
Unless changed in the request, the currency is the default associated with your provisioned PCC from Travelport.  
For Hotel: SourceCurrency is based on the location of the hotel and used for all rates in the response. TargetCurrency is the currency code sent in the request in requestedCurrency.

  - `ErrorResponse.CurrencyRateConversion.SourceCurrency.value` (string)
    An ISO 4217 currency code.
    Example: USD

  - `ErrorResponse.CurrencyRateConversion.SourceCurrency.codeAuthority` (string)
    Currency code authority
    Example: ISO 4217

  - `ErrorResponse.CurrencyRateConversion.SourceCurrency.decimalPlace` (integer)
    Number of decimal places for the currency.
    Example: 4

  - `ErrorResponse.CurrencyRateConversion.SourceCurrency.decimalAuthority` (string)
    Currency code decimal authority
    Example: ISO 4217

  - `ErrorResponse.CurrencyRateConversion.ConversionRate` (object, required)
    Conversion rate of SourceCurrency value to TargetCurrency value. This value can be used to calculate, independently of the API, conversion for the rates in the response. The response does not convert any amounts.

  - `ErrorResponse.CurrencyRateConversion.ConversionRate.value` (number)

  - `ErrorResponse.CurrencyRateConversion.ConversionRate.rateAuthority` (string)
    Contextual rate authority
    Example: ISO 4217

  - `ErrorResponse.CurrencyRateConversion.ConversionRate.rateAsOf` (string)
    Rate as of
    Example: 2026-08-07T12:12:00Z

  - `ErrorResponse.Pagination` (object)
    Pagination object used when result sets span across a number of pages.

  - `ErrorResponse.Pagination.@type` (string, required)
    Example: Pagination

  - `ErrorResponse.Pagination.page` (integer, required)
    The current page number of the full result set
    Example: 1

  - `ErrorResponse.Pagination.pageSize` (integer, required)
    The total number of items on this page
    Example: 20

  - `ErrorResponse.Pagination.totalPages` (integer, required)
    The total number of pages in this result set
    Example: 5

  - `ErrorResponse.Pagination.totalItems` (integer, required)
    The total number of pages in this result set
    Example: 100

## Response 500 fields (application/json):

  - `ErrorResponse` (object)
    Base common error response

  - `ErrorResponse.@type` (string)
    Example: response

  - `ErrorResponse.transactionId` (string)
    A unique system-generated (128 bit GUID format) transaction/tracking id for a single request and response (i.e. for a single transaction) used for internal tracking and troubleshooting.  
Also known as E2ETrackingId.  
Not returned in all Hotel API responses.
    Example: 49f58f5f-c443-43b4-9f5d-be405fd00a01

  - `ErrorResponse.traceId` (string)
    Used in hospitality workflows to provide a unique transaction or tracking id for a single request and response.  
For Air Eligibility, returned if a custom trace ID was sent in the request header.  
For Hotel Rules, returned if a custom trace ID was sent in the request header.
    Example: TraceID_123456

  - `ErrorResponse.correlationId` (string)
    Identifier used to correlate hotel API invocations across a multi-call business flows.

  - `ErrorResponse.reservationStatus` (string)
    Status of reservation or offer completion.
    Enum: "Success", "Fail", "Partial", "Pending", "OnHold", "Retry", "Other"

  - `ErrorResponse.Result` (object)
    Returns the error and/or warning message information, if applicable.

  - `ErrorResponse.Result.@type` (string)
    Discriminator class Result only
    Example: Result

  - `ErrorResponse.Result.status` (string)
    The status of an error or warning
    Enum: "Not processed", "Incomplete", "Complete", "Unknown"

  - `ErrorResponse.Result.Error` (array)
    A list of error information returned at the provider level for a response.

  - `ErrorResponse.Result.Error.@type` (string, required)
    Discriminator classes Error or ErrorDetail
    Example: ErrorDetail

  - `ErrorResponse.Result.Error.StatusCode` (integer)
    Http standard response code
    Example: 200

  - `ErrorResponse.Result.Error.Message` (string)
    The Travelport standardized error or warning message
    Example: No flights found.

  - `ErrorResponse.Result.Error.NameValuePair` (array)

  - `ErrorResponse.Result.Error.NameValuePair.value` (string)
    Text directly related to name description, providing more detail. May have character restrictions based on remark type (e.g. Free Text limitations: 84 characters, alphanumeric and some special characters).
    Example: Sunday

  - `ErrorResponse.Result.Error.NameValuePair.id` (string)
    Optional internally referenced id
    Example: 6

  - `ErrorResponse.Result.Error.NameValuePair.name` (string, required)
    Key, categorizing the type of remark or error.
    Example: Day1

  - `ErrorResponse.Result.Warning` (array)
    A list of warning information returned at the provider level for a response.

  - `ErrorResponse.Result.Warning.@type` (string, required)
    Discriminator classes Warning or WarningDetail
    Example: WarningDetail

  - `ErrorResponse.Result.Warning.StatusCode` (integer)
    Http standard response code
    Example: 200

  - `ErrorResponse.Result.Warning.Message` (string)
    The Travelport standardized error or warning message
    Example: Customer Loyalty could not be applied.

  - `ErrorResponse.Result.Warning.NameValuePair` (array)

  - `ErrorResponse.Identifier` (object)
    A globally unique identifier key often used to reference a given option (such as Pricing, Booking, Rules, or additional workflows) or to retrieve information (such as Hotel pagination).

  - `ErrorResponse.Identifier.value` (string)
    Unique offer identifier that can be sent in subsequent payload requests to reference this offer.
When used for reference flight calls, the CatalogProductOfferingsIdentifier will be the transaction identifier from the Search, Next Leg Search, or Flight Specific Search response in CatalogProductOfferings/Identifier/value.
If you choose to pull the CatalogProductOfferingsIdentifier from the Price response instead (OfferListResponse/Identifier/value), either full or reference payload, please note for subsequent Add Offer requests you must remove the _PC appended to the end of the value in the AirPrice response (e.g., change value: '93d2091d-3d04-48ab-8091-6ae1525f02ea_PC' to value: '93d2091d-3d04-48ab-8091-6ae1525f02ea').
When building an AirPrice or Add Offer reference payload request:
- Look for the CatalogProductOfferingIdentifier (ex: o1) in a Search response at CatalogProductOfferings/CatalogProductOffering/id or a Price response at OfferListResponse/OfferID/id.
- Look for the ProductIdentifier (ex: p0) in a Search response at CatalogProductOfferings/CatalogProductOffering/ProductBrandOptions/ProductBrandOffering/Product/productRef or from a Price response at OfferListResponse/OfferID/Product/id.

When returned from a Workbench, this value is the workbench identifier that must be sent in all subsequent requests for this workbench session.
When returned from Air Exchange Eligibility, value is the ticket number sent with the eligibility request.
When used specifically for form of payment, the value will begin with the characters 'FOP'. Similarly, the OfferIdentifier associated will begin with the character 'O'.
For Hotel Create Reservation (Reference Payload), send the value from the Availability response in CatalogOffering/id or the value from SearchComplete returned in propertyItems/lowestPublicAvailableRate/rateKey/value.
Results from Hotel Availability and Hotel SearchComplete are stored in the cache for 30 minutes. If the offers expire before booking, you must send a new request.
    Example: A0656EFF-FAF4-456F-B061-0161008D7C4E

  - `ErrorResponse.Identifier.authority` (string)
    Name of the supplier system that created this identifier - the source of information.  
For AirPrice, please note that GDS offers return the value 'Travelport' in authority while NDC offers return the carrier code of the issuing NDC carrier.  
When returned from Air Exchange Eligibility, authority is always 'Travelport' as the transaction issuer.  
For Hotels, authority indicates which supplier returned the lowest available rate for that property: either 'TVPT' (Travelport) or 'BKNG' (booking.com). Booking.com access requires additional provisioning and a direct agreement with the supplier. Authority is not returned if the property is closed or returns an error.  
For Hotel Create Reservation (Full Payload) and Sync Reservation send the value from the Availability response in CatalogOffering/Identifier/authority for the instance you want to book.
    Example: TVPT

  - `ErrorResponse.NextSteps` (object)
    Container for the steps that describe actions that may be taken on the containing object.  
Not applicable for an Eligibility or Exchange response.

  - `ErrorResponse.NextSteps.baseURI` (string, required)
    The base portion of the URI in order to shorten the uris in the individual steps

  - `ErrorResponse.NextSteps.id` (string)
    Optional internally referenced id
    Example: 5

  - `ErrorResponse.NextSteps.NextStep` (array, required)

  - `ErrorResponse.NextSteps.NextStep.value` (string)
    Example: www.resourcelocation.com

  - `ErrorResponse.NextSteps.NextStep.id` (string)
    Identifier for the Next Step
    Example: 2

  - `ErrorResponse.NextSteps.NextStep.action` (string, required)
    The action this next step is intended to achieve
    Example: cancel

  - `ErrorResponse.NextSteps.NextStep.method` (string, required)
    Describes the set of potential methods that can be taken after an operation.
    Enum: "GET", "DELETE", "PUT", "POST"

  - `ErrorResponse.NextSteps.NextStep.description` (string)
    Additional clarification for the next step
    Example: remove offer from the order

  - `ErrorResponse.ReferenceList` (array)

  - `ErrorResponse.ReferenceList.@type` (string, required)
    Discriminator
- Air Search child classes are ReferenceListAmenity, ReferenceListBrand, ReferenceListFlight, ReferenceListProduct, ReferenceListTermsAndConditions, and ReferenceListUniversalProductAttribute.
- Air Price child classes are ReferenceListAmenity and ReferenceListBrand.
- FareRules child class is ReferenceListFlight.
- Search Ancillaries child class is ReferenceListFlight.
- Seat Map child class is ReferenceListSeatingChart.
- Hotel Availability child class is ReferenceListPropertyDates.
- Reservation and Reservation Workbench child classes are ReferenceListAmenity, ReferenceListBrand, and ReferenceListUniversalProductAttribute.
- Exchange Search child classes are ReferenceListBrand, ReferenceListFlight, and ReferenceListExchangedPrice.
- Reservation Receipt child classes are ReferenceListOffer and ReferenceListTraveler.
- Book_Traveler child class is ReferenceListTraveler.
    Example: ReferenceListFlight

  - `ErrorResponse.ReferenceList.id` (string)
    Uniquely identifies for the Reference List

  - `ErrorResponse.CurrencyRateConversion` (array)

  - `ErrorResponse.CurrencyRateConversion.@type` (string)

  - `ErrorResponse.CurrencyRateConversion.SourceCurrency` (object, required)
    Currency codes are the three-letter alphabetic codes that represent the various currencies used throughout the world.  
Unless changed in the request, the currency is the default associated with your provisioned PCC from Travelport.  
For Hotel: SourceCurrency is based on the location of the hotel and used for all rates in the response. TargetCurrency is the currency code sent in the request in requestedCurrency.

  - `ErrorResponse.CurrencyRateConversion.SourceCurrency.value` (string)
    An ISO 4217 currency code.
    Example: USD

  - `ErrorResponse.CurrencyRateConversion.SourceCurrency.codeAuthority` (string)
    Currency code authority
    Example: ISO 4217

  - `ErrorResponse.CurrencyRateConversion.SourceCurrency.decimalPlace` (integer)
    Number of decimal places for the currency.
    Example: 4

  - `ErrorResponse.CurrencyRateConversion.SourceCurrency.decimalAuthority` (string)
    Currency code decimal authority
    Example: ISO 4217

  - `ErrorResponse.CurrencyRateConversion.ConversionRate` (object, required)
    Conversion rate of SourceCurrency value to TargetCurrency value. This value can be used to calculate, independently of the API, conversion for the rates in the response. The response does not convert any amounts.

  - `ErrorResponse.CurrencyRateConversion.ConversionRate.value` (number)

  - `ErrorResponse.CurrencyRateConversion.ConversionRate.rateAuthority` (string)
    Contextual rate authority
    Example: ISO 4217

  - `ErrorResponse.CurrencyRateConversion.ConversionRate.rateAsOf` (string)
    Rate as of
    Example: 2026-08-07T12:12:00Z

  - `ErrorResponse.Pagination` (object)
    Pagination object used when result sets span across a number of pages.

  - `ErrorResponse.Pagination.@type` (string, required)
    Example: Pagination

  - `ErrorResponse.Pagination.page` (integer, required)
    The current page number of the full result set
    Example: 1

  - `ErrorResponse.Pagination.pageSize` (integer, required)
    The total number of items on this page
    Example: 20

  - `ErrorResponse.Pagination.totalPages` (integer, required)
    The total number of pages in this result set
    Example: 5

  - `ErrorResponse.Pagination.totalItems` (integer, required)
    The total number of pages in this result set
    Example: 100