--- title: "Update a Reservation" method: PUT path: "/air/book/reservation/reservations/{Identifier}" tags: ["Deprecated"] deprecated: true --- # Update a Reservation `PUT /air/book/reservation/reservations/{Identifier}` > **Deprecated.** ## Path parameters - `Identifier` string, required ## Headers - `TraceId` string - `XAUTH_TRAVELPORT_ACCESSGROUP` string - `travelportPlusSessionIdentifier` string - `TVP-PCC-Core` string ## Request body - ReservationDetailWrapper — Wrapper schema to expose the name of the top level schema in the JSON example - `ReservationDetail` ReservationDetail — Empty container to request workbench ID. - `@type` string, required — Discriminator classes ReservationID, Reservation, or ReservationDetail - `id` string — Internal identifier for the response. - `Identifier` Identifier — 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). - `value` string — Unique offer identifier that can be sent in subsequent payload requests to reference this offer. When used for reference flight calls, the CatalogProductOfferingsIdentifier will be the transaction identifier from the Search, Next Leg Search, or Flight Specific Search response in CatalogProductOfferings/Identifier/value. If you choose to pull the CatalogProductOfferingsIdentifier from the Price response instead (OfferListResponse/Identifier/value), either full or reference payload, please note for subsequent Add Offer requests you must remove the _PC appended to the end of the value in the AirPrice response (e.g., change value: '93d2091d-3d04-48ab-8091-6ae1525f02ea_PC' to value: '93d2091d-3d04-48ab-8091-6ae1525f02ea'). When building an AirPrice or Add Offer reference payload request: - Look for the CatalogProductOfferingIdentifier (ex: o1) in a Search response at CatalogProductOfferings/CatalogProductOffering/id or a Price response at OfferListResponse/OfferID/id. - Look for the ProductIdentifier (ex: p0) in a Search response at CatalogProductOfferings/CatalogProductOffering/ProductBrandOptions/ProductBrandOffering/Product/productRef or from a Price response at OfferListResponse/OfferID/Product/id. When returned from a Workbench, this value is the workbench identifier that must be sent in all subsequent requests for this workbench session. When returned from Air Exchange Eligibility, value is the ticket number sent with the eligibility request. When used specifically for form of payment, the value will begin with the characters 'FOP'. Similarly, the OfferIdentifier associated will begin with the character 'O'. For Hotel Create Reservation (Reference Payload), send the value from the Availability response in CatalogOffering/id or the value from SearchComplete returned in propertyItems/lowestPublicAvailableRate/rateKey/value. Results from Hotel Availability and Hotel SearchComplete are stored in the cache for 30 minutes. If the offers expire before booking, you must send a new request. - `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. - `Offer` 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. - `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. - `offerRef` string — Used to reference another instance of this object in the same message - `Identifier` Identifier — 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). - `value` string — Unique offer identifier that can be sent in subsequent payload requests to reference this offer. When used for reference flight calls, the CatalogProductOfferingsIdentifier will be the transaction identifier from the Search, Next Leg Search, or Flight Specific Search response in CatalogProductOfferings/Identifier/value. If you choose to pull the CatalogProductOfferingsIdentifier from the Price response instead (OfferListResponse/Identifier/value), either full or reference payload, please note for subsequent Add Offer requests you must remove the _PC appended to the end of the value in the AirPrice response (e.g., change value: '93d2091d-3d04-48ab-8091-6ae1525f02ea_PC' to value: '93d2091d-3d04-48ab-8091-6ae1525f02ea'). When building an AirPrice or Add Offer reference payload request: - Look for the CatalogProductOfferingIdentifier (ex: o1) in a Search response at CatalogProductOfferings/CatalogProductOffering/id or a Price response at OfferListResponse/OfferID/id. - Look for the ProductIdentifier (ex: p0) in a Search response at CatalogProductOfferings/CatalogProductOffering/ProductBrandOptions/ProductBrandOffering/Product/productRef or from a Price response at OfferListResponse/OfferID/Product/id. When returned from a Workbench, this value is the workbench identifier that must be sent in all subsequent requests for this workbench session. When returned from Air Exchange Eligibility, value is the ticket number sent with the eligibility request. When used specifically for form of payment, the value will begin with the characters 'FOP'. Similarly, the OfferIdentifier associated will begin with the character 'O'. For Hotel Create Reservation (Reference Payload), send the value from the Availability response in CatalogOffering/id or the value from SearchComplete returned in propertyItems/lowestPublicAvailableRate/rateKey/value. Results from Hotel Availability and Hotel SearchComplete are stored in the cache for 30 minutes. If the offers expire before booking, you must send a new request. - `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. - `ContentSource` 'GDS' | 'NDC' | 'LCC' | 'API' — Indicates the owner the offer or document. - `parentOfferRef` string — A reference to the Offer this offer is sold in conjunction with - `offerModifyRef` string — Reference to the new Offer created as a result of this Offer being subject to a schedule change. - `Product` ProductID[], required — Lists the flight or flights for one leg of the itinerary. Repeats for additional leg or legs. - `@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. - `id` string — Local id within a given message to support referencing this object. - `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. - `Identifier` Identifier — 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). - `value` string — Unique offer identifier that can be sent in subsequent payload requests to reference this offer. When used for reference flight calls, the CatalogProductOfferingsIdentifier will be the transaction identifier from the Search, Next Leg Search, or Flight Specific Search response in CatalogProductOfferings/Identifier/value. If you choose to pull the CatalogProductOfferingsIdentifier from the Price response instead (OfferListResponse/Identifier/value), either full or reference payload, please note for subsequent Add Offer requests you must remove the _PC appended to the end of the value in the AirPrice response (e.g., change value: '93d2091d-3d04-48ab-8091-6ae1525f02ea_PC' to value: '93d2091d-3d04-48ab-8091-6ae1525f02ea'). When building an AirPrice or Add Offer reference payload request: - Look for the CatalogProductOfferingIdentifier (ex: o1) in a Search response at CatalogProductOfferings/CatalogProductOffering/id or a Price response at OfferListResponse/OfferID/id. - Look for the ProductIdentifier (ex: p0) in a Search response at CatalogProductOfferings/CatalogProductOffering/ProductBrandOptions/ProductBrandOffering/Product/productRef or from a Price response at OfferListResponse/OfferID/Product/id. When returned from a Workbench, this value is the workbench identifier that must be sent in all subsequent requests for this workbench session. When returned from Air Exchange Eligibility, value is the ticket number sent with the eligibility request. When used specifically for form of payment, the value will begin with the characters 'FOP'. Similarly, the OfferIdentifier associated will begin with the character 'O'. For Hotel Create Reservation (Reference Payload), send the value from the Availability response in CatalogOffering/id or the value from SearchComplete returned in propertyItems/lowestPublicAvailableRate/rateKey/value. Results from Hotel Availability and Hotel SearchComplete are stored in the cache for 30 minutes. If the offers expire before booking, you must send a new request. - `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. - `Price` Price, 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. - `@type` string, required — Discriminator classes Price or PriceDetail - `id` string — Internally referenced id - `CurrencyCode` CurrencyCode — 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. - `value` string — An ISO 4217 currency code. - `codeAuthority` string — Currency code authority - `decimalPlace` integer — Number of decimal places for the currency. - `decimalAuthority` string — Currency code decimal authority - `Base` number, float — Base price before taxes and fees. For Hotel, may not be returned by all suppliers. - `TotalTaxes` number, float — Total taxes applied to the base price. For Hotel, may not be returned by all suppliers. - `TotalFees` number, float — Total fees included in Total Price. - `TotalPrice` number, float — Total price of this offer including the base price and all taxes and fees. - `VendorCurrencyTotal` VendorCurrencyTotal — No longer used. Previously used to expose the local vendor currency when it is different to the purchased currency - `@type` string - `currencySource` 'Supplier' | 'Charged' | 'Requested' — The system requesting or returning the currency code specified in the attribute - `CurrencyCode` CurrencyCode — 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. - `value` string — An ISO 4217 currency code. - `codeAuthority` string — Currency code authority - `decimalPlace` integer — Number of decimal places for the currency. - `decimalAuthority` string — Currency code decimal authority - `Base` number, float — The price prior to all applicable taxes of a product such as the rate for a room or fare for a flight. - `Taxes` Taxes — Summary of all individual taxes. Child class TaxesDetail provides the breakdown of individual taxes. - `@type` string, required — Discriminator class is TaxesDetail - `TotalTaxes` number, float — A monetary amount, representing the total of all taxes included in this offer. Supports up to 4 decimal places; decimal place must be included. - `TaxInfo` TaxInfo[] — Returned for TripChange APIS only. - … - `Fees` Fees — 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. - `@type` string, required — Discriminator. Child class FeesDetail - `TotalFees` number, float — Total fees included in the TotalPrice. Supports up to 4 decimal places; decimal place needs to be included. - `TotalAdditionalFeesPayableLocally` number, float — Fees due separately at the property. Expected to be paid in local currency. These fees are not included in the Offer TotalPrice. - `Total` number, float — Specifies the total price including base + taxes + fees - `approximateInd` boolean — True if this amount has been converted from the original amount - `TermsAndConditionsFull` TermsAndConditionsFullID[] — 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. - `@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. - `id` string — Local identifier within a given message for this object. - `termsAndConditionsRef` string — Used to reference another instance of this object in the same message. - `Identifier` Identifier — 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). - `value` string — Unique offer identifier that can be sent in subsequent payload requests to reference this offer. When used for reference flight calls, the CatalogProductOfferingsIdentifier will be the transaction identifier from the Search, Next Leg Search, or Flight Specific Search response in CatalogProductOfferings/Identifier/value. If you choose to pull the CatalogProductOfferingsIdentifier from the Price response instead (OfferListResponse/Identifier/value), either full or reference payload, please note for subsequent Add Offer requests you must remove the _PC appended to the end of the value in the AirPrice response (e.g., change value: '93d2091d-3d04-48ab-8091-6ae1525f02ea_PC' to value: '93d2091d-3d04-48ab-8091-6ae1525f02ea'). When building an AirPrice or Add Offer reference payload request: - Look for the CatalogProductOfferingIdentifier (ex: o1) in a Search response at CatalogProductOfferings/CatalogProductOffering/id or a Price response at OfferListResponse/OfferID/id. - Look for the ProductIdentifier (ex: p0) in a Search response at CatalogProductOfferings/CatalogProductOffering/ProductBrandOptions/ProductBrandOffering/Product/productRef or from a Price response at OfferListResponse/OfferID/Product/id. When returned from a Workbench, this value is the workbench identifier that must be sent in all subsequent requests for this workbench session. When returned from Air Exchange Eligibility, value is the ticket number sent with the eligibility request. When used specifically for form of payment, the value will begin with the characters 'FOP'. Similarly, the OfferIdentifier associated will begin with the character 'O'. For Hotel Create Reservation (Reference Payload), send the value from the Availability response in CatalogOffering/id or the value from SearchComplete returned in propertyItems/lowestPublicAvailableRate/rateKey/value. Results from Hotel Availability and Hotel SearchComplete are stored in the cache for 30 minutes. If the offers expire before booking, you must send a new request. - `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. - `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. - `scheduleChangeInd` boolean — If true, this Offer is subject to a schedule change. - `Traveler` Traveler[] - `@type` string, required — Discriminator classes TravelerID or Traveler - `id` string - `TravelerRef` string - `Identifier` Identifier — 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). - `value` string — Unique offer identifier that can be sent in subsequent payload requests to reference this offer. When used for reference flight calls, the CatalogProductOfferingsIdentifier will be the transaction identifier from the Search, Next Leg Search, or Flight Specific Search response in CatalogProductOfferings/Identifier/value. If you choose to pull the CatalogProductOfferingsIdentifier from the Price response instead (OfferListResponse/Identifier/value), either full or reference payload, please note for subsequent Add Offer requests you must remove the _PC appended to the end of the value in the AirPrice response (e.g., change value: '93d2091d-3d04-48ab-8091-6ae1525f02ea_PC' to value: '93d2091d-3d04-48ab-8091-6ae1525f02ea'). When building an AirPrice or Add Offer reference payload request: - Look for the CatalogProductOfferingIdentifier (ex: o1) in a Search response at CatalogProductOfferings/CatalogProductOffering/id or a Price response at OfferListResponse/OfferID/id. - Look for the ProductIdentifier (ex: p0) in a Search response at CatalogProductOfferings/CatalogProductOffering/ProductBrandOptions/ProductBrandOffering/Product/productRef or from a Price response at OfferListResponse/OfferID/Product/id. When returned from a Workbench, this value is the workbench identifier that must be sent in all subsequent requests for this workbench session. When returned from Air Exchange Eligibility, value is the ticket number sent with the eligibility request. When used specifically for form of payment, the value will begin with the characters 'FOP'. Similarly, the OfferIdentifier associated will begin with the character 'O'. For Hotel Create Reservation (Reference Payload), send the value from the Availability response in CatalogOffering/id or the value from SearchComplete returned in propertyItems/lowestPublicAvailableRate/rateKey/value. Results from Hotel Availability and Hotel SearchComplete are stored in the cache for 30 minutes. If the offers expire before booking, you must send a new request. - `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. - `birthDate` string, date — 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. - `gender` 'Male' | 'Female' | 'Unknown' | 'Undisclosed' — 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. - `PersonName` PersonName, 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. - `@type` string, required — Discriminator classes PersonName or PersonNameDetail - `Prefix` string — Salutation of honorific (e.g. Mr., Mrs., Ms., Miss, Dr.) - `Given` string — Traveler first or given name. - `Middle` string — Traveler middle name. - `Surname` string, required — Traveler last name or surname. - `Address` Address[] - `@type` string, required — Discriminator classes Address or AddressDetail - `id` string — unique address id - `BldgRoom` AddressBldgRoom — Address with building and room number - `value` string - `buldingInd` boolean — When true, the information is a building name. When false, it is an apartment or room # - `Number` AddressStreetNumber — The street number alone is the numerical number that precedes the street name in the address. - `value` string — Street number value. - `streetNmbrSuffix` string — Street Number Suffix - `streetDirection` string — Direction of the Street - `ruralRouteNmbr` string — RuralRoute Number - `po_Box` string — PO Box Number - `Street` string — Street name. May also contain the street number when the Number element is missing. - `AddressLine` string[] — Property street address. Used in place of Street and Number. Each element of the array represents an address line. - `City` string, required — Full name of the city, town, or postal station (i.e., a postal service territory, often used in a military address). - `County` string — County or Region Name. - `StateProv` StateProv — The standard code or abbreviation for the state, province, or region. May also include full length name. - `value` string — State, province, or region code needed to identify location (typically two characters). - `name` string — State, province, or region name needed to identify location. - `Country` Country — Contains the information needed to identify a country. - `value` string — The ISO 3166 code for the property's address. - `id` string — Custom user-assigned identifier for the country. - `name` string — The full name of the country for the property's address. - `codeContext` string — The source of a code, such as the organization that provided the id number - `PostalCode` string — Postal code for the address. - `Addressee` string — The name of the company or person to be addressed - `role` 'Home' | 'Business' | 'Mailing' | 'Delivery' | 'Destination' | 'Other' | 'Billing' — Defines the type of location the address is assigned to. For TravelAgency address leave blank or use "Other". - `Telephone` Telephone[] - `@type` string, required — Discriminator classes Telephone or TelephoneDetail - `countryAccessCode` string — Phone country code - `areaCityCode` string — Phone local area code - `phoneNumber` string, required — Mobile/Telephone Number. Accepted characters are numeric, dash, space, and period. - `extension` string — Telephone extension number - `id` string — Optional custom user-assigned identifier for a phone number. - `cityCode` string — IATA city code if referenced by phone number. - `role` 'Mobile' | 'Home' | 'Work' | 'Office' | 'Fax' | 'Other' — Defines the type of location the Telephone is assigned to. For Travel Agency telephone select "Other" or leave blank. - `Email` Email[] - `value` string — The email address. - `id` string — Electronic email addresses, in IETF specified format. - `emailType` string — Use email type to specify if the email is to be sent "TO" or sent "FROM" - `comment` string — Any freeform note for the email, such as its purpose. - `preferredFormat` string — Mime media type - `shareMarketing` 'Yes' | 'No' | 'Inherit' — Used to indicate marketing preferences, Yes, No, Inherit - `shareSync` 'Yes' | 'No' | 'Inherit' — Used to indicate marketing preferences, Yes, No, Inherit - `optOutInd` 'Yes' | 'No' | 'Inherit' — Used to indicate marketing preferences, Yes, No, Inherit - `optInStatus` 'OptedIn' | 'OptedOut' | 'Unknown' — Used to indicate marketing preferences, OptIn, OptOut - `optInDate` string, date-time — The datetime of receiving the opt in notice - `optOutDate` string, date-time — The datetime the opt out notice was received - `validInd` boolean — If true, this is a valid email address that has been system verified via a successful email transmission. - `provisionedInd` boolean — If true then the email address came from the provisioning process - `passengerTypeCode` string — Passenger type code (PTC) for this traveler. - `nationality` string — Nationality on country code ISO - `age` integer — The age of the traveller at the time of travel - `CustomerLoyalty` CustomerLoyalty[] - `value` string, required — Number on loyalty card. - `id` string — Optional Customer Loyalty Id. Not saved - `priority` integer — Optional Numeric Priority Code - `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. - `programName` string — Supplier's loyalty program name. - `supplierType` string — The type of supplier of a loyalty program. Uses 'hotel' for frequent guest number or 'air' for frequent flyer number. - `supplier` string — Supplier of a loyalty program (typically 2 characters representing the hotel, brand, or airline). - `tier` string — Customer Loyalty tier - `shareWithSupplier` string[] — 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. - `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 - `validatedInd` boolean — Customer loyalty number has been validated by the supplier - `prefix` string — The cardholder name prefix title like Mr, Mrs, Dr - `given` string — The First Name of the Cardholder - `middle` string — Middle Name of the Cardholder - `surname` string — Last Name of the Cardholder - `AlternateContact` AlternateContact[] - `@type` string - `id` string - `contactType` string — Contact type value - `relation` string — Relation value - `PersonName` PersonName, 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. - `@type` string, required — Discriminator classes PersonName or PersonNameDetail - `Prefix` string — Salutation of honorific (e.g. Mr., Mrs., Ms., Miss, Dr.) - `Given` string — Traveler first or given name. - `Middle` string — Traveler middle name. - `Surname` string, required — Traveler last name or surname. - `Address` Address[] - `@type` string, required — Discriminator classes Address or AddressDetail - `id` string — unique address id - `BldgRoom` AddressBldgRoom — Address with building and room number - `value` string - `buldingInd` boolean — When true, the information is a building name. When false, it is an apartment or room # - `Number` AddressStreetNumber — The street number alone is the numerical number that precedes the street name in the address. - `value` string — Street number value. - `streetNmbrSuffix` string — Street Number Suffix - `streetDirection` string — Direction of the Street - `ruralRouteNmbr` string — RuralRoute Number - `po_Box` string — PO Box Number - `Street` string — Street name. May also contain the street number when the Number element is missing. - `AddressLine` string[] — Property street address. Used in place of Street and Number. Each element of the array represents an address line. - `City` string, required — Full name of the city, town, or postal station (i.e., a postal service territory, often used in a military address). - `County` string — County or Region Name. - `StateProv` StateProv — The standard code or abbreviation for the state, province, or region. May also include full length name. - `value` string — State, province, or region code needed to identify location (typically two characters). - `name` string — State, province, or region name needed to identify location. - `Country` Country — Contains the information needed to identify a country. - `value` string — The ISO 3166 code for the property's address. - `id` string — Custom user-assigned identifier for the country. - `name` string — The full name of the country for the property's address. - `codeContext` string — The source of a code, such as the organization that provided the id number - `PostalCode` string — Postal code for the address. - `Addressee` string — The name of the company or person to be addressed - `role` 'Home' | 'Business' | 'Mailing' | 'Delivery' | 'Destination' | 'Other' | 'Billing' — Defines the type of location the address is assigned to. For TravelAgency address leave blank or use "Other". - `Telephone` Telephone[] - `@type` string, required — Discriminator classes Telephone or TelephoneDetail - `countryAccessCode` string — Phone country code - `areaCityCode` string — Phone local area code - `phoneNumber` string, required — Mobile/Telephone Number. Accepted characters are numeric, dash, space, and period. - `extension` string — Telephone extension number - `id` string — Optional custom user-assigned identifier for a phone number. - `cityCode` string — IATA city code if referenced by phone number. - `role` 'Mobile' | 'Home' | 'Work' | 'Office' | 'Fax' | 'Other' — Defines the type of location the Telephone is assigned to. For Travel Agency telephone select "Other" or leave blank. - `Email` Email[] - `value` string — The email address. - `id` string — Electronic email addresses, in IETF specified format. - `emailType` string — Use email type to specify if the email is to be sent "TO" or sent "FROM" - `comment` string — Any freeform note for the email, such as its purpose. - `preferredFormat` string — Mime media type - `shareMarketing` 'Yes' | 'No' | 'Inherit' — Used to indicate marketing preferences, Yes, No, Inherit - `shareSync` 'Yes' | 'No' | 'Inherit' — Used to indicate marketing preferences, Yes, No, Inherit - `optOutInd` 'Yes' | 'No' | 'Inherit' — Used to indicate marketing preferences, Yes, No, Inherit - `optInStatus` 'OptedIn' | 'OptedOut' | 'Unknown' — Used to indicate marketing preferences, OptIn, OptOut - `optInDate` string, date-time — The datetime of receiving the opt in notice - `optOutDate` string, date-time — The datetime the opt out notice was received - `validInd` boolean — If true, this is a valid email address that has been system verified via a successful email transmission. - `provisionedInd` boolean — If true then the email address came from the provisioning process - `emergencyInd` boolean — This is the contact in case of an emergency - `defaultInd` boolean — This is the default contact - `TravelDocument` TravelDocument[] - `@type` string, required — Discriminator classes TravelDocument or TravelDocumentDetail - `docNumber` string — Travel document number. - `docType` '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' — Supported Travel Document types - `issueDate` string, date — Issue date of document. Required for a visa - `expireDate` string, date — Expiration date of document. Required for a visa. - `stateProvCode` string — State Province Code value - `placeOfIssue` string — Place of issue value - `issueCountry` string — Issuing country of document; ISO3166 standard format. - `birthDate` string, date — The date of birth of the document holder in YYYY-MM-DD format. - `birthCountry` string — Country of birth of the document holder in ISO3166 standard format. - `birthPlace` string — Birth place value - `residence` string — Residence value - `id` string — Locally referenced id - `Gender` 'Male' | 'Female' | 'Unknown' | 'Undisclosed', required — 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. - `Nationality` string — Birth country as noted on document; specifies a 2 character country code as defined in ISO3166. - `PersonName` PersonName, 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. - `@type` string, required — Discriminator classes PersonName or PersonNameDetail - `Prefix` string — Salutation of honorific (e.g. Mr., Mrs., Ms., Miss, Dr.) - `Given` string — Traveler first or given name. - `Middle` string — Traveler middle name. - `Surname` string, required — Traveler last name or surname. - `Comments` Comments — 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. - `@type` string - `Comment` 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. - `id` string — Local identifier within a given message for this object. - `name` string — Title of comment or type of remark. - `language` string — Language code using ISO-639 standard - `RailDiscountCard` RailDiscountCard[] - `value` string - `supplierCode` string, required — Code of the Supplier - `referenceNumber` string — ReferenceNumber - `accompaniedByInfantInd` boolean - `TravelerProduct` TravelerProduct[] - `@type` string, required — Discriminator classes TravelerProductID or TravelerProduct - `id` string - `TravelerRef` string — Traveler reference number associated with offer in OfferRef. - `OfferRef` string — Offer reference number associated with traveler in TravelerRef. - `ProductRef` string — A pointer to the product id - `ConfirmationStatusEnum` 'Pending' | 'Confirmed' | 'Cancelled' | 'Rejected' | 'Requested' — Status returned in a response for a two or more phase commitment process - `UnpricedFlightSegmentRefs` string[] — References the flight segment/s within UnpricedSegments that are associated to this Traveler. - `FormOfPayment` FormOfPaymentID[] - `@type` string, required — Discriminator classes FormOfPaymentID, FormOfPaymentBSP, FormOfPaymentCash, FormOfPaymentCheck, FormOfPaymentDocument, FormOfPaymentFlightPass, FormOfPaymentForfeit, FormOfPaymentInvoice, FormOfPaymentPaymentCard, FormOfPaymentVirtualPaymentAccount, FormOfPaymentWaiverCode - `id` string — Form of Payment reference ID. - `FormOfPaymentRef` string - `Identifier` Identifier — 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). - `value` string — Unique offer identifier that can be sent in subsequent payload requests to reference this offer. When used for reference flight calls, the CatalogProductOfferingsIdentifier will be the transaction identifier from the Search, Next Leg Search, or Flight Specific Search response in CatalogProductOfferings/Identifier/value. If you choose to pull the CatalogProductOfferingsIdentifier from the Price response instead (OfferListResponse/Identifier/value), either full or reference payload, please note for subsequent Add Offer requests you must remove the _PC appended to the end of the value in the AirPrice response (e.g., change value: '93d2091d-3d04-48ab-8091-6ae1525f02ea_PC' to value: '93d2091d-3d04-48ab-8091-6ae1525f02ea'). When building an AirPrice or Add Offer reference payload request: - Look for the CatalogProductOfferingIdentifier (ex: o1) in a Search response at CatalogProductOfferings/CatalogProductOffering/id or a Price response at OfferListResponse/OfferID/id. - Look for the ProductIdentifier (ex: p0) in a Search response at CatalogProductOfferings/CatalogProductOffering/ProductBrandOptions/ProductBrandOffering/Product/productRef or from a Price response at OfferListResponse/OfferID/Product/id. When returned from a Workbench, this value is the workbench identifier that must be sent in all subsequent requests for this workbench session. When returned from Air Exchange Eligibility, value is the ticket number sent with the eligibility request. When used specifically for form of payment, the value will begin with the characters 'FOP'. Similarly, the OfferIdentifier associated will begin with the character 'O'. For Hotel Create Reservation (Reference Payload), send the value from the Availability response in CatalogOffering/id or the value from SearchComplete returned in propertyItems/lowestPublicAvailableRate/rateKey/value. Results from Hotel Availability and Hotel SearchComplete are stored in the cache for 30 minutes. If the offers expire before booking, you must send a new request. - `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. - `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. - `activeInd` boolean — Deprecated. Will not implement. - `Payment` Payment[] - `@type` string, required — Discriminator classes PaymentID or Payment - `id` string — Customer-assigned identifier for the payment. - `PaymentRef` string — Customer-assigned name for the payment. - `Identifier` Identifier — 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). - `value` string — Unique offer identifier that can be sent in subsequent payload requests to reference this offer. When used for reference flight calls, the CatalogProductOfferingsIdentifier will be the transaction identifier from the Search, Next Leg Search, or Flight Specific Search response in CatalogProductOfferings/Identifier/value. If you choose to pull the CatalogProductOfferingsIdentifier from the Price response instead (OfferListResponse/Identifier/value), either full or reference payload, please note for subsequent Add Offer requests you must remove the _PC appended to the end of the value in the AirPrice response (e.g., change value: '93d2091d-3d04-48ab-8091-6ae1525f02ea_PC' to value: '93d2091d-3d04-48ab-8091-6ae1525f02ea'). When building an AirPrice or Add Offer reference payload request: - Look for the CatalogProductOfferingIdentifier (ex: o1) in a Search response at CatalogProductOfferings/CatalogProductOffering/id or a Price response at OfferListResponse/OfferID/id. - Look for the ProductIdentifier (ex: p0) in a Search response at CatalogProductOfferings/CatalogProductOffering/ProductBrandOptions/ProductBrandOffering/Product/productRef or from a Price response at OfferListResponse/OfferID/Product/id. When returned from a Workbench, this value is the workbench identifier that must be sent in all subsequent requests for this workbench session. When returned from Air Exchange Eligibility, value is the ticket number sent with the eligibility request. When used specifically for form of payment, the value will begin with the characters 'FOP'. Similarly, the OfferIdentifier associated will begin with the character 'O'. For Hotel Create Reservation (Reference Payload), send the value from the Availability response in CatalogOffering/id or the value from SearchComplete returned in propertyItems/lowestPublicAvailableRate/rateKey/value. Results from Hotel Availability and Hotel SearchComplete are stored in the cache for 30 minutes. If the offers expire before booking, you must send a new request. - `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. - `Amount` CurrencyAmount, required — A monetary amount, up to 4 decimal places. Decimal place must be included. - `value` number, float — The amount of a given currency. - `code` string — An ISO 4217 alpha character code (3 characters) that specifies a money unit. - `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. - `currencySource` 'Supplier' | 'Charged' | 'Requested' — The system requesting or returning the currency code specified in the attribute - `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. - `FormOfPaymentIdentifier` FormOfPaymentIdentifier — The Travelport-assigned identifier for the FOP used for purchase. - `@type` string - `id` string — Form of payment identifier reference ID. - `FormOfPaymentRef` string - `Identifier` Identifier — 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). - `value` string — Unique offer identifier that can be sent in subsequent payload requests to reference this offer. When used for reference flight calls, the CatalogProductOfferingsIdentifier will be the transaction identifier from the Search, Next Leg Search, or Flight Specific Search response in CatalogProductOfferings/Identifier/value. If you choose to pull the CatalogProductOfferingsIdentifier from the Price response instead (OfferListResponse/Identifier/value), either full or reference payload, please note for subsequent Add Offer requests you must remove the _PC appended to the end of the value in the AirPrice response (e.g., change value: '93d2091d-3d04-48ab-8091-6ae1525f02ea_PC' to value: '93d2091d-3d04-48ab-8091-6ae1525f02ea'). When building an AirPrice or Add Offer reference payload request: - Look for the CatalogProductOfferingIdentifier (ex: o1) in a Search response at CatalogProductOfferings/CatalogProductOffering/id or a Price response at OfferListResponse/OfferID/id. - Look for the ProductIdentifier (ex: p0) in a Search response at CatalogProductOfferings/CatalogProductOffering/ProductBrandOptions/ProductBrandOffering/Product/productRef or from a Price response at OfferListResponse/OfferID/Product/id. When returned from a Workbench, this value is the workbench identifier that must be sent in all subsequent requests for this workbench session. When returned from Air Exchange Eligibility, value is the ticket number sent with the eligibility request. When used specifically for form of payment, the value will begin with the characters 'FOP'. Similarly, the OfferIdentifier associated will begin with the character 'O'. For Hotel Create Reservation (Reference Payload), send the value from the Availability response in CatalogOffering/id or the value from SearchComplete returned in propertyItems/lowestPublicAvailableRate/rateKey/value. Results from Hotel Availability and Hotel SearchComplete are stored in the cache for 30 minutes. If the offers expire before booking, you must send a new request. - `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. - `activeInd` boolean — If true, this form of payment will be used for document issuance and override any other form of payment in the reservation. - `OfferIdentifier` OfferIdentifier[] - `id` string — Local identifier within a given message for this object. - `offerRef` string — Used to reference another instance of this object in the same message - `Identifier` Identifier — 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). - `value` string — Unique offer identifier that can be sent in subsequent payload requests to reference this offer. When used for reference flight calls, the CatalogProductOfferingsIdentifier will be the transaction identifier from the Search, Next Leg Search, or Flight Specific Search response in CatalogProductOfferings/Identifier/value. If you choose to pull the CatalogProductOfferingsIdentifier from the Price response instead (OfferListResponse/Identifier/value), either full or reference payload, please note for subsequent Add Offer requests you must remove the _PC appended to the end of the value in the AirPrice response (e.g., change value: '93d2091d-3d04-48ab-8091-6ae1525f02ea_PC' to value: '93d2091d-3d04-48ab-8091-6ae1525f02ea'). When building an AirPrice or Add Offer reference payload request: - Look for the CatalogProductOfferingIdentifier (ex: o1) in a Search response at CatalogProductOfferings/CatalogProductOffering/id or a Price response at OfferListResponse/OfferID/id. - Look for the ProductIdentifier (ex: p0) in a Search response at CatalogProductOfferings/CatalogProductOffering/ProductBrandOptions/ProductBrandOffering/Product/productRef or from a Price response at OfferListResponse/OfferID/Product/id. When returned from a Workbench, this value is the workbench identifier that must be sent in all subsequent requests for this workbench session. When returned from Air Exchange Eligibility, value is the ticket number sent with the eligibility request. When used specifically for form of payment, the value will begin with the characters 'FOP'. Similarly, the OfferIdentifier associated will begin with the character 'O'. For Hotel Create Reservation (Reference Payload), send the value from the Availability response in CatalogOffering/id or the value from SearchComplete returned in propertyItems/lowestPublicAvailableRate/rateKey/value. Results from Hotel Availability and Hotel SearchComplete are stored in the cache for 30 minutes. If the offers expire before booking, you must send a new request. - `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. - `Fees` Fees — 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. - `@type` string, required — Discriminator. Child class FeesDetail - `TotalFees` number, float — Total fees included in the TotalPrice. Supports up to 4 decimal places; decimal place needs to be included. - `TotalAdditionalFeesPayableLocally` number, float — Fees due separately at the property. Expected to be paid in local currency. These fees are not included in the Offer TotalPrice. - `Taxes` Taxes — Summary of all individual taxes. Child class TaxesDetail provides the breakdown of individual taxes. - `@type` string, required — Discriminator class is TaxesDetail - `TotalTaxes` number, float — A monetary amount, representing the total of all taxes included in this offer. Supports up to 4 decimal places; decimal place must be included. - `TaxInfo` TaxInfo[] — Returned for TripChange APIS only. - `@type` string - `TaxCode` string, required — The tax code - `CurrencyCode` CurrencyCode — 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. - `value` string — An ISO 4217 currency code. - `codeAuthority` string — Currency code authority - `decimalPlace` integer — Number of decimal places for the currency. - `decimalAuthority` string — Currency code decimal authority - `Amount` number, float, required — The amount of the tax applied - `TaxBreakdown` TaxBreakdown[], required — The breakdown of the tax for this tax code - `@type` string - `AirportCode` string, required — The airport location the tax applies to - `CurrencyCode` CurrencyCode — 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. - … - `Amount` number, float — The amount of the tax applied - `TravelerIdentifierRef` TravelerIdentifierRef[] - `value` string - `id` string — A locally referenced ID - `description` string — Descriptive text used to identify the contents of a target object - `uris` string[] — Uniform Resource Identifier - `BaseAmount` CurrencyAmount — A monetary amount, up to 4 decimal places. Decimal place must be included. - `value` number, float — The amount of a given currency. - `code` string — An ISO 4217 alpha character code (3 characters) that specifies a money unit. - `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. - `currencySource` 'Supplier' | 'Charged' | 'Requested' — The system requesting or returning the currency code specified in the attribute - `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. - `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. - `ExtendedPayment` ExtendedPayment — Note this field is deprecated in Payment schema and should be passed in FormOfPaymentPaymentCardExtendPayment schema - `NumberOfInstallments` integer, required — The number of installment payments to be charged by the payment card provider - `FirstInstallment` number, float — For Pagos Parceledos, specify the first installment amount. This will be the same currency as the payment - `RemainingAmount` number, float — 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 - `OTATOCode` string — For Pagos Parceledos the OTATOCode - `AgencyServiceFeeIdentifier` AgencyServiceFeeIdentifier[] - `id` string — Unique id for this object within a message - `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. - `Receipt` Receipt[] - `@type` string, required — Discriminator classes ReceiptID, ReceiptConfirmation, ReceiptConfirmationDivide, ReceiptCancellation, ReceiptPayment - `id` string — The verification number. - `ReceiptRef` string - `Identifier` Identifier — 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). - `value` string — Unique offer identifier that can be sent in subsequent payload requests to reference this offer. When used for reference flight calls, the CatalogProductOfferingsIdentifier will be the transaction identifier from the Search, Next Leg Search, or Flight Specific Search response in CatalogProductOfferings/Identifier/value. If you choose to pull the CatalogProductOfferingsIdentifier from the Price response instead (OfferListResponse/Identifier/value), either full or reference payload, please note for subsequent Add Offer requests you must remove the _PC appended to the end of the value in the AirPrice response (e.g., change value: '93d2091d-3d04-48ab-8091-6ae1525f02ea_PC' to value: '93d2091d-3d04-48ab-8091-6ae1525f02ea'). When building an AirPrice or Add Offer reference payload request: - Look for the CatalogProductOfferingIdentifier (ex: o1) in a Search response at CatalogProductOfferings/CatalogProductOffering/id or a Price response at OfferListResponse/OfferID/id. - Look for the ProductIdentifier (ex: p0) in a Search response at CatalogProductOfferings/CatalogProductOffering/ProductBrandOptions/ProductBrandOffering/Product/productRef or from a Price response at OfferListResponse/OfferID/Product/id. When returned from a Workbench, this value is the workbench identifier that must be sent in all subsequent requests for this workbench session. When returned from Air Exchange Eligibility, value is the ticket number sent with the eligibility request. When used specifically for form of payment, the value will begin with the characters 'FOP'. Similarly, the OfferIdentifier associated will begin with the character 'O'. For Hotel Create Reservation (Reference Payload), send the value from the Availability response in CatalogOffering/id or the value from SearchComplete returned in propertyItems/lowestPublicAvailableRate/rateKey/value. Results from Hotel Availability and Hotel SearchComplete are stored in the cache for 30 minutes. If the offers expire before booking, you must send a new request. - `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. - `dateTime` string, date-time — Receipt date time - `OfferRef` string[] — List of offer reference ids for the offer(s) returned in the Reservation response. - `ProductRef` string — Reference of product - `OfferLink` OfferLink[] - `@type` string, required - `OfferRef` string - `ParentOffer` ParentOffer - `@type` string, required — Discriminator class ParentOffer only - `OfferRef` string - `ProductRef` string - `ReservationComment` ReservationComment[] - `@type` string, required — Discriminator classes ReservationCommentID or ReservationComment - `id` string — Local identifier within a given message for this object. - `commentSource` 'Agency' | 'Supplier' | 'Traveler' — Originator of a comment. - `shareWith` 'Supplier' | 'Agency' | 'Traveler' — Designates the visibility of a remark. - `shareWithSupplier` string[] — Reservation comment shared with supplier - `Comment` Comment[] — 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 - `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. - `id` string — Local identifier within a given message for this object. - `name` string — Title of comment or type of remark. - `language` string — Language code using ISO-639 standard - `AppliesTo` AppliesTo[] - `@type` string, required — Discriminator classes AppliesToOffer, AppliesToOfferProduct, and AppliesToOfferProductSegment - `PrimaryContact` PrimaryContact[] - `@type` string, required — Discriminator classes PrimaryContactID or PrimaryContact - `id` string - `Identifier` Identifier — 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). - `value` string — Unique offer identifier that can be sent in subsequent payload requests to reference this offer. When used for reference flight calls, the CatalogProductOfferingsIdentifier will be the transaction identifier from the Search, Next Leg Search, or Flight Specific Search response in CatalogProductOfferings/Identifier/value. If you choose to pull the CatalogProductOfferingsIdentifier from the Price response instead (OfferListResponse/Identifier/value), either full or reference payload, please note for subsequent Add Offer requests you must remove the _PC appended to the end of the value in the AirPrice response (e.g., change value: '93d2091d-3d04-48ab-8091-6ae1525f02ea_PC' to value: '93d2091d-3d04-48ab-8091-6ae1525f02ea'). When building an AirPrice or Add Offer reference payload request: - Look for the CatalogProductOfferingIdentifier (ex: o1) in a Search response at CatalogProductOfferings/CatalogProductOffering/id or a Price response at OfferListResponse/OfferID/id. - Look for the ProductIdentifier (ex: p0) in a Search response at CatalogProductOfferings/CatalogProductOffering/ProductBrandOptions/ProductBrandOffering/Product/productRef or from a Price response at OfferListResponse/OfferID/Product/id. When returned from a Workbench, this value is the workbench identifier that must be sent in all subsequent requests for this workbench session. When returned from Air Exchange Eligibility, value is the ticket number sent with the eligibility request. When used specifically for form of payment, the value will begin with the characters 'FOP'. Similarly, the OfferIdentifier associated will begin with the character 'O'. For Hotel Create Reservation (Reference Payload), send the value from the Availability response in CatalogOffering/id or the value from SearchComplete returned in propertyItems/lowestPublicAvailableRate/rateKey/value. Results from Hotel Availability and Hotel SearchComplete are stored in the cache for 30 minutes. If the offers expire before booking, you must send a new request. - `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. - `shareWith` 'Supplier' | 'Agency' | 'Traveler' — Designates the visibility of a remark. - `shareWithSupplier` string[] — Primary contact shared with supplier - `Email` Email — 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. - `value` string — The email address. - `id` string — Electronic email addresses, in IETF specified format. - `emailType` string — Use email type to specify if the email is to be sent "TO" or sent "FROM" - `comment` string — Any freeform note for the email, such as its purpose. - `preferredFormat` string — Mime media type - `shareMarketing` 'Yes' | 'No' | 'Inherit' — Used to indicate marketing preferences, Yes, No, Inherit - `shareSync` 'Yes' | 'No' | 'Inherit' — Used to indicate marketing preferences, Yes, No, Inherit - `optOutInd` 'Yes' | 'No' | 'Inherit' — Used to indicate marketing preferences, Yes, No, Inherit - `optInStatus` 'OptedIn' | 'OptedOut' | 'Unknown' — Used to indicate marketing preferences, OptIn, OptOut - `optInDate` string, date-time — The datetime of receiving the opt in notice - `optOutDate` string, date-time — The datetime the opt out notice was received - `validInd` boolean — If true, this is a valid email address that has been system verified via a successful email transmission. - `provisionedInd` boolean — If true then the email address came from the provisioning process - `Telephone` Telephone — 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. - `@type` string, required — Discriminator classes Telephone or TelephoneDetail - `countryAccessCode` string — Phone country code - `areaCityCode` string — Phone local area code - `phoneNumber` string, required — Mobile/Telephone Number. Accepted characters are numeric, dash, space, and period. - `extension` string — Telephone extension number - `id` string — Optional custom user-assigned identifier for a phone number. - `cityCode` string — IATA city code if referenced by phone number. - `role` 'Mobile' | 'Home' | 'Work' | 'Office' | 'Fax' | 'Other' — Defines the type of location the Telephone is assigned to. For Travel Agency telephone select "Other" or leave blank. - `TravelerIdentifier` TravelerIdentifier — Returns the system-generated traveler identifier in key value pairs; authority, if returned, is Travelport. - `@type` string - `id` string - `TravelerRef` string - `Identifier` Identifier — 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). - `value` string — Unique offer identifier that can be sent in subsequent payload requests to reference this offer. When used for reference flight calls, the CatalogProductOfferingsIdentifier will be the transaction identifier from the Search, Next Leg Search, or Flight Specific Search response in CatalogProductOfferings/Identifier/value. If you choose to pull the CatalogProductOfferingsIdentifier from the Price response instead (OfferListResponse/Identifier/value), either full or reference payload, please note for subsequent Add Offer requests you must remove the _PC appended to the end of the value in the AirPrice response (e.g., change value: '93d2091d-3d04-48ab-8091-6ae1525f02ea_PC' to value: '93d2091d-3d04-48ab-8091-6ae1525f02ea'). When building an AirPrice or Add Offer reference payload request: - Look for the CatalogProductOfferingIdentifier (ex: o1) in a Search response at CatalogProductOfferings/CatalogProductOffering/id or a Price response at OfferListResponse/OfferID/id. - Look for the ProductIdentifier (ex: p0) in a Search response at CatalogProductOfferings/CatalogProductOffering/ProductBrandOptions/ProductBrandOffering/Product/productRef or from a Price response at OfferListResponse/OfferID/Product/id. When returned from a Workbench, this value is the workbench identifier that must be sent in all subsequent requests for this workbench session. When returned from Air Exchange Eligibility, value is the ticket number sent with the eligibility request. When used specifically for form of payment, the value will begin with the characters 'FOP'. Similarly, the OfferIdentifier associated will begin with the character 'O'. For Hotel Create Reservation (Reference Payload), send the value from the Availability response in CatalogOffering/id or the value from SearchComplete returned in propertyItems/lowestPublicAvailableRate/rateKey/value. Results from Hotel Availability and Hotel SearchComplete are stored in the cache for 30 minutes. If the offers expire before booking, you must send a new request. - `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. - `contactInformationRefusedInd` boolean — If true, the passenger has refused to provide emergency contact details - `TravelAgency` TravelAgency — An optional object to define travel agency information. - `@type` string, required — Discriminator classes TravelAgency, TravelAgencyID, or TravelAgencyDetail - `id` string — Simple xsd id, not for external use - `TravelOrganizationRef` string — An organization that has a name and a structure and members and directly works in the travel industry - `Identifier` Identifier — 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). - `value` string — Unique offer identifier that can be sent in subsequent payload requests to reference this offer. When used for reference flight calls, the CatalogProductOfferingsIdentifier will be the transaction identifier from the Search, Next Leg Search, or Flight Specific Search response in CatalogProductOfferings/Identifier/value. If you choose to pull the CatalogProductOfferingsIdentifier from the Price response instead (OfferListResponse/Identifier/value), either full or reference payload, please note for subsequent Add Offer requests you must remove the _PC appended to the end of the value in the AirPrice response (e.g., change value: '93d2091d-3d04-48ab-8091-6ae1525f02ea_PC' to value: '93d2091d-3d04-48ab-8091-6ae1525f02ea'). When building an AirPrice or Add Offer reference payload request: - Look for the CatalogProductOfferingIdentifier (ex: o1) in a Search response at CatalogProductOfferings/CatalogProductOffering/id or a Price response at OfferListResponse/OfferID/id. - Look for the ProductIdentifier (ex: p0) in a Search response at CatalogProductOfferings/CatalogProductOffering/ProductBrandOptions/ProductBrandOffering/Product/productRef or from a Price response at OfferListResponse/OfferID/Product/id. When returned from a Workbench, this value is the workbench identifier that must be sent in all subsequent requests for this workbench session. When returned from Air Exchange Eligibility, value is the ticket number sent with the eligibility request. When used specifically for form of payment, the value will begin with the characters 'FOP'. Similarly, the OfferIdentifier associated will begin with the character 'O'. For Hotel Create Reservation (Reference Payload), send the value from the Availability response in CatalogOffering/id or the value from SearchComplete returned in propertyItems/lowestPublicAvailableRate/rateKey/value. Results from Hotel Availability and Hotel SearchComplete are stored in the cache for 30 minutes. If the offers expire before booking, you must send a new request. - `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. - `organizationType` 'TravelAgency' | 'AgencyBranch' | 'LoyaltyProgram' | 'IdDocumentIssuer' | 'TravelSupplier' | 'TravelProvider' | 'Regulatory' — The type of organization such as an Agency, Branch, Company, Supplier, Provider - `OrganizationName` CompanyName, required — Identifies a company by name - `value` string - `id` string — Use this id to internally identify this company in NextSteps - `division` string — The division name or ID with which the contact is associated - `department` string — The department name or ID with which the contact is associated - `shortName` string — Used to provide the company common name - `code` string — Identifies a company by the company code - `codeContext` string — Identifies the context of the identifying code, such as DUNS, IATA, or internal code - `systemOfRecord` string[] — The system(s) that maintain the data - `CorporateCode` string — A reference assigned by the Travel Agency to identify the corporate organization - `ProfileName` string[] - `GroupName` string — Group name will be passed in the new Group object - `SpecialService` SpecialService[] - `@type` string, required — Discriminator classes SpecialServiceID, SpecialServiceBassinet, SpecialServiceBlind, SpecialServiceDeaf, SpecialServiceDPNA, SpecialServiceMeal, SpecialServiceUnaccompaniedMinor, SpecialServiceWheelchairAirlineSupplied, SpecialServiceWheelchairTravelerSupplied - `id` string — Internal Id - `Identifier` Identifier — 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). - `value` string — Unique offer identifier that can be sent in subsequent payload requests to reference this offer. When used for reference flight calls, the CatalogProductOfferingsIdentifier will be the transaction identifier from the Search, Next Leg Search, or Flight Specific Search response in CatalogProductOfferings/Identifier/value. If you choose to pull the CatalogProductOfferingsIdentifier from the Price response instead (OfferListResponse/Identifier/value), either full or reference payload, please note for subsequent Add Offer requests you must remove the _PC appended to the end of the value in the AirPrice response (e.g., change value: '93d2091d-3d04-48ab-8091-6ae1525f02ea_PC' to value: '93d2091d-3d04-48ab-8091-6ae1525f02ea'). When building an AirPrice or Add Offer reference payload request: - Look for the CatalogProductOfferingIdentifier (ex: o1) in a Search response at CatalogProductOfferings/CatalogProductOffering/id or a Price response at OfferListResponse/OfferID/id. - Look for the ProductIdentifier (ex: p0) in a Search response at CatalogProductOfferings/CatalogProductOffering/ProductBrandOptions/ProductBrandOffering/Product/productRef or from a Price response at OfferListResponse/OfferID/Product/id. When returned from a Workbench, this value is the workbench identifier that must be sent in all subsequent requests for this workbench session. When returned from Air Exchange Eligibility, value is the ticket number sent with the eligibility request. When used specifically for form of payment, the value will begin with the characters 'FOP'. Similarly, the OfferIdentifier associated will begin with the character 'O'. For Hotel Create Reservation (Reference Payload), send the value from the Availability response in CatalogOffering/id or the value from SearchComplete returned in propertyItems/lowestPublicAvailableRate/rateKey/value. Results from Hotel Availability and Hotel SearchComplete are stored in the cache for 30 minutes. If the offers expire before booking, you must send a new request. - `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. - `AppliesTo` AppliesTo — In a request, used to apply a feature to a specific Offer, Product, or Segment. In a response, returned for Special Instruction and Associated Remarks. - `@type` string, required — Discriminator classes AppliesToOffer, AppliesToOfferProduct, and AppliesToOfferProductSegment - `Status` Status - `value` 'Pending' | 'Confirmed' | 'Cancelled' | 'Rejected' | 'Requested' — Status returned in a response for a two or more phase commitment process - `supplierText` string — Supplier status text - `code` string — Special service status code - `ServiceAnimalType` string — The type of service animal accompanying the Traveler. If no service animal leave blank. - `TravelerIdentifier` TravelerIdentifier — Returns the system-generated traveler identifier in key value pairs; authority, if returned, is Travelport. - `@type` string - `id` string - `TravelerRef` string - `Identifier` Identifier — 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). - `value` string — Unique offer identifier that can be sent in subsequent payload requests to reference this offer. When used for reference flight calls, the CatalogProductOfferingsIdentifier will be the transaction identifier from the Search, Next Leg Search, or Flight Specific Search response in CatalogProductOfferings/Identifier/value. If you choose to pull the CatalogProductOfferingsIdentifier from the Price response instead (OfferListResponse/Identifier/value), either full or reference payload, please note for subsequent Add Offer requests you must remove the _PC appended to the end of the value in the AirPrice response (e.g., change value: '93d2091d-3d04-48ab-8091-6ae1525f02ea_PC' to value: '93d2091d-3d04-48ab-8091-6ae1525f02ea'). When building an AirPrice or Add Offer reference payload request: - Look for the CatalogProductOfferingIdentifier (ex: o1) in a Search response at CatalogProductOfferings/CatalogProductOffering/id or a Price response at OfferListResponse/OfferID/id. - Look for the ProductIdentifier (ex: p0) in a Search response at CatalogProductOfferings/CatalogProductOffering/ProductBrandOptions/ProductBrandOffering/Product/productRef or from a Price response at OfferListResponse/OfferID/Product/id. When returned from a Workbench, this value is the workbench identifier that must be sent in all subsequent requests for this workbench session. When returned from Air Exchange Eligibility, value is the ticket number sent with the eligibility request. When used specifically for form of payment, the value will begin with the characters 'FOP'. Similarly, the OfferIdentifier associated will begin with the character 'O'. For Hotel Create Reservation (Reference Payload), send the value from the Availability response in CatalogOffering/id or the value from SearchComplete returned in propertyItems/lowestPublicAvailableRate/rateKey/value. Results from Hotel Availability and Hotel SearchComplete are stored in the cache for 30 minutes. If the offers expire before booking, you must send a new request. - `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. - `Quantity` integer - `FreeText` string - `SSRCode` string - `Carrier` string — For unassociated SSRs use carrier to instruct which airline to send the service information to - `Preference` Preference - `@type` string, required — Discriminator classes PreferenceID, Preference, PreferenceAirSeat, or PreferenceRailSeat - `id` string - `AppliesTo` AppliesTo — In a request, used to apply a feature to a specific Offer, Product, or Segment. In a response, returned for Special Instruction and Associated Remarks. - `@type` string, required — Discriminator classes AppliesToOffer, AppliesToOfferProduct, and AppliesToOfferProductSegment - `TravelerIdentifier` TravelerIdentifier — Returns the system-generated traveler identifier in key value pairs; authority, if returned, is Travelport. - `@type` string - `id` string - `TravelerRef` string - `Identifier` Identifier — 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). - `value` string — Unique offer identifier that can be sent in subsequent payload requests to reference this offer. When used for reference flight calls, the CatalogProductOfferingsIdentifier will be the transaction identifier from the Search, Next Leg Search, or Flight Specific Search response in CatalogProductOfferings/Identifier/value. If you choose to pull the CatalogProductOfferingsIdentifier from the Price response instead (OfferListResponse/Identifier/value), either full or reference payload, please note for subsequent Add Offer requests you must remove the _PC appended to the end of the value in the AirPrice response (e.g., change value: '93d2091d-3d04-48ab-8091-6ae1525f02ea_PC' to value: '93d2091d-3d04-48ab-8091-6ae1525f02ea'). When building an AirPrice or Add Offer reference payload request: - Look for the CatalogProductOfferingIdentifier (ex: o1) in a Search response at CatalogProductOfferings/CatalogProductOffering/id or a Price response at OfferListResponse/OfferID/id. - Look for the ProductIdentifier (ex: p0) in a Search response at CatalogProductOfferings/CatalogProductOffering/ProductBrandOptions/ProductBrandOffering/Product/productRef or from a Price response at OfferListResponse/OfferID/Product/id. When returned from a Workbench, this value is the workbench identifier that must be sent in all subsequent requests for this workbench session. When returned from Air Exchange Eligibility, value is the ticket number sent with the eligibility request. When used specifically for form of payment, the value will begin with the characters 'FOP'. Similarly, the OfferIdentifier associated will begin with the character 'O'. For Hotel Create Reservation (Reference Payload), send the value from the Availability response in CatalogOffering/id or the value from SearchComplete returned in propertyItems/lowestPublicAvailableRate/rateKey/value. Results from Hotel Availability and Hotel SearchComplete are stored in the cache for 30 minutes. If the offers expire before booking, you must send a new request. - `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. - `OrganizationLoyaltyProgram` OrganizationLoyaltyProgram[] - `@type` string, required — Discriminator classes OrganizationLoyaltyProgramID or OrganizationLoyaltyProgram - `id` string - `Identifier` Identifier — 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). - `value` string — Unique offer identifier that can be sent in subsequent payload requests to reference this offer. When used for reference flight calls, the CatalogProductOfferingsIdentifier will be the transaction identifier from the Search, Next Leg Search, or Flight Specific Search response in CatalogProductOfferings/Identifier/value. If you choose to pull the CatalogProductOfferingsIdentifier from the Price response instead (OfferListResponse/Identifier/value), either full or reference payload, please note for subsequent Add Offer requests you must remove the _PC appended to the end of the value in the AirPrice response (e.g., change value: '93d2091d-3d04-48ab-8091-6ae1525f02ea_PC' to value: '93d2091d-3d04-48ab-8091-6ae1525f02ea'). When building an AirPrice or Add Offer reference payload request: - Look for the CatalogProductOfferingIdentifier (ex: o1) in a Search response at CatalogProductOfferings/CatalogProductOffering/id or a Price response at OfferListResponse/OfferID/id. - Look for the ProductIdentifier (ex: p0) in a Search response at CatalogProductOfferings/CatalogProductOffering/ProductBrandOptions/ProductBrandOffering/Product/productRef or from a Price response at OfferListResponse/OfferID/Product/id. When returned from a Workbench, this value is the workbench identifier that must be sent in all subsequent requests for this workbench session. When returned from Air Exchange Eligibility, value is the ticket number sent with the eligibility request. When used specifically for form of payment, the value will begin with the characters 'FOP'. Similarly, the OfferIdentifier associated will begin with the character 'O'. For Hotel Create Reservation (Reference Payload), send the value from the Availability response in CatalogOffering/id or the value from SearchComplete returned in propertyItems/lowestPublicAvailableRate/rateKey/value. Results from Hotel Availability and Hotel SearchComplete are stored in the cache for 30 minutes. If the offers expire before booking, you must send a new request. - `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. - `Supplier` string, required — The supplier of the loyalty program - `LoyaltyIdentifier` string, required — Loyalty Identifier - `ShoppingCart` ShoppingCart — This object is deprecated and no longer in use. - `@type` string - `Product` ProductAir[] - `@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. - `id` string — Local id within a given message to support referencing this object. - `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. - `Identifier` Identifier — 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). - `value` string — Unique offer identifier that can be sent in subsequent payload requests to reference this offer. When used for reference flight calls, the CatalogProductOfferingsIdentifier will be the transaction identifier from the Search, Next Leg Search, or Flight Specific Search response in CatalogProductOfferings/Identifier/value. If you choose to pull the CatalogProductOfferingsIdentifier from the Price response instead (OfferListResponse/Identifier/value), either full or reference payload, please note for subsequent Add Offer requests you must remove the _PC appended to the end of the value in the AirPrice response (e.g., change value: '93d2091d-3d04-48ab-8091-6ae1525f02ea_PC' to value: '93d2091d-3d04-48ab-8091-6ae1525f02ea'). When building an AirPrice or Add Offer reference payload request: - Look for the CatalogProductOfferingIdentifier (ex: o1) in a Search response at CatalogProductOfferings/CatalogProductOffering/id or a Price response at OfferListResponse/OfferID/id. - Look for the ProductIdentifier (ex: p0) in a Search response at CatalogProductOfferings/CatalogProductOffering/ProductBrandOptions/ProductBrandOffering/Product/productRef or from a Price response at OfferListResponse/OfferID/Product/id. When returned from a Workbench, this value is the workbench identifier that must be sent in all subsequent requests for this workbench session. When returned from Air Exchange Eligibility, value is the ticket number sent with the eligibility request. When used specifically for form of payment, the value will begin with the characters 'FOP'. Similarly, the OfferIdentifier associated will begin with the character 'O'. For Hotel Create Reservation (Reference Payload), send the value from the Availability response in CatalogOffering/id or the value from SearchComplete returned in propertyItems/lowestPublicAvailableRate/rateKey/value. Results from Hotel Availability and Hotel SearchComplete are stored in the cache for 30 minutes. If the offers expire before booking, you must send a new request. - `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. - `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. - `totalDuration` string — Total duration of the combined segments in hours (H) and minutes (M). ISO 8601 format. - `FlightSegment` FlightSegment[], required — One instance for each flight segment in the product. - `@type` string — Discriminator. No child classes. - `id` string — Local identifier within a given message for this object. For AirPrice this identifier starts with s as in s1, s2, etc. - `sequence` integer, required — Order of the flight segment. e.g. 1 for the first segment on the leg. - `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. - `amenityRefs` string[] — 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. - `universalProductAttributeRefs` string[] — 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. - `Flight` FlightID, 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. - `@type` string, required — Discriminator. Child classes Flight and FlightDetail. - `id` string — Local id within a given message to support referencing this object - an internal flight identifier. - `FlightRef` string — Reference id that corresponds to the flight 'id' in ReferenceListFlight.Flight. - `Identifier` Identifier — 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). - … - `IntermediateStopAmenities` IntermediateStopAmenities[] - `@type` string, required — Discriminator. No child classes. - `departureLocation` string, required — The departure location. - `arrivalLocation` string, required — The arrival location. - `amenityRefs` string[] — List of amenity references for this portion of the flight. - `universalProductAttributeRefs` string[] — List of UPA references for this portion of the flight. - `OperationalStatus` OperationalStatusENUM — The operational status of the flight - `value` 'FlightBoarding' | 'FlightCancelled' | 'FlightDeparted' | 'FlightPastScheduledDeparture' | 'NotAvailableUseSearch' — List of operational flight status - `boundFlightsInd` boolean — GDS only; not supported for NDC. Indicates flight segments are married/bound. When 'true', indicates the flight segments in a single or double connection must be sold together. When true, the indicator is returned for all leading segments on one leg of the flight, and not returned for the last segment of the bound flight leg journey, indicating where the bound flights end. For example, if an origin and destination pair has 3 flight segments, boundFlightsInd is returned for the first two segments on that leg. If the segments are not bound, boundFlightsInd is false and not returned. - `CO2Actual` Measurement — Used for dimensional units (width, height, depth) or weight - `value` number, float - `measurementType` 'Width' | 'Height' | 'Depth' | 'Weight' | 'OverallDimension' — The type of measurement such as width, height, weight - `unit` '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' — The unit of measure in a code format. Refer to OpenTravel Code List Unit of Measure Code (UOM). - `PassengerFlight` PassengerFlight[], required - `@type` string — Discriminator. No child classes. - `passengerQuantity` integer — Number of passengers of the specified passenger type code. - `passengerTypeCode` string — Passenger type code applicable to the offer/offering. This may be different to the requested passenger type code sent in PassengerCriteria. - `requestedPassengerTypeCodes` string[] — 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. - `FlightProduct` FlightProduct[] - `@type` string — Discriminator. No child classes. - `segmentSequence` integer[], 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. - `classOfService` string — The class of service code. - `cabin` 'PremiumFirst' | 'First' | 'Business' | 'PremiumEconomy' | 'Economy' — 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. - `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. - `fareType` 'PublicFare' | 'AgencyPrivateFare' | 'AirlinePrivateFare' | 'NetFare' — Indicates the type of fare that applies to this Offer/Offering. NetFare is not supported for NDC. - `carCode` string — The car code or deal code. Net remit. May be a Commercial Airline Agreement number. 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. - `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. - `Brand` BrandID — Brand ID parent class, returned for branded fares. - … - `CustomerLoyaltyCredit` CustomerLoyaltyCredit[] - … - `ClassOfServiceAvailability` ClassOfServiceAvailability[] - … - `FareQualifier` FareQualifierENUM — deprecated - do not use - … - `stopoverPriced` 'Yes' | 'No' | 'Unknown' — Yes , No , Unknown - `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. - `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. - `FareQualifierString` string — NDC only. Not supported for GDS. Fare qualifier of a private leisure fares. - `ReservationDisplaySequence` ReservationDisplaySequence - `@type` string, required — Discriminator class ReservationDisplaySequence only - `DisplaySequence` DisplaySequence[] - `@type` string, required — Discriminator - `displaySequence` integer, required — The sequence the products are to be displayed for sequential date ordering. Data type has been corrected from string to integer in v11.24 - `OfferRef` string, required — Offer reference - `ProductRef` string — Product reference. If blank, display sequence applies to all products within the Offer. - `Sequence` integer — Segment sequence, if blank, display sequence applies to all segments within the product - `autoDeleteDateSequence` integer — The sequence of the autoDeleteDate (retention segment) within the Reservation - `AuxiliaryDisplaySequence` AuxiliaryDisplaySequence[] - `@type` string, required — Discriminator class AuxillaryDisplaySequence only - `displaySequence` integer, required - `CustomAuxiliarySegmentRef` string - `UnpricedSegmentDisplaySequence` UnpricedSegmentDisplaySequence[] - `@type` string, required — Discriminator class UnpricedSegmentDisplaySequence only - `displaySequence` integer, required — The order for this segment to be displayed - `UnpricedFlightSegmentRef` string, required — Reference to the Unpriced Flight Segment - `AgencyServiceFee` AgencyServiceFee[] - `@type` string, required — Discriminator classes AgencyServiceFeeID or AgencyServiceFee - `id` string — Unique id for this object within a message - `ExpiryDate` string, date-time — The service fee expiry date. Once expiry date has been reached, the service fee information will only be stored in the ReservationReceipt - `Description` string — The description of the service fee - `Amount` CurrencyAmount, required — A monetary amount, up to 4 decimal places. Decimal place must be included. - `value` number, float — The amount of a given currency. - `code` string — An ISO 4217 alpha character code (3 characters) that specifies a money unit. - `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. - `currencySource` 'Supplier' | 'Charged' | 'Requested' — The system requesting or returning the currency code specified in the attribute - `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. - `Tax` Tax[] - `value` number, float — Amount of the tax. Returned as 0 if a tax was marked as exempt with TaxExemption. - `currencyCode` string — A ISO 4217 currency code associated to the value. - `taxCode` string — Code for the tax. For Hotels this is the OTA code. - `reportingAuthority` string — Identifies the reporting authority such as airport code for XF taxes - `purpose` string — Supplier returned description of tax. - `description` string — Short summary of the tax. In Air workflows this is returned only for NDC. Note that descriptions are not returned for tax codes YQ and YR, which are fees charged by airlines and not government-imposed taxes. For Hotels this is the OTA tax description. - `includedInBase` 'Yes' | 'No' | 'Unknown' — Yes , No , Unknown - `codeAuthority` string — Not used. Currency Code Authority - `decimalPlace` integer — Permitted number of decimals. Associated to the currency value. - `decimalAuthority` string — Not used. Currency decimal authority - `exemptInd` boolean — GDS only; not supported for NDC. Returned if a tax was marked exempt in a prior request with the TaxExemption pricing modifer. If true, this tax is exempt" - `nonRefundableInd` boolean — If true, the tax is non refundable. This indicator is only supported for exchange search and exchange price quote transactions. - `excludedFromTotalPriceInd` boolean — Returned in Hotel APIs when a tax is not included in the TotalPrice. Default behavior is for taxes to be included in TotalPrice. - `RelatedDocumentNumber` DocumentNumber — Document Number with additional attributes that the document represents - `value` string - `documentIssuer` string — Document issuer - `documentType` 'EMD' | 'MCO' | 'Ticket' | 'TASF' | 'Invoice' — Document type like EMD, MCO - `travelerIdentifierRef` string — traveler identifier reference - `name` string — The name of the Traveler being referenced. - `passengerTypeCode` string — The passenger type code of the Traveler being referenced. - `id` string — A locally referenced ID - `description` string — Descriptive text used to identify the contents of a target object - `uris` string[] — The URI used to GET the target object in another domain. - `TravelerRef` string — Reference to a Traveler within the Reservation that this service fee applies to - `OfferRef` string — Reference to an Offer within the Reservation that this service fee applies to - `autoDeleteDate` string, date — The auto delete date represents the date that the Reservation will be kept active. Also known as retention segment or retention date. - `notificationDate` string, date — The notification date represents the date that the Reservation should be reviewed. Also known as ticket time limit date. - `CustomAuxiliarySegment` CustomAuxiliarySegmentID[] - `@type` string, required — Discriminator classes CustomAuxiliarySegmentID or CustomAuxiliarySegment - `id` string — Custom Auxiliary segment reference ID. - `customAuxiliarySegmentRef` string - `Identifier` Identifier — 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). - `value` string — Unique offer identifier that can be sent in subsequent payload requests to reference this offer. When used for reference flight calls, the CatalogProductOfferingsIdentifier will be the transaction identifier from the Search, Next Leg Search, or Flight Specific Search response in CatalogProductOfferings/Identifier/value. If you choose to pull the CatalogProductOfferingsIdentifier from the Price response instead (OfferListResponse/Identifier/value), either full or reference payload, please note for subsequent Add Offer requests you must remove the _PC appended to the end of the value in the AirPrice response (e.g., change value: '93d2091d-3d04-48ab-8091-6ae1525f02ea_PC' to value: '93d2091d-3d04-48ab-8091-6ae1525f02ea'). When building an AirPrice or Add Offer reference payload request: - Look for the CatalogProductOfferingIdentifier (ex: o1) in a Search response at CatalogProductOfferings/CatalogProductOffering/id or a Price response at OfferListResponse/OfferID/id. - Look for the ProductIdentifier (ex: p0) in a Search response at CatalogProductOfferings/CatalogProductOffering/ProductBrandOptions/ProductBrandOffering/Product/productRef or from a Price response at OfferListResponse/OfferID/Product/id. When returned from a Workbench, this value is the workbench identifier that must be sent in all subsequent requests for this workbench session. When returned from Air Exchange Eligibility, value is the ticket number sent with the eligibility request. When used specifically for form of payment, the value will begin with the characters 'FOP'. Similarly, the OfferIdentifier associated will begin with the character 'O'. For Hotel Create Reservation (Reference Payload), send the value from the Availability response in CatalogOffering/id or the value from SearchComplete returned in propertyItems/lowestPublicAvailableRate/rateKey/value. Results from Hotel Availability and Hotel SearchComplete are stored in the cache for 30 minutes. If the offers expire before booking, you must send a new request. - `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. - `Group` Group - `@type` string, required — Discriminator. - `id` string - `GroupRef` string - `Identifier` Identifier — 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). - `value` string — Unique offer identifier that can be sent in subsequent payload requests to reference this offer. When used for reference flight calls, the CatalogProductOfferingsIdentifier will be the transaction identifier from the Search, Next Leg Search, or Flight Specific Search response in CatalogProductOfferings/Identifier/value. If you choose to pull the CatalogProductOfferingsIdentifier from the Price response instead (OfferListResponse/Identifier/value), either full or reference payload, please note for subsequent Add Offer requests you must remove the _PC appended to the end of the value in the AirPrice response (e.g., change value: '93d2091d-3d04-48ab-8091-6ae1525f02ea_PC' to value: '93d2091d-3d04-48ab-8091-6ae1525f02ea'). When building an AirPrice or Add Offer reference payload request: - Look for the CatalogProductOfferingIdentifier (ex: o1) in a Search response at CatalogProductOfferings/CatalogProductOffering/id or a Price response at OfferListResponse/OfferID/id. - Look for the ProductIdentifier (ex: p0) in a Search response at CatalogProductOfferings/CatalogProductOffering/ProductBrandOptions/ProductBrandOffering/Product/productRef or from a Price response at OfferListResponse/OfferID/Product/id. When returned from a Workbench, this value is the workbench identifier that must be sent in all subsequent requests for this workbench session. When returned from Air Exchange Eligibility, value is the ticket number sent with the eligibility request. When used specifically for form of payment, the value will begin with the characters 'FOP'. Similarly, the OfferIdentifier associated will begin with the character 'O'. For Hotel Create Reservation (Reference Payload), send the value from the Availability response in CatalogOffering/id or the value from SearchComplete returned in propertyItems/lowestPublicAvailableRate/rateKey/value. Results from Hotel Availability and Hotel SearchComplete are stored in the cache for 30 minutes. If the offers expire before booking, you must send a new request. - `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. - `unallocatedPlaces` integer, required — The amount of unallocated places available which is the difference between the group size and the number of Travelers associated - `totalGroupPlaces` integer, required — The total number of passenger places available for this group booking - `GroupName` string, required - `UnpricedSegments` UnpricedSegments — Top level object for request. Top level container object for response. - `@type` string, required — Discriminator. No child classes. - `UnpricedFlightSegment` UnpricedFlightSegment[], required - `@type` string, required - `id` string — Local identifier within a given message for this FlightSegment - `sequence` integer, required — Sequence of the leg of the segment. - `connectionDuration` string — The actual duration of the connecting FlightSegment - `passengerQuantity` integer — Number of passengers on this segment. - `cabin` 'PremiumFirst' | 'First' | 'Business' | 'PremiumEconomy' | 'Economy' — 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. - `classOfService` string — Class of service of the segment. - `amenityRefs` string[] — List of amenity references for this flight - `universalProductAttributeRefs` string[] — List of universal product attributes for this flight. - `passiveSegmentStatus` string — 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. - `IntermediateStopAmenities` IntermediateStopAmenities[] - `@type` string, required — Discriminator. No child classes. - `departureLocation` string, required — The departure location. - `arrivalLocation` string, required — The arrival location. - `amenityRefs` string[] — List of amenity references for this portion of the flight. - `universalProductAttributeRefs` string[] — List of UPA references for this portion of the flight. - `OperationalStatus` OperationalStatusENUM — The operational status of the flight - `value` 'FlightBoarding' | 'FlightCancelled' | 'FlightDeparted' | 'FlightPastScheduledDeparture' | 'NotAvailableUseSearch' — List of operational flight status - `Flight` FlightID, 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. - `@type` string, required — Discriminator. Child classes Flight and FlightDetail. - `id` string — Local id within a given message to support referencing this object - an internal flight identifier. - `FlightRef` string — Reference id that corresponds to the flight 'id' in ReferenceListFlight.Flight. - `Identifier` Identifier — 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). - `value` string — Unique offer identifier that can be sent in subsequent payload requests to reference this offer. When used for reference flight calls, the CatalogProductOfferingsIdentifier will be the transaction identifier from the Search, Next Leg Search, or Flight Specific Search response in CatalogProductOfferings/Identifier/value. If you choose to pull the CatalogProductOfferingsIdentifier from the Price response instead (OfferListResponse/Identifier/value), either full or reference payload, please note for subsequent Add Offer requests you must remove the _PC appended to the end of the value in the AirPrice response (e.g., change value: '93d2091d-3d04-48ab-8091-6ae1525f02ea_PC' to value: '93d2091d-3d04-48ab-8091-6ae1525f02ea'). When building an AirPrice or Add Offer reference payload request: - Look for the CatalogProductOfferingIdentifier (ex: o1) in a Search response at CatalogProductOfferings/CatalogProductOffering/id or a Price response at OfferListResponse/OfferID/id. - Look for the ProductIdentifier (ex: p0) in a Search response at CatalogProductOfferings/CatalogProductOffering/ProductBrandOptions/ProductBrandOffering/Product/productRef or from a Price response at OfferListResponse/OfferID/Product/id. When returned from a Workbench, this value is the workbench identifier that must be sent in all subsequent requests for this workbench session. When returned from Air Exchange Eligibility, value is the ticket number sent with the eligibility request. When used specifically for form of payment, the value will begin with the characters 'FOP'. Similarly, the OfferIdentifier associated will begin with the character 'O'. For Hotel Create Reservation (Reference Payload), send the value from the Availability response in CatalogOffering/id or the value from SearchComplete returned in propertyItems/lowestPublicAvailableRate/rateKey/value. Results from Hotel Availability and Hotel SearchComplete are stored in the cache for 30 minutes. If the offers expire before booking, you must send a new request. - `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. - `Co2Actual` Measurement — Used for dimensional units (width, height, depth) or weight - `value` number, float - `measurementType` 'Width' | 'Height' | 'Depth' | 'Weight' | 'OverallDimension' — The type of measurement such as width, height, weight - `unit` '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' — The unit of measure in a code format. Refer to OpenTravel Code List Unit of Measure Code (UOM). - `boundFlightInd` boolean — If present and true, the Segments in this Connection are married. - `Accounting` Accounting — Defines Accounting information. Used for all DOCI remarks. - `@type` string, required — Discriminator classes AccountingID or Accounting - `id` string - `AccountingRef` string — Accounting reference - `Identifier` Identifier — 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). - `value` string — Unique offer identifier that can be sent in subsequent payload requests to reference this offer. When used for reference flight calls, the CatalogProductOfferingsIdentifier will be the transaction identifier from the Search, Next Leg Search, or Flight Specific Search response in CatalogProductOfferings/Identifier/value. If you choose to pull the CatalogProductOfferingsIdentifier from the Price response instead (OfferListResponse/Identifier/value), either full or reference payload, please note for subsequent Add Offer requests you must remove the _PC appended to the end of the value in the AirPrice response (e.g., change value: '93d2091d-3d04-48ab-8091-6ae1525f02ea_PC' to value: '93d2091d-3d04-48ab-8091-6ae1525f02ea'). When building an AirPrice or Add Offer reference payload request: - Look for the CatalogProductOfferingIdentifier (ex: o1) in a Search response at CatalogProductOfferings/CatalogProductOffering/id or a Price response at OfferListResponse/OfferID/id. - Look for the ProductIdentifier (ex: p0) in a Search response at CatalogProductOfferings/CatalogProductOffering/ProductBrandOptions/ProductBrandOffering/Product/productRef or from a Price response at OfferListResponse/OfferID/Product/id. When returned from a Workbench, this value is the workbench identifier that must be sent in all subsequent requests for this workbench session. When returned from Air Exchange Eligibility, value is the ticket number sent with the eligibility request. When used specifically for form of payment, the value will begin with the characters 'FOP'. Similarly, the OfferIdentifier associated will begin with the character 'O'. For Hotel Create Reservation (Reference Payload), send the value from the Availability response in CatalogOffering/id or the value from SearchComplete returned in propertyItems/lowestPublicAvailableRate/rateKey/value. Results from Hotel Availability and Hotel SearchComplete are stored in the cache for 30 minutes. If the offers expire before booking, you must send a new request. - `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. - `dataType` string — Accounting data type. When used as Accounting remark designator the accepted value is DOCI. - `template` string — Accounting template - `NameValuePair` NameValuePair[] — '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' - `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). - `id` string — Optional internally referenced id - `name` string, required — Key, categorizing the type of remark or error. - `DocumentOverrides` DocumentOverrides[] - `@type` string, required — Discriminator classes DocumentOverridesID or DocumentOverrides - `id` string — The reporting number. - `DocumentOverridesRef` string - `Identifier` Identifier — 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). - `value` string — Unique offer identifier that can be sent in subsequent payload requests to reference this offer. When used for reference flight calls, the CatalogProductOfferingsIdentifier will be the transaction identifier from the Search, Next Leg Search, or Flight Specific Search response in CatalogProductOfferings/Identifier/value. If you choose to pull the CatalogProductOfferingsIdentifier from the Price response instead (OfferListResponse/Identifier/value), either full or reference payload, please note for subsequent Add Offer requests you must remove the _PC appended to the end of the value in the AirPrice response (e.g., change value: '93d2091d-3d04-48ab-8091-6ae1525f02ea_PC' to value: '93d2091d-3d04-48ab-8091-6ae1525f02ea'). When building an AirPrice or Add Offer reference payload request: - Look for the CatalogProductOfferingIdentifier (ex: o1) in a Search response at CatalogProductOfferings/CatalogProductOffering/id or a Price response at OfferListResponse/OfferID/id. - Look for the ProductIdentifier (ex: p0) in a Search response at CatalogProductOfferings/CatalogProductOffering/ProductBrandOptions/ProductBrandOffering/Product/productRef or from a Price response at OfferListResponse/OfferID/Product/id. When returned from a Workbench, this value is the workbench identifier that must be sent in all subsequent requests for this workbench session. When returned from Air Exchange Eligibility, value is the ticket number sent with the eligibility request. When used specifically for form of payment, the value will begin with the characters 'FOP'. Similarly, the OfferIdentifier associated will begin with the character 'O'. For Hotel Create Reservation (Reference Payload), send the value from the Availability response in CatalogOffering/id or the value from SearchComplete returned in propertyItems/lowestPublicAvailableRate/rateKey/value. Results from Hotel Availability and Hotel SearchComplete are stored in the cache for 30 minutes. If the offers expire before booking, you must send a new request. - `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. - `OfferIdentifier` OfferIdentifier — Travelport-generated offer identifier number. - `id` string — Local identifier within a given message for this object. - `offerRef` string — Used to reference another instance of this object in the same message - `Identifier` Identifier — 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). - `value` string — Unique offer identifier that can be sent in subsequent payload requests to reference this offer. When used for reference flight calls, the CatalogProductOfferingsIdentifier will be the transaction identifier from the Search, Next Leg Search, or Flight Specific Search response in CatalogProductOfferings/Identifier/value. If you choose to pull the CatalogProductOfferingsIdentifier from the Price response instead (OfferListResponse/Identifier/value), either full or reference payload, please note for subsequent Add Offer requests you must remove the _PC appended to the end of the value in the AirPrice response (e.g., change value: '93d2091d-3d04-48ab-8091-6ae1525f02ea_PC' to value: '93d2091d-3d04-48ab-8091-6ae1525f02ea'). When building an AirPrice or Add Offer reference payload request: - Look for the CatalogProductOfferingIdentifier (ex: o1) in a Search response at CatalogProductOfferings/CatalogProductOffering/id or a Price response at OfferListResponse/OfferID/id. - Look for the ProductIdentifier (ex: p0) in a Search response at CatalogProductOfferings/CatalogProductOffering/ProductBrandOptions/ProductBrandOffering/Product/productRef or from a Price response at OfferListResponse/OfferID/Product/id. When returned from a Workbench, this value is the workbench identifier that must be sent in all subsequent requests for this workbench session. When returned from Air Exchange Eligibility, value is the ticket number sent with the eligibility request. When used specifically for form of payment, the value will begin with the characters 'FOP'. Similarly, the OfferIdentifier associated will begin with the character 'O'. For Hotel Create Reservation (Reference Payload), send the value from the Availability response in CatalogOffering/id or the value from SearchComplete returned in propertyItems/lowestPublicAvailableRate/rateKey/value. Results from Hotel Availability and Hotel SearchComplete are stored in the cache for 30 minutes. If the offers expire before booking, you must send a new request. - `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. - `ProductIdentifier` ProductIdentifier — 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. - `id` string — Local identifier within a given message for this object. - `productRef` string — Used to reference another instance of this object in the same payload. - `Identifier` Identifier — 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). - `value` string — Unique offer identifier that can be sent in subsequent payload requests to reference this offer. When used for reference flight calls, the CatalogProductOfferingsIdentifier will be the transaction identifier from the Search, Next Leg Search, or Flight Specific Search response in CatalogProductOfferings/Identifier/value. If you choose to pull the CatalogProductOfferingsIdentifier from the Price response instead (OfferListResponse/Identifier/value), either full or reference payload, please note for subsequent Add Offer requests you must remove the _PC appended to the end of the value in the AirPrice response (e.g., change value: '93d2091d-3d04-48ab-8091-6ae1525f02ea_PC' to value: '93d2091d-3d04-48ab-8091-6ae1525f02ea'). When building an AirPrice or Add Offer reference payload request: - Look for the CatalogProductOfferingIdentifier (ex: o1) in a Search response at CatalogProductOfferings/CatalogProductOffering/id or a Price response at OfferListResponse/OfferID/id. - Look for the ProductIdentifier (ex: p0) in a Search response at CatalogProductOfferings/CatalogProductOffering/ProductBrandOptions/ProductBrandOffering/Product/productRef or from a Price response at OfferListResponse/OfferID/Product/id. When returned from a Workbench, this value is the workbench identifier that must be sent in all subsequent requests for this workbench session. When returned from Air Exchange Eligibility, value is the ticket number sent with the eligibility request. When used specifically for form of payment, the value will begin with the characters 'FOP'. Similarly, the OfferIdentifier associated will begin with the character 'O'. For Hotel Create Reservation (Reference Payload), send the value from the Availability response in CatalogOffering/id or the value from SearchComplete returned in propertyItems/lowestPublicAvailableRate/rateKey/value. Results from Hotel Availability and Hotel SearchComplete are stored in the cache for 30 minutes. If the offers expire before booking, you must send a new request. - `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. - `Commissions` Commissions[] - `@type` string - `TravelerIdentifierRef` TravelerIdentifierRef[] - `value` string - `id` string — A locally referenced ID - `description` string — Descriptive text used to identify the contents of a target object - `uris` string[] — Uniform Resource Identifier - `Commission` Commission, 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). - `@type` string, required — Discriminator. Child classes CommissionAmount or CommissionPercent - `application` 'Full' | 'Partial' | 'Non-paying' | 'No-show' | 'Adjustment' | 'Commissionable' — Type of commission - `ApplyTo` 'Base' | 'Fee' — List of commission Apply - `DestinationPurpose` DestinationPurpose[] - `@type` string - `destination` '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', required — List of destinations - `purpose` 'Business' | 'Pleasure' | 'Charter Service', required — The purpose exposed. - `Restrictions` Restrictions[] - `@type` string - `TravelerIdentifierRef` TravelerIdentifierRef[] - `value` string - `id` string — A locally referenced ID - `description` string — Descriptive text used to identify the contents of a target object - `uris` string[] — Uniform Resource Identifier - `Restriction` string[], required - `DocumentType` 'EMD' | 'MCO' | 'Ticket' | 'TASF' | 'Invoice' — Document type like EMD, MCO - `TourCodes` TourCodes[] - `@type` string — Discriminator. No child classes. - `TravelerIdentifierRef` TravelerIdentifierRef[] — Reference the traveler if the tour code is traveler specific. Leave blank to apply to all travelers. - `value` string - `id` string — A locally referenced ID - `description` string — Descriptive text used to identify the contents of a target object - `uris` string[] — Uniform Resource Identifier - `TourCode` TourCode, required — Tour code - `value` string — The actual value of the tour code. - `tourCodeType` 'Bulk Tour' | 'Inclusive Tour' — List of tour code types. - `ChangeFeeCollectionMethod` ChangeFeeCollectionMethod - `value` 'EMD' | 'MCO' | 'Tax' | 'Unknown' — List of change fee method - `code` string, required — The code value - `subCode` string — The subcode value - `description` string — The description value - `changeFeeIssuedSeparatelyInd` boolean — if true, the change fee will be issued as a separate transaction to the residual amount - `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 - `NetRemitInfo` NetRemitInfo - `@type` string - `CarCode` string — The CAR code or deal code applied to this product for use in net remit. - `ValueCode` string — The Value code applied to this product for use in net remit - `ActualSellingFare` number, float — The actual selling fare which will override the Offer base fare on the document - `NetBaseAmount` FiledAmount — Returned only in the Price 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. - `value` number, float — Filed amount value - `currencyCode` string — Code for the currency in which the base fare was filed. - `codeAuthority` string — Filed amount currency code authority - `decimalPlace` integer, required — Number of decimal places in the currency in ISO 4217 standard format. - `decimalAuthority` string — ISO 4217 standard decimal authority - `ClientDiscountCode` string — The client discount code applied to this product for net remit. - `TicketDesignators` TicketDesignators[] - `@type` string, required — Discriminator class TicketDesignators only - `TravelerIdentifierRef` TravelerIdentifierRef[] - `value` string - `id` string — A locally referenced ID - `description` string — Descriptive text used to identify the contents of a target object - `uris` string[] — Uniform Resource Identifier - `TicketDesignator` string, required - `InvoiceFareAmount` CurrencyAmount — A monetary amount, up to 4 decimal places. Decimal place must be included. - `value` number, float — The amount of a given currency. - `code` string — An ISO 4217 alpha character code (3 characters) that specifies a money unit. - `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. - `currencySource` 'Supplier' | 'Charged' | 'Requested' — The system requesting or returning the currency code specified in the attribute - `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. - `residualValueAsEvenExchangeMIRInd` boolean — Report an exchange with residual value transaction as an Even exchange in the MIR. - `obFeeExemptInd` boolean — If true, the associated Offer is exempt from OB Payment Card Fees. - `CustomRule` CustomRule - `@type` string, required — Discriminator classes CustomRuleID or CustomRule - `id` string — Custom rule id reference ID. - `Identifier` Identifier — 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). - `value` string — Unique offer identifier that can be sent in subsequent payload requests to reference this offer. When used for reference flight calls, the CatalogProductOfferingsIdentifier will be the transaction identifier from the Search, Next Leg Search, or Flight Specific Search response in CatalogProductOfferings/Identifier/value. If you choose to pull the CatalogProductOfferingsIdentifier from the Price response instead (OfferListResponse/Identifier/value), either full or reference payload, please note for subsequent Add Offer requests you must remove the _PC appended to the end of the value in the AirPrice response (e.g., change value: '93d2091d-3d04-48ab-8091-6ae1525f02ea_PC' to value: '93d2091d-3d04-48ab-8091-6ae1525f02ea'). When building an AirPrice or Add Offer reference payload request: - Look for the CatalogProductOfferingIdentifier (ex: o1) in a Search response at CatalogProductOfferings/CatalogProductOffering/id or a Price response at OfferListResponse/OfferID/id. - Look for the ProductIdentifier (ex: p0) in a Search response at CatalogProductOfferings/CatalogProductOffering/ProductBrandOptions/ProductBrandOffering/Product/productRef or from a Price response at OfferListResponse/OfferID/Product/id. When returned from a Workbench, this value is the workbench identifier that must be sent in all subsequent requests for this workbench session. When returned from Air Exchange Eligibility, value is the ticket number sent with the eligibility request. When used specifically for form of payment, the value will begin with the characters 'FOP'. Similarly, the OfferIdentifier associated will begin with the character 'O'. For Hotel Create Reservation (Reference Payload), send the value from the Availability response in CatalogOffering/id or the value from SearchComplete returned in propertyItems/lowestPublicAvailableRate/rateKey/value. Results from Hotel Availability and Hotel SearchComplete are stored in the cache for 30 minutes. If the offers expire before booking, you must send a new request. - `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. ## Response `200` OK - Successful Response - 200 - ReservationResponseWrapper — Wrapper schema to expose the name of the top level schema in the JSON example - `ReservationResponse` ReservationResponse — Base response is part of all TripServices responses and includes common items which are relevant across all APIs - `Reservation` ReservationID — Empty container to request workbench ID. - `@type` string, required — Discriminator classes ReservationID, Reservation, or ReservationDetail - `id` string — Internal identifier for the response. - `Identifier` Identifier — 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). - `value` string — Unique offer identifier that can be sent in subsequent payload requests to reference this offer. When used for reference flight calls, the CatalogProductOfferingsIdentifier will be the transaction identifier from the Search, Next Leg Search, or Flight Specific Search response in CatalogProductOfferings/Identifier/value. If you choose to pull the CatalogProductOfferingsIdentifier from the Price response instead (OfferListResponse/Identifier/value), either full or reference payload, please note for subsequent Add Offer requests you must remove the _PC appended to the end of the value in the AirPrice response (e.g., change value: '93d2091d-3d04-48ab-8091-6ae1525f02ea_PC' to value: '93d2091d-3d04-48ab-8091-6ae1525f02ea'). When building an AirPrice or Add Offer reference payload request: - Look for the CatalogProductOfferingIdentifier (ex: o1) in a Search response at CatalogProductOfferings/CatalogProductOffering/id or a Price response at OfferListResponse/OfferID/id. - Look for the ProductIdentifier (ex: p0) in a Search response at CatalogProductOfferings/CatalogProductOffering/ProductBrandOptions/ProductBrandOffering/Product/productRef or from a Price response at OfferListResponse/OfferID/Product/id. When returned from a Workbench, this value is the workbench identifier that must be sent in all subsequent requests for this workbench session. When returned from Air Exchange Eligibility, value is the ticket number sent with the eligibility request. When used specifically for form of payment, the value will begin with the characters 'FOP'. Similarly, the OfferIdentifier associated will begin with the character 'O'. For Hotel Create Reservation (Reference Payload), send the value from the Availability response in CatalogOffering/id or the value from SearchComplete returned in propertyItems/lowestPublicAvailableRate/rateKey/value. Results from Hotel Availability and Hotel SearchComplete are stored in the cache for 30 minutes. If the offers expire before booking, you must send a new request. - `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. - `@type` string - `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. - `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. - `correlationId` string, uuid — Identifier used to correlate hotel API invocations across a multi-call business flows. - `reservationStatus` 'Success' | 'Fail' | 'Partial' | 'Pending' | 'OnHold' | 'Retry' | 'Other' — Status of reservation or offer completion. - `Result` Result — Returns the error and/or warning message information, if applicable. - `@type` string — Discriminator class Result only - `status` 'Not processed' | 'Incomplete' | 'Complete' | 'Unknown' — The status of an error or warning - `Error` Error[] — A list of error information returned at the provider level for a response. - `@type` string, required — Discriminator classes Error or ErrorDetail - `StatusCode` integer — Http standard response code - `Message` string — The Travelport standardized error or warning message - `NameValuePair` 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). - `id` string — Optional internally referenced id - `name` string, required — Key, categorizing the type of remark or error. - `Warning` Warning[] — A list of warning information returned at the provider level for a response. - `@type` string, required — Discriminator classes Warning or WarningDetail - `StatusCode` integer — Http standard response code - `Message` string — The Travelport standardized error or warning message - `NameValuePair` 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). - `id` string — Optional internally referenced id - `name` string, required — Key, categorizing the type of remark or error. - `Identifier` Identifier — 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). - `value` string — Unique offer identifier that can be sent in subsequent payload requests to reference this offer. When used for reference flight calls, the CatalogProductOfferingsIdentifier will be the transaction identifier from the Search, Next Leg Search, or Flight Specific Search response in CatalogProductOfferings/Identifier/value. If you choose to pull the CatalogProductOfferingsIdentifier from the Price response instead (OfferListResponse/Identifier/value), either full or reference payload, please note for subsequent Add Offer requests you must remove the _PC appended to the end of the value in the AirPrice response (e.g., change value: '93d2091d-3d04-48ab-8091-6ae1525f02ea_PC' to value: '93d2091d-3d04-48ab-8091-6ae1525f02ea'). When building an AirPrice or Add Offer reference payload request: - Look for the CatalogProductOfferingIdentifier (ex: o1) in a Search response at CatalogProductOfferings/CatalogProductOffering/id or a Price response at OfferListResponse/OfferID/id. - Look for the ProductIdentifier (ex: p0) in a Search response at CatalogProductOfferings/CatalogProductOffering/ProductBrandOptions/ProductBrandOffering/Product/productRef or from a Price response at OfferListResponse/OfferID/Product/id. When returned from a Workbench, this value is the workbench identifier that must be sent in all subsequent requests for this workbench session. When returned from Air Exchange Eligibility, value is the ticket number sent with the eligibility request. When used specifically for form of payment, the value will begin with the characters 'FOP'. Similarly, the OfferIdentifier associated will begin with the character 'O'. For Hotel Create Reservation (Reference Payload), send the value from the Availability response in CatalogOffering/id or the value from SearchComplete returned in propertyItems/lowestPublicAvailableRate/rateKey/value. Results from Hotel Availability and Hotel SearchComplete are stored in the cache for 30 minutes. If the offers expire before booking, you must send a new request. - `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. - `NextSteps` NextSteps — Container for the steps that describe actions that may be taken on the containing object. Not applicable for an Eligibility or Exchange response. - `baseURI` string, required — The base portion of the URI in order to shorten the uris in the individual steps - `id` string — Optional internally referenced id - `NextStep` NextStep[], required - `value` string - `id` string — Identifier for the Next Step - `action` string, required — The action this next step is intended to achieve - `method` 'GET' | 'DELETE' | 'PUT' | 'POST', required — Describes the set of potential methods that can be taken after an operation. - `description` string — Additional clarification for the next step - `ReferenceList` 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. - `id` string — Uniquely identifies for the Reference List - `CurrencyRateConversion` CurrencyRateConversion[] - `@type` string - `SourceCurrency` CurrencyCode, 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. - `value` string — An ISO 4217 currency code. - `codeAuthority` string — Currency code authority - `decimalPlace` integer — Number of decimal places for the currency. - `decimalAuthority` string — Currency code decimal authority - `TargetCurrency` CurrencyCode, 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. - `value` string — An ISO 4217 currency code. - `codeAuthority` string — Currency code authority - `decimalPlace` integer — Number of decimal places for the currency. - `decimalAuthority` string — Currency code decimal authority - `ConversionRate` ConversionRate, 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. - `value` number, float - `rateAuthority` string — Contextual rate authority - `rateAsOf` string, date-time — Rate as of - `Pagination` Pagination — Pagination object used when result sets span across a number of pages. - `@type` string, required - `page` integer, required — The current page number of the full result set - `pageSize` integer, required — The total number of items on this page - `totalPages` integer, required — The total number of pages in this result set - `totalItems` integer, required — The total number of pages in this result set ## Other responses - `400` — Bad Request - 400 - `401` — Unauthorized - 401 - `402` — Payment Required - 402 - `403` — Forbidden - 403 - `404` — Not Found - 404 - `500` — Internal Server Error - 500 - `503` — Service Unavailable - 503. This error may be returned when the service is temporarily unavailable due to infrastructure or network issues. --- [API](https://skmtc.net/travelport/apis/tripservices-flights.md) · [All operations](https://skmtc.net/travelport/apis/tripservices-flights/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/travelport/tripservices-flights/revisions/90abcc916990/schema)