# Modify existing hotel reservation.

Use Modify Hotel Reservation to modify specific data on an existing booking. Modify Hotel supports changes to the following data: 
  - Dates of reservation  
    - If allowed by supplier; note that a change in price may occur  

  - Form of payment details  

  - One or more specific details of the traveler associated with a booking:  
      - Changing the given name and/or surname to that of another traveler currently on the reservation; other name changes are not supported  
      - Telephone number  
      - Email address  
      - Adding new comments  

Please note: Booking.com does not support modify capabilities. You cannot modify reservations made from Booking.com content.  
Please note: When changing dates for a reservation sold through Travelport, best practice is to first send an Availability request for the new dates and look for the same booking code that is on the existing reservation. Although an Availability request is not mandatory, the Modify request will fail if the new dates are not available.  
Add Hotel Reservation allows you to add another hotel room to an existing reservation. The full payload request sends complete offer details and the booking code from a preceding Availability request. Reference payload request sends a cached offer ID from a preceding Availability response. It requires both a preceding search (either by location or by ID) request and an Availability request, or a SearchComplete request.

Endpoint: PUT /hotel/book/reservations/{Identifier}
Version: 11.36.0
Security: bearerAuth

## Security:

  - `bearerAuth` (unknown)
    http bearer JWT

## Path parameters:

  - `Identifier` (string, required)
    Identifier provides the ability to create a globally unique identifier. For the identifier to be globally unique it must have a system provided identifier and the system must be identified using a global naming authority. System identification uses the domain naming system (DNS) to assure they are globally unique and should be an URL. The system provided ID will typically be a primary or surrogate key in a database.

## Query parameters:

  - `acceptPriceChangeInd` (boolean)
    If true, user accepts any difference in the total price received in availability versus what is the current price in the sell process; false denotes that the user does not accept a price difference and the sell process should not complete. If indicator is not sent the service will default to false.

  - `acceptGuaranteeChangeInd` (boolean)
    If true, the user accepts any difference in the guarantee type (guarantee required, deposit required, prepay required) received in availability versus what is the current guarantee type in the sell process; false denotes that the user does not accept a guarantee type difference and the sell process should not complete. If indicator is not sent the service will default to false.

  - `maximumPriceIncrease` (number)
    When acceptPriceChangeInd parameter is set to true you can use this maximumPriceIncrease parameter to specify a percentage threshold where a price change is acceptable. If the total price increase between the Sell and the Avail/Rules request is over this threshold the sell will be stopped and an error returned.

  - `applyStrictReservationCommentValidationInd` (boolean)
    If true, the user expects that the sell request will be failed if any of the requested reservation comments fail.  If indicator is not sent the service will default to false.

## Header parameters:

  - `TraceId` (string)
    Used in hospitality workflows to provide a Unique transaction or tracking id for a single request and response.

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

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

  - `TVP-Correlation-Id` (string)
    Identifier used to correlate hotel API invocations across a multi-call business flows.

## Request fields (application/json):

  - `ReservationDetail` (object)
    Used for Hotel Reservation (Full Payload), Sync Reservation, and Passive Reservation requests. Defines the reservation details sent to create, add, modify, synchronize, or passively store a hotel booking segment.  In standard booking workflows, this request is typically sent after Hotel Availability, Rules, or SearchComplete.  In passive or sync workflows, it is used to store or synchronize hotel reservation information without performing a standard hotel sell. Additionally used for the response of Create Reservation (Reference Payload), Create Reservation (Full Payload), or Sync endpoint calls.

  - `ReservationDetail.Accounting` (object)
    Defines Accounting information. Used for all DOCI remarks.

  - `ReservationDetail.Accounting.@type` (string, required)
    Discriminator classes AccountingID or Accounting
    Example: Accounting

  - `ReservationDetail.Accounting.id` (string)

  - `ReservationDetail.Accounting.AccountingRef` (string)
    Accounting reference

  - `ReservationDetail.Accounting.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).

  - `ReservationDetail.Accounting.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 system generated 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'.
- If not available, for Payment, any unique identifier can be sent.

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

  - `ReservationDetail.Accounting.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

  - `ReservationDetail.Accounting.dataType` (string)
    Accounting data type. When used as Accounting remark designator the accepted value is DOCI.
    Example: DateTime

  - `ReservationDetail.Accounting.template` (string)
    Accounting template
    Example: Internal Finance template

  - `ReservationDetail.Accounting.NameValuePair` (array)
    'Defines the type of accounting-specific remark (name) and the remark itself (value).
Send the following in "name" for each type of remark: DYO - Design Your Own Itinerary FS - Fare Saver CR - Canned Remarks TK - Ticket Number Details AC - Agent, Account, or Branch Details AR - Replace Sign On Code X* - Back Office Accounting Details FT - Free Text
For remark text "value", please note character limits for each type of remark:  DYO - 2 digit, numeric FS - 9 characters total limit in format 1 (all numeric) or format 2 (numeric “–“ two alpha) CR - 42 characters total limit in format (two numeric "." two numeric "." etc) TK - 8 to 12 characters in format 1 (all numeric) or format 2 (numeric “-“ three numeric) AC - 42 characters, alphanumeric and some special characters AR - 10 characters, alphanumeric X* - 84 characters, alphanumeric and some special characters FT - 84 characters, alphanumeric and some special characters'

  - `ReservationDetail.Accounting.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

  - `ReservationDetail.Accounting.NameValuePair.id` (string)
    Optional internally referenced id
    Example: 6

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

  - `ReservationDetail.DocumentOverrides` (array)

  - `ReservationDetail.DocumentOverrides.@type` (string, required)
    Discriminator classes DocumentOverridesID or DocumentOverrides
    Example: DocumentOverrides

  - `ReservationDetail.DocumentOverrides.id` (string)
    The reporting number.
    Example: documentoverrides_001

  - `ReservationDetail.DocumentOverrides.DocumentOverridesRef` (string)

  - `ReservationDetail.DocumentOverrides.OfferIdentifier` (object)
    Travelport-generated offer identifier number.

  - `ReservationDetail.DocumentOverrides.OfferIdentifier.id` (string)
    Local identifier within a given message for this object.
    Example: offer_1

  - `ReservationDetail.DocumentOverrides.OfferIdentifier.offerRef` (string)
    Used to reference another instance of this object in the same message
    Example: offer_1

  - `ReservationDetail.DocumentOverrides.ProductIdentifier` (object)
    Product Identifier class. In next leg search Value from CatalogProductOffering/ProductBrandOptions/ProductBrandOffering/Product/productRef in the Search response for the product to select for the first leg of the itinerary. When sending a second Next Leg Search request in a multi-city search, this value should be the offer for the second leg of the itinerary, and so on for additional O&D pairs.

  - `ReservationDetail.DocumentOverrides.ProductIdentifier.id` (string)
    Local identifier within a given message for this object.
    Example: product_1

  - `ReservationDetail.DocumentOverrides.ProductIdentifier.productRef` (string)
    Used to reference another instance of this object in the same payload.
    Example: product_1

  - `ReservationDetail.DocumentOverrides.Commissions` (array)

  - `ReservationDetail.DocumentOverrides.Commissions.@type` (string)

  - `ReservationDetail.DocumentOverrides.Commissions.TravelerIdentifierRef` (array)

  - `ReservationDetail.DocumentOverrides.Commissions.TravelerIdentifierRef.value` (string)
    Example: traveler_001

  - `ReservationDetail.DocumentOverrides.Commissions.TravelerIdentifierRef.id` (string)
    A locally referenced ID
    Example: id_001

  - `ReservationDetail.DocumentOverrides.Commissions.TravelerIdentifierRef.description` (string)
    Descriptive text used to identify the contents of a target object
    Example: Descriptive Text

  - `ReservationDetail.DocumentOverrides.Commissions.TravelerIdentifierRef.uris` (array)
    Uniform Resource Identifier
    Example: ["www.travelport.com/uri"]

  - `ReservationDetail.DocumentOverrides.Commissions.Commission` (object, required)
    GDS only; not supported for NDC.  
Commission information.  
Any commission filed by an airline in a CAT35 fare is returned in PriceBreakdownAir/Commission. The amount is either a percent of the fare component (@type CommissionPercent and the Percent object) or an amount (@type CommissionAmount and the Amount object).

  - `ReservationDetail.DocumentOverrides.Commissions.Commission.@type` (string, required)
    Discriminator. Child classes CommissionAmount or CommissionPercent
    Example: CommissionAmount

  - `ReservationDetail.DocumentOverrides.Commissions.Commission.application` (string)
    Type of commission
    Enum: "Full", "Partial", "Non-paying", "No-show", "Adjustment", "Commissionable"

  - `ReservationDetail.DocumentOverrides.Commissions.Commission.Amount` (object)
    A monetary amount, up to 4 decimal places. Decimal place must be included.

  - `ReservationDetail.DocumentOverrides.Commissions.Commission.Amount.value` (number)
    The amount of a given currency.
    Example: 124.56

  - `ReservationDetail.DocumentOverrides.Commissions.Commission.Amount.code` (string)
    An ISO 4217 alpha character code (3 characters) that specifies a money unit.
    Example: USD

  - `ReservationDetail.DocumentOverrides.Commissions.Commission.Amount.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

  - `ReservationDetail.DocumentOverrides.Commissions.Commission.Amount.currencySource` (string)
    The system requesting or returning the currency code specified in the attribute
    Enum: "Supplier", "Charged", "Requested"

  - `ReservationDetail.DocumentOverrides.Commissions.Commission.Amount.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

  - `ReservationDetail.DocumentOverrides.Commissions.Commission.Percent` (number)
    Percent amount of commission
    Example: 20

  - `ReservationDetail.DocumentOverrides.Commissions.ApplyTo` (string)
    List of commission Apply
    Enum: "Base", "Fee"

  - `ReservationDetail.DocumentOverrides.DestinationPurpose` (array)

  - `ReservationDetail.DocumentOverrides.DestinationPurpose.@type` (string)
    Example: DestinationPurpose

  - `ReservationDetail.DocumentOverrides.DestinationPurpose.destination` (string, required)
    List of destinations
    Enum: "United States of America", "Mexico / Central America / Canal Zone/ Costa Rica", "Islands and Countries of the Caribbean", "South America", "Europe", "Africa", "Middle East / Western Asia", "Asia", "Australia / New Zealand / Pacific Islands", "Canada and Greenland"

  - `ReservationDetail.DocumentOverrides.DestinationPurpose.purpose` (string, required)
    The purpose exposed.
    Enum: "Business", "Pleasure", "Charter Service"

  - `ReservationDetail.DocumentOverrides.Restrictions` (array)

  - `ReservationDetail.DocumentOverrides.Restrictions.@type` (string)

  - `ReservationDetail.DocumentOverrides.Restrictions.TravelerIdentifierRef` (array)

  - `ReservationDetail.DocumentOverrides.Restrictions.Restriction` (array, required)
    The restriction/endorsement text. Maximum 29 characters per line.
    Example: ["VALID BA ONLY","NON REFUNDABLE"]

  - `ReservationDetail.DocumentOverrides.Restrictions.DocumentType` (string)
    Document type like EMD, MCO
    Enum: "EMD", "MCO", "Ticket", "TASF", "Invoice"

  - `ReservationDetail.DocumentOverrides.TourCodes` (array)

  - `ReservationDetail.DocumentOverrides.TourCodes.@type` (string)
    Discriminator. No child classes.
    Example: TourCodes

  - `ReservationDetail.DocumentOverrides.TourCodes.TravelerIdentifierRef` (array)
    Reference the traveler if the tour code is traveler specific. Leave blank to apply to all travelers.

  - `ReservationDetail.DocumentOverrides.TourCodes.TourCode` (object, required)
    Tour code

  - `ReservationDetail.DocumentOverrides.TourCodes.TourCode.value` (string)
    The actual value of the tour code.

  - `ReservationDetail.DocumentOverrides.TourCodes.TourCode.tourCodeType` (string)
    List of tour code types.
    Enum: "Bulk Tour", "Inclusive Tour"

  - `ReservationDetail.DocumentOverrides.ChangeFeeCollectionMethod` (object)

  - `ReservationDetail.DocumentOverrides.ChangeFeeCollectionMethod.value` (string)
    List of change fee method
    Enum: "EMD", "MCO", "Tax", "Unknown"

  - `ReservationDetail.DocumentOverrides.ChangeFeeCollectionMethod.code` (string, required)
    The code value
    Example: f2142

  - `ReservationDetail.DocumentOverrides.ChangeFeeCollectionMethod.subCode` (string)
    The subcode value
    Example: 631b

  - `ReservationDetail.DocumentOverrides.ChangeFeeCollectionMethod.description` (string)
    The description value
    Example: Change fee collection method

  - `ReservationDetail.DocumentOverrides.ChangeFeeCollectionMethod.changeFeeIssuedSeparatelyInd` (boolean)
    if true, the change fee will be issued as a separate transaction to the residual amount
    Example: true

  - `ReservationDetail.DocumentOverrides.ChangeFeeCollectionMethod.taxIncludedInBaseAmountInd` (boolean)
    If true, the tax  on the fee will be included in the base fee amount and sent as a single value to the supplier for fulfilment
    Example: true

  - `ReservationDetail.DocumentOverrides.NetRemitInfo` (object)

  - `ReservationDetail.DocumentOverrides.NetRemitInfo.@type` (string)
    Example: NetRemitInfo

  - `ReservationDetail.DocumentOverrides.NetRemitInfo.CarCode` (string)
    The CAR code or deal code applied to this product for use in net remit.
    Example: ACAR

  - `ReservationDetail.DocumentOverrides.NetRemitInfo.ValueCode` (string)
    The Value code applied to this product for use in net remit
    Example: D1000

  - `ReservationDetail.DocumentOverrides.NetRemitInfo.ActualSellingFare` (number)
    The actual selling fare which will override the Offer base fare on the document
    Example: 100.5

  - `ReservationDetail.DocumentOverrides.NetRemitInfo.NetBaseAmount` (object)
    Returned only in the Price and Reservation Retrieve APIs. GDS only; not supported for NDC.
The base amount of a ticket price or net price that is filed in local currency.
Returned when the origin currency is not the same as the PCC currency to show the currency in which the base fare has been filed.
When used for NetBaseAmount: Net ticket data (NTD) is returned in the AirPrice, AirReservation, Exchange Search, and Reservation Retrieve responses for any GDS fare that has a private fare component (fareType=AgencyPrivateFare). When NTD is returned, TermsAndConditionsFuill includes FareGuaranteePolicy to return the fare calculation indicator for the fare.   When NTD is returned, PriceBreakdown may include NetBaseAmount.

  - `ReservationDetail.DocumentOverrides.NetRemitInfo.NetBaseAmount.value` (number)
    Filed amount value
    Example: 43.3422

  - `ReservationDetail.DocumentOverrides.NetRemitInfo.NetBaseAmount.currencyCode` (string)
    Code for the currency in which the base fare was filed.
    Example: USD

  - `ReservationDetail.DocumentOverrides.NetRemitInfo.NetBaseAmount.codeAuthority` (string)
    Filed amount currency code authority
    Example: Australian Dollar

  - `ReservationDetail.DocumentOverrides.NetRemitInfo.NetBaseAmount.decimalPlace` (integer, required)
    Number of decimal places in the currency in ISO 4217 standard format.
    Example: 3

  - `ReservationDetail.DocumentOverrides.NetRemitInfo.NetBaseAmount.decimalAuthority` (string)
    ISO 4217 standard decimal authority
    Example: ISO 4217

  - `ReservationDetail.DocumentOverrides.NetRemitInfo.ClientDiscountCode` (string)
    The client discount code applied to this product for net remit.
    Example: DEF456

  - `ReservationDetail.DocumentOverrides.TicketDesignators` (array)

  - `ReservationDetail.DocumentOverrides.TicketDesignators.@type` (string, required)
    Discriminator class TicketDesignators only

  - `ReservationDetail.DocumentOverrides.TicketDesignators.TravelerIdentifierRef` (array)

  - `ReservationDetail.DocumentOverrides.TicketDesignators.TicketDesignator` (string, required)

  - `ReservationDetail.DocumentOverrides.residualValueAsEvenExchangeMIRInd` (boolean)
    Report an exchange with residual value transaction as an Even exchange in the MIR.
    Example: true

  - `ReservationDetail.DocumentOverrides.obFeeExemptInd` (boolean)
    If true, the associated Offer is exempt from OB Payment Card Fees.
    Example: true

  - `ReservationDetail.CustomRule` (object)

  - `ReservationDetail.CustomRule.@type` (string, required)
    Discriminator classes CustomRuleID or CustomRule

  - `ReservationDetail.CustomRule.id` (string)
    Custom rule id reference ID.

## Request examples:

  - `Reservation by offer ID` (unknown)

  - `Group reservation by offer ID` (unknown)

  - `Reservation by full offer` (unknown)

  - `Modify reservation payment card` (unknown)

  - `Modify reservation check In/Out` (unknown)

  - `Modify reservation comment` (unknown)

  - `Modify reservation traveler phone` (unknown)

  - `Modify reservation traveler name` (unknown)

  - `Create MK passive reservation` (unknown)

## Response 200:

  - `200` (unknown)
    OK - Successful Response - 200

## Response 200 fields (application/json):

  - `ReservationResponse` (object)
    The response of a Create Reservation (Reference or Full Payload), Sync Reservation, Modify/Add Reservation, Create/Modify Passive Reservation, Retrieve Reservation, or Cancel Reservation endpoint.
The structure detailed here is the same for all of these API responses. For Post-Commit Workbench Create and Workbench Retrieve the response is structured the same, plus a workbench identifier.
The information returned in the Reservation Retrieve response varies depending on the information that has been added to the reservation at the time of retrieve, whether the reservation has been ticketed, and whether the reservation was created using the Travelport TripServices APIs or another program.
Please note the requests for Workbench Commit (Create Reservation), Post-Commit Workbench Create, and Workbench Retrieve do not support the query parameters available in Reservation Retrieve and do not return the following:
- any document override, accounting, historical, and DOCI remarks
- any custom rules
- brand attributes
- baggage dimension and fee details
- fare rules
- ATPCO RouteHappy flight amenities

For Two-step Commit:   In the initial booking workflow, or when adding an offer to an existing reservation, or during an exchange, you can send enableTwoStepCommitInd=true to enable a two-step commit process that returns a warning if specific error scenarios occur. See [Two-step Commit in the Guides](https://developer.travelport.com/docs/flights/guides/booking-and-reservations/flights-booking-guide#enable-warnings-for-price-or-schedule-changes-or-minimum-connect-time-mct-two-step-commit) for more information.   If a Two-step Commit is triggered, the booking is not created and the first commit response returns objects that may not return in a typical commit response payload. The payload varies based on the warning that triggered the Two-step Commit, and may include additional objects if seats or other ancillaries were added to the workbench. Because the booking was not committed, Result/status is 'Not Processed'. A descriptive error or warning is returned in Result/Error/Message or Result/Warning/Message.   The response to a second commit that creates a booking uses the same structure as a Reservation Retrieve response.

  - `ReservationResponse.Reservation` (object)
    Empty container to request workbench ID.  
In the response, this is the top-level object for reservation details. Generally includes the Identifier, Offer, Traveler, and ReservationDisplaySequence objects. Depending on the information in the reservation, may include Receipt, ReservationComment, PrimaryContact, CustomAuxiliarySegment.

  - `ReservationResponse.Reservation.@type` (string, required)
    Discriminator classes ReservationID, Reservation, or ReservationDetail
    Example: Reservation

  - `ReservationResponse.Reservation.id` (string)
    Internal identifier for the response.
    Example: REF12873

  - `ReservationResponse.Reservation.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).

  - `ReservationResponse.Reservation.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 system generated 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'.
- If not available, for Payment, any unique identifier can be sent.

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

  - `ReservationResponse.Reservation.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

  - `ReservationResponse.Reservation.Offer` (array)
    Each instance returns details about one offer on the reservation. An offer could be flight/s on the itinerary, seats, or a paid ancillary.
Additional instances of Offer are returned by default if the booking includes hotel and/or car segments. The hotel and/or car segments must have been booked with the TripServices Stays APIs or TripServices Car APIs (full release pending), or a terminal program. See the [Multi-Content Booking Guide (Air, Hotel, Car)](https://developer.travelport.com/docs/flights/guides/booking-and-reservations/flights-booking-guide#multi-content-bookings-air-hotel-car) for more information.
In the two-step commit, several objects in Offer vary from the standard response. For price or schedule changes, Offer is returned with @type OfferModify.
For NDC only, when an airline-initiated flight change has occurred, the Reservation Retrieve response returns the Offer object with @type OfferModify and scheduleChangeInd=true to indicate a change has occurred. See the [NDC Flight Disruption Handing in the Air Booking Guide](https://developer.travelport.com/docs/flights/guides/booking-and-reservations/flights-booking-guide#ndc-flight-disruption-handling-involuntary-changes) for details.

  - `ReservationResponse.Reservation.Offer.@type` (string, required)
    Discriminator
- Air Price child classes OfferID, Offer, and OfferUpsell.
- Reservation and ReservationWorkbench child classes OfferID, Offer, OfferModify, and OfferUpsell.
- Hotel Rules child classes OfferID and Offer.
    Example: Offer

  - `ReservationResponse.Reservation.Offer.id` (string)
    Offer identifier sent in the reference payload request to book that offer. Not returned in the full payload response; this is the only difference in the two responses.
    Example: offer_1

  - `ReservationResponse.Reservation.Offer.offerRef` (string)
    Used to reference another instance of this object in the same message
    Example: offer_1

  - `ReservationResponse.Reservation.Offer.ContentSource` (string)
    Indicates the owner the offer or document.
    Enum: "GDS", "NDC", "LCC", "API"

  - `ReservationResponse.Reservation.Offer.parentOfferRef` (string)
    A reference to the Offer this offer is sold in conjunction with
    Example: offer_1

  - `ReservationResponse.Reservation.Offer.offerModifyRef` (string)
    Reference to the new Offer created as a result of this Offer being subject to a schedule change.

  - `ReservationResponse.Reservation.Offer.Product` (array, required)
    Lists the flight or flights for one leg of the itinerary. Repeats for additional leg or legs.

  - `ReservationResponse.Reservation.Offer.Product.@type` (string, required)
    Discriminator.
- Air Search child classes are ProductAir and ProductAncillary.
- Exchange Search child class is ProductAir.
- Ancillary Search child class is ProductAncillary.
- Seat Map child class is ProductSeatAvailability.
- Air Price child classes are ProductAir and ProductAncillary.
- Hotel Availability child classes are ProductHospitality and ProductHospitalityOffer.
- Hotel Rules and HotelReservation child classes are ProductHospitality.
- All Vehicle APIs child classes are ProductVehicle and ProductAncillaryVehicle.
- Reservation and Reservation Workbench child classes are ProductAir, ProductAncillary, ProductHospitality, ProductVehicle, and ProductAncillaryVehicle.
    Example: ProductAir

  - `ReservationResponse.Reservation.Offer.Product.id` (string)
    Local id within a given message to support referencing this object.
    Example: product_1

  - `ReservationResponse.Reservation.Offer.Product.productRef` (string)
    Reference id that corresponds to the product 'id' in ReferenceListProduct.Product. To find flight details for a product, use the ProductRef id to identify the product in ReferenceListProduct.Product, and use the Flight id's (e.g., s3, s4) to match to flight information in ReferenceListFlight.Flight.
    Example: product_1

  - `ReservationResponse.Reservation.Offer.Product.Quantity` (integer)
    The quantity of the product. 
For Hotel Create Reservation (Full Payload) request, the number of rooms requested; 1-9 inclusive supported. If not provided, default is 1. For Hotel responses, the number of rooms currently available matching this rate.
In Air Search quantity represents the number of seats available for that Product. If the Product has connecting flights, Quantity returns the lowest number available. For example, if the first flight has 9 seats in Y class and the connecting flight has 4 seats in Y class, Quantity returns a value of 4.
    Example: 2

  - `ReservationResponse.Reservation.Offer.Price` (object, required)
    Price includes a summary of the Base, Taxes, and Fees applicable to the offer in the currency indicated.  
The amounts in Base, TotalTaxes, TotalFees, and TotalPrice are inclusive of all travelers across all PTCs. The amounts in PriceBreakdown apply to one traveler with the PTC returned in that instance.  
Certain types of offers on a booking, such as seats and ancillaries, generally include only the CurrencyCode, Base, and TotalPrice objects.

  - `ReservationResponse.Reservation.Offer.Price.@type` (string, required)
    Discriminator classes Price or PriceDetail
    Example: PriceDetail

  - `ReservationResponse.Reservation.Offer.Price.id` (string)
    Internally referenced id
    Example: 2

  - `ReservationResponse.Reservation.Offer.Price.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.

  - `ReservationResponse.Reservation.Offer.Price.CurrencyCode.value` (string)
    An ISO 4217 currency code.
    Example: USD

  - `ReservationResponse.Reservation.Offer.Price.CurrencyCode.codeAuthority` (string)
    Currency code authority
    Example: ISO 4217

  - `ReservationResponse.Reservation.Offer.Price.CurrencyCode.decimalPlace` (integer)
    Number of decimal places for the currency.
    Example: 2

  - `ReservationResponse.Reservation.Offer.Price.CurrencyCode.decimalAuthority` (string)
    Currency code decimal authority
    Example: ISO 4217

  - `ReservationResponse.Reservation.Offer.Price.Base` (number)
    Base price before taxes and fees.  
For Hotel, may not be returned by all suppliers.
    Example: 20.2

  - `ReservationResponse.Reservation.Offer.Price.TotalTaxes` (number)
    Total taxes applied to the base price.  
For Hotel, may not be returned by all suppliers.
    Example: 34.4

  - `ReservationResponse.Reservation.Offer.Price.TotalFees` (number)
    Total fees included in Total Price.
    Example: 201

  - `ReservationResponse.Reservation.Offer.Price.TotalPrice` (number)
    Total price of this offer including the base price and all taxes and fees.
    Example: 34

  - `ReservationResponse.Reservation.Offer.Price.VendorCurrencyTotal` (object)
    No longer used. Previously used to expose the local vendor currency when it is different to the purchased currency

  - `ReservationResponse.Reservation.Offer.Price.VendorCurrencyTotal.@type` (string)

  - `ReservationResponse.Reservation.Offer.Price.VendorCurrencyTotal.currencySource` (string)
    The system requesting or returning the currency code specified in the attribute
    Enum: "Supplier", "Charged", "Requested"

  - `ReservationResponse.Reservation.Offer.Price.VendorCurrencyTotal.Base` (number)
    The price prior to all applicable taxes of a product such as the rate for a room or fare for a flight.
    Example: 120.2

  - `ReservationResponse.Reservation.Offer.Price.VendorCurrencyTotal.Taxes` (object)
    Summary of all individual taxes. Child class TaxesDetail provides the breakdown of individual taxes.

  - `ReservationResponse.Reservation.Offer.Price.VendorCurrencyTotal.Taxes.@type` (string, required)
    Discriminator class is TaxesDetail
    Example: TaxesDetail

  - `ReservationResponse.Reservation.Offer.Price.VendorCurrencyTotal.Taxes.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

  - `ReservationResponse.Reservation.Offer.Price.VendorCurrencyTotal.Taxes.TaxInfo` (array)
    Returned for TripChange APIS only.

  - `ReservationResponse.Reservation.Offer.Price.VendorCurrencyTotal.Taxes.TaxInfo.@type` (string)
    Example: TaxInfo

  - `ReservationResponse.Reservation.Offer.Price.VendorCurrencyTotal.Taxes.TaxInfo.TaxCode` (string, required)
    The tax code
    Example: XF

  - `ReservationResponse.Reservation.Offer.Price.VendorCurrencyTotal.Taxes.TaxInfo.Amount` (number, required)
    The amount of the tax applied

  - `ReservationResponse.Reservation.Offer.Price.VendorCurrencyTotal.Taxes.TaxInfo.TaxBreakdown` (array, required)
    The breakdown of the tax for this tax code

  - `ReservationResponse.Reservation.Offer.Price.VendorCurrencyTotal.Taxes.Tax` (array)

  - `ReservationResponse.Reservation.Offer.Price.VendorCurrencyTotal.Taxes.TaxPercent` (object)
    Returned when the tax is expressed as a percentage of the amount.

  - `ReservationResponse.Reservation.Offer.Price.VendorCurrencyTotal.Taxes.TaxPercent.value` (number)
    The tax percentage amount.
    Example: 5.5

  - `ReservationResponse.Reservation.Offer.Price.VendorCurrencyTotal.Taxes.TaxPercent.taxCode` (string)
    Any code for the tax.
    Example: 971 - IRS Notice

  - `ReservationResponse.Reservation.Offer.Price.VendorCurrencyTotal.Taxes.TaxPercent.reportingAuthority` (string)
    Tax reporting authority
    Example: Georgia Department of Revenue

  - `ReservationResponse.Reservation.Offer.Price.VendorCurrencyTotal.Taxes.TaxPercent.purpose` (string)
    Purpose of tax
    Example: statutory tax

  - `ReservationResponse.Reservation.Offer.Price.VendorCurrencyTotal.Taxes.TaxPercent.description` (string)
    Description
    Example: 1.5% of SGST

  - `ReservationResponse.Reservation.Offer.Price.VendorCurrencyTotal.Taxes.TaxPercent.includedInBase` (string)
    Yes , No , Unknown
    Enum: "Yes", "No", "Unknown"

  - `ReservationResponse.Reservation.Offer.Price.VendorCurrencyTotal.Fees` (object)
    Includes TotalFees object to return the sum total of any fees.  
May include array of Fee objects to break down individual fees.  
Child class FeesDetail may also include a breakdown of the individual fees.

  - `ReservationResponse.Reservation.Offer.Price.VendorCurrencyTotal.Fees.@type` (string, required)
    Discriminator. Child class FeesDetail
    Example: FeesDetail

  - `ReservationResponse.Reservation.Offer.Price.VendorCurrencyTotal.Fees.TotalFees` (number)
    Total fees included in the TotalPrice. Supports up to 4 decimal places; decimal place needs to be included.
    Example: 55

  - `ReservationResponse.Reservation.Offer.Price.VendorCurrencyTotal.Fees.TotalAdditionalFeesPayableLocally` (number)
    Fees due separately at the property. Expected to be paid in local currency. These fees are not included in the Offer TotalPrice.
    Example: 25

  - `ReservationResponse.Reservation.Offer.Price.VendorCurrencyTotal.Fees.Fee` (array)
    Array of individual fees.

  - `ReservationResponse.Reservation.Offer.Price.VendorCurrencyTotal.Total` (number)
    Specifies the total price including base + taxes + fees
    Example: 30.13

  - `ReservationResponse.Reservation.Offer.Price.VendorCurrencyTotal.approximateInd` (boolean)
    True if this amount has been converted from the original amount
    Example: true

  - `ReservationResponse.Reservation.Offer.Price.FlightPassCredits` (integer)
    Indicates the number of flight pass credits the offer “costs” for all passengers. Air Canada NDC only.
    Example: 2

  - `ReservationResponse.Reservation.Offer.Price.PriceBreakdown` (array)

  - `ReservationResponse.Reservation.Offer.Price.PriceBreakdown.@type` (string, required)
    Discriminator
- Air Search and Air Price APIs child classes are PriceBreakdownAir and PriceBreakdownAncillary.
- Search Ancillaries and Seat Availabilities child classes are PriceBreakdown, PriceBreakdownAncillary, and PriceBreakdownAncillaryAir.
- All Hotel API child classes are PriceBreakdownHospitality.
- Vehicle API child classes are PriceBreakdownVehicleCharges, PriceBreakdownVehicleDeposit, PriceBreakdownVehiclePrice, and PriceBreakdownAncillaryVehicle.
- Reservation and Reservation Workbench APIs are PriceBreakdownAir, PriceBreakdownAncillary, PriceBreakdownHospitality, PriceBreakdownVehicleCharges, PriceBreakdownVehicleDeposit, PriceBreakdownVehiclePrice, and PriceBreakdownAncillaryVehicle.
    Example: PriceBreakdownAir

  - `ReservationResponse.Reservation.Offer.Price.PriceBreakdown.Amount` (object)
    Amount represents the cost applied.

  - `ReservationResponse.Reservation.Offer.Price.PriceBreakdown.Amount.@type` (string)

  - `ReservationResponse.Reservation.Offer.Price.PriceBreakdown.Amount.Base` (number)
    The base price prior to all applicable taxes or fees of a product, such as the amount for a room or fare for a flight (one passenger).
    Example: 120.2

  - `ReservationResponse.Reservation.Offer.Price.PriceBreakdown.Amount.Total` (number)
    Specifies the total price including base + taxes + fees.
In PriceBreakdownHospitality, this total is for a given group of nights.
In PriceBreakdownAir this is the total of base cost and all fees and taxes for one passenger of this PTC type.
    Example: 230.13

  - `ReservationResponse.Reservation.Offer.Price.PriceBreakdown.Amount.approximateInd` (boolean)
    if true this amount has been converted from the original amount
    Example: true

  - `ReservationResponse.Reservation.Offer.Price.PriceBreakdown.Commission` (object)
    GDS only; not supported for NDC.  
Commission information.  
Any commission filed by an airline in a CAT35 fare is returned in PriceBreakdownAir/Commission. The amount is either a percent of the fare component (@type CommissionPercent and the Percent object) or an amount (@type CommissionAmount and the Amount object).

  - `ReservationResponse.Reservation.Offer.Price.PriceBreakdown.Commission.@type` (string, required)
    Discriminator. Child classes CommissionAmount or CommissionPercent
    Example: CommissionAmount

  - `ReservationResponse.Reservation.Offer.Price.PriceBreakdown.Commission.application` (string)
    Type of commission
    Enum: "Full", "Partial", "Non-paying", "No-show", "Adjustment", "Commissionable"

  - `ReservationResponse.Reservation.Offer.Price.PriceBreakdown.roomPricingType` (string)
    A string provided by the hotel to describe how a service is priced, such as per night or per stay.
    Enum: "Per stay", "Per person", "Per night", "Per person per night", "Per use"

  - `ReservationResponse.Reservation.Offer.Price.PriceBreakdown.Description` (string)
    Example: Advance Purchase-Ro-Free WiFi

  - `ReservationResponse.Reservation.Offer.Price.PriceBreakdown.NightlyRate` (array)

  - `ReservationResponse.Reservation.Offer.Price.PriceBreakdown.AverageNightlyRate` (array)
    The average nightly rate for a given offer.

  - `ReservationResponse.Reservation.Offer.Price.PriceBreakdown.AmenitySurcharges` (object)
    Amenity Surcharges information.

  - `ReservationResponse.Reservation.Offer.Price.PriceBreakdown.priceChangesDuringStayInd` (boolean)
    "If true, indicates the price changes at least once during requested dates.
If roomPricingType = Per night, multiple instances of priceChangesDuringStayInd are returned."

  - `ReservationResponse.Reservation.Offer.Price.PriceBreakdown.shortRateDescription` (string)
    A normalized rate description for comparing rates across multiple aggregators.
    Example: Flexible Rate

  - `ReservationResponse.Reservation.Offer.TermsAndConditionsFull` (array)
    For Hotel Rules and Reservation responses, this array will contain a single TermsAndConditionsFullHospitality entry. Cancellation terms with multiple time periods are represented within that entry's CancelPenalty array rather than as multiple TermsAndConditionsFull entries.  
For Two-Step Commit (FLights), this is a standard object, no changes.  
For Unified Checkout (Flights), if no payment information was sent in the request, the booking is confirmed by the airline but not yet ticketed. This object provides the payment and ticketing time limits in ExpiryDate and PaymentTimeLimit.

  - `ReservationResponse.Reservation.Offer.TermsAndConditionsFull.@type` (string, required)
    Discriminator
- Air Price child classes are TermsAndConditionsFullAir and TermsAndConditionsFullAncillary.
- Hotel Rules and Reservation class is TermsAndConditionsFullHospitality.
- Vehicle Rules and Reservation class is TermsAndConditionsFullVehicle.
- Reservation and Reservation Workbench APIs child classes are TermsAndConditionsFullAir, TermsAndConditionsFullAncillary, TermsAndConditionsFullHospitality, TermsAndConditionsFullVehicle, TermsAndConditionsFullVehicle, and TermsAndConditionsFullScheduleChange.
    Example: TermsAndConditionsFullAir

  - `ReservationResponse.Reservation.Offer.TermsAndConditionsFull.id` (string)
    Local identifier within a given message for this object.
    Example: TC_1

  - `ReservationResponse.Reservation.Offer.TermsAndConditionsFull.termsAndConditionsRef` (string)
    Used to reference another instance of this object in the same message.
    Example: TC_1

  - `ReservationResponse.Reservation.Offer.TermsAndConditionsFull.ExpiryDate` (string)
    The date and time in UTC the offer will no longer be valid.
    Example: 2022-08-07T12:12:00Z

  - `ReservationResponse.Reservation.Offer.TermsAndConditionsFull.CustomerLoyalty` (array)

  - `ReservationResponse.Reservation.Offer.TermsAndConditionsFull.CustomerLoyalty.value` (string, required)
    Number on loyalty card.
    Example: 132456

  - `ReservationResponse.Reservation.Offer.TermsAndConditionsFull.CustomerLoyalty.id` (string)
    Optional Customer Loyalty Id. Not saved
    Example: Loyalty_1

  - `ReservationResponse.Reservation.Offer.TermsAndConditionsFull.CustomerLoyalty.priority` (integer)
    Optional Numeric Priority Code
    Example: 2

  - `ReservationResponse.Reservation.Offer.TermsAndConditionsFull.CustomerLoyalty.programId` (string)
    Specifies an identifier to indicate the company owner of the loyalty program. Typically two characters.  
For frequent guest number, the hotel supplier or brand code.  
For frequent flyer number, the air supplier code of the loyalty program.
    Example: HY

  - `ReservationResponse.Reservation.Offer.TermsAndConditionsFull.CustomerLoyalty.programName` (string)
    Supplier's loyalty program name.
    Example: Frontier-EarlyReturns

  - `ReservationResponse.Reservation.Offer.TermsAndConditionsFull.CustomerLoyalty.supplierType` (string)
    The type of supplier of a loyalty program. Uses 'hotel' for frequent guest number or 'air' for frequent flyer number.
    Example: Hotel

  - `ReservationResponse.Reservation.Offer.TermsAndConditionsFull.CustomerLoyalty.supplier` (string)
    Supplier of a loyalty program (typically 2 characters representing the hotel, brand, or airline).
    Example: UA

  - `ReservationResponse.Reservation.Offer.TermsAndConditionsFull.CustomerLoyalty.tier` (string)
    Customer Loyalty tier
    Example: Silver

  - `ReservationResponse.Reservation.Offer.TermsAndConditionsFull.CustomerLoyalty.shareWithSupplier` (array)
    The list of suppliers that the CustomerLoyalty number is shared. Used for cross accrual programs.  
If valid carrier codes are not sent, the response returns the message NO CROSS ACCRUAL AGREEMENT EXISTS.

  - `ReservationResponse.Reservation.Offer.TermsAndConditionsFull.CustomerLoyalty.cardHolderName` (string)
    Customer loyalty member name; up to 128 characters are supported. In Air Search, for discounted offers to be returned, the name must be sent as LAST FIRST; e.g., if SMITH is the last name and JORDAN the first name, send as SMITH JORDAN
    Example: John Smith

  - `ReservationResponse.Reservation.Offer.TermsAndConditionsFull.CustomerLoyalty.validatedInd` (boolean)
    Customer loyalty number has been validated by the supplier
    Example: true

  - `ReservationResponse.Reservation.Offer.TermsAndConditionsFull.CustomerLoyalty.prefix` (string)
    The cardholder name prefix title like Mr, Mrs, Dr
    Example: Dr

  - `ReservationResponse.Reservation.Offer.TermsAndConditionsFull.CustomerLoyalty.given` (string)
    The First Name of the Cardholder
    Example: John

  - `ReservationResponse.Reservation.Offer.TermsAndConditionsFull.CustomerLoyalty.middle` (string)
    Middle Name of the Cardholder
    Example: Wilkinson

  - `ReservationResponse.Reservation.Offer.TermsAndConditionsFull.CustomerLoyalty.surname` (string)
    Last Name of the Cardholder
    Example: Smith

  - `ReservationResponse.Reservation.Offer.TermsAndConditionsFull.TextBlock` (array)
    A list of free text terms and conditions.

  - `ReservationResponse.Reservation.Offer.TermsAndConditionsFull.TextBlock.@type` (string, required)
    Discriminator classes TextBlock or TextBlockDetail
    Example: TextBlockDetail

  - `ReservationResponse.Reservation.Offer.TermsAndConditionsFull.TextBlock.title` (string)
    The title of the rule or information. 
For TermsAndConditionsFullHospitality, may include any of the following Rule Types; Promotional Data, Rate Description, Room Rate Data, Rate Text, Guarantee, Cancellation, Deposit, Check in/out, Room detail, Extra charges, Packages, Property, Location, Miscellaneous, Rate Amount, Alternate Rate Amount, Rate Comment, FAX, Phone, Special Information, Information, Room Hold Expiration Time. Not every property returns all of these types. Some properties do not return any title. Only English is supported for these values.
    Example: Baggage Details

  - `ReservationResponse.Reservation.Offer.TermsAndConditionsFull.TextBlock.id` (string)
    Internally referenced id
    Example: 2

  - `ReservationResponse.Reservation.Offer.TermsAndConditionsFull.TextBlock.TextFormatted` (array, required)

  - `ReservationResponse.Reservation.Offer.passiveOfferInd` (boolean)
    Indicates aggregator segment built into PNR. Always send with true when using in a request. If returned true in a response, the Offer is passive for booking purposes.
    Example: true

  - `ReservationResponse.Reservation.Offer.scheduleChangeInd` (boolean)
    - If true: this Offer is subject to a schedule change.
May be seen in a Two-step Commit, on the first Commit response payload, in the event of a schedule change. If this is the case, the Product object returns previous and updated schedule details in two instances of Product/FlightSegment as follows:
  - The previous flight segment is identified with sequence=1 and Flight/id=flight_1
  - The updated flight segment is identified with sequence=2 and Flight/id=flight_2

Offer includes a ModifyPrice object; however, unless a price change has also occurred, Offer/Price repeats the original price of the offer and Offer/ModifyPrice returns all amounts as zero (0) to indicate there is no price change.
NDC only - for Reservation Retrieve, when an airline-initiated flight change has occurred, the response also returns the Offer object with @type OfferModify and scheduleChangeInd=true to indicate a change has occurred. See [NDC Flight Disruption Handing](https://developer.travelport.com/docs/flights/guides/booking-and-reservations/flights-booking-guide#ndc-flight-disruption-handling-involuntary-changes) in the Air Booking Guide for details.

  - `ReservationResponse.Reservation.Traveler` (array)

  - `ReservationResponse.Reservation.Traveler.@type` (string, required)
    Discriminator classes TravelerID or Traveler
    Example: Traveler

  - `ReservationResponse.Reservation.Traveler.id` (string)
    Send value of travelerRefId_1 for the first traveler, then increment for each additional traveler (e.g., travelerRefId_2).
Traveler/id is only mandatory when referenced elsewhere in the request, such as in SpecialService and PrimaryContact (TravelerIdentifier/Identifier/value).

  - `ReservationResponse.Reservation.Traveler.TravelerRef` (string)

  - `ReservationResponse.Reservation.Traveler.birthDate` (string)
    Date of birth in YYYY-MM-DD format.
The TripServices APIs require this object only for infant and child PTC types (e.g., INF, INS, CHD, UNN).
When sending [minimum secure flight information](https://developer.travelport.com/docs/flights/guides/booking-and-reservations/remarks-and-service-requests#minimum-secure-flight-information-ssr-docs), which is required by some carriers, this object is required for all PTCs.
    Example: 2021-06-05

  - `ReservationResponse.Reservation.Traveler.gender` (string)
    Gender Type Male, Female etc.
When sending [minimum secure flight information](https://developer.travelport.com/docs/flights/guides/booking-and-reservations/remarks-and-service-requests#minimum-secure-flight-information-ssr-docs) in the Traveler object, which is required by some carriers, this object is required for all PTCs.
This field is not used by Hotel APIs and will be ignored.
    Enum: "Male", "Female", "Unknown", "Undisclosed"

  - `ReservationResponse.Reservation.Traveler.PersonName` (object, required)
    Travelport+ limits the combination of Given and Surname to 22 characters. Given name must have at least one character. Any PersonName exceeding 22 characters is truncated in the response.

  - `ReservationResponse.Reservation.Traveler.PersonName.@type` (string, required)
    Discriminator classes PersonName or PersonNameDetail
    Example: PersonNameDetail

  - `ReservationResponse.Reservation.Traveler.PersonName.Prefix` (string)
    Salutation of honorific (e.g. Mr., Mrs., Ms., Miss, Dr.)
    Example: Mr

  - `ReservationResponse.Reservation.Traveler.PersonName.Given` (string)
    Traveler first or given name.
    Example: John

  - `ReservationResponse.Reservation.Traveler.PersonName.Middle` (string)
    Traveler middle name.
    Example: Erick

  - `ReservationResponse.Reservation.Traveler.PersonName.Surname` (string, required)
    Traveler last name or surname.
    Example: Smith

  - `ReservationResponse.Reservation.Traveler.PersonName.personNameType` (string)
    OTA Code
    Enum: "Former", "Nickname", "Alternate", "Maiden"

  - `ReservationResponse.Reservation.Traveler.PersonName.language` (string)
    'ISO639 code of the language the name is represented
    Example: EN

  - `ReservationResponse.Reservation.Traveler.PersonName.SurnamePrefix` (string)
    The surname prefix
    Example: Von

  - `ReservationResponse.Reservation.Traveler.PersonName.Suffix` (string)
    Traveler name suffix such as Jr. or Sr.
    Example: Jr.

  - `ReservationResponse.Reservation.Traveler.PersonName.Title` (string)
    Degree or honors
    Example: DR

  - `ReservationResponse.Reservation.Traveler.PersonName.Privacy` (object)
    Confidential details for marketing purpose

  - `ReservationResponse.Reservation.Traveler.PersonName.Privacy.id` (string)
    Optional internally referenced id
    Example: 2

  - `ReservationResponse.Reservation.Traveler.PersonName.Privacy.shareMarketing` (string)
    Used to indicate marketing preferences, Yes, No, Inherit
    Enum: "Yes", "No", "Inherit"

  - `ReservationResponse.Reservation.Traveler.PersonName.Privacy.optInStatus` (string)
    Used to indicate marketing preferences, OptIn, OptOut
    Enum: "OptedIn", "OptedOut", "Unknown"

  - `ReservationResponse.Reservation.Traveler.PersonName.Privacy.optInDate` (string)
    The datetime of receiving the opt in notice
    Example: 2026-08-07T12:12:00Z

  - `ReservationResponse.Reservation.Traveler.PersonName.Privacy.optOutDate` (string)
    The datetime the opt out notice was received
    Example: 2026-08-07T12:12:00Z

  - `ReservationResponse.Reservation.Traveler.PersonName.defaultInd` (boolean)
    If true, this is the default or primary name within a collection of names.
    Example: true

  - `ReservationResponse.Reservation.Traveler.Address` (array)

  - `ReservationResponse.Reservation.Traveler.Address.@type` (string, required)
    Discriminator classes Address or AddressDetail
    Example: AddressDetail

  - `ReservationResponse.Reservation.Traveler.Address.id` (string)
    unique address id
    Example: Address_1

  - `ReservationResponse.Reservation.Traveler.Address.BldgRoom` (object)
    Address with building and room number

  - `ReservationResponse.Reservation.Traveler.Address.BldgRoom.value` (string)
    Example: Moore House

  - `ReservationResponse.Reservation.Traveler.Address.BldgRoom.buldingInd` (boolean)
    When true, the information is a building name. When false, it is an apartment or room #
    Example: true

  - `ReservationResponse.Reservation.Traveler.Address.Number` (object)
    The street number alone is the numerical number that precedes the street name in the address.

  - `ReservationResponse.Reservation.Traveler.Address.Number.value` (string)
    Street number value.
    Example: 23B

  - `ReservationResponse.Reservation.Traveler.Address.Number.streetNmbrSuffix` (string)
    Street Number Suffix
    Example: B

  - `ReservationResponse.Reservation.Traveler.Address.Number.streetDirection` (string)
    Direction of the Street
    Example: NW

  - `ReservationResponse.Reservation.Traveler.Address.Number.ruralRouteNmbr` (string)
    RuralRoute Number
    Example: 76

  - `ReservationResponse.Reservation.Traveler.Address.Number.po_Box` (string)
    PO Box Number
    Example: 1001

  - `ReservationResponse.Reservation.Traveler.Address.Street` (string)
    Street name. May also contain the street number when the Number element is missing.
    Example: ABC Street

  - `ReservationResponse.Reservation.Traveler.Address.AddressLine` (array)
    Property street address. Used in place of Street and Number. Each element of the array represents an address line.

  - `ReservationResponse.Reservation.Traveler.Address.City` (string, required)
    Full name of the city, town, or postal station (i.e., a postal service territory, often used in a military address).
    Example: Dublin

  - `ReservationResponse.Reservation.Traveler.Address.County` (string)
    County or Region Name.
    Example: Berkshire

  - `ReservationResponse.Reservation.Traveler.Address.StateProv` (object)
    The standard code or abbreviation for the state, province, or region. May also include full length name.

  - `ReservationResponse.Reservation.Traveler.Address.StateProv.value` (string)
    State, province, or region code needed to identify location (typically two characters).
    Example: CA

  - `ReservationResponse.Reservation.Traveler.Address.StateProv.name` (string)
    State, province, or region name needed to identify location.
    Example: California

  - `ReservationResponse.Reservation.Traveler.Address.Country` (object)
    Contains the information needed to identify a country.

  - `ReservationResponse.Reservation.Traveler.Address.Country.value` (string)
    The ISO 3166 code for the property's address.
    Example: US

  - `ReservationResponse.Reservation.Traveler.Address.Country.id` (string)
    Custom user-assigned identifier for the country.
    Example: 23

  - `ReservationResponse.Reservation.Traveler.Address.Country.name` (string)
    The full name of the country for the property's address.
    Example: United States

  - `ReservationResponse.Reservation.Traveler.Address.Country.codeContext` (string)
    The source of a code, such as the organization that provided the id number
    Example: IATA

  - `ReservationResponse.Reservation.Traveler.Address.PostalCode` (string)
    Postal code for the address.
    Example: Sl6 1AB

  - `ReservationResponse.Reservation.Traveler.Address.Addressee` (string)
    The name of the company or person to be addressed
    Example: ACME INC

  - `ReservationResponse.Reservation.Traveler.Address.role` (string)
    Defines the type of location the address is assigned to. For TravelAgency address leave blank or use "Other".
    Enum: "Home", "Business", "Mailing", "Delivery", "Destination", "Other", "Billing"

  - `ReservationResponse.Reservation.Traveler.Address.addressType` (string)
    OTA code for address type
    Example: CLT

  - `ReservationResponse.Reservation.Traveler.Address.use` (string)
    OTA code for address use
    Example: AUT

  - `ReservationResponse.Reservation.Traveler.Address.Comment` (object)
    Textual information.

  - `ReservationResponse.Reservation.Traveler.Address.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

  - `ReservationResponse.Reservation.Traveler.Address.Comment.id` (string)
    Local identifier within a given message for this object.
    Example: comment_1

  - `ReservationResponse.Reservation.Traveler.Address.Comment.name` (string)
    Title of comment or type of remark.
    Example: Comment name

  - `ReservationResponse.Reservation.Traveler.Address.Comment.language` (string)
    Language code using ISO-639 standard
    Example: EN

  - `ReservationResponse.Reservation.Traveler.Address.Priority` (integer)
    The priority ranking within the group
    Example: 1

  - `ReservationResponse.Reservation.Traveler.Address.validInd` (boolean)
    If true, this is a valid and complete mailing address that has been verified through an address verification service or previously mailed materials have not been returned.
    Example: false

  - `ReservationResponse.Reservation.Traveler.Address.provisionedInd` (boolean)
    If true, this address came into the system through provisioning
    Example: false

  - `ReservationResponse.Reservation.Traveler.Telephone` (array)

  - `ReservationResponse.Reservation.Traveler.Telephone.@type` (string, required)
    Discriminator classes Telephone or TelephoneDetail
    Example: Telephone

  - `ReservationResponse.Reservation.Traveler.Telephone.countryAccessCode` (string)
    Phone country code
    Example: 1

  - `ReservationResponse.Reservation.Traveler.Telephone.areaCityCode` (string)
    Phone local area code
    Example: 972

  - `ReservationResponse.Reservation.Traveler.Telephone.phoneNumber` (string, required)
    Mobile/Telephone Number. Accepted characters are numeric, dash, space, and period.
    Example: 972-000-787

  - `ReservationResponse.Reservation.Traveler.Telephone.extension` (string)
    Telephone extension number
    Example: 234

  - `ReservationResponse.Reservation.Traveler.Telephone.id` (string)
    Optional custom user-assigned identifier for a phone number.
    Example: 3

  - `ReservationResponse.Reservation.Traveler.Telephone.cityCode` (string)
    IATA city code if referenced by phone number.
    Example: DEN

  - `ReservationResponse.Reservation.Traveler.Telephone.role` (string)
    Defines the type of location the Telephone is assigned to. For Travel Agency telephone select "Other" or leave blank.
    Enum: "Mobile", "Home", "Work", "Office", "Fax", "Other"

  - `ReservationResponse.Reservation.Traveler.Telephone.phoneLocationType` (string)
    Location of the phone
    Example: Agency

  - `ReservationResponse.Reservation.Traveler.Telephone.phoneTechType` (string)
    Indicates the type of technology associated with the telephone number
    Example: Voice

  - `ReservationResponse.Reservation.Traveler.Telephone.phoneUseType` (string)
    Agency code for how phone is used (e.g., Home, Business, Emergency Contact, Travel Arranger, Day, Evening).
    Example: Home

  - `ReservationResponse.Reservation.Traveler.Telephone.pin` (string)
    Additional codes used for telephone
    Example: 3456

  - `ReservationResponse.Reservation.Traveler.Telephone.priority` (integer)
    Priority
    Example: 1

  - `ReservationResponse.Reservation.Traveler.Telephone.defaultInd` (boolean)
    When true, indicates a default value should be used.
    Example: true

  - `ReservationResponse.Reservation.Traveler.Telephone.provisionedInd` (boolean)
    true indicates this phone number was created through provisioned
    Example: false

  - `ReservationResponse.Reservation.Traveler.Email` (array)
    For a reservation Retrieve response, all email addresses are associated with the first traveler on the reservation for GDS. NDC supports contact information for each traveler on the reservation.

  - `ReservationResponse.Reservation.Traveler.Email.value` (string)
    The email address.
    Example: exampledomain@example.com

  - `ReservationResponse.Reservation.Traveler.Email.id` (string)
    Electronic email addresses, in IETF specified format.
    Example: email_1

  - `ReservationResponse.Reservation.Traveler.Email.emailType` (string)
    Use email type to specify if the email is to be sent "TO" or sent "FROM"
    Example: FROM

  - `ReservationResponse.Reservation.Traveler.Email.comment` (string)
    Any freeform note for the email, such as its purpose.
    Example: work email

  - `ReservationResponse.Reservation.Traveler.Email.preferredFormat` (string)
    Mime media type
    Example: text/html

  - `ReservationResponse.Reservation.Traveler.Email.optInDate` (string)
    The datetime of receiving the opt in notice
    Example: 2026-03-03T11:11:00Z

  - `ReservationResponse.Reservation.Traveler.Email.optOutDate` (string)
    The datetime the opt out notice was received
    Example: 2026-03-03T11:11:00Z

  - `ReservationResponse.Reservation.Traveler.Email.validInd` (boolean)
    If true, this is a valid email address that has been system verified via a successful email transmission.
    Example: true

  - `ReservationResponse.Reservation.Traveler.Email.provisionedInd` (boolean)
    If true then the email address came from the provisioning process
    Example: true

  - `ReservationResponse.Reservation.Traveler.passengerTypeCode` (string)
    Passenger type code (PTC) for this traveler.  
Required for all PTCs other than ADT (adult); if not sent defaults to ADT.  
Some of the common PTCs supported include ADT, INF, INS, CHD, UNN. Private fare PTCs, including INN, JNN, VNN, ITF, JNF, and VFF, may also be supported, subject to airline support.
    Example: CHD

  - `ReservationResponse.Reservation.Traveler.nationality` (string)
    Nationality on country code ISO
    Example: AL

  - `ReservationResponse.Reservation.Traveler.age` (integer)
    The age of the traveller at the time of travel
    Example: 13

  - `ReservationResponse.Reservation.Traveler.CustomerLoyalty` (array)

  - `ReservationResponse.Reservation.Traveler.AlternateContact` (array)

  - `ReservationResponse.Reservation.Traveler.AlternateContact.@type` (string)
    Example: AlternateContact

  - `ReservationResponse.Reservation.Traveler.AlternateContact.id` (string)

  - `ReservationResponse.Reservation.Traveler.AlternateContact.contactType` (string)
    Contact type value
    Example: Relative

  - `ReservationResponse.Reservation.Traveler.AlternateContact.relation` (string)
    Relation value
    Example: Mother

  - `ReservationResponse.Reservation.Traveler.AlternateContact.Address` (array)

  - `ReservationResponse.Reservation.Traveler.AlternateContact.Telephone` (array)

  - `ReservationResponse.Reservation.Traveler.AlternateContact.Email` (array)

  - `ReservationResponse.Reservation.Traveler.AlternateContact.emergencyInd` (boolean)
    This is the contact in case of an emergency
    Example: true

  - `ReservationResponse.Reservation.Traveler.AlternateContact.defaultInd` (boolean)
    This is the default contact
    Example: true

  - `ReservationResponse.Reservation.Traveler.TravelDocument` (array)

  - `ReservationResponse.Reservation.Traveler.TravelDocument.@type` (string, required)
    Discriminator classes TravelDocument or TravelDocumentDetail
    Example: TravelDocumentDetail

  - `ReservationResponse.Reservation.Traveler.TravelDocument.docNumber` (string)
    Travel document number.
    Example: B37201

  - `ReservationResponse.Reservation.Traveler.TravelDocument.docType` (string)
    Supported Travel Document types
    Enum: "Visa", "Passport", "MilitaryIdentification", "DriversLicense", "NationalIdentityDocument", "VaccinationCertificate", "AlienRegistrationNumber", "InsurancePolicyNumber", "TaxExemptionNumber", "VehicleRegistrationLicenseNumber", "BoderCrossingCard", "RefugeeTravelDocument", "PilotsLicense", "PermanentResidentCard", "RedressNumber", "KnownTravelerNumber", "Non-Standard", "MerchantNumber", "AirNexusCard", "CrewMemberCertificate", "PassportCard", "NaturalizationCertificate", "TicketNumber", "LargeFamilyDiscountCard", "IdentityCardTypeA", "IdentityCardTypeC", "IdentityCardTypeI"

  - `ReservationResponse.Reservation.Traveler.TravelDocument.issueDate` (string)
    Issue date of document. Required for a visa
    Example: 2002-10-13

  - `ReservationResponse.Reservation.Traveler.TravelDocument.expireDate` (string)
    Expiration date of document. Required for a visa.
    Example: 2002-11-13

  - `ReservationResponse.Reservation.Traveler.TravelDocument.stateProvCode` (string)
    State Province Code value
    Example: 44

  - `ReservationResponse.Reservation.Traveler.TravelDocument.placeOfIssue` (string)
    Place of issue value
    Example: Birmingham

  - `ReservationResponse.Reservation.Traveler.TravelDocument.issueCountry` (string)
    Issuing country of document; ISO3166 standard format.
    Example: CA

  - `ReservationResponse.Reservation.Traveler.TravelDocument.birthDate` (string)
    The date of birth of the document holder in YYYY-MM-DD format.
    Example: 1995-04-22

  - `ReservationResponse.Reservation.Traveler.TravelDocument.birthCountry` (string)
    Country of birth of the document holder in ISO3166 standard format.
    Example: AR

  - `ReservationResponse.Reservation.Traveler.TravelDocument.birthPlace` (string)
    Birth place value
    Example: Ontario

  - `ReservationResponse.Reservation.Traveler.TravelDocument.residence` (string)
    Residence value
    Example: 1st section 8th st

  - `ReservationResponse.Reservation.Traveler.TravelDocument.id` (string)
    Locally referenced id
    Example: 34

  - `ReservationResponse.Reservation.Traveler.TravelDocument.Nationality` (string)
    Birth country as noted on document; specifies a 2 character country code as defined in ISO3166.
    Example: BR

  - `ReservationResponse.Reservation.Traveler.TravelDocument.IssuedForGeoPoliticalArea` (object)
    The location code of the geographical location. Codes from Ref Pub

  - `ReservationResponse.Reservation.Traveler.TravelDocument.IssuedForGeoPoliticalArea.value` (string)
    Example: G

  - `ReservationResponse.Reservation.Traveler.TravelDocument.IssuedForGeoPoliticalArea.level` (string)
    Represents the type of geopolitical area (country, Continent, State etc)
    Enum: "World", "Global Area", "Continent Group", "Continent", "Country", "StateProvince", "City", "Airport"

  - `ReservationResponse.Reservation.Traveler.TravelDocument.IssuedForGeoPoliticalArea.id` (string)
    Optional internally referenced id
    Example: 2

  - `ReservationResponse.Reservation.Traveler.Comments` (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.

  - `ReservationResponse.Reservation.Traveler.Comments.@type` (string)
    Example: Comments

  - `ReservationResponse.Reservation.Traveler.Comments.Comment` (array)

  - `ReservationResponse.Reservation.Traveler.RailDiscountCard` (array)

  - `ReservationResponse.Reservation.Traveler.RailDiscountCard.value` (string)
    Example: Rail1234546

  - `ReservationResponse.Reservation.Traveler.RailDiscountCard.supplierCode` (string, required)
    Code of the Supplier
    Example: Enco

  - `ReservationResponse.Reservation.Traveler.RailDiscountCard.referenceNumber` (string)
    ReferenceNumber
    Example: 134256

  - `ReservationResponse.Reservation.Traveler.accompaniedByInfantInd` (boolean)
    Example: true

  - `ReservationResponse.Reservation.TravelerProduct` (array)
    A list of travelers on a given reservation.

  - `ReservationResponse.Reservation.TravelerProduct.@type` (string, required)
    Discriminator classes TravelerProductID or TravelerProduct
    Example: TravelerProduct

  - `ReservationResponse.Reservation.TravelerProduct.id` (string)

  - `ReservationResponse.Reservation.TravelerProduct.TravelerRef` (string)
    Traveler reference number, associated with offer or unpriced segment in OfferRef.

  - `ReservationResponse.Reservation.TravelerProduct.OfferRef` (string)
    Id for the offer. Cross-references to value in corresponding Offer/id.

  - `ReservationResponse.Reservation.TravelerProduct.ProductRef` (string)
    Id for the product offer. Cross-references to value in corresponding Offer/Product/id.

  - `ReservationResponse.Reservation.TravelerProduct.ConfirmationStatusEnum` (string)
    Status returned in a response for a given process. This may be seen in a two-step commitment process, seats, or other multi-commit processes.
    Enum: "Pending", "Confirmed", "Cancelled", "Rejected", "Requested"

  - `ReservationResponse.Reservation.TravelerProduct.UnpricedFlightSegmentRefs` (array)
    Returned in a reservation Retrieve response if unpriced segments are associated with this traveler. Cross-references to value in corresponding UnpricedFlightSegment/id.
    Example: ["unpricedFlightSegment_001","unpricedFlightSegment_002"]

  - `ReservationResponse.Reservation.FormOfPayment` (array)
    A list of key-value pairs that represent form(s) of payment.

  - `ReservationResponse.Reservation.FormOfPayment.@type` (string, required)
    Discriminator classes FormOfPaymentID, FormOfPaymentBSP, FormOfPaymentCash, FormOfPaymentCheck, FormOfPaymentDocument, FormOfPaymentFlightPass, FormOfPaymentForfeit, FormOfPaymentInvoice, FormOfPaymentPaymentCard, FormOfPaymentVirtualPaymentAccount, FormOfPaymentWaiverCode
    Example: FormOfPaymentPaymentCard

  - `ReservationResponse.Reservation.FormOfPayment.id` (string)
    Form of Payment reference ID.
    Example: formofpayment_1

  - `ReservationResponse.Reservation.FormOfPayment.FormOfPaymentRef` (string)
    Send a custom identifier for this FOP. Supports up to 256 alphanumeric characters.
    Example: formofpayment_1

  - `ReservationResponse.Reservation.FormOfPayment.reservationFOPInd` (boolean)
    If true, this form of payment is the primary form of payment stored in the Reservation and will be used as the default payment unless alternate form of payment is referenced during the payment process.
    Example: true

  - `ReservationResponse.Reservation.FormOfPayment.activeInd` (boolean)
    Deprecated. Will not implement.
    Example: true

  - `ReservationResponse.Reservation.FormOfPayment.agentNonRefundableInd` (boolean)
    This indicates that the Cash payment should not be refunded

  - `ReservationResponse.Reservation.FormOfPayment.Comment` (string)

  - `ReservationResponse.Reservation.FormOfPayment.FreeText` (string)

  - `ReservationResponse.Reservation.FormOfPayment.miscellaneousInd` (boolean)
    If true, the form of payment type is MS, miscellaneous

  - `ReservationResponse.Reservation.FormOfPayment.PaymentCard` (object)
    Form of payment details for a payment card.

  - `ReservationResponse.Reservation.FormOfPayment.PaymentCard.@type` (string, required)
    Discriminator classes PaymentCard or PaymentCardDetail
    Example: PaymentCard

  - `ReservationResponse.Reservation.FormOfPayment.PaymentCard.id` (string)
    Payment card reference ID.
    Example: paymentCard_01

  - `ReservationResponse.Reservation.FormOfPayment.PaymentCard.effectiveDate` (string)
    Indicated starting date.

  - `ReservationResponse.Reservation.FormOfPayment.PaymentCard.expireDate` (string)
    Card expiration date in MMYY format.
    Example: 0558

  - `ReservationResponse.Reservation.FormOfPayment.PaymentCard.approvalCode` (string)
    The approval code value
    Example: C59

  - `ReservationResponse.Reservation.FormOfPayment.PaymentCard.CardType` (string)
    Type of card; supported values are Credit, Debit, Gift.
    Enum: "Credit", "Debit", "Gift"

  - `ReservationResponse.Reservation.FormOfPayment.PaymentCard.CardCode` (string)
    Specifies the two character code (MC, VI, AX, etc) for the payment card (open enumeration)
    Example: VI

  - `ReservationResponse.Reservation.FormOfPayment.PaymentCard.CardBrand` (object)
    This object contains Cards details for Payment

  - `ReservationResponse.Reservation.FormOfPayment.PaymentCard.CardBrand.paymentCardIssuers` (object)
    An array of Payment Card Issuers

  - `ReservationResponse.Reservation.FormOfPayment.PaymentCard.CardBrand.paymentCardIssuers.value` (string)
    Source: OpenTravel
    Enum: "VISA", "USAirways", "UnitedAirlines", "StarwoodHotels", "SouthwestAirlines", "RitzCarlton", "Mastercard", "Mariott", "Hyatt", "Hilton", "Eurocard", "Disney", "DiscoverCard", "DeltaAirlines", "ContinentalAirlines", "Citibank", "Chase", "CapitalOne", "BritishAirways", "BankOfAmerica", "AmericanExpress"

  - `ReservationResponse.Reservation.FormOfPayment.PaymentCard.CardBrand.paymentCardIssuersExtension` (string)

  - `ReservationResponse.Reservation.FormOfPayment.PaymentCard.CardBrand.issueNumber` (integer)
    Assigned Type: c-1100:NumberDoubleDigit

  - `ReservationResponse.Reservation.FormOfPayment.PaymentCard.CardHolderName` (string)
    Name as displayed on payment card

  - `ReservationResponse.Reservation.FormOfPayment.PaymentCard.CardNumber` (object)
    The payment card number

  - `ReservationResponse.Reservation.FormOfPayment.PaymentCard.CardNumber.@type` (string)

  - `ReservationResponse.Reservation.FormOfPayment.PaymentCard.CardNumber.encryptionKey` (string)
    Note: This contains a key required to retrieve the full payment instrument details compliant with PCI DSS standards.
    Example: secret

  - `ReservationResponse.Reservation.FormOfPayment.PaymentCard.CardNumber.encryptionKeyMethod` (string)
    Developer: This contains a reference to the key generation method being used - this is NOT the key value.
    Example: RSA

  - `ReservationResponse.Reservation.FormOfPayment.PaymentCard.CardNumber.encryptionMethod` (string)
    OpenTravel Best Practice: Encryption Method: When using the OpenTravel Encryption element, it is RECOMMENDED that all trading partners be informed of all encryption methods being used in advance of implementation to ensure message processing compatibility.
    Example: RSA

  - `ReservationResponse.Reservation.FormOfPayment.PaymentCard.CardNumber.encryptedValue` (string)
    Encrypted value
    Example: 5dfc52b51bd35553df8592078de921bc

  - `ReservationResponse.Reservation.FormOfPayment.PaymentCard.CardNumber.mask` (string)
    Masked Value
    Example: xxxx436

  - `ReservationResponse.Reservation.FormOfPayment.PaymentCard.CardNumber.token` (string)
    Token value
    Example: A567GTREWQ

  - `ReservationResponse.Reservation.FormOfPayment.PaymentCard.CardNumber.tokenProviderID` (string)
    Developer: This contains a provider ID if multiple providers are used for secure information exchange.
    Example: c1234532

  - `ReservationResponse.Reservation.FormOfPayment.PaymentCard.CardNumber.authenticationMethod` (string)
    Type of Authentication
    Enum: "SecurityCode", "MagneticStripe"

  - `ReservationResponse.Reservation.FormOfPayment.PaymentCard.CardNumber.PlainText` (string)
    Don't use this unless it is REALLY ok to not use encryption. Non-secure (plain text) value.
    Example: un-encrypted data

  - `ReservationResponse.Reservation.FormOfPayment.PaymentCard.CardNumber.ErrorWarning` (object)
    parent class of ErrorWarningDetail

  - `ReservationResponse.Reservation.FormOfPayment.PaymentCard.CardNumber.ErrorWarning.@type` (string, required)
    Discriminator classes ErrorWarning or ErrorWarningDetail
    Example: ErrorWarning

  - `ReservationResponse.Reservation.FormOfPayment.PaymentCard.CardNumber.ErrorWarning.StatusCode` (integer)
    Http standard response code

  - `ReservationResponse.Reservation.FormOfPayment.PaymentCard.CardNumber.ErrorWarning.Message` (string)
    The Travelport standardized error or warning message

  - `ReservationResponse.Reservation.FormOfPayment.PaymentCard.CardNumber.ErrorWarning.NameValuePair` (array)

  - `ReservationResponse.Reservation.FormOfPayment.PaymentCard.CardNumber.ErrorWarning.category` (string)
    A category to assist in identifying the error
    Example: VALIDATION

  - `ReservationResponse.Reservation.FormOfPayment.PaymentCard.CardNumber.ErrorWarning.SourceID` (string, required)
    The identifier of the source system sending the error or warning

  - `ReservationResponse.Reservation.FormOfPayment.PaymentCard.CardNumber.ErrorWarning.SourceCode` (string)
    The error or warning code returned by the source airline or host system

  - `ReservationResponse.Reservation.FormOfPayment.PaymentCard.CardNumber.ErrorWarning.SourceDescription` (string)
    The error or warning message as it is returned by the source airline or host system

  - `ReservationResponse.Reservation.FormOfPayment.PaymentCard.SeriesCode` (object)
    The security code of card.

  - `ReservationResponse.Reservation.FormOfPayment.PaymentCard.SeriesCode.@type` (string)

  - `ReservationResponse.Reservation.FormOfPayment.PaymentCard.SeriesCode.encryptionKey` (string)
    Note: This contains a key required to retrieve the full payment instrument details compliant with PCI DSS standards.
    Example: secret

  - `ReservationResponse.Reservation.FormOfPayment.PaymentCard.SeriesCode.encryptionKeyMethod` (string)
    Developer: This contains a reference to the key generation method being used - this is NOT the key value.
    Example: RSA

  - `ReservationResponse.Reservation.FormOfPayment.PaymentCard.SeriesCode.encryptionMethod` (string)
    OpenTravel Best Practice: Encryption Method: When using the OpenTravel Encryption element, it is RECOMMENDED that all trading partners be informed of all encryption methods being used in advance of implementation to ensure message processing compatibility.
    Example: RSA

  - `ReservationResponse.Reservation.FormOfPayment.PaymentCard.SeriesCode.encryptedValue` (string)
    Encrypted value
    Example: 5dfc52b51bd35553df8592078de921bc

  - `ReservationResponse.Reservation.FormOfPayment.PaymentCard.SeriesCode.mask` (string)
    Masked Value
    Example: xxxx436

  - `ReservationResponse.Reservation.FormOfPayment.PaymentCard.SeriesCode.token` (string)
    Token value
    Example: A567GTREWQ

  - `ReservationResponse.Reservation.FormOfPayment.PaymentCard.SeriesCode.tokenProviderID` (string)
    Developer: This contains a provider ID if multiple providers are used for secure information exchange.
    Example: c1234532

  - `ReservationResponse.Reservation.FormOfPayment.PaymentCard.SeriesCode.PlainText` (string)
    Don't use this unless it is REALLY ok to not use encryption. Non-secure (plain text) value. The credit card three or four digit CVV code. Required by certain suppliers. Booking.com requires the CVV code.
    Example: un-encrypted data

  - `ReservationResponse.Reservation.FormOfPayment.PaymentCard.MagneticStripe` (array)

  - `ReservationResponse.Reservation.FormOfPayment.PaymentCard.MagneticStripe.@type` (string)

  - `ReservationResponse.Reservation.FormOfPayment.PaymentCard.MagneticStripe.encryptionKey` (string)
    Note: This contains a key required to retrieve the full payment instrument details compliant with PCI DSS standards.
    Example: secret

  - `ReservationResponse.Reservation.FormOfPayment.PaymentCard.MagneticStripe.encryptionKeyMethod` (string)
    Developer: This contains a reference to the key generation method being used - this is NOT the key value.
    Example: RSA

  - `ReservationResponse.Reservation.FormOfPayment.PaymentCard.MagneticStripe.encryptionMethod` (string)
    OpenTravel Best Practice: Encryption Method: When using the OpenTravel Encryption element, it is RECOMMENDED that all trading partners be informed of all encryption methods being used in advance of implementation to ensure message processing compatibility.
    Example: RSA

  - `ReservationResponse.Reservation.FormOfPayment.PaymentCard.MagneticStripe.encryptedValue` (string)
    Encrypted value
    Example: 5dfc52b51bd35553df8592078de921bc

  - `ReservationResponse.Reservation.FormOfPayment.PaymentCard.MagneticStripe.mask` (string)
    Masked Value
    Example: xxxx436

  - `ReservationResponse.Reservation.FormOfPayment.PaymentCard.MagneticStripe.token` (string)
    Token value
    Example: A567GTREWQ

  - `ReservationResponse.Reservation.FormOfPayment.PaymentCard.MagneticStripe.tokenProviderID` (string)
    Developer: This contains a provider ID if multiple providers are used for secure information exchange.
    Example: c1234532

  - `ReservationResponse.Reservation.FormOfPayment.PaymentCard.MagneticStripe.PlainText` (string)
    Don't use this unless it is REALLY ok to not use encryption. Non-secure (plain text) value.
    Example: un-encrypted data

  - `ReservationResponse.Reservation.FormOfPayment.PaymentCard.secureInd` (boolean)
    Implementer: If true, all or a portion of this data is secure, via tokenization, encryption and/or masking.

  - `ReservationResponse.Reservation.FormOfPayment.PaymentCard.countryOfIssue` (string)
    The country code ISO
    Example: AG

  - `ReservationResponse.Reservation.FormOfPayment.PaymentCard.companyCardReference` (string)
    The company card reference
    Example: IOR1386861

  - `ReservationResponse.Reservation.FormOfPayment.PaymentCard.bankName` (string)
    The bank name value
    Example: Bank of America

  - `ReservationResponse.Reservation.FormOfPayment.PaymentCard.bankCountryCode` (string)
    The bank country code ISO
    Example: BOFAUS3N

  - `ReservationResponse.Reservation.FormOfPayment.PaymentCard.bankStateCode` (string)
    The bank state code ISO
    Example: NE

  - `ReservationResponse.Reservation.FormOfPayment.PaymentCard.Telephone` (array)

  - `ReservationResponse.Reservation.FormOfPayment.PaymentCard.Email` (array)

  - `ReservationResponse.Reservation.FormOfPayment.PaymentCard.CustomerLoyalty` (array)

  - `ReservationResponse.Reservation.FormOfPayment.PaymentCard.SignatureOnFile` (object)
    Signature held on file

  - `ReservationResponse.Reservation.FormOfPayment.PaymentCard.SignatureOnFile.@type` (string)
    Example: SignatureOnFile

  - `ReservationResponse.Reservation.FormOfPayment.PaymentCard.SignatureOnFile.Date_EffectiveExpire` (object)
    Used to identify the effective date and/or expiration date.

  - `ReservationResponse.Reservation.FormOfPayment.PaymentCard.SignatureOnFile.Date_EffectiveExpire.effective` (string)
    Indicates the starting date.

  - `ReservationResponse.Reservation.FormOfPayment.PaymentCard.SignatureOnFile.Date_EffectiveExpire.expire` (string)
    Indicates the ending date.

  - `ReservationResponse.Reservation.FormOfPayment.PaymentCard.SignatureOnFile.Date_EffectiveExpire.expireDateExclusiveInd` (boolean)
    When true, indicates that the ExpireDate is the first day after the applicable period (e.g. when expire date is Oct 15  the last date of the period is Oct 14).

  - `ReservationResponse.Reservation.FormOfPayment.PaymentCard.SignatureOnFile.signatureOnFileInd` (boolean)
    When true, indicates a signature has been obtained.
    Example: true

  - `ReservationResponse.Reservation.FormOfPayment.PaymentCard.ThreeDomainSecurity` (object)
    3DS authentication information

  - `ReservationResponse.Reservation.FormOfPayment.PaymentCard.ThreeDomainSecurity.@type` (string)
    Example: ThreeDomainSecurity

  - `ReservationResponse.Reservation.FormOfPayment.PaymentCard.ThreeDomainSecurity.ThreeDomainSecurityGateway` (object, required)
    3DS authentication information

  - `ReservationResponse.Reservation.FormOfPayment.PaymentCard.ThreeDomainSecurity.ThreeDomainSecurityGateway.@type` (string)
    Example: ThreeDomainSecurityGateway

  - `ReservationResponse.Reservation.FormOfPayment.PaymentCard.ThreeDomainSecurity.ThreeDomainSecurityGateway.eCI` (string)
    The eCI value
    Example: 2

  - `ReservationResponse.Reservation.FormOfPayment.PaymentCard.ThreeDomainSecurity.ThreeDomainSecurityGateway.merchantID` (string)
    The merchant ID value
    Example: mycart

  - `ReservationResponse.Reservation.FormOfPayment.PaymentCard.ThreeDomainSecurity.ThreeDomainSecurityGateway.processorID` (string)
    The processor ID value
    Example: 201

  - `ReservationResponse.Reservation.FormOfPayment.PaymentCard.ThreeDomainSecurity.ThreeDomainSecurityGateway.uRL` (string)
    Transaction URL.
    Example: https://transactionURL

  - `ReservationResponse.Reservation.FormOfPayment.PaymentCard.ThreeDomainSecurity.ThreeDomainSecurityGateway.AuthenticationVerification` (object)
    Authentication and verification information

  - `ReservationResponse.Reservation.FormOfPayment.PaymentCard.ThreeDomainSecurity.ThreeDomainSecurityGateway.Password` (object)
    Password information

  - `ReservationResponse.Reservation.FormOfPayment.PaymentCard.ThreeDomainSecurity.ThreeDomainSecurityResults` (object, required)
    3DS authentication information

  - `ReservationResponse.Reservation.FormOfPayment.PaymentCard.ThreeDomainSecurity.ThreeDomainSecurityResults.@type` (string)
    Example: ThreeDomainSecurityResults

  - `ReservationResponse.Reservation.FormOfPayment.PaymentCard.ThreeDomainSecurity.ThreeDomainSecurityResults.cAVV` (string)
    The cAVV value
    Example: AAABAFaQRwAAAAAAEZBHAAAAAAA=ECI05

  - `ReservationResponse.Reservation.FormOfPayment.PaymentCard.ThreeDomainSecurity.ThreeDomainSecurityResults.pAResStatus` (string)
    The pAResStatus value
    Example: 1

  - `ReservationResponse.Reservation.FormOfPayment.PaymentCard.ThreeDomainSecurity.ThreeDomainSecurityResults.signatureVerfication` (string)
    The signature Verification value
    Example: Y

  - `ReservationResponse.Reservation.FormOfPayment.PaymentCard.ThreeDomainSecurity.ThreeDomainSecurityResults.transactionID` (string)
    The transaction ID
    Example: 9D920E9-6FCF-4A74-A4E0-D6A591D1108F

  - `ReservationResponse.Reservation.FormOfPayment.PaymentCard.ThreeDomainSecurity.ThreeDomainSecurityResults.xID` (string)
    Merchants must ensure that each Payer Authentication Request (PAReq) contains a unique combination of account ID and XID
    Example: 2bxUs1emK0SCevbivcApzAcAAQk=

  - `ReservationResponse.Reservation.FormOfPayment.PaymentCard.ThreeDomainSecurity.ThreeDomainSecurityResults.eCI` (string)
    Electronic Commerce Indicator - 3-D secure data, contact your authenticator for rules and downline processing.
    Example: 2

  - `ReservationResponse.Reservation.FormOfPayment.PaymentCard.ThreeDomainSecurity.ThreeDomainSecurityResults.uCAFIndicator` (string)
    Universal Card Authentication Field™ MasterCard only UCAF is the mechanism that is used to transmit the AAV from the merchant to issuer for authentication purposes during the authorization process
    Example: 0

  - `ReservationResponse.Reservation.FormOfPayment.PaymentCard.extendedPaymentInd` (boolean)
    Implementer: If true, the credit card company is requested to delay the date on which the amount of this transaction is applied to the customer's account.

  - `ReservationResponse.Reservation.FormOfPayment.PaymentCard.enettInd` (boolean)
    True if this payment card has been issued through Enett
    Example: true

  - `ReservationResponse.Reservation.FormOfPayment.PaymentCard.thirdPartyInd` (boolean)
    If true, then the payment card holder is not one of the travelers in the reservation
    Example: true

  - `ReservationResponse.Reservation.FormOfPayment.PaymentCard.acceptanceOverrideInd` (boolean)
    If true, override airline restriction on the payment card
    Example: true

  - `ReservationResponse.Reservation.FormOfPayment.inhibitPaymentCardAuthorizationInd` (boolean)
    If true, the payment card will not go through card authorization process

  - `ReservationResponse.Reservation.FormOfPayment.notValidForPaymentInd` (boolean)
    If true, the payment card has been masked and is not valid for making payments

  - `ReservationResponse.Reservation.FormOfPayment.ExtendedPayment` (object)
    Note this field is deprecated in Payment schema and should be passed in FormOfPaymentPaymentCardExtendPayment schema

  - `ReservationResponse.Reservation.FormOfPayment.ExtendedPayment.NumberOfInstallments` (integer, required)
    The number of installment payments to be charged by the payment card provider
    Example: 6

  - `ReservationResponse.Reservation.FormOfPayment.ExtendedPayment.FirstInstallment` (number)
    For Pagos Parceledos, specify the first installment amount. This will be the same currency as the payment
    Example: 100

  - `ReservationResponse.Reservation.FormOfPayment.ExtendedPayment.RemainingAmount` (number)
    For Pagos Parceledos, specify the remaining amount to be charged that will be spread across the number of installments. This will be the same currency as the payment
    Example: 50

  - `ReservationResponse.Reservation.FormOfPayment.ExtendedPayment.OTATOCode` (string)
    For Pagos Parceledos the OTATOCode

  - `ReservationResponse.Reservation.FormOfPayment.forfeitInd` (boolean)
    If true, this form of payment instruction is to forfeit residual amounts specified in an Offer. Used in conjunction with Payment to specify which amounts to be forfeited

  - `ReservationResponse.Reservation.FormOfPayment.accountNumber` (string)
    The account number for the Form of payment BSP
    Example: 378282246310005

  - `ReservationResponse.Reservation.FormOfPayment.agencyId` (string)
    The identifier of the pre-established agency account to be billed. This is not validated or created by this API — the account must already exist with the supplier or settlement provider. Format and issuing authority vary by supplier; consult supplier-specific documentation.
    Example: 87654321

  - `ReservationResponse.Reservation.FormOfPayment.InvoiceNumber` (string)
    The invoice number this payment is applied against. Must correspond to an invoice already established outside this transaction; the API does not verify invoice existence or outstanding balance.

  - `ReservationResponse.Reservation.FormOfPayment.DocumentNumber` (object)
    Document Number with additional attributes that the document represents

  - `ReservationResponse.Reservation.FormOfPayment.DocumentNumber.value` (string)
    Example: 1259900123456

  - `ReservationResponse.Reservation.FormOfPayment.DocumentNumber.documentIssuer` (string)
    Document issuer
    Example: BA

  - `ReservationResponse.Reservation.FormOfPayment.DocumentNumber.documentType` (string)
    Document type like EMD, MCO
    Enum: "EMD", "MCO", "Ticket", "TASF", "Invoice"

  - `ReservationResponse.Reservation.FormOfPayment.DocumentNumber.travelerIdentifierRef` (string)
    traveler identifier reference
    Example: traveler_1

  - `ReservationResponse.Reservation.FormOfPayment.DocumentNumber.name` (string)
    The name of the Traveler being referenced.
    Example: SMITH/JMR

  - `ReservationResponse.Reservation.FormOfPayment.DocumentNumber.passengerTypeCode` (string)
    The passenger type code of the Traveler being referenced.
    Example: ADT

  - `ReservationResponse.Reservation.FormOfPayment.DocumentNumber.id` (string)
    A locally referenced ID
    Example: id_1

  - `ReservationResponse.Reservation.FormOfPayment.DocumentNumber.description` (string)
    Descriptive text used to identify the contents of a target object
    Example: Descriptive text.

  - `ReservationResponse.Reservation.FormOfPayment.DocumentNumber.uris` (array)
    The URI used to GET the target object in another domain.
    Example: ["www.travelport.com/uri"]

  - `ReservationResponse.Reservation.FormOfPayment.WaiverCode` (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.

  - `ReservationResponse.Reservation.FormOfPayment.WaiverCode.value` (string)

  - `ReservationResponse.Reservation.FormOfPayment.WaiverCode.reasonCode` (integer)
    A code assigned to identify the reason for disruption
    Example: 2

  - `ReservationResponse.Reservation.FormOfPayment.WaiverCode.waiverType` (string)
    List of waiver types.
    Enum: "ChangePenalty", "PriceDifference", "ChangePenaltyAndPriceDifference", "RefundPenalty", "NameChangePenalty"

  - `ReservationResponse.Reservation.FormOfPayment.FlightPass` (array, required)

  - `ReservationResponse.Reservation.FormOfPayment.FlightPass.@type` (string, required)
    Discriminator. No child classes
    Example: FlightPass

  - `ReservationResponse.Reservation.FormOfPayment.FlightPass.accountNumber` (string, required)
    The flight pass account number.
    Example: 0140851633093

  - `ReservationResponse.Reservation.FormOfPayment.FlightPass.supplier` (string, required)
    The flight pass supplier code. AC is the only value accepted at this time.
    Example: AC

  - `ReservationResponse.Reservation.FormOfPayment.FlightPass.Description` (array)

  - `ReservationResponse.Reservation.FormOfPayment.FlightPass.TravelerIdentifierRef` (array)
    In Search, use the passengerCriteriaRef to reference the owner of the flightpass. This is a mandatory field for Search API.

  - `ReservationResponse.Reservation.FormOfPayment.FlightPass.TravelerIdentifierRef.value` (string)
    Example: traveler_001

  - `ReservationResponse.Reservation.FormOfPayment.FlightPass.TravelerIdentifierRef.id` (string)
    A locally referenced ID
    Example: id_001

  - `ReservationResponse.Reservation.FormOfPayment.FlightPass.TravelerIdentifierRef.description` (string)
    Descriptive text used to identify the contents of a target object
    Example: Descriptive Text

  - `ReservationResponse.Reservation.FormOfPayment.FlightPass.TravelerIdentifierRef.uris` (array)
    Uniform Resource Identifier
    Example: ["www.travelport.com/uri"]

  - `ReservationResponse.Reservation.FormOfPayment.checkInd` (boolean)
    If true, the form of payment type is check

  - `ReservationResponse.Reservation.Payment` (array)
    Contains payment details related to a ticketed itinerary.

  - `ReservationResponse.Reservation.Payment.@type` (string, required)
    Discriminator classes PaymentID or Payment
    Example: Payment

  - `ReservationResponse.Reservation.Payment.id` (string)
    Customer-assigned identifier for the payment.

  - `ReservationResponse.Reservation.Payment.PaymentRef` (string)
    Customer-assigned name for the payment.

  - `ReservationResponse.Reservation.Payment.Amount` (object, required)
    A monetary amount, up to 4 decimal places. Decimal place must be included.

  - `ReservationResponse.Reservation.Payment.Amount.value` (number)
    The amount of a given currency.
    Example: 124.56

  - `ReservationResponse.Reservation.Payment.Amount.code` (string)
    An ISO 4217 alpha character code (3 characters) that specifies a money unit.
    Example: USD

  - `ReservationResponse.Reservation.Payment.Amount.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

  - `ReservationResponse.Reservation.Payment.Amount.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

  - `ReservationResponse.Reservation.Payment.FormOfPaymentIdentifier` (object)
    The Travelport-assigned identifier to identify the form of payment to which a payment was charged.

  - `ReservationResponse.Reservation.Payment.FormOfPaymentIdentifier.@type` (string)
    Example: FormOfPaymentPaymentCash

  - `ReservationResponse.Reservation.Payment.FormOfPaymentIdentifier.id` (string)
    Form of payment identifier reference ID.

  - `ReservationResponse.Reservation.Payment.FormOfPaymentIdentifier.FormOfPaymentRef` (string)
    User-assigned custom ID sent with the Add Form of Payment request.

  - `ReservationResponse.Reservation.Payment.FormOfPaymentIdentifier.activeInd` (boolean)
    If true, this form of payment will be used for document issuance and override any other form of payment in the reservation.
    Example: true

  - `ReservationResponse.Reservation.Payment.OfferIdentifier` (array)

  - `ReservationResponse.Reservation.Payment.OfferIdentifier.id` (string)
    Local identifier within a given message for this object.
    Example: offer_1

  - `ReservationResponse.Reservation.Payment.OfferIdentifier.offerRef` (string)
    Used to reference another instance of this object in the same message
    Example: offer_1

  - `ReservationResponse.Reservation.Payment.TravelerIdentifierRef` (array)

  - `ReservationResponse.Reservation.Payment.depositInd` (boolean)
    If true, the payment is a deposit on the referenced Offer; at booking the provided card is charged for deposit or prepay rate.

  - `ReservationResponse.Reservation.Payment.AgencyServiceFeeIdentifier` (array)

  - `ReservationResponse.Reservation.Payment.AgencyServiceFeeIdentifier.id` (string)
    Unique id for this object within a message

  - `ReservationResponse.Reservation.Payment.guaranteeInd` (boolean)
    If true, the payment is a guarantee for the referenced Offer; no amounts are charged at booking; the customer is to make payment in person upon arrival.

  - `ReservationResponse.Reservation.Receipt` (array)
    Returns confirmation details, including the booking locator code.

  - `ReservationResponse.Reservation.Receipt.@type` (string, required)
    Discriminator classes ReceiptID, ReceiptConfirmation, ReceiptConfirmationDivide, ReceiptCancellation, ReceiptPayment
    Example: ReceiptConfirmation

  - `ReservationResponse.Reservation.Receipt.id` (string)
    The verification number.
    Example: 3493289238

  - `ReservationResponse.Reservation.Receipt.ReceiptRef` (string)
    Example: 6773 2389 2239 2832

  - `ReservationResponse.Reservation.Receipt.dateTime` (string)
    Receipt date time
    Example: 2022-08-07T12:12:00Z

  - `ReservationResponse.Reservation.Receipt.OfferRef` (array)
    List of offer reference ids for the offer(s) returned in the Reservation response.
    Example: ["offer_001"]

  - `ReservationResponse.Reservation.Receipt.ProductRef` (string)
    Reference of product
    Example: product_001

  - `ReservationResponse.Reservation.OfferLink` (array)

  - `ReservationResponse.Reservation.OfferLink.@type` (string, required)
    Example: OfferLink

  - `ReservationResponse.Reservation.OfferLink.OfferRef` (string)

  - `ReservationResponse.Reservation.OfferLink.ParentOffer` (object)

  - `ReservationResponse.Reservation.OfferLink.ParentOffer.@type` (string, required)
    Discriminator class ParentOffer only
    Example: ParentOffer

  - `ReservationResponse.Reservation.OfferLink.ParentOffer.OfferRef` (string)

  - `ReservationResponse.Reservation.OfferLink.ParentOffer.ProductRef` (string)

  - `ReservationResponse.Reservation.ReservationComment` (array)
    Any remarks added to the reservation.

  - `ReservationResponse.Reservation.ReservationComment.@type` (string, required)
    Discriminator classes ReservationCommentID or ReservationComment
    Example: ReservationComment

  - `ReservationResponse.Reservation.ReservationComment.id` (string)
    Local identifier within a given message for this object.

  - `ReservationResponse.Reservation.ReservationComment.commentSource` (string)
    Originator of a comment.
    Enum: "Agency", "Supplier", "Traveler"

  - `ReservationResponse.Reservation.ReservationComment.shareWith` (string)
    Designates the visibility of a remark.
    Enum: "Supplier", "Agency", "Traveler"

  - `ReservationResponse.Reservation.ReservationComment.shareWithSupplier` (array)
    Reservation comment shared with supplier
    Example: ["AA","BA"]

  - `ReservationResponse.Reservation.ReservationComment.Comment` (array)
    Defines the type of remark (name) and the remark itself (value).
Send the following in 'name' for each type of remark: Notepad remarks: Two-character code. Use asterisk for any placeholder. (HS, CR, R*, **) Unassociated remarks: ITIN COMMENTS Special instruction remarks: SI
For remark text 'value', please note character limits for each type of remark: Notepad remarks: 87 Unassociated remarks: 70 Special instruction remarks: 50

  - `ReservationResponse.Reservation.ReservationComment.AppliesTo` (array)

  - `ReservationResponse.Reservation.ReservationComment.AppliesTo.@type` (string, required)
    Discriminator classes AppliesToOffer, AppliesToOfferProduct, and AppliesToOfferProductSegment
    Example: AppliesToOffer

  - `ReservationResponse.Reservation.ReservationComment.AppliesTo.OfferIdentifier` (array)

  - `ReservationResponse.Reservation.ReservationComment.AppliesTo.ProductIdentifier` (array)

  - `ReservationResponse.Reservation.ReservationComment.AppliesTo.ProductIdentifier.id` (string)
    Local identifier within a given message for this object.
    Example: product_1

  - `ReservationResponse.Reservation.ReservationComment.AppliesTo.ProductIdentifier.productRef` (string)
    Used to reference another instance of this object in the same payload.
    Example: product_1

  - `ReservationResponse.Reservation.PrimaryContact` (array)
    Any primary contact details for the reservation.

  - `ReservationResponse.Reservation.PrimaryContact.@type` (string, required)
    Discriminator classes PrimaryContactID or PrimaryContact
    Example: PrimaryContact

  - `ReservationResponse.Reservation.PrimaryContact.id` (string)

  - `ReservationResponse.Reservation.PrimaryContact.shareWithSupplier` (array)
    Primary contact shared with supplier
    Example: ["AA","BA"]

  - `ReservationResponse.Reservation.PrimaryContact.TravelerIdentifier` (object)
    Returns the system-generated traveler identifier in key value pairs; authority, if returned, is Travelport.

  - `ReservationResponse.Reservation.PrimaryContact.TravelerIdentifier.@type` (string)
    Example: TravelerIdentifier

  - `ReservationResponse.Reservation.PrimaryContact.TravelerIdentifier.id` (string)

  - `ReservationResponse.Reservation.PrimaryContact.TravelerIdentifier.TravelerRef` (string)

  - `ReservationResponse.Reservation.PrimaryContact.contactInformationRefusedInd` (boolean)
    If true, the passenger has refused to provide emergency contact details
    Example: true

  - `ReservationResponse.Reservation.TravelAgency` (object)
    An optional object to define travel agency information.

  - `ReservationResponse.Reservation.TravelAgency.@type` (string, required)
    Discriminator classes TravelAgency, TravelAgencyID, or TravelAgencyDetail
    Example: TravelAgencyDetail

  - `ReservationResponse.Reservation.TravelAgency.id` (string)
    Simple xsd id, not for external use
    Example: 2

  - `ReservationResponse.Reservation.TravelAgency.TravelOrganizationRef` (string)
    An organization that has a name and a structure and members and directly works in the travel industry
    Example: TravelAgency_1

  - `ReservationResponse.Reservation.TravelAgency.organizationType` (string)
    The type of organization such as an Agency, Branch, Company, Supplier, Provider
    Enum: "TravelAgency", "AgencyBranch", "LoyaltyProgram", "IdDocumentIssuer", "TravelSupplier", "TravelProvider", "Regulatory"

  - `ReservationResponse.Reservation.TravelAgency.OrganizationName` (object, required)
    Identifies a company by name

  - `ReservationResponse.Reservation.TravelAgency.OrganizationName.value` (string)

  - `ReservationResponse.Reservation.TravelAgency.OrganizationName.id` (string)
    Use this id to internally identify this company in NextSteps
    Example: 2

  - `ReservationResponse.Reservation.TravelAgency.OrganizationName.division` (string)
    The division name or ID with which the contact is associated
    Example: Travel Division

  - `ReservationResponse.Reservation.TravelAgency.OrganizationName.department` (string)
    The department name or ID with which the contact is associated
    Example: Adventure department

  - `ReservationResponse.Reservation.TravelAgency.OrganizationName.shortName` (string)
    Used to provide the company common name
    Example: Adventure Inc

  - `ReservationResponse.Reservation.TravelAgency.OrganizationName.code` (string)
    Identifies a company by the company code
    Example: AI

  - `ReservationResponse.Reservation.TravelAgency.OrganizationName.codeContext` (string)
    Identifies the context of the identifying code, such as DUNS, IATA, or internal code
    Example: ISO

  - `ReservationResponse.Reservation.TravelAgency.OrganizationName.systemOfRecord` (array)
    The system(s) that maintain the data

  - `ReservationResponse.Reservation.TravelAgency.CorporateCode` (string)
    A reference assigned by the Travel Agency to identify the corporate organization
    Example: Air Agency

  - `ReservationResponse.Reservation.TravelAgency.ProfileName` (array)

  - `ReservationResponse.Reservation.GroupName` (string)
    Group name will be passed in the new Group object

  - `ReservationResponse.Reservation.SpecialService` (array)

  - `ReservationResponse.Reservation.SpecialService.@type` (string, required)
    Discriminator classes SpecialServiceID, SpecialServiceBassinet, SpecialServiceBlind, SpecialServiceDeaf, SpecialServiceDPNA, SpecialServiceMeal, SpecialServiceUnaccompaniedMinor, SpecialServiceWheelchairAirlineSupplied, SpecialServiceWheelchairTravelerSupplied
    Example: SpecialService

  - `ReservationResponse.Reservation.SpecialService.id` (string)
    Internal Id

  - `ReservationResponse.Reservation.SpecialService.Status` (object)

  - `ReservationResponse.Reservation.SpecialService.Status.supplierText` (string)
    Supplier status text
    Example: Active/In-active

  - `ReservationResponse.Reservation.SpecialService.Status.code` (string)
    Special service status code
    Example: NN

  - `ReservationResponse.Reservation.SpecialService.ServiceAnimalType` (string)
    The type of service animal accompanying the Traveler. If no service animal leave blank.
    Example: Horse

  - `ReservationResponse.Reservation.SpecialService.Quantity` (integer)
    Example: 1

  - `ReservationResponse.Reservation.SpecialService.FreeText` (string)
    Example: NO SEAFOOD

  - `ReservationResponse.Reservation.SpecialService.SSRCode` (string)
    Example: SPML

  - `ReservationResponse.Reservation.SpecialService.Carrier` (string)
    For unassociated SSRs use carrier to instruct which airline to send the service information to
    Example: BA

  - `ReservationResponse.Reservation.Preference` (object)

  - `ReservationResponse.Reservation.Preference.@type` (string, required)
    Discriminator classes PreferenceID, Preference, PreferenceAirSeat, or PreferenceRailSeat
    Example: Preference

  - `ReservationResponse.Reservation.Preference.id` (string)

  - `ReservationResponse.Reservation.OrganizationLoyaltyProgram` (array)

  - `ReservationResponse.Reservation.OrganizationLoyaltyProgram.@type` (string, required)
    Discriminator classes OrganizationLoyaltyProgramID or OrganizationLoyaltyProgram
    Example: OrganizationLoyaltyProgramID

  - `ReservationResponse.Reservation.OrganizationLoyaltyProgram.id` (string)

  - `ReservationResponse.Reservation.OrganizationLoyaltyProgram.Supplier` (string, required)
    The supplier of the loyalty program
    Example: Air Canada

  - `ReservationResponse.Reservation.OrganizationLoyaltyProgram.LoyaltyIdentifier` (string, required)
    Loyalty Identifier
    Example: LP029381

  - `ReservationResponse.Reservation.ShoppingCart` (object)
    This object is deprecated and no longer in use.

  - `ReservationResponse.Reservation.ShoppingCart.@type` (string)
    Example: ShoppingCart

  - `ReservationResponse.Reservation.ShoppingCart.Product` (array)

  - `ReservationResponse.Reservation.ShoppingCart.Product.totalDuration` (string)
    Total duration of the combined segments in hours (H) and minutes (M). ISO 8601 format.
    Example: PT2H40M

  - `ReservationResponse.Reservation.ShoppingCart.Product.FlightSegment` (array, required)
    One instance for each flight segment in the product.

  - `ReservationResponse.Reservation.ShoppingCart.Product.FlightSegment.@type` (string)
    Discriminator. No child classes.
    Example: FlightSegment

  - `ReservationResponse.Reservation.ShoppingCart.Product.FlightSegment.id` (string)
    Local identifier within a given message for this object.  
Generally this identifier starts with s as in s1, s2, etc.
    Example: flightSegment_01

  - `ReservationResponse.Reservation.ShoppingCart.Product.FlightSegment.sequence` (integer, required)
    Order of the flight segment. e.g. 1 for the first segment on the leg.
    Example: 1

  - `ReservationResponse.Reservation.ShoppingCart.Product.FlightSegment.connectionDuration` (string)
    When a flight connection exists, this is the lapsed time between the connecting flights in the format PT{x}H{x}M, in which P is the duration designator, T is the time designator, {x}H is the number of hours for the connection, and {x}M is the number of minutes for the connection.
    Example: PT1H3M

  - `ReservationResponse.Reservation.ShoppingCart.Product.FlightSegment.amenityRefs` (array)
    If RouteHappy flight amenities were requested (includeFlightAmenitiesInd=true), amenityRefs is returned to cross-reference the amenities available on this flight and listed in ReferenceList/ReferenceListAmenity.

  - `ReservationResponse.Reservation.ShoppingCart.Product.FlightSegment.universalProductAttributeRefs` (array)
    If universal product attributes (UPAs) for RouteHappy data were requested (includeUniversalProductAttributesInd=true) along with RouteHappy flight amenities, universalProductAttributeRefs is returned. Cross-reference the universalProductAttributeRef with the universalProductAttribute 'id' in ReferenceListUniversalProductAttribute.UniversalProductAttribute. UPAs provide images, icons, and URLs as provided by ATPCO. RouteHappy data must have also been requested per amenityRefs above.

  - `ReservationResponse.Reservation.ShoppingCart.Product.FlightSegment.Flight` (object, required)
    Flight common schema. Used across Air workflow.  
One instance for each flight in the FlightSegment. A direct flight option has one Flight object while connecting flights have a Flight object for each flight on the leg.

  - `ReservationResponse.Reservation.ShoppingCart.Product.FlightSegment.Flight.@type` (string, required)
    Discriminator. Child classes Flight and FlightDetail.
    Example: FlightDetail

  - `ReservationResponse.Reservation.ShoppingCart.Product.FlightSegment.Flight.id` (string)
    Local id within a given message to support referencing this object - an internal flight identifier.
    Example: 126

  - `ReservationResponse.Reservation.ShoppingCart.Product.FlightSegment.Flight.FlightRef` (string)
    Reference id that corresponds to the flight 'id' in ReferenceListFlight.Flight.
    Example: s1

  - `ReservationResponse.Reservation.ShoppingCart.Product.FlightSegment.Flight.distance` (integer)
    Distance covered by the flight.
    Example: 6574

  - `ReservationResponse.Reservation.ShoppingCart.Product.FlightSegment.Flight.stops` (integer)
    Number of stops
    Example: 2

  - `ReservationResponse.Reservation.ShoppingCart.Product.FlightSegment.Flight.duration` (string)
    Elapsed flight time.
Represented in hours (H) and minutes (M) OR the format PT{x}H{x}M, in which P is the duration designator, T is the time designator, {x}H is the number of hours for the connection, and {x}H is the number of minutes for the connection.
    Example: PT1H40M

  - `ReservationResponse.Reservation.ShoppingCart.Product.FlightSegment.Flight.carrier` (string, required)
    The airline code.
    Example: BA

  - `ReservationResponse.Reservation.ShoppingCart.Product.FlightSegment.Flight.number` (string, required)
    The marketing carrier flight number.
    Example: 98

  - `ReservationResponse.Reservation.ShoppingCart.Product.FlightSegment.Flight.operatingCarrier` (string)
    The operating airline IATA code. Shown in codeshare situations when the operating carrier is different to the marketing carrier.
    Example: BA

  - `ReservationResponse.Reservation.ShoppingCart.Product.FlightSegment.Flight.operatingCarrierName` (string)
    Name of the marketing operating carrier.
    Example: Liberty Aerospace

  - `ReservationResponse.Reservation.ShoppingCart.Product.FlightSegment.Flight.operatingCarrierNumber` (string)
    Operating airline flight number. If there is no operating carrier number, then CO2 emission estimates for operating carriers is not supported. GDS only; not returned for NDC. Returned only in Search response.
    Example: 091

  - `ReservationResponse.Reservation.ShoppingCart.Product.FlightSegment.Flight.equipment` (string)
    Equipment model.  
Note that TRN, TRS, and BUS equipment codes indicate ground transportation.
    Example: 777

  - `ReservationResponse.Reservation.ShoppingCart.Product.FlightSegment.Flight.Departure` (object, required)
    Departure details for a given leg.

  - `ReservationResponse.Reservation.ShoppingCart.Product.FlightSegment.Flight.Arrival` (object, required)
    Arrival information.

  - `ReservationResponse.Reservation.ShoppingCart.Product.FlightSegment.Flight.IntermediateStop` (array)
    GDS only; not supported for NDC.  
Returned if the flight has a technical stop but does not incur a change in flight number.

  - `ReservationResponse.Reservation.ShoppingCart.Product.FlightSegment.Flight.subjectToGovernmentApprovalInd` (boolean)
    GDS only, not supported for NDC.
- If true: the airline has filed in its schedule that availability for a specific flight is subject to government approval. Returned only in the Air Search API response.
    Example: true

  - `ReservationResponse.Reservation.ShoppingCart.Product.FlightSegment.IntermediateStopAmenities` (array)

  - `ReservationResponse.Reservation.ShoppingCart.Product.FlightSegment.IntermediateStopAmenities.@type` (string, required)
    Discriminator. No child classes.
    Example: IntermediateStopAmenities

  - `ReservationResponse.Reservation.ShoppingCart.Product.FlightSegment.IntermediateStopAmenities.departureLocation` (string, required)
    The departure location.
    Example: NYC

  - `ReservationResponse.Reservation.ShoppingCart.Product.FlightSegment.IntermediateStopAmenities.arrivalLocation` (string, required)
    The arrival location.
    Example: DEN

  - `ReservationResponse.Reservation.ShoppingCart.Product.FlightSegment.IntermediateStopAmenities.amenityRefs` (array)
    List of amenity references for this portion of the flight.

  - `ReservationResponse.Reservation.ShoppingCart.Product.FlightSegment.IntermediateStopAmenities.universalProductAttributeRefs` (array)
    List of UPA references for this portion of the flight.

  - `ReservationResponse.Reservation.ShoppingCart.Product.FlightSegment.OperationalStatus` (object)
    The operational status of the flight

  - `ReservationResponse.Reservation.ShoppingCart.Product.FlightSegment.OperationalStatus.value` (string)
    List of operational flight status
    Enum: "FlightBoarding", "FlightCancelled", "FlightDeparted", "FlightPastScheduledDeparture", "NotAvailableUseSearch"

  - `ReservationResponse.Reservation.ShoppingCart.Product.FlightSegment.boundFlightsInd` (boolean)
    GDS only; not supported for NDC.
Indicates flight segments are married/bound.
- If true: indicates the flight segments in a single or double connection must be sold together. The indicator is returned for all leading segments on one leg of the flight, and not returned for the last segment of the bound flight leg journey, indicating where the bound flights end.
  - For example, if an origin and destination pair has 3 flight segments, boundFlightsInd is returned for the first two segments on that leg.
- If false: the segments are not bound, boundFlightsInd is not returned.
    Example: true

  - `ReservationResponse.Reservation.ShoppingCart.Product.FlightSegment.CO2Actual` (object)
    Used for dimensional units (width, height, depth) or weight

  - `ReservationResponse.Reservation.ShoppingCart.Product.FlightSegment.CO2Actual.value` (number)
    Example: 2.22

  - `ReservationResponse.Reservation.ShoppingCart.Product.FlightSegment.CO2Actual.measurementType` (string)
    The type of measurement such as width, height, weight
    Enum: "Width", "Height", "Depth", "Weight", "OverallDimension"

  - `ReservationResponse.Reservation.ShoppingCart.Product.FlightSegment.CO2Actual.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"

  - `ReservationResponse.Reservation.ShoppingCart.Product.PassengerFlight` (array, required)
    Returns PTC and class/fare information for each PTC. One instance per PTC.

  - `ReservationResponse.Reservation.ShoppingCart.Product.PassengerFlight.@type` (string)
    Discriminator. No child classes.
    Example: PassengerFlight

  - `ReservationResponse.Reservation.ShoppingCart.Product.PassengerFlight.passengerQuantity` (integer)
    Number of passengers of the specified passenger type code.
    Example: 26

  - `ReservationResponse.Reservation.ShoppingCart.Product.PassengerFlight.passengerTypeCode` (string)
    Passenger type code applicable to the offer/offering. This may be different to the requested passenger type code sent in PassengerCriteria.
    Example: ADT

  - `ReservationResponse.Reservation.ShoppingCart.Product.PassengerFlight.requestedPassengerTypeCodes` (array)
    The requested passenger type code for this product as opposed to the priced passenger type code. Multiple passenger type codes may have been requested with the response resulting in only one passenger type code available for the offer/offering.
    Example: ["ADT","MIL"]

  - `ReservationResponse.Reservation.ShoppingCart.Product.PassengerFlight.FlightProduct` (array)

  - `ReservationResponse.Reservation.ShoppingCart.Product.PassengerFlight.FlightProduct.@type` (string)
    Discriminator. No child classes.
    Example: FlightProduct

  - `ReservationResponse.Reservation.ShoppingCart.Product.PassengerFlight.FlightProduct.segmentSequence` (array, required)
    Order of the corresponding flight in the sequence.  
Note that the segmentSequence value for connecting flights is the same; for example, for two connecting flights on the outbound or first leg of the itinerary, both flights have the segmentSequence value 1.
    Example: [1]

  - `ReservationResponse.Reservation.ShoppingCart.Product.PassengerFlight.FlightProduct.classOfService` (string)
    The class of service code.
    Example: F

  - `ReservationResponse.Reservation.ShoppingCart.Product.PassengerFlight.FlightProduct.cabin` (string)
    Specifies the cabin type.  
If sent for Flight Specific Search, this field is ignored.  
Many carriers use Business and First as the same cabin. If the request is for Business and only First is available, the response returns only First and returns a message that the cabin class may differ from the class requested.  
Some carriers do not support lowFareFinderInd with Premium First cabin class.
    Enum: "PremiumFirst", "First", "Business", "PremiumEconomy", "Economy"

  - `ReservationResponse.Reservation.ShoppingCart.Product.PassengerFlight.FlightProduct.fareBasisCode` (string)
    Fare basis code for the flight.  
For NDC, also returns the ticket designator after a slash (/) following the fare basis code.  
GDS ticket designators are returned in ticketDesignator.
    Example: YEE1Y

  - `ReservationResponse.Reservation.ShoppingCart.Product.PassengerFlight.FlightProduct.fareType` (string)
    Indicates the type of fare that applies to this Offer/Offering.  
NetFare is not supported for NDC.
    Enum: "PublicFare", "AgencyPrivateFare", "AirlinePrivateFare", "NetFare"

  - `ReservationResponse.Reservation.ShoppingCart.Product.PassengerFlight.FlightProduct.carCode` (string)
    GDS only; not supported for NDC.  
The car code or deal code. Net remit. May be a Commercial Airline Agreement number.  
AirPrice and Reservation Retrieve return the net ticket data (NTD) if a fare returned has a private fare component and private fares were requested (fareType of AgencyPrivateFare).
    Example: P1234

  - `ReservationResponse.Reservation.ShoppingCart.Product.PassengerFlight.FlightProduct.valueCode` (string)
    The value code for the fare. Net remit.  
AirPrice returns the net ticket data (NTD) if a fare returned has a private fare component and private fares were requested (fareType of AgencyPrivateFare). GDS only; not supported for NDC.
    Example: 365

  - `ReservationResponse.Reservation.ShoppingCart.Product.PassengerFlight.FlightProduct.Brand` (object)
    Brand ID parent class, returned for branded fares.

  - `ReservationResponse.Reservation.ShoppingCart.Product.PassengerFlight.FlightProduct.CustomerLoyaltyCredit` (array)

  - `ReservationResponse.Reservation.ShoppingCart.Product.PassengerFlight.FlightProduct.ClassOfServiceAvailability` (array)

  - `ReservationResponse.Reservation.ShoppingCart.Product.PassengerFlight.FlightProduct.FareQualifier` (object)
    deprecated - do not use

  - `ReservationResponse.Reservation.ShoppingCart.Product.PassengerFlight.FlightProduct.ticketDesignator` (string)
    GDS only; not supported for NDC. (NDC ticket designators are returned in fareBasisCode after a slash (/), following the fare basis code.)  
Returns the ticket designator for GDS. The ticket designator is a code used by airlines to indicate the type of discount applied to a fare. An airline may have a specific ticket designator used to differentiate its fares, which may also signify anything from private fares, wholesale, promotion, or discounted fares.
    Example: BB5662Y

  - `ReservationResponse.Reservation.ShoppingCart.Product.PassengerFlight.FlightProduct.fareTypeCode` (string)
    GDS only; not supported for NDC.  
Identifies whether the fare is bundled or unbundled by providing the ATPCO defined fare type code when the coresponding response includes unbundled fares.
    Example: ERU

  - `ReservationResponse.Reservation.ShoppingCart.Product.PassengerFlight.FlightProduct.FareQualifierString` (string)
    NDC only. Not supported for GDS. Fare qualifier of a private leisure fares.
    Example: ["Tour"]

  - `ReservationResponse.Reservation.ReservationDisplaySequence` (object)
    Returned to provide the chronological (by date) order of all offers on the booking.
If a booking includes car and/or hotel segments along with air segments, includes those offers. Returned for all reservations even if hotel/car content is not on the booking. See [Multi-Content Booking Guide (Air, Hotel, Car)](https://developer.travelport.com/docs/flights/guides/booking-and-reservations/multi-content-booking-guide) for more details.

  - `ReservationResponse.Reservation.ReservationDisplaySequence.@type` (string, required)
    Discriminator class ReservationDisplaySequence only
    Example: ReservationDisplaySequence

  - `ReservationResponse.Reservation.ReservationDisplaySequence.DisplaySequence` (array)
    One instance for each air, hotel, or car offer on the booking.

  - `ReservationResponse.Reservation.ReservationDisplaySequence.DisplaySequence.@type` (string, required)
    Discriminator
    Example: DisplaySequence

  - `ReservationResponse.Reservation.ReservationDisplaySequence.DisplaySequence.displaySequence` (integer, required)
    The segment number in the system. A value of 1 indicates this offer occurs first in the itinerary, 2 second, etc.
    Example: 1

  - `ReservationResponse.Reservation.ReservationDisplaySequence.DisplaySequence.OfferRef` (string, required)
    System-generated offer id for that offer; corresponds to the value in Offer/id.

  - `ReservationResponse.Reservation.ReservationDisplaySequence.DisplaySequence.ProductRef` (string)
    System-generated product id that product; corresponds to the value in Offer/Product/id.  
Each hotel and car segment is returned as a single product.  
For air, each leg of the air itinerary is a single product. For example, a round-trip flight booking has two instances of DisplaySequence, each with a separate ProductRef value.  
If blank, display sequence applies to all products within the Offer.

  - `ReservationResponse.Reservation.ReservationDisplaySequence.DisplaySequence.Sequence` (integer)
    Returned for air segments; the flight sequence number in the itinerary.  
If blank, display sequence applies to all segments within the product.
    Example: 1

  - `ReservationResponse.Reservation.ReservationDisplaySequence.autoDeleteDateSequence` (integer)
    The sequence of the autoDeleteDate (retention segment) within the Reservation

  - `ReservationResponse.Reservation.ReservationDisplaySequence.AuxiliaryDisplaySequence` (array)
    Returned if a booking includes auxiliary segments. One instance for each tour or surface segment on the booking.

  - `ReservationResponse.Reservation.ReservationDisplaySequence.AuxiliaryDisplaySequence.@type` (string, required)
    Discriminator class AuxillaryDisplaySequence only
    Example: AuxiliaryDisplaySequence

  - `ReservationResponse.Reservation.ReservationDisplaySequence.AuxiliaryDisplaySequence.displaySequence` (integer, required)
    The segment number in the system. A value of 1 indicates this offer occurs first in the itinerary, 2 second, etc.
    Example: 3

  - `ReservationResponse.Reservation.ReservationDisplaySequence.AuxiliaryDisplaySequence.CustomAuxiliarySegmentRef` (string)
    System-generated id for this auxiliary segment; corresponds to the value in CustomAuxiliarySegment/id.
    Example: aux_1

  - `ReservationResponse.Reservation.ReservationDisplaySequence.UnpricedSegmentDisplaySequence` (array)
    Returned if a booking has unpriced segments (GDS only) to indicate the sequence of that content in the air itinerary.

  - `ReservationResponse.Reservation.ReservationDisplaySequence.UnpricedSegmentDisplaySequence.@type` (string, required)
    Discriminator class UnpricedSegmentDisplaySequence only
    Example: UnpricedSegmentDisplaySequence

  - `ReservationResponse.Reservation.ReservationDisplaySequence.UnpricedSegmentDisplaySequence.displaySequence` (integer, required)
    The segment number in the system. A value of 1 indicates this offer occurs first in the itinerary, 2 second, etc.
    Example: 2

  - `ReservationResponse.Reservation.ReservationDisplaySequence.UnpricedSegmentDisplaySequence.UnpricedFlightSegmentRef` (string, required)
    System-generated id for this unpriced segment; corresponds to the value in UnpricedFlightSegment/id.
    Example: s1

  - `ReservationResponse.Reservation.AgencyServiceFee` (array)

  - `ReservationResponse.Reservation.AgencyServiceFee.@type` (string, required)
    Discriminator classes AgencyServiceFeeID or AgencyServiceFee
    Example: AgencyServiceFee

  - `ReservationResponse.Reservation.AgencyServiceFee.id` (string)
    Unique id for this object within a message
    Example: AgencyServiceFee_1

  - `ReservationResponse.Reservation.AgencyServiceFee.ExpiryDate` (string)
    The service fee expiry date. Once expiry date has been reached, the service fee information will only be stored in the ReservationReceipt
    Example: 2022-08-07T12:12:00Z

  - `ReservationResponse.Reservation.AgencyServiceFee.Description` (string)
    The description of the service fee
    Example: Flight reservation service fee

  - `ReservationResponse.Reservation.AgencyServiceFee.Tax` (array)

  - `ReservationResponse.Reservation.AgencyServiceFee.TravelerRef` (string)
    Reference to a Traveler within the Reservation that this service fee applies to

  - `ReservationResponse.Reservation.AgencyServiceFee.OfferRef` (string)
    Reference to an Offer within the Reservation that this service fee applies to

  - `ReservationResponse.Reservation.autoDeleteDate` (string)
    The auto delete date represents the date that the Reservation will be kept active. Also known as retention segment or retention date.

  - `ReservationResponse.Reservation.notificationDate` (string)
    The notification date represents the date that the Reservation should be reviewed. Also known as ticket time limit date.

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

  - `ReservationResponse.Reservation.CustomAuxiliarySegment.@type` (string, required)
    Discriminator classes CustomAuxiliarySegmentID or CustomAuxiliarySegment
    Example: CustomAuxiliarySegment

  - `ReservationResponse.Reservation.CustomAuxiliarySegment.id` (string)
    Custom Auxiliary segment reference ID.
    Example: aux_001

  - `ReservationResponse.Reservation.CustomAuxiliarySegment.customAuxiliarySegmentRef` (string)

  - `ReservationResponse.Reservation.CustomAuxiliarySegment.SegmentType` (string, required)
    The auxiliary segment type; either TUR for tour or SUR for surface.
    Example: TUR

  - `ReservationResponse.Reservation.CustomAuxiliarySegment.SupplierCode` (string, required)
    Two-character provider/vendor code. May be returned as ZZ, the generic vendor code for a service provider in the Travelport system.
    Example: YY

  - `ReservationResponse.Reservation.CustomAuxiliarySegment.StatusCode` (string, required)
    Status code for booking.
    Example: BK

  - `ReservationResponse.Reservation.CustomAuxiliarySegment.Quantity` (integer, required)
    The quantity of services provided for this auxiliary segment.
    Example: 1

  - `ReservationResponse.Reservation.CustomAuxiliarySegment.Location` (string, required)
    Three character IATA location code relevant to the auxiliary segment.
    Example: LON

  - `ReservationResponse.Reservation.CustomAuxiliarySegment.Date` (string, required)
    The local start date relevant to the auxiliary segment.

  - `ReservationResponse.Reservation.CustomAuxiliarySegment.CustomTextQualifier` (string)
    Text qualifier such as DO for drop off.
    Example: DO

  - `ReservationResponse.Reservation.CustomAuxiliarySegment.CustomText` (string)
    Custom text relevant to this auxiliary segment.

  - `ReservationResponse.Reservation.Group` (object)

  - `ReservationResponse.Reservation.Group.@type` (string, required)
    Discriminator.
    Example: Group

  - `ReservationResponse.Reservation.Group.id` (string)
    Example: group_001

  - `ReservationResponse.Reservation.Group.GroupRef` (string)
    Example: groupRef_001

  - `ReservationResponse.Reservation.Group.unallocatedPlaces` (integer, required)
    The amount of unallocated places available which is the difference between the group size and the number of Travelers associated
    Example: 5

  - `ReservationResponse.Reservation.Group.totalGroupPlaces` (integer, required)
    The total number of passenger places available for this group booking
    Example: 15

  - `ReservationResponse.Reservation.Group.GroupName` (string, required)
    Example: EUROPAGLOBALCONFERENCE

  - `ReservationResponse.Reservation.UnpricedSegments` (object)
    Returned if a booking has unpriced segments (GDS only).
When unpriced segments are in the request, these objects also return unpriced segment information:
- TravelerProduct returns UnpricedFlightSegmentRefs to list unpriced segment/s for that traveler.
- Receipt/Confirmation returns UnpricedSegmentsStatus with the status of the air segment.
- ReservationDisplaySequence returns UnpricedSegmentDisplaySequence to indicate the sequence of the unpriced segment.

  - `ReservationResponse.Reservation.UnpricedSegments.@type` (string, required)
    Discriminator. No child classes.
    Example: UnpricedSegments

  - `ReservationResponse.Reservation.UnpricedSegments.UnpricedFlightSegment` (array, required)

  - `ReservationResponse.Reservation.UnpricedSegments.UnpricedFlightSegment.@type` (string, required)
    Example: UnpricedFlightSegment

  - `ReservationResponse.Reservation.UnpricedSegments.UnpricedFlightSegment.id` (string)
    Local identifier within a given message for this FlightSegment
    Example: unpricedSegment_1

  - `ReservationResponse.Reservation.UnpricedSegments.UnpricedFlightSegment.sequence` (integer, required)
    Sequence of the leg of the segment.
    Example: 1

  - `ReservationResponse.Reservation.UnpricedSegments.UnpricedFlightSegment.connectionDuration` (string)
    The actual duration of the connecting FlightSegment
    Example: PT2H30M

  - `ReservationResponse.Reservation.UnpricedSegments.UnpricedFlightSegment.passengerQuantity` (integer)
    Number of passengers on this segment.
    Example: 2

  - `ReservationResponse.Reservation.UnpricedSegments.UnpricedFlightSegment.classOfService` (string)
    Class of service of the segment.
    Example: Y

  - `ReservationResponse.Reservation.UnpricedSegments.UnpricedFlightSegment.amenityRefs` (array)
    List of amenity references for this flight
    Example: ["amenity_1","amenity_2"]

  - `ReservationResponse.Reservation.UnpricedSegments.UnpricedFlightSegment.universalProductAttributeRefs` (array)
    List of universal product attributes for this flight.
    Example: ["upa_1","upa_2"]

  - `ReservationResponse.Reservation.UnpricedSegments.UnpricedFlightSegment.passiveSegmentStatus` (string)
    Required for unpriced segment.
If the segment is to be sold as passive enter the passive segment status:
- AK supplier message sent upon cancel only
- BK supplier message sent on book and cancel
- YK Information only, no supplier message sent, segment cannot be priced or ticketed.

For Unpriced segments:
- AK (passive segment confirmed outside the GDS)
- BK (passive segment booked with carrier) segment statuses
- YK (Hold confirmed airline space)

Refer to Unpriced Segments in the [Unified Checkout Guide](https://developer.travelport.com/docs/flights/guides/booking-and-reservations/flights-unified-checkout-guide#unpriced-segments).
    Example: AK

  - `ReservationResponse.Reservation.UnpricedSegments.UnpricedFlightSegment.IntermediateStopAmenities` (array)

  - `ReservationResponse.Reservation.UnpricedSegments.UnpricedFlightSegment.Co2Actual` (object)
    The actual CO2 emissions of this flight. Measured in kilograms.

  - `ReservationResponse.Reservation.UnpricedSegments.UnpricedFlightSegment.boundFlightInd` (boolean)
    If present and true, the Segments in this Connection are married.
    Example: true

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

  - `ReservationResponse.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

  - `ReservationResponse.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

  - `ReservationResponse.correlationId` (string)
    Identifier used to correlate hotel API invocations across a multi-call business flows.
    Example: 49f58f5f-c443-43b4-9f5d-be405fd00a01

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

  - `ReservationResponse.Result` (object)
    Returns the error and/or warning message information, if applicable.
See [Error Messaging](https://developer.travelport.com/docs/flights/general/error-messaging) for additional details.

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

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

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

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

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

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

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

  - `ReservationResponse.Result.Error.category` (string)
    A category to assist in identifying the error
    Example: VALIDATION

  - `ReservationResponse.Result.Error.SourceID` (string)
    The identifier of the source system sending the error or warning
    Example: 1G

  - `ReservationResponse.Result.Error.SourceCode` (string)
    The error or warning code returned by the source airline or host system
    Example: 1234

  - `ReservationResponse.Result.Error.SourceDescription` (string)
    The error or warning message as it is returned by the source airline or host system

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

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

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

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

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

  - `ReservationResponse.Result.Warning.category` (string)
    A category to assist in identifying the error
    Example: INFORMATION

  - `ReservationResponse.Result.Warning.SourceID` (string)
    The identifier of the source system sending the error or warning
    Example: 1G

  - `ReservationResponse.Result.Warning.SourceCode` (string)
    The error or warning code returned by the source airline or host system
    Example: 1234

  - `ReservationResponse.Result.Warning.SourceDescription` (string)
    The error or warning message as it is returned by the source airline or host system

  - `ReservationResponse.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.

  - `ReservationResponse.NextSteps.baseURI` (string, required)
    The base portion of the URI in order to shorten the uris in the individual steps
    Example: www.travelport.com

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

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

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

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

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

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

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

  - `ReservationResponse.ReferenceList` (array)

  - `ReservationResponse.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

  - `ReservationResponse.ReferenceList.id` (string)
    Uniquely identifies for the Reference List
    Example: referenceList_001

  - `ReservationResponse.ReferenceList.PropertyDates` (array, required)

  - `ReservationResponse.ReferenceList.PropertyDates.@type` (string)

  - `ReservationResponse.ReferenceList.PropertyDates.availability` (string)
    Indicates whether the property has rooms available for the requested dates.
    Enum: "Open", "Close", "ClosedOnArrival", "ClosedOnArrivalOnRequest", "OnRequest", "RemoveCloseOnly", "Other"

  - `ReservationResponse.ReferenceList.PropertyDates.id` (string, required)
    Key to matching the common information in ReferenceList with an Offer; corresponds to the propertyDatesRef value in each Offer/Products/Product.

  - `ReservationResponse.ReferenceList.PropertyDates.moreRatesToken` (string)
    More rates token

  - `ReservationResponse.ReferenceList.PropertyDates.propertyName` (string)
    Name of property offering these products.

  - `ReservationResponse.ReferenceList.PropertyDates.PropertyKey` (object, required)
    Contains up to 250 PropertyKey objects. Each PropertyKey object identifies one property.

  - `ReservationResponse.ReferenceList.PropertyDates.PropertyKey.@type` (string)

  - `ReservationResponse.ReferenceList.PropertyDates.PropertyKey.chainCode` (string, required)
    Code for the hotel chain (typically 2 characters)
    Example: UR

  - `ReservationResponse.ReferenceList.PropertyDates.PropertyKey.propertyCode` (string, required)
    The property code of the requested property (typically 5 characters).
    Example: G3375

  - `ReservationResponse.ReferenceList.PropertyDates.DateRange` (object, required)
    Specifies the begin and end date of an event, such as check-in and check-out dates.

  - `ReservationResponse.ReferenceList.PropertyDates.DateRange.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

  - `ReservationResponse.ReferenceList.PropertyDates.DateRange.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

  - `ReservationResponse.ReferenceList.PropertyDates.GeoLocation` (object)
    For Hotel: the geographic coordinates of the property.

  - `ReservationResponse.ReferenceList.PropertyDates.GeoLocation.latitude` (number, required)
    Numeric value representing latitude of search center point in degrees and decimal minutes.
    Example: 38.8951

  - `ReservationResponse.ReferenceList.PropertyDates.GeoLocation.longitude` (number, required)
    Numeric value representing longitude of search center point in degrees and decimal minutes.
    Example: -77.0364

  - `ReservationResponse.ReferenceList.PropertyDates.GeoLocation.altitude` (number)
    The height of a location, typically measured above sea level
    Example: 5280

  - `ReservationResponse.ReferenceList.PropertyDates.GeoLocation.altitudeUnitOfDistance` (string)
    For Hotels: Optional object to request either miles or kilometers for the search radius from the specified location. If unitOfDistance is not specified, the search defaults to miles for properties in the United States, Myanmar, and Liberia. The search defaults to kilometers in all other countries.
    Enum: "Miles", "Kilometers"

  - `ReservationResponse.ReferenceList.PropertyDates.GeoLocation.positionAccuracy` (string)
    Specifies the level of accuracy for the position
    Enum: "Zip9Code", "Zip7Code", "Zip5Code", "Street", "State", "Property", "Intersection", "Exact", "County", "City", "Block"

  - `ReservationResponse.ReferenceList.PropertyDates.GeoLocation.mapURL` (string)
    link for embedded map showing location
    Example: www.destinationmap.com

  - `ReservationResponse.ReferenceList.PropertyDates.GeoLocation.formatURL` (string)
    The URL to the format for the latitude and longitude for this location.
    Example: www.destinationmap.com

  - `ReservationResponse.CurrencyRateConversion` (array)

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

  - `ReservationResponse.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.

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

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

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

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

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

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

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

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

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

## Response 400:

  - `400` (unknown)
    Bad Request - 400

## Response 400 fields (application/json):

  - `@type` (string)
    Example: response

  - `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

  - `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

  - `correlationId` (string)
    Identifier used to correlate hotel API invocations across a multi-call business flows.
    Example: 49f58f5f-c443-43b4-9f5d-be405fd00a01

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

  - `Result` (object)
    Returns the error and/or warning message information, if applicable.
See [Error Messaging](https://developer.travelport.com/docs/flights/general/error-messaging) for additional details.

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

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

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

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

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

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

  - `Result.Error.NameValuePair` (array)

  - `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

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

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

  - `Result.Error.category` (string)
    A category to assist in identifying the error
    Example: VALIDATION

  - `Result.Error.SourceID` (string)
    The identifier of the source system sending the error or warning
    Example: 1G

  - `Result.Error.SourceCode` (string)
    The error or warning code returned by the source airline or host system
    Example: 1234

  - `Result.Error.SourceDescription` (string)
    The error or warning message as it is returned by the source airline or host system

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

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

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

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

  - `Result.Warning.NameValuePair` (array)

  - `Result.Warning.category` (string)
    A category to assist in identifying the error
    Example: INFORMATION

  - `Result.Warning.SourceID` (string)
    The identifier of the source system sending the error or warning
    Example: 1G

  - `Result.Warning.SourceCode` (string)
    The error or warning code returned by the source airline or host system
    Example: 1234

  - `Result.Warning.SourceDescription` (string)
    The error or warning message as it is returned by the source airline or host system

  - `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).

  - `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 system generated 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'.
- If not available, for Payment, any unique identifier can be sent.

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

  - `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

  - `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.

  - `NextSteps.baseURI` (string, required)
    The base portion of the URI in order to shorten the uris in the individual steps
    Example: www.travelport.com

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

  - `NextSteps.NextStep` (array, required)

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

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

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

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

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

  - `ReferenceList` (array)

  - `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

  - `ReferenceList.id` (string)
    Uniquely identifies for the Reference List
    Example: referenceList_001

  - `ReferenceList.PropertyDates` (array, required)

  - `ReferenceList.PropertyDates.@type` (string)

  - `ReferenceList.PropertyDates.availability` (string)
    Indicates whether the property has rooms available for the requested dates.
    Enum: "Open", "Close", "ClosedOnArrival", "ClosedOnArrivalOnRequest", "OnRequest", "RemoveCloseOnly", "Other"

  - `ReferenceList.PropertyDates.adaCompliant` (string)
    Yes , No , Unknown
    Enum: "Yes", "No", "Unknown"

  - `ReferenceList.PropertyDates.id` (string, required)
    Key to matching the common information in ReferenceList with an Offer; corresponds to the propertyDatesRef value in each Offer/Products/Product.

  - `ReferenceList.PropertyDates.moreRatesToken` (string)
    More rates token

  - `ReferenceList.PropertyDates.propertyName` (string)
    Name of property offering these products.

  - `ReferenceList.PropertyDates.PropertyAddress` (object)
    The property or billing address information.  
For Flights Add Traveler sending Address is optional, but when sent it must have the role set to 'Delivery' and include at least one of its objects, such as Number or City.

  - `ReferenceList.PropertyDates.PropertyAddress.@type` (string, required)
    Discriminator classes Address or AddressDetail
    Example: AddressDetail

  - `ReferenceList.PropertyDates.PropertyAddress.id` (string)
    unique address id
    Example: Address_1

  - `ReferenceList.PropertyDates.PropertyAddress.BldgRoom` (object)
    Address with building and room number

  - `ReferenceList.PropertyDates.PropertyAddress.BldgRoom.value` (string)
    Example: Moore House

  - `ReferenceList.PropertyDates.PropertyAddress.BldgRoom.buldingInd` (boolean)
    When true, the information is a building name. When false, it is an apartment or room #
    Example: true

  - `ReferenceList.PropertyDates.PropertyAddress.Number` (object)
    The street number alone is the numerical number that precedes the street name in the address.

  - `ReferenceList.PropertyDates.PropertyAddress.Number.value` (string)
    Street number value.
    Example: 23B

  - `ReferenceList.PropertyDates.PropertyAddress.Number.streetNmbrSuffix` (string)
    Street Number Suffix
    Example: B

  - `ReferenceList.PropertyDates.PropertyAddress.Number.streetDirection` (string)
    Direction of the Street
    Example: NW

  - `ReferenceList.PropertyDates.PropertyAddress.Number.ruralRouteNmbr` (string)
    RuralRoute Number
    Example: 76

  - `ReferenceList.PropertyDates.PropertyAddress.Number.po_Box` (string)
    PO Box Number
    Example: 1001

  - `ReferenceList.PropertyDates.PropertyAddress.Street` (string)
    Street name. May also contain the street number when the Number element is missing.
    Example: ABC Street

  - `ReferenceList.PropertyDates.PropertyAddress.AddressLine` (array)
    Property street address. Used in place of Street and Number. Each element of the array represents an address line.

  - `ReferenceList.PropertyDates.PropertyAddress.City` (string, required)
    Full name of the city, town, or postal station (i.e., a postal service territory, often used in a military address).
    Example: Dublin

  - `ReferenceList.PropertyDates.PropertyAddress.County` (string)
    County or Region Name.
    Example: Berkshire

  - `ReferenceList.PropertyDates.PropertyAddress.StateProv` (object)
    The standard code or abbreviation for the state, province, or region. May also include full length name.

  - `ReferenceList.PropertyDates.PropertyAddress.StateProv.value` (string)
    State, province, or region code needed to identify location (typically two characters).
    Example: CA

  - `ReferenceList.PropertyDates.PropertyAddress.StateProv.name` (string)
    State, province, or region name needed to identify location.
    Example: California

  - `ReferenceList.PropertyDates.PropertyAddress.Country` (object)
    Contains the information needed to identify a country.

  - `ReferenceList.PropertyDates.PropertyAddress.Country.value` (string)
    The ISO 3166 code for the property's address.
    Example: US

  - `ReferenceList.PropertyDates.PropertyAddress.Country.id` (string)
    Custom user-assigned identifier for the country.
    Example: 23

  - `ReferenceList.PropertyDates.PropertyAddress.Country.name` (string)
    The full name of the country for the property's address.
    Example: United States

  - `ReferenceList.PropertyDates.PropertyAddress.Country.codeContext` (string)
    The source of a code, such as the organization that provided the id number
    Example: IATA

  - `ReferenceList.PropertyDates.PropertyAddress.PostalCode` (string)
    Postal code for the address.
    Example: Sl6 1AB

  - `ReferenceList.PropertyDates.PropertyAddress.Addressee` (string)
    The name of the company or person to be addressed
    Example: ACME INC

  - `ReferenceList.PropertyDates.PropertyAddress.role` (string)
    Defines the type of location the address is assigned to. For TravelAgency address leave blank or use "Other".
    Enum: "Home", "Business", "Mailing", "Delivery", "Destination", "Other", "Billing"

  - `ReferenceList.PropertyDates.PropertyAddress.addressType` (string)
    OTA code for address type
    Example: CLT

  - `ReferenceList.PropertyDates.PropertyAddress.use` (string)
    OTA code for address use
    Example: AUT

  - `ReferenceList.PropertyDates.PropertyAddress.Comment` (object)
    Textual information.

  - `ReferenceList.PropertyDates.PropertyAddress.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

  - `ReferenceList.PropertyDates.PropertyAddress.Comment.id` (string)
    Local identifier within a given message for this object.
    Example: comment_1

  - `ReferenceList.PropertyDates.PropertyAddress.Comment.name` (string)
    Title of comment or type of remark.
    Example: Comment name

  - `ReferenceList.PropertyDates.PropertyAddress.Comment.language` (string)
    Language code using ISO-639 standard
    Example: EN

  - `ReferenceList.PropertyDates.PropertyAddress.Privacy` (object)
    Confidential details for marketing purpose

  - `ReferenceList.PropertyDates.PropertyAddress.Privacy.id` (string)
    Optional internally referenced id
    Example: 2

  - `ReferenceList.PropertyDates.PropertyAddress.Privacy.shareMarketing` (string)
    Used to indicate marketing preferences, Yes, No, Inherit
    Enum: "Yes", "No", "Inherit"

  - `ReferenceList.PropertyDates.PropertyAddress.Privacy.optInStatus` (string)
    Used to indicate marketing preferences, OptIn, OptOut
    Enum: "OptedIn", "OptedOut", "Unknown"

  - `ReferenceList.PropertyDates.PropertyAddress.Privacy.optInDate` (string)
    The datetime of receiving the opt in notice
    Example: 2026-08-07T12:12:00Z

  - `ReferenceList.PropertyDates.PropertyAddress.Privacy.optOutDate` (string)
    The datetime the opt out notice was received
    Example: 2026-08-07T12:12:00Z

  - `ReferenceList.PropertyDates.PropertyAddress.Priority` (integer)
    The priority ranking within the group
    Example: 1

  - `ReferenceList.PropertyDates.PropertyAddress.validInd` (boolean)
    If true, this is a valid and complete mailing address that has been verified through an address verification service or previously mailed materials have not been returned.
    Example: false

  - `ReferenceList.PropertyDates.PropertyAddress.provisionedInd` (boolean)
    If true, this address came into the system through provisioning
    Example: false

  - `ReferenceList.PropertyDates.PropertyKey` (object, required)
    Contains up to 250 PropertyKey objects. Each PropertyKey object identifies one property.

  - `ReferenceList.PropertyDates.PropertyKey.@type` (string)

  - `ReferenceList.PropertyDates.PropertyKey.chainCode` (string, required)
    Code for the hotel chain (typically 2 characters)
    Example: UR

  - `ReferenceList.PropertyDates.PropertyKey.propertyCode` (string, required)
    The property code of the requested property (typically 5 characters).
    Example: G3375

  - `ReferenceList.PropertyDates.DateRange` (object, required)
    Specifies the begin and end date of an event, such as check-in and check-out dates.

  - `ReferenceList.PropertyDates.DateRange.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

  - `ReferenceList.PropertyDates.DateRange.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

  - `ReferenceList.PropertyDates.GeoLocation` (object)
    For Hotel: the geographic coordinates of the property.

  - `ReferenceList.PropertyDates.GeoLocation.latitude` (number, required)
    Numeric value representing latitude of search center point in degrees and decimal minutes.
    Example: 38.8951

  - `ReferenceList.PropertyDates.GeoLocation.longitude` (number, required)
    Numeric value representing longitude of search center point in degrees and decimal minutes.
    Example: -77.0364

  - `ReferenceList.PropertyDates.GeoLocation.altitude` (number)
    The height of a location, typically measured above sea level
    Example: 5280

  - `ReferenceList.PropertyDates.GeoLocation.altitudeUnitOfDistance` (string)
    For Hotels: Optional object to request either miles or kilometers for the search radius from the specified location. If unitOfDistance is not specified, the search defaults to miles for properties in the United States, Myanmar, and Liberia. The search defaults to kilometers in all other countries.
    Enum: "Miles", "Kilometers"

  - `ReferenceList.PropertyDates.GeoLocation.positionAccuracy` (string)
    Specifies the level of accuracy for the position
    Enum: "Zip9Code", "Zip7Code", "Zip5Code", "Street", "State", "Property", "Intersection", "Exact", "County", "City", "Block"

  - `ReferenceList.PropertyDates.GeoLocation.mapURL` (string)
    link for embedded map showing location
    Example: www.destinationmap.com

  - `ReferenceList.PropertyDates.GeoLocation.formatURL` (string)
    The URL to the format for the latitude and longitude for this location.
    Example: www.destinationmap.com

  - `ReferenceList.PropertyDates.Telephone` (object)
    Phone information for contacting the relevant individual or agency.  
For Flights Add Traveler, NDC carriers typically require either an email address or phone number for booking. Recommended best practice is to provide both Email and Telephone for NDC.

  - `ReferenceList.PropertyDates.Telephone.@type` (string, required)
    Discriminator classes Telephone or TelephoneDetail
    Example: Telephone

  - `ReferenceList.PropertyDates.Telephone.countryAccessCode` (string)
    Phone country code
    Example: 1

  - `ReferenceList.PropertyDates.Telephone.areaCityCode` (string)
    Phone local area code
    Example: 972

  - `ReferenceList.PropertyDates.Telephone.phoneNumber` (string, required)
    Mobile/Telephone Number. Accepted characters are numeric, dash, space, and period.
    Example: 972-000-787

  - `ReferenceList.PropertyDates.Telephone.extension` (string)
    Telephone extension number
    Example: 234

  - `ReferenceList.PropertyDates.Telephone.id` (string)
    Optional custom user-assigned identifier for a phone number.
    Example: 3

  - `ReferenceList.PropertyDates.Telephone.cityCode` (string)
    IATA city code if referenced by phone number.
    Example: DEN

  - `ReferenceList.PropertyDates.Telephone.role` (string)
    Defines the type of location the Telephone is assigned to. For Travel Agency telephone select "Other" or leave blank.
    Enum: "Mobile", "Home", "Work", "Office", "Fax", "Other"

  - `ReferenceList.PropertyDates.Telephone.phoneLocationType` (string)
    Location of the phone
    Example: Agency

  - `ReferenceList.PropertyDates.Telephone.phoneTechType` (string)
    Indicates the type of technology associated with the telephone number
    Example: Voice

  - `ReferenceList.PropertyDates.Telephone.phoneUseType` (string)
    Agency code for how phone is used (e.g., Home, Business, Emergency Contact, Travel Arranger, Day, Evening).
    Example: Home

  - `ReferenceList.PropertyDates.Telephone.pin` (string)
    Additional codes used for telephone
    Example: 3456

  - `ReferenceList.PropertyDates.Telephone.priority` (integer)
    Priority
    Example: 1

  - `ReferenceList.PropertyDates.Telephone.defaultInd` (boolean)
    When true, indicates a default value should be used.
    Example: true

  - `ReferenceList.PropertyDates.Telephone.provisionedInd` (boolean)
    true indicates this phone number was created through provisioned
    Example: false

  - `ReferenceList.PropertyDates.Email` (object)
    Electronic email addresses, in IETF specified format.  
Booking.com requires a traveler email address in the Hotel Create Reservation and Add Reservation requests. A system-generated confirmation email is sent to the traveler after the booking completes.
For Flights Add Traveler, NDC carriers typically require either an email address or phone number for booking. Recommended best practice is to provide both Email and Telephone for NDC.

  - `ReferenceList.PropertyDates.Email.value` (string)
    The email address.
    Example: exampledomain@example.com

  - `ReferenceList.PropertyDates.Email.id` (string)
    Electronic email addresses, in IETF specified format.
    Example: email_1

  - `ReferenceList.PropertyDates.Email.emailType` (string)
    Use email type to specify if the email is to be sent "TO" or sent "FROM"
    Example: FROM

  - `ReferenceList.PropertyDates.Email.comment` (string)
    Any freeform note for the email, such as its purpose.
    Example: work email

  - `ReferenceList.PropertyDates.Email.preferredFormat` (string)
    Mime media type
    Example: text/html

  - `ReferenceList.PropertyDates.Email.optInDate` (string)
    The datetime of receiving the opt in notice
    Example: 2026-03-03T11:11:00Z

  - `ReferenceList.PropertyDates.Email.optOutDate` (string)
    The datetime the opt out notice was received
    Example: 2026-03-03T11:11:00Z

  - `ReferenceList.PropertyDates.Email.validInd` (boolean)
    If true, this is a valid email address that has been system verified via a successful email transmission.
    Example: true

  - `ReferenceList.PropertyDates.Email.provisionedInd` (boolean)
    If true then the email address came from the provisioning process
    Example: true

  - `CurrencyRateConversion` (array)

  - `CurrencyRateConversion.@type` (string)

  - `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.

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

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

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

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

  - `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.

  - `CurrencyRateConversion.ConversionRate.value` (number)

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

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

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

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

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

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

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

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

## Response 401:

  - `401` (unknown)
    Unauthorized - 401

## Response 401 fields (application/json):

  - `@type` (string)
    Example: response

  - `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

  - `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

  - `correlationId` (string)
    Identifier used to correlate hotel API invocations across a multi-call business flows.
    Example: 49f58f5f-c443-43b4-9f5d-be405fd00a01

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

  - `Result` (object)
    Returns the error and/or warning message information, if applicable.
See [Error Messaging](https://developer.travelport.com/docs/flights/general/error-messaging) for additional details.

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

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

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

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

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

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

  - `Result.Error.NameValuePair` (array)

  - `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

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

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

  - `Result.Error.category` (string)
    A category to assist in identifying the error
    Example: VALIDATION

  - `Result.Error.SourceID` (string)
    The identifier of the source system sending the error or warning
    Example: 1G

  - `Result.Error.SourceCode` (string)
    The error or warning code returned by the source airline or host system
    Example: 1234

  - `Result.Error.SourceDescription` (string)
    The error or warning message as it is returned by the source airline or host system

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

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

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

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

  - `Result.Warning.NameValuePair` (array)

  - `Result.Warning.category` (string)
    A category to assist in identifying the error
    Example: INFORMATION

  - `Result.Warning.SourceID` (string)
    The identifier of the source system sending the error or warning
    Example: 1G

  - `Result.Warning.SourceCode` (string)
    The error or warning code returned by the source airline or host system
    Example: 1234

  - `Result.Warning.SourceDescription` (string)
    The error or warning message as it is returned by the source airline or host system

  - `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).

  - `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 system generated 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'.
- If not available, for Payment, any unique identifier can be sent.

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

  - `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

  - `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.

  - `NextSteps.baseURI` (string, required)
    The base portion of the URI in order to shorten the uris in the individual steps
    Example: www.travelport.com

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

  - `NextSteps.NextStep` (array, required)

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

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

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

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

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

  - `ReferenceList` (array)

  - `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

  - `ReferenceList.id` (string)
    Uniquely identifies for the Reference List
    Example: referenceList_001

  - `ReferenceList.PropertyDates` (array, required)

  - `ReferenceList.PropertyDates.@type` (string)

  - `ReferenceList.PropertyDates.availability` (string)
    Indicates whether the property has rooms available for the requested dates.
    Enum: "Open", "Close", "ClosedOnArrival", "ClosedOnArrivalOnRequest", "OnRequest", "RemoveCloseOnly", "Other"

  - `ReferenceList.PropertyDates.adaCompliant` (string)
    Yes , No , Unknown
    Enum: "Yes", "No", "Unknown"

  - `ReferenceList.PropertyDates.id` (string, required)
    Key to matching the common information in ReferenceList with an Offer; corresponds to the propertyDatesRef value in each Offer/Products/Product.

  - `ReferenceList.PropertyDates.moreRatesToken` (string)
    More rates token

  - `ReferenceList.PropertyDates.propertyName` (string)
    Name of property offering these products.

  - `ReferenceList.PropertyDates.PropertyAddress` (object)
    The property or billing address information.  
For Flights Add Traveler sending Address is optional, but when sent it must have the role set to 'Delivery' and include at least one of its objects, such as Number or City.

  - `ReferenceList.PropertyDates.PropertyAddress.@type` (string, required)
    Discriminator classes Address or AddressDetail
    Example: AddressDetail

  - `ReferenceList.PropertyDates.PropertyAddress.id` (string)
    unique address id
    Example: Address_1

  - `ReferenceList.PropertyDates.PropertyAddress.BldgRoom` (object)
    Address with building and room number

  - `ReferenceList.PropertyDates.PropertyAddress.BldgRoom.value` (string)
    Example: Moore House

  - `ReferenceList.PropertyDates.PropertyAddress.BldgRoom.buldingInd` (boolean)
    When true, the information is a building name. When false, it is an apartment or room #
    Example: true

  - `ReferenceList.PropertyDates.PropertyAddress.Number` (object)
    The street number alone is the numerical number that precedes the street name in the address.

  - `ReferenceList.PropertyDates.PropertyAddress.Number.value` (string)
    Street number value.
    Example: 23B

  - `ReferenceList.PropertyDates.PropertyAddress.Number.streetNmbrSuffix` (string)
    Street Number Suffix
    Example: B

  - `ReferenceList.PropertyDates.PropertyAddress.Number.streetDirection` (string)
    Direction of the Street
    Example: NW

  - `ReferenceList.PropertyDates.PropertyAddress.Number.ruralRouteNmbr` (string)
    RuralRoute Number
    Example: 76

  - `ReferenceList.PropertyDates.PropertyAddress.Number.po_Box` (string)
    PO Box Number
    Example: 1001

  - `ReferenceList.PropertyDates.PropertyAddress.Street` (string)
    Street name. May also contain the street number when the Number element is missing.
    Example: ABC Street

  - `ReferenceList.PropertyDates.PropertyAddress.AddressLine` (array)
    Property street address. Used in place of Street and Number. Each element of the array represents an address line.

  - `ReferenceList.PropertyDates.PropertyAddress.City` (string, required)
    Full name of the city, town, or postal station (i.e., a postal service territory, often used in a military address).
    Example: Dublin

  - `ReferenceList.PropertyDates.PropertyAddress.County` (string)
    County or Region Name.
    Example: Berkshire

  - `ReferenceList.PropertyDates.PropertyAddress.StateProv` (object)
    The standard code or abbreviation for the state, province, or region. May also include full length name.

  - `ReferenceList.PropertyDates.PropertyAddress.StateProv.value` (string)
    State, province, or region code needed to identify location (typically two characters).
    Example: CA

  - `ReferenceList.PropertyDates.PropertyAddress.StateProv.name` (string)
    State, province, or region name needed to identify location.
    Example: California

  - `ReferenceList.PropertyDates.PropertyAddress.Country` (object)
    Contains the information needed to identify a country.

  - `ReferenceList.PropertyDates.PropertyAddress.Country.value` (string)
    The ISO 3166 code for the property's address.
    Example: US

  - `ReferenceList.PropertyDates.PropertyAddress.Country.id` (string)
    Custom user-assigned identifier for the country.
    Example: 23

  - `ReferenceList.PropertyDates.PropertyAddress.Country.name` (string)
    The full name of the country for the property's address.
    Example: United States

  - `ReferenceList.PropertyDates.PropertyAddress.Country.codeContext` (string)
    The source of a code, such as the organization that provided the id number
    Example: IATA

  - `ReferenceList.PropertyDates.PropertyAddress.PostalCode` (string)
    Postal code for the address.
    Example: Sl6 1AB

  - `ReferenceList.PropertyDates.PropertyAddress.Addressee` (string)
    The name of the company or person to be addressed
    Example: ACME INC

  - `ReferenceList.PropertyDates.PropertyAddress.role` (string)
    Defines the type of location the address is assigned to. For TravelAgency address leave blank or use "Other".
    Enum: "Home", "Business", "Mailing", "Delivery", "Destination", "Other", "Billing"

  - `ReferenceList.PropertyDates.PropertyAddress.addressType` (string)
    OTA code for address type
    Example: CLT

  - `ReferenceList.PropertyDates.PropertyAddress.use` (string)
    OTA code for address use
    Example: AUT

  - `ReferenceList.PropertyDates.PropertyAddress.Comment` (object)
    Textual information.

  - `ReferenceList.PropertyDates.PropertyAddress.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

  - `ReferenceList.PropertyDates.PropertyAddress.Comment.id` (string)
    Local identifier within a given message for this object.
    Example: comment_1

  - `ReferenceList.PropertyDates.PropertyAddress.Comment.name` (string)
    Title of comment or type of remark.
    Example: Comment name

  - `ReferenceList.PropertyDates.PropertyAddress.Comment.language` (string)
    Language code using ISO-639 standard
    Example: EN

  - `ReferenceList.PropertyDates.PropertyAddress.Privacy` (object)
    Confidential details for marketing purpose

  - `ReferenceList.PropertyDates.PropertyAddress.Privacy.id` (string)
    Optional internally referenced id
    Example: 2

  - `ReferenceList.PropertyDates.PropertyAddress.Privacy.shareMarketing` (string)
    Used to indicate marketing preferences, Yes, No, Inherit
    Enum: "Yes", "No", "Inherit"

  - `ReferenceList.PropertyDates.PropertyAddress.Privacy.optInStatus` (string)
    Used to indicate marketing preferences, OptIn, OptOut
    Enum: "OptedIn", "OptedOut", "Unknown"

  - `ReferenceList.PropertyDates.PropertyAddress.Privacy.optInDate` (string)
    The datetime of receiving the opt in notice
    Example: 2026-08-07T12:12:00Z

  - `ReferenceList.PropertyDates.PropertyAddress.Privacy.optOutDate` (string)
    The datetime the opt out notice was received
    Example: 2026-08-07T12:12:00Z

  - `ReferenceList.PropertyDates.PropertyAddress.Priority` (integer)
    The priority ranking within the group
    Example: 1

  - `ReferenceList.PropertyDates.PropertyAddress.validInd` (boolean)
    If true, this is a valid and complete mailing address that has been verified through an address verification service or previously mailed materials have not been returned.
    Example: false

  - `ReferenceList.PropertyDates.PropertyAddress.provisionedInd` (boolean)
    If true, this address came into the system through provisioning
    Example: false

  - `ReferenceList.PropertyDates.PropertyKey` (object, required)
    Contains up to 250 PropertyKey objects. Each PropertyKey object identifies one property.

  - `ReferenceList.PropertyDates.PropertyKey.@type` (string)

  - `ReferenceList.PropertyDates.PropertyKey.chainCode` (string, required)
    Code for the hotel chain (typically 2 characters)
    Example: UR

  - `ReferenceList.PropertyDates.PropertyKey.propertyCode` (string, required)
    The property code of the requested property (typically 5 characters).
    Example: G3375

  - `ReferenceList.PropertyDates.DateRange` (object, required)
    Specifies the begin and end date of an event, such as check-in and check-out dates.

  - `ReferenceList.PropertyDates.DateRange.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

  - `ReferenceList.PropertyDates.DateRange.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

  - `ReferenceList.PropertyDates.GeoLocation` (object)
    For Hotel: the geographic coordinates of the property.

  - `ReferenceList.PropertyDates.GeoLocation.latitude` (number, required)
    Numeric value representing latitude of search center point in degrees and decimal minutes.
    Example: 38.8951

  - `ReferenceList.PropertyDates.GeoLocation.longitude` (number, required)
    Numeric value representing longitude of search center point in degrees and decimal minutes.
    Example: -77.0364

  - `ReferenceList.PropertyDates.GeoLocation.altitude` (number)
    The height of a location, typically measured above sea level
    Example: 5280

  - `ReferenceList.PropertyDates.GeoLocation.altitudeUnitOfDistance` (string)
    For Hotels: Optional object to request either miles or kilometers for the search radius from the specified location. If unitOfDistance is not specified, the search defaults to miles for properties in the United States, Myanmar, and Liberia. The search defaults to kilometers in all other countries.
    Enum: "Miles", "Kilometers"

  - `ReferenceList.PropertyDates.GeoLocation.positionAccuracy` (string)
    Specifies the level of accuracy for the position
    Enum: "Zip9Code", "Zip7Code", "Zip5Code", "Street", "State", "Property", "Intersection", "Exact", "County", "City", "Block"

  - `ReferenceList.PropertyDates.GeoLocation.mapURL` (string)
    link for embedded map showing location
    Example: www.destinationmap.com

  - `ReferenceList.PropertyDates.GeoLocation.formatURL` (string)
    The URL to the format for the latitude and longitude for this location.
    Example: www.destinationmap.com

  - `ReferenceList.PropertyDates.Telephone` (object)
    Phone information for contacting the relevant individual or agency.  
For Flights Add Traveler, NDC carriers typically require either an email address or phone number for booking. Recommended best practice is to provide both Email and Telephone for NDC.

  - `ReferenceList.PropertyDates.Telephone.@type` (string, required)
    Discriminator classes Telephone or TelephoneDetail
    Example: Telephone

  - `ReferenceList.PropertyDates.Telephone.countryAccessCode` (string)
    Phone country code
    Example: 1

  - `ReferenceList.PropertyDates.Telephone.areaCityCode` (string)
    Phone local area code
    Example: 972

  - `ReferenceList.PropertyDates.Telephone.phoneNumber` (string, required)
    Mobile/Telephone Number. Accepted characters are numeric, dash, space, and period.
    Example: 972-000-787

  - `ReferenceList.PropertyDates.Telephone.extension` (string)
    Telephone extension number
    Example: 234

  - `ReferenceList.PropertyDates.Telephone.id` (string)
    Optional custom user-assigned identifier for a phone number.
    Example: 3

  - `ReferenceList.PropertyDates.Telephone.cityCode` (string)
    IATA city code if referenced by phone number.
    Example: DEN

  - `ReferenceList.PropertyDates.Telephone.role` (string)
    Defines the type of location the Telephone is assigned to. For Travel Agency telephone select "Other" or leave blank.
    Enum: "Mobile", "Home", "Work", "Office", "Fax", "Other"

  - `ReferenceList.PropertyDates.Telephone.phoneLocationType` (string)
    Location of the phone
    Example: Agency

  - `ReferenceList.PropertyDates.Telephone.phoneTechType` (string)
    Indicates the type of technology associated with the telephone number
    Example: Voice

  - `ReferenceList.PropertyDates.Telephone.phoneUseType` (string)
    Agency code for how phone is used (e.g., Home, Business, Emergency Contact, Travel Arranger, Day, Evening).
    Example: Home

  - `ReferenceList.PropertyDates.Telephone.pin` (string)
    Additional codes used for telephone
    Example: 3456

  - `ReferenceList.PropertyDates.Telephone.priority` (integer)
    Priority
    Example: 1

  - `ReferenceList.PropertyDates.Telephone.defaultInd` (boolean)
    When true, indicates a default value should be used.
    Example: true

  - `ReferenceList.PropertyDates.Telephone.provisionedInd` (boolean)
    true indicates this phone number was created through provisioned
    Example: false

  - `ReferenceList.PropertyDates.Email` (object)
    Electronic email addresses, in IETF specified format.  
Booking.com requires a traveler email address in the Hotel Create Reservation and Add Reservation requests. A system-generated confirmation email is sent to the traveler after the booking completes.
For Flights Add Traveler, NDC carriers typically require either an email address or phone number for booking. Recommended best practice is to provide both Email and Telephone for NDC.

  - `ReferenceList.PropertyDates.Email.value` (string)
    The email address.
    Example: exampledomain@example.com

  - `ReferenceList.PropertyDates.Email.id` (string)
    Electronic email addresses, in IETF specified format.
    Example: email_1

  - `ReferenceList.PropertyDates.Email.emailType` (string)
    Use email type to specify if the email is to be sent "TO" or sent "FROM"
    Example: FROM

  - `ReferenceList.PropertyDates.Email.comment` (string)
    Any freeform note for the email, such as its purpose.
    Example: work email

  - `ReferenceList.PropertyDates.Email.preferredFormat` (string)
    Mime media type
    Example: text/html

  - `ReferenceList.PropertyDates.Email.optInDate` (string)
    The datetime of receiving the opt in notice
    Example: 2026-03-03T11:11:00Z

  - `ReferenceList.PropertyDates.Email.optOutDate` (string)
    The datetime the opt out notice was received
    Example: 2026-03-03T11:11:00Z

  - `ReferenceList.PropertyDates.Email.validInd` (boolean)
    If true, this is a valid email address that has been system verified via a successful email transmission.
    Example: true

  - `ReferenceList.PropertyDates.Email.provisionedInd` (boolean)
    If true then the email address came from the provisioning process
    Example: true

  - `CurrencyRateConversion` (array)

  - `CurrencyRateConversion.@type` (string)

  - `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.

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

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

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

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

  - `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.

  - `CurrencyRateConversion.ConversionRate.value` (number)

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

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

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

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

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

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

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

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

## Response 402:

  - `402` (unknown)
    Payment Required - 402

## Response 402 fields (application/json):

  - `@type` (string)
    Example: response

  - `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

  - `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

  - `correlationId` (string)
    Identifier used to correlate hotel API invocations across a multi-call business flows.
    Example: 49f58f5f-c443-43b4-9f5d-be405fd00a01

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

  - `Result` (object)
    Returns the error and/or warning message information, if applicable.
See [Error Messaging](https://developer.travelport.com/docs/flights/general/error-messaging) for additional details.

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

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

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

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

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

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

  - `Result.Error.NameValuePair` (array)

  - `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

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

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

  - `Result.Error.category` (string)
    A category to assist in identifying the error
    Example: VALIDATION

  - `Result.Error.SourceID` (string)
    The identifier of the source system sending the error or warning
    Example: 1G

  - `Result.Error.SourceCode` (string)
    The error or warning code returned by the source airline or host system
    Example: 1234

  - `Result.Error.SourceDescription` (string)
    The error or warning message as it is returned by the source airline or host system

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

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

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

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

  - `Result.Warning.NameValuePair` (array)

  - `Result.Warning.category` (string)
    A category to assist in identifying the error
    Example: INFORMATION

  - `Result.Warning.SourceID` (string)
    The identifier of the source system sending the error or warning
    Example: 1G

  - `Result.Warning.SourceCode` (string)
    The error or warning code returned by the source airline or host system
    Example: 1234

  - `Result.Warning.SourceDescription` (string)
    The error or warning message as it is returned by the source airline or host system

  - `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).

  - `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 system generated 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'.
- If not available, for Payment, any unique identifier can be sent.

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

  - `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

  - `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.

  - `NextSteps.baseURI` (string, required)
    The base portion of the URI in order to shorten the uris in the individual steps
    Example: www.travelport.com

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

  - `NextSteps.NextStep` (array, required)

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

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

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

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

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

  - `ReferenceList` (array)

  - `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

  - `ReferenceList.id` (string)
    Uniquely identifies for the Reference List
    Example: referenceList_001

  - `ReferenceList.PropertyDates` (array, required)

  - `ReferenceList.PropertyDates.@type` (string)

  - `ReferenceList.PropertyDates.availability` (string)
    Indicates whether the property has rooms available for the requested dates.
    Enum: "Open", "Close", "ClosedOnArrival", "ClosedOnArrivalOnRequest", "OnRequest", "RemoveCloseOnly", "Other"

  - `ReferenceList.PropertyDates.adaCompliant` (string)
    Yes , No , Unknown
    Enum: "Yes", "No", "Unknown"

  - `ReferenceList.PropertyDates.id` (string, required)
    Key to matching the common information in ReferenceList with an Offer; corresponds to the propertyDatesRef value in each Offer/Products/Product.

  - `ReferenceList.PropertyDates.moreRatesToken` (string)
    More rates token

  - `ReferenceList.PropertyDates.propertyName` (string)
    Name of property offering these products.

  - `ReferenceList.PropertyDates.PropertyAddress` (object)
    The property or billing address information.  
For Flights Add Traveler sending Address is optional, but when sent it must have the role set to 'Delivery' and include at least one of its objects, such as Number or City.

  - `ReferenceList.PropertyDates.PropertyAddress.@type` (string, required)
    Discriminator classes Address or AddressDetail
    Example: AddressDetail

  - `ReferenceList.PropertyDates.PropertyAddress.id` (string)
    unique address id
    Example: Address_1

  - `ReferenceList.PropertyDates.PropertyAddress.BldgRoom` (object)
    Address with building and room number

  - `ReferenceList.PropertyDates.PropertyAddress.BldgRoom.value` (string)
    Example: Moore House

  - `ReferenceList.PropertyDates.PropertyAddress.BldgRoom.buldingInd` (boolean)
    When true, the information is a building name. When false, it is an apartment or room #
    Example: true

  - `ReferenceList.PropertyDates.PropertyAddress.Number` (object)
    The street number alone is the numerical number that precedes the street name in the address.

  - `ReferenceList.PropertyDates.PropertyAddress.Number.value` (string)
    Street number value.
    Example: 23B

  - `ReferenceList.PropertyDates.PropertyAddress.Number.streetNmbrSuffix` (string)
    Street Number Suffix
    Example: B

  - `ReferenceList.PropertyDates.PropertyAddress.Number.streetDirection` (string)
    Direction of the Street
    Example: NW

  - `ReferenceList.PropertyDates.PropertyAddress.Number.ruralRouteNmbr` (string)
    RuralRoute Number
    Example: 76

  - `ReferenceList.PropertyDates.PropertyAddress.Number.po_Box` (string)
    PO Box Number
    Example: 1001

  - `ReferenceList.PropertyDates.PropertyAddress.Street` (string)
    Street name. May also contain the street number when the Number element is missing.
    Example: ABC Street

  - `ReferenceList.PropertyDates.PropertyAddress.AddressLine` (array)
    Property street address. Used in place of Street and Number. Each element of the array represents an address line.

  - `ReferenceList.PropertyDates.PropertyAddress.City` (string, required)
    Full name of the city, town, or postal station (i.e., a postal service territory, often used in a military address).
    Example: Dublin

  - `ReferenceList.PropertyDates.PropertyAddress.County` (string)
    County or Region Name.
    Example: Berkshire

  - `ReferenceList.PropertyDates.PropertyAddress.StateProv` (object)
    The standard code or abbreviation for the state, province, or region. May also include full length name.

  - `ReferenceList.PropertyDates.PropertyAddress.StateProv.value` (string)
    State, province, or region code needed to identify location (typically two characters).
    Example: CA

  - `ReferenceList.PropertyDates.PropertyAddress.StateProv.name` (string)
    State, province, or region name needed to identify location.
    Example: California

  - `ReferenceList.PropertyDates.PropertyAddress.Country` (object)
    Contains the information needed to identify a country.

  - `ReferenceList.PropertyDates.PropertyAddress.Country.value` (string)
    The ISO 3166 code for the property's address.
    Example: US

  - `ReferenceList.PropertyDates.PropertyAddress.Country.id` (string)
    Custom user-assigned identifier for the country.
    Example: 23

  - `ReferenceList.PropertyDates.PropertyAddress.Country.name` (string)
    The full name of the country for the property's address.
    Example: United States

  - `ReferenceList.PropertyDates.PropertyAddress.Country.codeContext` (string)
    The source of a code, such as the organization that provided the id number
    Example: IATA

  - `ReferenceList.PropertyDates.PropertyAddress.PostalCode` (string)
    Postal code for the address.
    Example: Sl6 1AB

  - `ReferenceList.PropertyDates.PropertyAddress.Addressee` (string)
    The name of the company or person to be addressed
    Example: ACME INC

  - `ReferenceList.PropertyDates.PropertyAddress.role` (string)
    Defines the type of location the address is assigned to. For TravelAgency address leave blank or use "Other".
    Enum: "Home", "Business", "Mailing", "Delivery", "Destination", "Other", "Billing"

  - `ReferenceList.PropertyDates.PropertyAddress.addressType` (string)
    OTA code for address type
    Example: CLT

  - `ReferenceList.PropertyDates.PropertyAddress.use` (string)
    OTA code for address use
    Example: AUT

  - `ReferenceList.PropertyDates.PropertyAddress.Comment` (object)
    Textual information.

  - `ReferenceList.PropertyDates.PropertyAddress.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

  - `ReferenceList.PropertyDates.PropertyAddress.Comment.id` (string)
    Local identifier within a given message for this object.
    Example: comment_1

  - `ReferenceList.PropertyDates.PropertyAddress.Comment.name` (string)
    Title of comment or type of remark.
    Example: Comment name

  - `ReferenceList.PropertyDates.PropertyAddress.Comment.language` (string)
    Language code using ISO-639 standard
    Example: EN

  - `ReferenceList.PropertyDates.PropertyAddress.Privacy` (object)
    Confidential details for marketing purpose

  - `ReferenceList.PropertyDates.PropertyAddress.Privacy.id` (string)
    Optional internally referenced id
    Example: 2

  - `ReferenceList.PropertyDates.PropertyAddress.Privacy.shareMarketing` (string)
    Used to indicate marketing preferences, Yes, No, Inherit
    Enum: "Yes", "No", "Inherit"

  - `ReferenceList.PropertyDates.PropertyAddress.Privacy.optInStatus` (string)
    Used to indicate marketing preferences, OptIn, OptOut
    Enum: "OptedIn", "OptedOut", "Unknown"

  - `ReferenceList.PropertyDates.PropertyAddress.Privacy.optInDate` (string)
    The datetime of receiving the opt in notice
    Example: 2026-08-07T12:12:00Z

  - `ReferenceList.PropertyDates.PropertyAddress.Privacy.optOutDate` (string)
    The datetime the opt out notice was received
    Example: 2026-08-07T12:12:00Z

  - `ReferenceList.PropertyDates.PropertyAddress.Priority` (integer)
    The priority ranking within the group
    Example: 1

  - `ReferenceList.PropertyDates.PropertyAddress.validInd` (boolean)
    If true, this is a valid and complete mailing address that has been verified through an address verification service or previously mailed materials have not been returned.
    Example: false

  - `ReferenceList.PropertyDates.PropertyAddress.provisionedInd` (boolean)
    If true, this address came into the system through provisioning
    Example: false

  - `ReferenceList.PropertyDates.PropertyKey` (object, required)
    Contains up to 250 PropertyKey objects. Each PropertyKey object identifies one property.

  - `ReferenceList.PropertyDates.PropertyKey.@type` (string)

  - `ReferenceList.PropertyDates.PropertyKey.chainCode` (string, required)
    Code for the hotel chain (typically 2 characters)
    Example: UR

  - `ReferenceList.PropertyDates.PropertyKey.propertyCode` (string, required)
    The property code of the requested property (typically 5 characters).
    Example: G3375

  - `ReferenceList.PropertyDates.DateRange` (object, required)
    Specifies the begin and end date of an event, such as check-in and check-out dates.

  - `ReferenceList.PropertyDates.DateRange.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

  - `ReferenceList.PropertyDates.DateRange.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

  - `ReferenceList.PropertyDates.GeoLocation` (object)
    For Hotel: the geographic coordinates of the property.

  - `ReferenceList.PropertyDates.GeoLocation.latitude` (number, required)
    Numeric value representing latitude of search center point in degrees and decimal minutes.
    Example: 38.8951

  - `ReferenceList.PropertyDates.GeoLocation.longitude` (number, required)
    Numeric value representing longitude of search center point in degrees and decimal minutes.
    Example: -77.0364

  - `ReferenceList.PropertyDates.GeoLocation.altitude` (number)
    The height of a location, typically measured above sea level
    Example: 5280

  - `ReferenceList.PropertyDates.GeoLocation.altitudeUnitOfDistance` (string)
    For Hotels: Optional object to request either miles or kilometers for the search radius from the specified location. If unitOfDistance is not specified, the search defaults to miles for properties in the United States, Myanmar, and Liberia. The search defaults to kilometers in all other countries.
    Enum: "Miles", "Kilometers"

  - `ReferenceList.PropertyDates.GeoLocation.positionAccuracy` (string)
    Specifies the level of accuracy for the position
    Enum: "Zip9Code", "Zip7Code", "Zip5Code", "Street", "State", "Property", "Intersection", "Exact", "County", "City", "Block"

  - `ReferenceList.PropertyDates.GeoLocation.mapURL` (string)
    link for embedded map showing location
    Example: www.destinationmap.com

  - `ReferenceList.PropertyDates.GeoLocation.formatURL` (string)
    The URL to the format for the latitude and longitude for this location.
    Example: www.destinationmap.com

  - `ReferenceList.PropertyDates.Telephone` (object)
    Phone information for contacting the relevant individual or agency.  
For Flights Add Traveler, NDC carriers typically require either an email address or phone number for booking. Recommended best practice is to provide both Email and Telephone for NDC.

  - `ReferenceList.PropertyDates.Telephone.@type` (string, required)
    Discriminator classes Telephone or TelephoneDetail
    Example: Telephone

  - `ReferenceList.PropertyDates.Telephone.countryAccessCode` (string)
    Phone country code
    Example: 1

  - `ReferenceList.PropertyDates.Telephone.areaCityCode` (string)
    Phone local area code
    Example: 972

  - `ReferenceList.PropertyDates.Telephone.phoneNumber` (string, required)
    Mobile/Telephone Number. Accepted characters are numeric, dash, space, and period.
    Example: 972-000-787

  - `ReferenceList.PropertyDates.Telephone.extension` (string)
    Telephone extension number
    Example: 234

  - `ReferenceList.PropertyDates.Telephone.id` (string)
    Optional custom user-assigned identifier for a phone number.
    Example: 3

  - `ReferenceList.PropertyDates.Telephone.cityCode` (string)
    IATA city code if referenced by phone number.
    Example: DEN

  - `ReferenceList.PropertyDates.Telephone.role` (string)
    Defines the type of location the Telephone is assigned to. For Travel Agency telephone select "Other" or leave blank.
    Enum: "Mobile", "Home", "Work", "Office", "Fax", "Other"

  - `ReferenceList.PropertyDates.Telephone.phoneLocationType` (string)
    Location of the phone
    Example: Agency

  - `ReferenceList.PropertyDates.Telephone.phoneTechType` (string)
    Indicates the type of technology associated with the telephone number
    Example: Voice

  - `ReferenceList.PropertyDates.Telephone.phoneUseType` (string)
    Agency code for how phone is used (e.g., Home, Business, Emergency Contact, Travel Arranger, Day, Evening).
    Example: Home

  - `ReferenceList.PropertyDates.Telephone.pin` (string)
    Additional codes used for telephone
    Example: 3456

  - `ReferenceList.PropertyDates.Telephone.priority` (integer)
    Priority
    Example: 1

  - `ReferenceList.PropertyDates.Telephone.defaultInd` (boolean)
    When true, indicates a default value should be used.
    Example: true

  - `ReferenceList.PropertyDates.Telephone.provisionedInd` (boolean)
    true indicates this phone number was created through provisioned
    Example: false

  - `ReferenceList.PropertyDates.Email` (object)
    Electronic email addresses, in IETF specified format.  
Booking.com requires a traveler email address in the Hotel Create Reservation and Add Reservation requests. A system-generated confirmation email is sent to the traveler after the booking completes.
For Flights Add Traveler, NDC carriers typically require either an email address or phone number for booking. Recommended best practice is to provide both Email and Telephone for NDC.

  - `ReferenceList.PropertyDates.Email.value` (string)
    The email address.
    Example: exampledomain@example.com

  - `ReferenceList.PropertyDates.Email.id` (string)
    Electronic email addresses, in IETF specified format.
    Example: email_1

  - `ReferenceList.PropertyDates.Email.emailType` (string)
    Use email type to specify if the email is to be sent "TO" or sent "FROM"
    Example: FROM

  - `ReferenceList.PropertyDates.Email.comment` (string)
    Any freeform note for the email, such as its purpose.
    Example: work email

  - `ReferenceList.PropertyDates.Email.preferredFormat` (string)
    Mime media type
    Example: text/html

  - `ReferenceList.PropertyDates.Email.optInDate` (string)
    The datetime of receiving the opt in notice
    Example: 2026-03-03T11:11:00Z

  - `ReferenceList.PropertyDates.Email.optOutDate` (string)
    The datetime the opt out notice was received
    Example: 2026-03-03T11:11:00Z

  - `ReferenceList.PropertyDates.Email.validInd` (boolean)
    If true, this is a valid email address that has been system verified via a successful email transmission.
    Example: true

  - `ReferenceList.PropertyDates.Email.provisionedInd` (boolean)
    If true then the email address came from the provisioning process
    Example: true

  - `CurrencyRateConversion` (array)

  - `CurrencyRateConversion.@type` (string)

  - `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.

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

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

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

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

  - `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.

  - `CurrencyRateConversion.ConversionRate.value` (number)

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

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

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

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

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

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

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

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

## Response 403:

  - `403` (unknown)
    Forbidden - 403

## Response 403 fields (application/json):

  - `@type` (string)
    Example: response

  - `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

  - `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

  - `correlationId` (string)
    Identifier used to correlate hotel API invocations across a multi-call business flows.
    Example: 49f58f5f-c443-43b4-9f5d-be405fd00a01

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

  - `Result` (object)
    Returns the error and/or warning message information, if applicable.
See [Error Messaging](https://developer.travelport.com/docs/flights/general/error-messaging) for additional details.

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

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

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

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

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

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

  - `Result.Error.NameValuePair` (array)

  - `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

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

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

  - `Result.Error.category` (string)
    A category to assist in identifying the error
    Example: VALIDATION

  - `Result.Error.SourceID` (string)
    The identifier of the source system sending the error or warning
    Example: 1G

  - `Result.Error.SourceCode` (string)
    The error or warning code returned by the source airline or host system
    Example: 1234

  - `Result.Error.SourceDescription` (string)
    The error or warning message as it is returned by the source airline or host system

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

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

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

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

  - `Result.Warning.NameValuePair` (array)

  - `Result.Warning.category` (string)
    A category to assist in identifying the error
    Example: INFORMATION

  - `Result.Warning.SourceID` (string)
    The identifier of the source system sending the error or warning
    Example: 1G

  - `Result.Warning.SourceCode` (string)
    The error or warning code returned by the source airline or host system
    Example: 1234

  - `Result.Warning.SourceDescription` (string)
    The error or warning message as it is returned by the source airline or host system

  - `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).

  - `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 system generated 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'.
- If not available, for Payment, any unique identifier can be sent.

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

  - `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

  - `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.

  - `NextSteps.baseURI` (string, required)
    The base portion of the URI in order to shorten the uris in the individual steps
    Example: www.travelport.com

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

  - `NextSteps.NextStep` (array, required)

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

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

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

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

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

  - `ReferenceList` (array)

  - `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

  - `ReferenceList.id` (string)
    Uniquely identifies for the Reference List
    Example: referenceList_001

  - `ReferenceList.PropertyDates` (array, required)

  - `ReferenceList.PropertyDates.@type` (string)

  - `ReferenceList.PropertyDates.availability` (string)
    Indicates whether the property has rooms available for the requested dates.
    Enum: "Open", "Close", "ClosedOnArrival", "ClosedOnArrivalOnRequest", "OnRequest", "RemoveCloseOnly", "Other"

  - `ReferenceList.PropertyDates.adaCompliant` (string)
    Yes , No , Unknown
    Enum: "Yes", "No", "Unknown"

  - `ReferenceList.PropertyDates.id` (string, required)
    Key to matching the common information in ReferenceList with an Offer; corresponds to the propertyDatesRef value in each Offer/Products/Product.

  - `ReferenceList.PropertyDates.moreRatesToken` (string)
    More rates token

  - `ReferenceList.PropertyDates.propertyName` (string)
    Name of property offering these products.

  - `ReferenceList.PropertyDates.PropertyAddress` (object)
    The property or billing address information.  
For Flights Add Traveler sending Address is optional, but when sent it must have the role set to 'Delivery' and include at least one of its objects, such as Number or City.

  - `ReferenceList.PropertyDates.PropertyAddress.@type` (string, required)
    Discriminator classes Address or AddressDetail
    Example: AddressDetail

  - `ReferenceList.PropertyDates.PropertyAddress.id` (string)
    unique address id
    Example: Address_1

  - `ReferenceList.PropertyDates.PropertyAddress.BldgRoom` (object)
    Address with building and room number

  - `ReferenceList.PropertyDates.PropertyAddress.BldgRoom.value` (string)
    Example: Moore House

  - `ReferenceList.PropertyDates.PropertyAddress.BldgRoom.buldingInd` (boolean)
    When true, the information is a building name. When false, it is an apartment or room #
    Example: true

  - `ReferenceList.PropertyDates.PropertyAddress.Number` (object)
    The street number alone is the numerical number that precedes the street name in the address.

  - `ReferenceList.PropertyDates.PropertyAddress.Number.value` (string)
    Street number value.
    Example: 23B

  - `ReferenceList.PropertyDates.PropertyAddress.Number.streetNmbrSuffix` (string)
    Street Number Suffix
    Example: B

  - `ReferenceList.PropertyDates.PropertyAddress.Number.streetDirection` (string)
    Direction of the Street
    Example: NW

  - `ReferenceList.PropertyDates.PropertyAddress.Number.ruralRouteNmbr` (string)
    RuralRoute Number
    Example: 76

  - `ReferenceList.PropertyDates.PropertyAddress.Number.po_Box` (string)
    PO Box Number
    Example: 1001

  - `ReferenceList.PropertyDates.PropertyAddress.Street` (string)
    Street name. May also contain the street number when the Number element is missing.
    Example: ABC Street

  - `ReferenceList.PropertyDates.PropertyAddress.AddressLine` (array)
    Property street address. Used in place of Street and Number. Each element of the array represents an address line.

  - `ReferenceList.PropertyDates.PropertyAddress.City` (string, required)
    Full name of the city, town, or postal station (i.e., a postal service territory, often used in a military address).
    Example: Dublin

  - `ReferenceList.PropertyDates.PropertyAddress.County` (string)
    County or Region Name.
    Example: Berkshire

  - `ReferenceList.PropertyDates.PropertyAddress.StateProv` (object)
    The standard code or abbreviation for the state, province, or region. May also include full length name.

  - `ReferenceList.PropertyDates.PropertyAddress.StateProv.value` (string)
    State, province, or region code needed to identify location (typically two characters).
    Example: CA

  - `ReferenceList.PropertyDates.PropertyAddress.StateProv.name` (string)
    State, province, or region name needed to identify location.
    Example: California

  - `ReferenceList.PropertyDates.PropertyAddress.Country` (object)
    Contains the information needed to identify a country.

  - `ReferenceList.PropertyDates.PropertyAddress.Country.value` (string)
    The ISO 3166 code for the property's address.
    Example: US

  - `ReferenceList.PropertyDates.PropertyAddress.Country.id` (string)
    Custom user-assigned identifier for the country.
    Example: 23

  - `ReferenceList.PropertyDates.PropertyAddress.Country.name` (string)
    The full name of the country for the property's address.
    Example: United States

  - `ReferenceList.PropertyDates.PropertyAddress.Country.codeContext` (string)
    The source of a code, such as the organization that provided the id number
    Example: IATA

  - `ReferenceList.PropertyDates.PropertyAddress.PostalCode` (string)
    Postal code for the address.
    Example: Sl6 1AB

  - `ReferenceList.PropertyDates.PropertyAddress.Addressee` (string)
    The name of the company or person to be addressed
    Example: ACME INC

  - `ReferenceList.PropertyDates.PropertyAddress.role` (string)
    Defines the type of location the address is assigned to. For TravelAgency address leave blank or use "Other".
    Enum: "Home", "Business", "Mailing", "Delivery", "Destination", "Other", "Billing"

  - `ReferenceList.PropertyDates.PropertyAddress.addressType` (string)
    OTA code for address type
    Example: CLT

  - `ReferenceList.PropertyDates.PropertyAddress.use` (string)
    OTA code for address use
    Example: AUT

  - `ReferenceList.PropertyDates.PropertyAddress.Comment` (object)
    Textual information.

  - `ReferenceList.PropertyDates.PropertyAddress.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

  - `ReferenceList.PropertyDates.PropertyAddress.Comment.id` (string)
    Local identifier within a given message for this object.
    Example: comment_1

  - `ReferenceList.PropertyDates.PropertyAddress.Comment.name` (string)
    Title of comment or type of remark.
    Example: Comment name

  - `ReferenceList.PropertyDates.PropertyAddress.Comment.language` (string)
    Language code using ISO-639 standard
    Example: EN

  - `ReferenceList.PropertyDates.PropertyAddress.Privacy` (object)
    Confidential details for marketing purpose

  - `ReferenceList.PropertyDates.PropertyAddress.Privacy.id` (string)
    Optional internally referenced id
    Example: 2

  - `ReferenceList.PropertyDates.PropertyAddress.Privacy.shareMarketing` (string)
    Used to indicate marketing preferences, Yes, No, Inherit
    Enum: "Yes", "No", "Inherit"

  - `ReferenceList.PropertyDates.PropertyAddress.Privacy.optInStatus` (string)
    Used to indicate marketing preferences, OptIn, OptOut
    Enum: "OptedIn", "OptedOut", "Unknown"

  - `ReferenceList.PropertyDates.PropertyAddress.Privacy.optInDate` (string)
    The datetime of receiving the opt in notice
    Example: 2026-08-07T12:12:00Z

  - `ReferenceList.PropertyDates.PropertyAddress.Privacy.optOutDate` (string)
    The datetime the opt out notice was received
    Example: 2026-08-07T12:12:00Z

  - `ReferenceList.PropertyDates.PropertyAddress.Priority` (integer)
    The priority ranking within the group
    Example: 1

  - `ReferenceList.PropertyDates.PropertyAddress.validInd` (boolean)
    If true, this is a valid and complete mailing address that has been verified through an address verification service or previously mailed materials have not been returned.
    Example: false

  - `ReferenceList.PropertyDates.PropertyAddress.provisionedInd` (boolean)
    If true, this address came into the system through provisioning
    Example: false

  - `ReferenceList.PropertyDates.PropertyKey` (object, required)
    Contains up to 250 PropertyKey objects. Each PropertyKey object identifies one property.

  - `ReferenceList.PropertyDates.PropertyKey.@type` (string)

  - `ReferenceList.PropertyDates.PropertyKey.chainCode` (string, required)
    Code for the hotel chain (typically 2 characters)
    Example: UR

  - `ReferenceList.PropertyDates.PropertyKey.propertyCode` (string, required)
    The property code of the requested property (typically 5 characters).
    Example: G3375

  - `ReferenceList.PropertyDates.DateRange` (object, required)
    Specifies the begin and end date of an event, such as check-in and check-out dates.

  - `ReferenceList.PropertyDates.DateRange.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

  - `ReferenceList.PropertyDates.DateRange.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

  - `ReferenceList.PropertyDates.GeoLocation` (object)
    For Hotel: the geographic coordinates of the property.

  - `ReferenceList.PropertyDates.GeoLocation.latitude` (number, required)
    Numeric value representing latitude of search center point in degrees and decimal minutes.
    Example: 38.8951

  - `ReferenceList.PropertyDates.GeoLocation.longitude` (number, required)
    Numeric value representing longitude of search center point in degrees and decimal minutes.
    Example: -77.0364

  - `ReferenceList.PropertyDates.GeoLocation.altitude` (number)
    The height of a location, typically measured above sea level
    Example: 5280

  - `ReferenceList.PropertyDates.GeoLocation.altitudeUnitOfDistance` (string)
    For Hotels: Optional object to request either miles or kilometers for the search radius from the specified location. If unitOfDistance is not specified, the search defaults to miles for properties in the United States, Myanmar, and Liberia. The search defaults to kilometers in all other countries.
    Enum: "Miles", "Kilometers"

  - `ReferenceList.PropertyDates.GeoLocation.positionAccuracy` (string)
    Specifies the level of accuracy for the position
    Enum: "Zip9Code", "Zip7Code", "Zip5Code", "Street", "State", "Property", "Intersection", "Exact", "County", "City", "Block"

  - `ReferenceList.PropertyDates.GeoLocation.mapURL` (string)
    link for embedded map showing location
    Example: www.destinationmap.com

  - `ReferenceList.PropertyDates.GeoLocation.formatURL` (string)
    The URL to the format for the latitude and longitude for this location.
    Example: www.destinationmap.com

  - `ReferenceList.PropertyDates.Telephone` (object)
    Phone information for contacting the relevant individual or agency.  
For Flights Add Traveler, NDC carriers typically require either an email address or phone number for booking. Recommended best practice is to provide both Email and Telephone for NDC.

  - `ReferenceList.PropertyDates.Telephone.@type` (string, required)
    Discriminator classes Telephone or TelephoneDetail
    Example: Telephone

  - `ReferenceList.PropertyDates.Telephone.countryAccessCode` (string)
    Phone country code
    Example: 1

  - `ReferenceList.PropertyDates.Telephone.areaCityCode` (string)
    Phone local area code
    Example: 972

  - `ReferenceList.PropertyDates.Telephone.phoneNumber` (string, required)
    Mobile/Telephone Number. Accepted characters are numeric, dash, space, and period.
    Example: 972-000-787

  - `ReferenceList.PropertyDates.Telephone.extension` (string)
    Telephone extension number
    Example: 234

  - `ReferenceList.PropertyDates.Telephone.id` (string)
    Optional custom user-assigned identifier for a phone number.
    Example: 3

  - `ReferenceList.PropertyDates.Telephone.cityCode` (string)
    IATA city code if referenced by phone number.
    Example: DEN

  - `ReferenceList.PropertyDates.Telephone.role` (string)
    Defines the type of location the Telephone is assigned to. For Travel Agency telephone select "Other" or leave blank.
    Enum: "Mobile", "Home", "Work", "Office", "Fax", "Other"

  - `ReferenceList.PropertyDates.Telephone.phoneLocationType` (string)
    Location of the phone
    Example: Agency

  - `ReferenceList.PropertyDates.Telephone.phoneTechType` (string)
    Indicates the type of technology associated with the telephone number
    Example: Voice

  - `ReferenceList.PropertyDates.Telephone.phoneUseType` (string)
    Agency code for how phone is used (e.g., Home, Business, Emergency Contact, Travel Arranger, Day, Evening).
    Example: Home

  - `ReferenceList.PropertyDates.Telephone.pin` (string)
    Additional codes used for telephone
    Example: 3456

  - `ReferenceList.PropertyDates.Telephone.priority` (integer)
    Priority
    Example: 1

  - `ReferenceList.PropertyDates.Telephone.defaultInd` (boolean)
    When true, indicates a default value should be used.
    Example: true

  - `ReferenceList.PropertyDates.Telephone.provisionedInd` (boolean)
    true indicates this phone number was created through provisioned
    Example: false

  - `ReferenceList.PropertyDates.Email` (object)
    Electronic email addresses, in IETF specified format.  
Booking.com requires a traveler email address in the Hotel Create Reservation and Add Reservation requests. A system-generated confirmation email is sent to the traveler after the booking completes.
For Flights Add Traveler, NDC carriers typically require either an email address or phone number for booking. Recommended best practice is to provide both Email and Telephone for NDC.

  - `ReferenceList.PropertyDates.Email.value` (string)
    The email address.
    Example: exampledomain@example.com

  - `ReferenceList.PropertyDates.Email.id` (string)
    Electronic email addresses, in IETF specified format.
    Example: email_1

  - `ReferenceList.PropertyDates.Email.emailType` (string)
    Use email type to specify if the email is to be sent "TO" or sent "FROM"
    Example: FROM

  - `ReferenceList.PropertyDates.Email.comment` (string)
    Any freeform note for the email, such as its purpose.
    Example: work email

  - `ReferenceList.PropertyDates.Email.preferredFormat` (string)
    Mime media type
    Example: text/html

  - `ReferenceList.PropertyDates.Email.optInDate` (string)
    The datetime of receiving the opt in notice
    Example: 2026-03-03T11:11:00Z

  - `ReferenceList.PropertyDates.Email.optOutDate` (string)
    The datetime the opt out notice was received
    Example: 2026-03-03T11:11:00Z

  - `ReferenceList.PropertyDates.Email.validInd` (boolean)
    If true, this is a valid email address that has been system verified via a successful email transmission.
    Example: true

  - `ReferenceList.PropertyDates.Email.provisionedInd` (boolean)
    If true then the email address came from the provisioning process
    Example: true

  - `CurrencyRateConversion` (array)

  - `CurrencyRateConversion.@type` (string)

  - `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.

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

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

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

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

  - `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.

  - `CurrencyRateConversion.ConversionRate.value` (number)

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

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

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

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

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

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

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

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

## Response 404:

  - `404` (unknown)
    Not Found - 404

## Response 404 fields (application/json):

  - `@type` (string)
    Example: response

  - `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

  - `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

  - `correlationId` (string)
    Identifier used to correlate hotel API invocations across a multi-call business flows.
    Example: 49f58f5f-c443-43b4-9f5d-be405fd00a01

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

  - `Result` (object)
    Returns the error and/or warning message information, if applicable.
See [Error Messaging](https://developer.travelport.com/docs/flights/general/error-messaging) for additional details.

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

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

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

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

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

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

  - `Result.Error.NameValuePair` (array)

  - `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

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

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

  - `Result.Error.category` (string)
    A category to assist in identifying the error
    Example: VALIDATION

  - `Result.Error.SourceID` (string)
    The identifier of the source system sending the error or warning
    Example: 1G

  - `Result.Error.SourceCode` (string)
    The error or warning code returned by the source airline or host system
    Example: 1234

  - `Result.Error.SourceDescription` (string)
    The error or warning message as it is returned by the source airline or host system

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

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

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

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

  - `Result.Warning.NameValuePair` (array)

  - `Result.Warning.category` (string)
    A category to assist in identifying the error
    Example: INFORMATION

  - `Result.Warning.SourceID` (string)
    The identifier of the source system sending the error or warning
    Example: 1G

  - `Result.Warning.SourceCode` (string)
    The error or warning code returned by the source airline or host system
    Example: 1234

  - `Result.Warning.SourceDescription` (string)
    The error or warning message as it is returned by the source airline or host system

  - `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).

  - `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 system generated 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'.
- If not available, for Payment, any unique identifier can be sent.

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

  - `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

  - `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.

  - `NextSteps.baseURI` (string, required)
    The base portion of the URI in order to shorten the uris in the individual steps
    Example: www.travelport.com

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

  - `NextSteps.NextStep` (array, required)

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

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

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

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

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

  - `ReferenceList` (array)

  - `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

  - `ReferenceList.id` (string)
    Uniquely identifies for the Reference List
    Example: referenceList_001

  - `ReferenceList.PropertyDates` (array, required)

  - `ReferenceList.PropertyDates.@type` (string)

  - `ReferenceList.PropertyDates.availability` (string)
    Indicates whether the property has rooms available for the requested dates.
    Enum: "Open", "Close", "ClosedOnArrival", "ClosedOnArrivalOnRequest", "OnRequest", "RemoveCloseOnly", "Other"

  - `ReferenceList.PropertyDates.adaCompliant` (string)
    Yes , No , Unknown
    Enum: "Yes", "No", "Unknown"

  - `ReferenceList.PropertyDates.id` (string, required)
    Key to matching the common information in ReferenceList with an Offer; corresponds to the propertyDatesRef value in each Offer/Products/Product.

  - `ReferenceList.PropertyDates.moreRatesToken` (string)
    More rates token

  - `ReferenceList.PropertyDates.propertyName` (string)
    Name of property offering these products.

  - `ReferenceList.PropertyDates.PropertyAddress` (object)
    The property or billing address information.  
For Flights Add Traveler sending Address is optional, but when sent it must have the role set to 'Delivery' and include at least one of its objects, such as Number or City.

  - `ReferenceList.PropertyDates.PropertyAddress.@type` (string, required)
    Discriminator classes Address or AddressDetail
    Example: AddressDetail

  - `ReferenceList.PropertyDates.PropertyAddress.id` (string)
    unique address id
    Example: Address_1

  - `ReferenceList.PropertyDates.PropertyAddress.BldgRoom` (object)
    Address with building and room number

  - `ReferenceList.PropertyDates.PropertyAddress.BldgRoom.value` (string)
    Example: Moore House

  - `ReferenceList.PropertyDates.PropertyAddress.BldgRoom.buldingInd` (boolean)
    When true, the information is a building name. When false, it is an apartment or room #
    Example: true

  - `ReferenceList.PropertyDates.PropertyAddress.Number` (object)
    The street number alone is the numerical number that precedes the street name in the address.

  - `ReferenceList.PropertyDates.PropertyAddress.Number.value` (string)
    Street number value.
    Example: 23B

  - `ReferenceList.PropertyDates.PropertyAddress.Number.streetNmbrSuffix` (string)
    Street Number Suffix
    Example: B

  - `ReferenceList.PropertyDates.PropertyAddress.Number.streetDirection` (string)
    Direction of the Street
    Example: NW

  - `ReferenceList.PropertyDates.PropertyAddress.Number.ruralRouteNmbr` (string)
    RuralRoute Number
    Example: 76

  - `ReferenceList.PropertyDates.PropertyAddress.Number.po_Box` (string)
    PO Box Number
    Example: 1001

  - `ReferenceList.PropertyDates.PropertyAddress.Street` (string)
    Street name. May also contain the street number when the Number element is missing.
    Example: ABC Street

  - `ReferenceList.PropertyDates.PropertyAddress.AddressLine` (array)
    Property street address. Used in place of Street and Number. Each element of the array represents an address line.

  - `ReferenceList.PropertyDates.PropertyAddress.City` (string, required)
    Full name of the city, town, or postal station (i.e., a postal service territory, often used in a military address).
    Example: Dublin

  - `ReferenceList.PropertyDates.PropertyAddress.County` (string)
    County or Region Name.
    Example: Berkshire

  - `ReferenceList.PropertyDates.PropertyAddress.StateProv` (object)
    The standard code or abbreviation for the state, province, or region. May also include full length name.

  - `ReferenceList.PropertyDates.PropertyAddress.StateProv.value` (string)
    State, province, or region code needed to identify location (typically two characters).
    Example: CA

  - `ReferenceList.PropertyDates.PropertyAddress.StateProv.name` (string)
    State, province, or region name needed to identify location.
    Example: California

  - `ReferenceList.PropertyDates.PropertyAddress.Country` (object)
    Contains the information needed to identify a country.

  - `ReferenceList.PropertyDates.PropertyAddress.Country.value` (string)
    The ISO 3166 code for the property's address.
    Example: US

  - `ReferenceList.PropertyDates.PropertyAddress.Country.id` (string)
    Custom user-assigned identifier for the country.
    Example: 23

  - `ReferenceList.PropertyDates.PropertyAddress.Country.name` (string)
    The full name of the country for the property's address.
    Example: United States

  - `ReferenceList.PropertyDates.PropertyAddress.Country.codeContext` (string)
    The source of a code, such as the organization that provided the id number
    Example: IATA

  - `ReferenceList.PropertyDates.PropertyAddress.PostalCode` (string)
    Postal code for the address.
    Example: Sl6 1AB

  - `ReferenceList.PropertyDates.PropertyAddress.Addressee` (string)
    The name of the company or person to be addressed
    Example: ACME INC

  - `ReferenceList.PropertyDates.PropertyAddress.role` (string)
    Defines the type of location the address is assigned to. For TravelAgency address leave blank or use "Other".
    Enum: "Home", "Business", "Mailing", "Delivery", "Destination", "Other", "Billing"

  - `ReferenceList.PropertyDates.PropertyAddress.addressType` (string)
    OTA code for address type
    Example: CLT

  - `ReferenceList.PropertyDates.PropertyAddress.use` (string)
    OTA code for address use
    Example: AUT

  - `ReferenceList.PropertyDates.PropertyAddress.Comment` (object)
    Textual information.

  - `ReferenceList.PropertyDates.PropertyAddress.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

  - `ReferenceList.PropertyDates.PropertyAddress.Comment.id` (string)
    Local identifier within a given message for this object.
    Example: comment_1

  - `ReferenceList.PropertyDates.PropertyAddress.Comment.name` (string)
    Title of comment or type of remark.
    Example: Comment name

  - `ReferenceList.PropertyDates.PropertyAddress.Comment.language` (string)
    Language code using ISO-639 standard
    Example: EN

  - `ReferenceList.PropertyDates.PropertyAddress.Privacy` (object)
    Confidential details for marketing purpose

  - `ReferenceList.PropertyDates.PropertyAddress.Privacy.id` (string)
    Optional internally referenced id
    Example: 2

  - `ReferenceList.PropertyDates.PropertyAddress.Privacy.shareMarketing` (string)
    Used to indicate marketing preferences, Yes, No, Inherit
    Enum: "Yes", "No", "Inherit"

  - `ReferenceList.PropertyDates.PropertyAddress.Privacy.optInStatus` (string)
    Used to indicate marketing preferences, OptIn, OptOut
    Enum: "OptedIn", "OptedOut", "Unknown"

  - `ReferenceList.PropertyDates.PropertyAddress.Privacy.optInDate` (string)
    The datetime of receiving the opt in notice
    Example: 2026-08-07T12:12:00Z

  - `ReferenceList.PropertyDates.PropertyAddress.Privacy.optOutDate` (string)
    The datetime the opt out notice was received
    Example: 2026-08-07T12:12:00Z

  - `ReferenceList.PropertyDates.PropertyAddress.Priority` (integer)
    The priority ranking within the group
    Example: 1

  - `ReferenceList.PropertyDates.PropertyAddress.validInd` (boolean)
    If true, this is a valid and complete mailing address that has been verified through an address verification service or previously mailed materials have not been returned.
    Example: false

  - `ReferenceList.PropertyDates.PropertyAddress.provisionedInd` (boolean)
    If true, this address came into the system through provisioning
    Example: false

  - `ReferenceList.PropertyDates.PropertyKey` (object, required)
    Contains up to 250 PropertyKey objects. Each PropertyKey object identifies one property.

  - `ReferenceList.PropertyDates.PropertyKey.@type` (string)

  - `ReferenceList.PropertyDates.PropertyKey.chainCode` (string, required)
    Code for the hotel chain (typically 2 characters)
    Example: UR

  - `ReferenceList.PropertyDates.PropertyKey.propertyCode` (string, required)
    The property code of the requested property (typically 5 characters).
    Example: G3375

  - `ReferenceList.PropertyDates.DateRange` (object, required)
    Specifies the begin and end date of an event, such as check-in and check-out dates.

  - `ReferenceList.PropertyDates.DateRange.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

  - `ReferenceList.PropertyDates.DateRange.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

  - `ReferenceList.PropertyDates.GeoLocation` (object)
    For Hotel: the geographic coordinates of the property.

  - `ReferenceList.PropertyDates.GeoLocation.latitude` (number, required)
    Numeric value representing latitude of search center point in degrees and decimal minutes.
    Example: 38.8951

  - `ReferenceList.PropertyDates.GeoLocation.longitude` (number, required)
    Numeric value representing longitude of search center point in degrees and decimal minutes.
    Example: -77.0364

  - `ReferenceList.PropertyDates.GeoLocation.altitude` (number)
    The height of a location, typically measured above sea level
    Example: 5280

  - `ReferenceList.PropertyDates.GeoLocation.altitudeUnitOfDistance` (string)
    For Hotels: Optional object to request either miles or kilometers for the search radius from the specified location. If unitOfDistance is not specified, the search defaults to miles for properties in the United States, Myanmar, and Liberia. The search defaults to kilometers in all other countries.
    Enum: "Miles", "Kilometers"

  - `ReferenceList.PropertyDates.GeoLocation.positionAccuracy` (string)
    Specifies the level of accuracy for the position
    Enum: "Zip9Code", "Zip7Code", "Zip5Code", "Street", "State", "Property", "Intersection", "Exact", "County", "City", "Block"

  - `ReferenceList.PropertyDates.GeoLocation.mapURL` (string)
    link for embedded map showing location
    Example: www.destinationmap.com

  - `ReferenceList.PropertyDates.GeoLocation.formatURL` (string)
    The URL to the format for the latitude and longitude for this location.
    Example: www.destinationmap.com

  - `ReferenceList.PropertyDates.Telephone` (object)
    Phone information for contacting the relevant individual or agency.  
For Flights Add Traveler, NDC carriers typically require either an email address or phone number for booking. Recommended best practice is to provide both Email and Telephone for NDC.

  - `ReferenceList.PropertyDates.Telephone.@type` (string, required)
    Discriminator classes Telephone or TelephoneDetail
    Example: Telephone

  - `ReferenceList.PropertyDates.Telephone.countryAccessCode` (string)
    Phone country code
    Example: 1

  - `ReferenceList.PropertyDates.Telephone.areaCityCode` (string)
    Phone local area code
    Example: 972

  - `ReferenceList.PropertyDates.Telephone.phoneNumber` (string, required)
    Mobile/Telephone Number. Accepted characters are numeric, dash, space, and period.
    Example: 972-000-787

  - `ReferenceList.PropertyDates.Telephone.extension` (string)
    Telephone extension number
    Example: 234

  - `ReferenceList.PropertyDates.Telephone.id` (string)
    Optional custom user-assigned identifier for a phone number.
    Example: 3

  - `ReferenceList.PropertyDates.Telephone.cityCode` (string)
    IATA city code if referenced by phone number.
    Example: DEN

  - `ReferenceList.PropertyDates.Telephone.role` (string)
    Defines the type of location the Telephone is assigned to. For Travel Agency telephone select "Other" or leave blank.
    Enum: "Mobile", "Home", "Work", "Office", "Fax", "Other"

  - `ReferenceList.PropertyDates.Telephone.phoneLocationType` (string)
    Location of the phone
    Example: Agency

  - `ReferenceList.PropertyDates.Telephone.phoneTechType` (string)
    Indicates the type of technology associated with the telephone number
    Example: Voice

  - `ReferenceList.PropertyDates.Telephone.phoneUseType` (string)
    Agency code for how phone is used (e.g., Home, Business, Emergency Contact, Travel Arranger, Day, Evening).
    Example: Home

  - `ReferenceList.PropertyDates.Telephone.pin` (string)
    Additional codes used for telephone
    Example: 3456

  - `ReferenceList.PropertyDates.Telephone.priority` (integer)
    Priority
    Example: 1

  - `ReferenceList.PropertyDates.Telephone.defaultInd` (boolean)
    When true, indicates a default value should be used.
    Example: true

  - `ReferenceList.PropertyDates.Telephone.provisionedInd` (boolean)
    true indicates this phone number was created through provisioned
    Example: false

  - `ReferenceList.PropertyDates.Email` (object)
    Electronic email addresses, in IETF specified format.  
Booking.com requires a traveler email address in the Hotel Create Reservation and Add Reservation requests. A system-generated confirmation email is sent to the traveler after the booking completes.
For Flights Add Traveler, NDC carriers typically require either an email address or phone number for booking. Recommended best practice is to provide both Email and Telephone for NDC.

  - `ReferenceList.PropertyDates.Email.value` (string)
    The email address.
    Example: exampledomain@example.com

  - `ReferenceList.PropertyDates.Email.id` (string)
    Electronic email addresses, in IETF specified format.
    Example: email_1

  - `ReferenceList.PropertyDates.Email.emailType` (string)
    Use email type to specify if the email is to be sent "TO" or sent "FROM"
    Example: FROM

  - `ReferenceList.PropertyDates.Email.comment` (string)
    Any freeform note for the email, such as its purpose.
    Example: work email

  - `ReferenceList.PropertyDates.Email.preferredFormat` (string)
    Mime media type
    Example: text/html

  - `ReferenceList.PropertyDates.Email.optInDate` (string)
    The datetime of receiving the opt in notice
    Example: 2026-03-03T11:11:00Z

  - `ReferenceList.PropertyDates.Email.optOutDate` (string)
    The datetime the opt out notice was received
    Example: 2026-03-03T11:11:00Z

  - `ReferenceList.PropertyDates.Email.validInd` (boolean)
    If true, this is a valid email address that has been system verified via a successful email transmission.
    Example: true

  - `ReferenceList.PropertyDates.Email.provisionedInd` (boolean)
    If true then the email address came from the provisioning process
    Example: true

  - `CurrencyRateConversion` (array)

  - `CurrencyRateConversion.@type` (string)

  - `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.

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

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

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

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

  - `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.

  - `CurrencyRateConversion.ConversionRate.value` (number)

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

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

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

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

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

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

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

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

## Response 500:

  - `500` (unknown)
    Internal Server Error - 500

## Response 500 fields (application/json):

  - `@type` (string)
    Example: response

  - `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

  - `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

  - `correlationId` (string)
    Identifier used to correlate hotel API invocations across a multi-call business flows.
    Example: 49f58f5f-c443-43b4-9f5d-be405fd00a01

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

  - `Result` (object)
    Returns the error and/or warning message information, if applicable.
See [Error Messaging](https://developer.travelport.com/docs/flights/general/error-messaging) for additional details.

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

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

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

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

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

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

  - `Result.Error.NameValuePair` (array)

  - `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

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

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

  - `Result.Error.category` (string)
    A category to assist in identifying the error
    Example: VALIDATION

  - `Result.Error.SourceID` (string)
    The identifier of the source system sending the error or warning
    Example: 1G

  - `Result.Error.SourceCode` (string)
    The error or warning code returned by the source airline or host system
    Example: 1234

  - `Result.Error.SourceDescription` (string)
    The error or warning message as it is returned by the source airline or host system

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

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

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

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

  - `Result.Warning.NameValuePair` (array)

  - `Result.Warning.category` (string)
    A category to assist in identifying the error
    Example: INFORMATION

  - `Result.Warning.SourceID` (string)
    The identifier of the source system sending the error or warning
    Example: 1G

  - `Result.Warning.SourceCode` (string)
    The error or warning code returned by the source airline or host system
    Example: 1234

  - `Result.Warning.SourceDescription` (string)
    The error or warning message as it is returned by the source airline or host system

  - `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).

  - `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 system generated 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'.
- If not available, for Payment, any unique identifier can be sent.

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

  - `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

  - `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.

  - `NextSteps.baseURI` (string, required)
    The base portion of the URI in order to shorten the uris in the individual steps
    Example: www.travelport.com

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

  - `NextSteps.NextStep` (array, required)

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

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

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

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

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

  - `ReferenceList` (array)

  - `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

  - `ReferenceList.id` (string)
    Uniquely identifies for the Reference List
    Example: referenceList_001

  - `ReferenceList.PropertyDates` (array, required)

  - `ReferenceList.PropertyDates.@type` (string)

  - `ReferenceList.PropertyDates.availability` (string)
    Indicates whether the property has rooms available for the requested dates.
    Enum: "Open", "Close", "ClosedOnArrival", "ClosedOnArrivalOnRequest", "OnRequest", "RemoveCloseOnly", "Other"

  - `ReferenceList.PropertyDates.adaCompliant` (string)
    Yes , No , Unknown
    Enum: "Yes", "No", "Unknown"

  - `ReferenceList.PropertyDates.id` (string, required)
    Key to matching the common information in ReferenceList with an Offer; corresponds to the propertyDatesRef value in each Offer/Products/Product.

  - `ReferenceList.PropertyDates.moreRatesToken` (string)
    More rates token

  - `ReferenceList.PropertyDates.propertyName` (string)
    Name of property offering these products.

  - `ReferenceList.PropertyDates.PropertyAddress` (object)
    The property or billing address information.  
For Flights Add Traveler sending Address is optional, but when sent it must have the role set to 'Delivery' and include at least one of its objects, such as Number or City.

  - `ReferenceList.PropertyDates.PropertyAddress.@type` (string, required)
    Discriminator classes Address or AddressDetail
    Example: AddressDetail

  - `ReferenceList.PropertyDates.PropertyAddress.id` (string)
    unique address id
    Example: Address_1

  - `ReferenceList.PropertyDates.PropertyAddress.BldgRoom` (object)
    Address with building and room number

  - `ReferenceList.PropertyDates.PropertyAddress.BldgRoom.value` (string)
    Example: Moore House

  - `ReferenceList.PropertyDates.PropertyAddress.BldgRoom.buldingInd` (boolean)
    When true, the information is a building name. When false, it is an apartment or room #
    Example: true

  - `ReferenceList.PropertyDates.PropertyAddress.Number` (object)
    The street number alone is the numerical number that precedes the street name in the address.

  - `ReferenceList.PropertyDates.PropertyAddress.Number.value` (string)
    Street number value.
    Example: 23B

  - `ReferenceList.PropertyDates.PropertyAddress.Number.streetNmbrSuffix` (string)
    Street Number Suffix
    Example: B

  - `ReferenceList.PropertyDates.PropertyAddress.Number.streetDirection` (string)
    Direction of the Street
    Example: NW

  - `ReferenceList.PropertyDates.PropertyAddress.Number.ruralRouteNmbr` (string)
    RuralRoute Number
    Example: 76

  - `ReferenceList.PropertyDates.PropertyAddress.Number.po_Box` (string)
    PO Box Number
    Example: 1001

  - `ReferenceList.PropertyDates.PropertyAddress.Street` (string)
    Street name. May also contain the street number when the Number element is missing.
    Example: ABC Street

  - `ReferenceList.PropertyDates.PropertyAddress.AddressLine` (array)
    Property street address. Used in place of Street and Number. Each element of the array represents an address line.

  - `ReferenceList.PropertyDates.PropertyAddress.City` (string, required)
    Full name of the city, town, or postal station (i.e., a postal service territory, often used in a military address).
    Example: Dublin

  - `ReferenceList.PropertyDates.PropertyAddress.County` (string)
    County or Region Name.
    Example: Berkshire

  - `ReferenceList.PropertyDates.PropertyAddress.StateProv` (object)
    The standard code or abbreviation for the state, province, or region. May also include full length name.

  - `ReferenceList.PropertyDates.PropertyAddress.StateProv.value` (string)
    State, province, or region code needed to identify location (typically two characters).
    Example: CA

  - `ReferenceList.PropertyDates.PropertyAddress.StateProv.name` (string)
    State, province, or region name needed to identify location.
    Example: California

  - `ReferenceList.PropertyDates.PropertyAddress.Country` (object)
    Contains the information needed to identify a country.

  - `ReferenceList.PropertyDates.PropertyAddress.Country.value` (string)
    The ISO 3166 code for the property's address.
    Example: US

  - `ReferenceList.PropertyDates.PropertyAddress.Country.id` (string)
    Custom user-assigned identifier for the country.
    Example: 23

  - `ReferenceList.PropertyDates.PropertyAddress.Country.name` (string)
    The full name of the country for the property's address.
    Example: United States

  - `ReferenceList.PropertyDates.PropertyAddress.Country.codeContext` (string)
    The source of a code, such as the organization that provided the id number
    Example: IATA

  - `ReferenceList.PropertyDates.PropertyAddress.PostalCode` (string)
    Postal code for the address.
    Example: Sl6 1AB

  - `ReferenceList.PropertyDates.PropertyAddress.Addressee` (string)
    The name of the company or person to be addressed
    Example: ACME INC

  - `ReferenceList.PropertyDates.PropertyAddress.role` (string)
    Defines the type of location the address is assigned to. For TravelAgency address leave blank or use "Other".
    Enum: "Home", "Business", "Mailing", "Delivery", "Destination", "Other", "Billing"

  - `ReferenceList.PropertyDates.PropertyAddress.addressType` (string)
    OTA code for address type
    Example: CLT

  - `ReferenceList.PropertyDates.PropertyAddress.use` (string)
    OTA code for address use
    Example: AUT

  - `ReferenceList.PropertyDates.PropertyAddress.Comment` (object)
    Textual information.

  - `ReferenceList.PropertyDates.PropertyAddress.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

  - `ReferenceList.PropertyDates.PropertyAddress.Comment.id` (string)
    Local identifier within a given message for this object.
    Example: comment_1

  - `ReferenceList.PropertyDates.PropertyAddress.Comment.name` (string)
    Title of comment or type of remark.
    Example: Comment name

  - `ReferenceList.PropertyDates.PropertyAddress.Comment.language` (string)
    Language code using ISO-639 standard
    Example: EN

  - `ReferenceList.PropertyDates.PropertyAddress.Privacy` (object)
    Confidential details for marketing purpose

  - `ReferenceList.PropertyDates.PropertyAddress.Privacy.id` (string)
    Optional internally referenced id
    Example: 2

  - `ReferenceList.PropertyDates.PropertyAddress.Privacy.shareMarketing` (string)
    Used to indicate marketing preferences, Yes, No, Inherit
    Enum: "Yes", "No", "Inherit"

  - `ReferenceList.PropertyDates.PropertyAddress.Privacy.optInStatus` (string)
    Used to indicate marketing preferences, OptIn, OptOut
    Enum: "OptedIn", "OptedOut", "Unknown"

  - `ReferenceList.PropertyDates.PropertyAddress.Privacy.optInDate` (string)
    The datetime of receiving the opt in notice
    Example: 2026-08-07T12:12:00Z

  - `ReferenceList.PropertyDates.PropertyAddress.Privacy.optOutDate` (string)
    The datetime the opt out notice was received
    Example: 2026-08-07T12:12:00Z

  - `ReferenceList.PropertyDates.PropertyAddress.Priority` (integer)
    The priority ranking within the group
    Example: 1

  - `ReferenceList.PropertyDates.PropertyAddress.validInd` (boolean)
    If true, this is a valid and complete mailing address that has been verified through an address verification service or previously mailed materials have not been returned.
    Example: false

  - `ReferenceList.PropertyDates.PropertyAddress.provisionedInd` (boolean)
    If true, this address came into the system through provisioning
    Example: false

  - `ReferenceList.PropertyDates.PropertyKey` (object, required)
    Contains up to 250 PropertyKey objects. Each PropertyKey object identifies one property.

  - `ReferenceList.PropertyDates.PropertyKey.@type` (string)

  - `ReferenceList.PropertyDates.PropertyKey.chainCode` (string, required)
    Code for the hotel chain (typically 2 characters)
    Example: UR

  - `ReferenceList.PropertyDates.PropertyKey.propertyCode` (string, required)
    The property code of the requested property (typically 5 characters).
    Example: G3375

  - `ReferenceList.PropertyDates.DateRange` (object, required)
    Specifies the begin and end date of an event, such as check-in and check-out dates.

  - `ReferenceList.PropertyDates.DateRange.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

  - `ReferenceList.PropertyDates.DateRange.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

  - `ReferenceList.PropertyDates.GeoLocation` (object)
    For Hotel: the geographic coordinates of the property.

  - `ReferenceList.PropertyDates.GeoLocation.latitude` (number, required)
    Numeric value representing latitude of search center point in degrees and decimal minutes.
    Example: 38.8951

  - `ReferenceList.PropertyDates.GeoLocation.longitude` (number, required)
    Numeric value representing longitude of search center point in degrees and decimal minutes.
    Example: -77.0364

  - `ReferenceList.PropertyDates.GeoLocation.altitude` (number)
    The height of a location, typically measured above sea level
    Example: 5280

  - `ReferenceList.PropertyDates.GeoLocation.altitudeUnitOfDistance` (string)
    For Hotels: Optional object to request either miles or kilometers for the search radius from the specified location. If unitOfDistance is not specified, the search defaults to miles for properties in the United States, Myanmar, and Liberia. The search defaults to kilometers in all other countries.
    Enum: "Miles", "Kilometers"

  - `ReferenceList.PropertyDates.GeoLocation.positionAccuracy` (string)
    Specifies the level of accuracy for the position
    Enum: "Zip9Code", "Zip7Code", "Zip5Code", "Street", "State", "Property", "Intersection", "Exact", "County", "City", "Block"

  - `ReferenceList.PropertyDates.GeoLocation.mapURL` (string)
    link for embedded map showing location
    Example: www.destinationmap.com

  - `ReferenceList.PropertyDates.GeoLocation.formatURL` (string)
    The URL to the format for the latitude and longitude for this location.
    Example: www.destinationmap.com

  - `ReferenceList.PropertyDates.Telephone` (object)
    Phone information for contacting the relevant individual or agency.  
For Flights Add Traveler, NDC carriers typically require either an email address or phone number for booking. Recommended best practice is to provide both Email and Telephone for NDC.

  - `ReferenceList.PropertyDates.Telephone.@type` (string, required)
    Discriminator classes Telephone or TelephoneDetail
    Example: Telephone

  - `ReferenceList.PropertyDates.Telephone.countryAccessCode` (string)
    Phone country code
    Example: 1

  - `ReferenceList.PropertyDates.Telephone.areaCityCode` (string)
    Phone local area code
    Example: 972

  - `ReferenceList.PropertyDates.Telephone.phoneNumber` (string, required)
    Mobile/Telephone Number. Accepted characters are numeric, dash, space, and period.
    Example: 972-000-787

  - `ReferenceList.PropertyDates.Telephone.extension` (string)
    Telephone extension number
    Example: 234

  - `ReferenceList.PropertyDates.Telephone.id` (string)
    Optional custom user-assigned identifier for a phone number.
    Example: 3

  - `ReferenceList.PropertyDates.Telephone.cityCode` (string)
    IATA city code if referenced by phone number.
    Example: DEN

  - `ReferenceList.PropertyDates.Telephone.role` (string)
    Defines the type of location the Telephone is assigned to. For Travel Agency telephone select "Other" or leave blank.
    Enum: "Mobile", "Home", "Work", "Office", "Fax", "Other"

  - `ReferenceList.PropertyDates.Telephone.phoneLocationType` (string)
    Location of the phone
    Example: Agency

  - `ReferenceList.PropertyDates.Telephone.phoneTechType` (string)
    Indicates the type of technology associated with the telephone number
    Example: Voice

  - `ReferenceList.PropertyDates.Telephone.phoneUseType` (string)
    Agency code for how phone is used (e.g., Home, Business, Emergency Contact, Travel Arranger, Day, Evening).
    Example: Home

  - `ReferenceList.PropertyDates.Telephone.pin` (string)
    Additional codes used for telephone
    Example: 3456

  - `ReferenceList.PropertyDates.Telephone.priority` (integer)
    Priority
    Example: 1

  - `ReferenceList.PropertyDates.Telephone.defaultInd` (boolean)
    When true, indicates a default value should be used.
    Example: true

  - `ReferenceList.PropertyDates.Telephone.provisionedInd` (boolean)
    true indicates this phone number was created through provisioned
    Example: false

  - `ReferenceList.PropertyDates.Email` (object)
    Electronic email addresses, in IETF specified format.  
Booking.com requires a traveler email address in the Hotel Create Reservation and Add Reservation requests. A system-generated confirmation email is sent to the traveler after the booking completes.
For Flights Add Traveler, NDC carriers typically require either an email address or phone number for booking. Recommended best practice is to provide both Email and Telephone for NDC.

  - `ReferenceList.PropertyDates.Email.value` (string)
    The email address.
    Example: exampledomain@example.com

  - `ReferenceList.PropertyDates.Email.id` (string)
    Electronic email addresses, in IETF specified format.
    Example: email_1

  - `ReferenceList.PropertyDates.Email.emailType` (string)
    Use email type to specify if the email is to be sent "TO" or sent "FROM"
    Example: FROM

  - `ReferenceList.PropertyDates.Email.comment` (string)
    Any freeform note for the email, such as its purpose.
    Example: work email

  - `ReferenceList.PropertyDates.Email.preferredFormat` (string)
    Mime media type
    Example: text/html

  - `ReferenceList.PropertyDates.Email.optInDate` (string)
    The datetime of receiving the opt in notice
    Example: 2026-03-03T11:11:00Z

  - `ReferenceList.PropertyDates.Email.optOutDate` (string)
    The datetime the opt out notice was received
    Example: 2026-03-03T11:11:00Z

  - `ReferenceList.PropertyDates.Email.validInd` (boolean)
    If true, this is a valid email address that has been system verified via a successful email transmission.
    Example: true

  - `ReferenceList.PropertyDates.Email.provisionedInd` (boolean)
    If true then the email address came from the provisioning process
    Example: true

  - `CurrencyRateConversion` (array)

  - `CurrencyRateConversion.@type` (string)

  - `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.

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

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

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

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

  - `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.

  - `CurrencyRateConversion.ConversionRate.value` (number)

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

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

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

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

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

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

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

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