v1.19.22 | December 6, 2023
- This new release offers the ability to retrieve additional information from the reservation.
API Information
What's New
- This new release offers the ability to retrieve additional information from the reservation.
New Features
In the Response
Optional
- Parameter: paymentCardToken
-
Type: String
Description: The new response element is dedicated to returning information regarding Payment Card token for the FOP (5-) Remark. The new element will be returned under the following response parameter: Reservation/Remarks/Remark/@paymentCardToken
Sample Value:
<stl19:Remark index="1" id="12" type="FOP" elementId="pnr-12" paymentCardToken="4ABCDDEFG123456">
<stl19:RemarkLines>
<stl19:RemarkLine>
<stl19:Text>VI4XXXXXXXXXXX1881¥12/26</stl19:Text>
</stl19:RemarkLine>
</stl19:RemarkLines>
</stl19:Remark>Note: Examples of request and response are available in the Resources tab.
v1.19.21 | September 28, 2023
- This new release offers the ability to retrieve additional information from the reservation.
API Information
What's New
- This new release offers the ability to retrieve additional information from the reservation.
New Features
In the Response
Optional
- Parameter: CheckInInfo
-
Type: String
Description: The new response element is dedicated to returning information regarding Passenger Checkin Information. The new element will be returned under the following response node: Reservation/PassengerReservation/Segments/Air/CheckInInfo
Sample Value:
<CheckInInfo>CHECK-IN ONLINE AT RAIL-CHECKIN.CO</CheckInInfo>Note: Examples of request and response are available in the Resources tab.
In the Response
Optional
- Parameter: CheckInAirlineCode
-
Type: String
Description: The new response element is dedicated to returning information regarding Check-in Carrier Code. The new element will be returned under the following response node: Reservation/PassengerReservation/Segments/Air/CheckInAirlineCode This element is always returned together with CheckInInfo response parameter.
Sample Value:
<CheckInInfo>CHECK-IN WITH AMERICAN AIRLINES</CheckInInfo>
<CheckInAirlineCode>AA</CheckInAirlineCode>Note: Examples of request and response are available in the Resources tab.
In the Response
Optional
- Parameter: GroupManagementInformation
-
Type: Complex
Description: The new response element is dedicated to returning information regarding Group Manager Information that can be returned for Group Bookings. The new element will be returned under the following response node: Reservation/PassengerReservation/Segments/Air/GroupManagementInformation
Sample Value:
<stl19:GroupManagementInformation>
<stl19:GmrLocator>VYMIXW</stl19:GmrLocator>
<stl19:OaDealId>
<stl19:AirlineCode>AA</stl19:AirlineCode>
<stl19:AirlineLocator>LNJDMO</stl19:AirlineLocator>
</stl19:OaDealId>
</stl19:GroupManagementInformation>Note: The information returned under GroupManagementInformation is equivalent to the one that can be returned using host entry: T/XBAS*28« EXTENDED BAS INFORMATION DISPLAY SEGMENT NUMBER: 01 *TYPE 28 - GROUP MANAGER INFORMATION GMR LOCATOR - VYMIXW OA DEAL ID - AA*LNJDMO Examples of request and response are available in the Resources tab.
v1.19.20 | August 3, 2023
- This new release offers the ability to retrieve additional information from the reservation.
API Information
What's New
- This new release offers the ability to retrieve additional information from the reservation.
New Features
In the Response
Optional
- Parameter: MembershipPrograms
-
Type: Complex
Description: The new response element is dedicated to return detailed information regarding all loyalty programs for a particular Frequent Traveler. This is an optional element and can be returned only in certain cases when Carrier supports multiple loyalty programs. New element will be returned under the following response node: Reservation/OpenReservationElements/OpenReservationElements/Loyalty/FrequentFlyer/MembershipPrograms
Sample Value:
<or114:FrequentFlyer>
<or114:ActionCode>HK</or114:ActionCode>
<or114:PreviousActionCode>NN</or114:PreviousActionCode>
<or114:Vendor>XX</or114:Vendor>
<or114:ReceivingCarrierCode>XX</or114:ReceivingCarrierCode>
<or114:VitType>97</or114:VitType>
<or114:FrequentFlyerNumber>Y94W899</or114:FrequentFlyerNumber>
<or114:ATPCOTierLevel>1</or114:ATPCOTierLevel>
<or114:Banner>EXECUTIVE PLATINUM * EMERALD</or114:Banner>
<or114:Tag>EXP/EMD/AAP/PCC</or114:Tag>
<or114:MembershipPrograms domainId="XX" supplierCode="XX">
<or114:MembershipProgram>
<or114:ProgramType>FT</or114:ProgramType>
<or114:TierValue>04</or114:TierValue>
<or114:PnrTier>96</or114:PnrTier>
<or114:AtpcoTier>1</or114:AtpcoTier>
<or114:DisplayPriority>2</or114:DisplayPriority>
<or114:Banner>EXECUTIVE PLATINUM * EMERALD</or114:Banner>
<or114:PrimaryTag>EXP</or114:PrimaryTag>
<or114:DisplayTag>EXP/EMD</or114:DisplayTag>
</or114:MembershipProgram>
<or114:MembershipProgram>
<or114:ProgramType>AP</or114:ProgramType>
<or114:TierValue>13</or114:TierValue>
<or114:PnrTier>1</or114:PnrTier>
<or114:DisplayPriority>20</or114:DisplayPriority>
<or114:Banner>AIRPASS - NO COMPANION BENEFITS</or114:Banner>
<or114:PrimaryTag>AAP</or114:PrimaryTag>
<or114:DisplayTag>AAP</or114:DisplayTag>
</or114:MembershipProgram>
<or114:MembershipProgram>
<or114:ProgramType>PC</or114:ProgramType>
<or114:TierValue>10</or114:TierValue>
<or114:PnrTier>4096</or114:PnrTier>
<or114:AtpcoTier>8</or114:AtpcoTier>
<or114:DisplayPriority>30</or114:DisplayPriority>
<or114:Banner>PREMIUM CREDIT CARD</or114:Banner>
<or114:PrimaryTag>PCC</or114:PrimaryTag>
<or114:DisplayTag>PCC</or114:DisplayTag>
</or114:MembershipProgram>
</or114:MembershipPrograms>
</or114:FrequentFlyer>Note: Example of request and response in the Resources section.
v1.19.19 | June 15, 2023
- This new release offers ability to retrieve additional information from the reservation and also supporting new options during Lodging modification process.
API Information
What's New
- This new release offers ability to retrieve additional information from the reservation and also supporting new options during Lodging modification process.
New Features
In the Response
Optional
- Parameter: SubscriptionCard
-
Type: Complex
Description: New response element is dedicated to return Air France Subscription Card which allows all Sabre-connected agents to connect to the Air France Subscription Card holder's server and use the specially discounted Subscription Card holder's fares. Subscription Card information will be returned under following response element: Reservation/SubscriptionCards/ SubscriptionCard
Sample Value:
<stl19:SubscriptionCard id="17">
<stl19:NameAssociation>
<stl19:AssociatedName>1</stl19:AssociatedName>
</stl19:NameAssociation>
<stl19:SubscriptionCardNumber>999426244</stl19:SubscriptionCardNumber>
<stl19:SubscriptionCardAirline>AF</stl19:SubscriptionCardAirline>
<stl19:FrequentFlyerNumber/>
<stl19:RejectedCard>false</stl19:RejectedCard>
<stl19:DateValidFrom>2021-10-19</stl19:DateValidFrom>
<stl19:DateValidTo>2023-10-18</stl19:DateValidTo>
<stl19:SubscriptionCardSegments>
<stl19:SubscriptionCardSegment>
<stl19:ValidSegmentAssociation>true</stl19:ValidSegmentAssociation>
<stl19:Segment>
<stl19:CarrierCode>AF</stl19:CarrierCode>
<stl19:FlightNumber>1105</stl19:FlightNumber>
<stl19:DepartureDate>2023-09-27</stl19:DepartureDate>
<stl19:BoardPoint>FCO</stl19:BoardPoint>
<stl19:OffPoint>CDG</stl19:OffPoint>
<stl19:ClassOfService>Y</stl19:ClassOfService>
</stl19:Segment>
<stl19:AssociatedItinerarySegment>2</stl19:AssociatedItinerarySegment>
<stl19:SubscriptionOrDiscountCode>RPFM</stl19:SubscriptionOrDiscountCode>
<stl19:PassengerTypeCode>CFM</stl19:PassengerTypeCode>
</stl19:SubscriptionCardSegment>
</stl19:SubscriptionCardSegments>
</stl19:SubscriptionCard>Note: Example of request and response in the Resources section.
Functional Updates And Enhancements
In the Request
N/A
- Parameter: New ability for modification of Lodging segments using Virtual Payments
-
Type: N/A
Description: Virtual form of payment (previously supported only on sell path) is now available also during Lodging segment modify process. The operations supported now are: •Ability to modify any non-virtual form of payment supported for Lodging to Virtual form of payment •Ability to modify booking parameters (for example stay date range) for the booking that already has Virtual Card as form of payment
Note: For more information visit: Virtual Form Of Payment
v1.19.18 | April 27, 2023
- This new release offers the ability to retrieve additional payment data from the reservation.
API Information
What's New
- This new release offers the ability to retrieve additional payment data from the reservation.
New Features
In the Request/Response
Optional
- Parameter: InterfaceUserRecord
-
Type: Complex
Description: New response parameters stored for payment cards with the IR Use Type can now be returned for Back Office (UIR) System purposes. If registered, Amount and Notes information can be returned as sub-elements under the following response elements: For an active form of payment: Reservation/OpenReservationElements/OpenReservationElements/FormOfPayment/PaymentCard/InterfaceUserRecord For historical transactions: Reservation/History/HistoryTransaction/ItineraryHistoryOrRemarkHistoryOrFactHistory/FormOfPayment/PaymentCard/InterfaceUserRecord
Sample Value:
Request:
<ns8:FormOfPayment>
<ns8:PaymentCard reconcileAsCash="false" virtual="false">
<ns8:PaymentType>CC</ns8:PaymentType>
<ns8:CardCode>VI</ns8:CardCode>
<ns8:CardNumber>XXXXXXXXXXXXXX</ns8:CardNumber>
<ns8:ExpiryMonth>12</ns8:ExpiryMonth>
<ns8:ExpiryYear>2023</ns8:ExpiryYear>
<ns8:DefaultExtendPayment>false</ns8:DefaultExtendPayment>
<ns8:SuppressFromInvoice>false</ns8:SuppressFromInvoice>
<ns8:GenerateApprovalAtTicketing>false </ns8:GenerateApprovalAtTicketing>
<ns8:InterfaceUserRecord>
<ns8:Amount currencyCode="USD">29.90</ns8:Amount>
<ns8:Notes>Notes for Back Office </ns8:Notes>
</ns8:InterfaceUserRecord>
</ns8:PaymentCard>
</ns8:FormOfPayment>
Response:
<or114:FormOfPayment migrated="false">
<or114:PaymentCard reconcileAsCash="false" virtual="false">
<or114:PaymentType>CC</or114:PaymentType>
<or114:CardCode>VI</or114:CardCode>
<or114:CardNumber tokenized="true" masked="true">4XXXXXXXXXXX1111</or114:CardNumber>
<or114:ExpiryMonth>--12</or114:ExpiryMonth>
<or114:ExpiryYear>2023</or114:ExpiryYear>
<or114:DefaultExtendPayment>false</or114:DefaultExtendPayment>
<or114:SuppressFromInvoice>false</or114:SuppressFromInvoice>
<or114:GenerateApprovalAtTicketing>false</or114:GenerateApprovalAtTicketing>
<or114:InterfaceUserRecord>
<or114:Amount currencyCode="USD">29.90</or114:Amount>
<or114:Notes>Notes for Back Office </or114:Notes>
</or114:InterfaceUserRecord>
</or114:PaymentCard>
</or114:FormOfPayment>Note: Full request and response examples containing these new parameters are available in the Resources section.
v1.19.17 | February 16, 2023
- Ability to retrieve additional data from the reservation.
API Information
What's New
- Ability to retrieve additional data from the reservation.
New Features
In the Response
Optional
- Parameter: PreferredCustomer
-
Type: boolean
Description: A new parameter stored in the cardholder's information now indicates whether the cardholder is a preferred customer: *CC« CREDIT CARD DATA PREFERRED CUSTOMER STATUS - AUTO AVS NOT REQUESTED PreferredCustomer will be returned as an attribute within the following response element: Reservation/PassengerReservation/FormsOfPayment/CreditCardPayment/CardHolderInfo/@PreferredCustomer
Sample Value:
<stl19:CardHolderInfo Name="TEST PAX" PreferredCustomer="true">
<stl19:AddressLines>
<stl19:AddressLine>
<stl19:Text>LONG</stl19:Text>
</stl19:AddressLine>
<stl19:AddressLine>
<stl19:Text>STREET</stl19:Text>
</stl19:AddressLine>
<stl19:AddressLine>
<stl19:Text>12323-2323</stl19:Text>
</stl19:AddressLine>
</stl19:AddressLines>
</stl19:CardHolderInfo>Note: Full request and response examples containing this new element are available in the Resource section.
In the Response
Optional
- Parameter: nameId
-
Type: string
Description: A new response parameter called nameId has been added to TicketDetails and AccountingLines. This parameter identifies the Name field the PNR, ticket, and accounting line are associated with. The PNAPNR TJR setting determines whether nameId will be returned in the response. The parameters below will only be returned if PNAPNR is set to ON in the pcc TJR: Reservation/PassengerReservation/Passengers/Passenger/TicketingInfo/TicketDetails/PassengerName/@nameId Reservation/PassengerReservation/Passengers/Passenger/AccountingLines/accountingLine/passengerName/@nameId Reservation/PassengerReservation/TicketingInfo/TicketDetails/PassengerName/@nameId The parameter below will be returned regardless of what the PNAPNR setting is: Reservation/AccountingLines/AccountingLine/PassengerName/@nameId
Sample Value:
AccountingLine information:
<stl19:AccountingLine id="18" index="1" elementId="pnr-18">
<stl19:FareApplication>ONE</stl19:FareApplication>
<stl19:FormOfPaymentCode>CA</stl19:FormOfPaymentCode>
<stl19:AirlineDesignator>AF</stl19:AirlineDesignator>
<stl19:DocumentNumber>7959016930</stl19:DocumentNumber>
<stl19:CommissionAmount>0.00</stl19:CommissionAmount>
<stl19:Fare>1010.00</stl19:Fare>
<stl19:BaseFare>1010.00</stl19:BaseFare>
<stl19:TaxAmount>50.80</stl19:TaxAmount>
<stl19:PassengerName nameId="1.1">MOSIO PAT</stl19:PassengerName>
<stl19:NumberOfConjunctedDocuments>1</stl19:NumberOfConjunctedDocuments>
<stl19:TarriffBasis>F</stl19:TarriffBasis>
<stl19:TransactionInd>E</stl19:TransactionInd>
<stl19:AccountingLineText> AF$7959016930/ 0.00/ 1010.00/ 50.80/ONE/CA 1.1MOSIO PAT/1/F/E</stl19:AccountingLineText>
</stl19:AccountingLine>
TicketDetails information:
<stl19:TicketDetails id="26" index="2" elementId="pnr-26">
<stl19:OriginalTicketDetails>TE 0557959016950-AT MOSIO/P B4T0*-KR 2040/02JUN*</stl19:OriginalTicketDetails>
<stl19:TransactionIndicator>TE</stl19:TransactionIndicator>
<stl19:TicketNumber>0557959016950</stl19:TicketNumber>
<stl19:PassengerName nameId="01.01">MOSIO/P</stl19:PassengerName>
<stl19:AgencyLocation>B4T0</stl19:AgencyLocation>
<stl19:DutyCode>*</stl19:DutyCode>
<stl19:AgentSine>-KR</stl19:AgentSine>
<stl19:Timestamp>2023-06-02T20:40:00</stl19:Timestamp>
<stl19:PaymentType>*</stl19:PaymentType>
<stl19:Status>ACTIVE</stl19:Status>
</stl19:TicketDetails>Note: Full request and response examples containing this new element are available in the Resource section.
v1.19.16 | June 1, 2022
- Ability to add a new IUR attribute during CSL segment creation.
API Information
What's New
- Ability to add a new IUR attribute during CSL segment creation.
New Features
In the Request/Response
Optional
- Parameter: LegacyCompatible
-
Type: boolean
Description: The new IUR attribute ("LegacyCompatible") is valid for GDS bookings only. This parameter is stored within segment details with a default value of "False". This parameter is available in the request and in the response: RQ: ReservationUpdateList/ReservationUpdateItem/ProductUpdate/Product/or:ProductDetails/or:Lodging/@LegacyCompatible RS: Reservation/PassengerReservation/Segments/Product/ns1:ProductDetails/ns1:Lodging/@LegacyCompatible
Sample Value:
RQ:
<ProductUpdate op="C">
<Product>
<or:ProductDetails xmlns:or="http://services.sabre.com/res/or/v1_14">
<or:ProductName type="HHL">Lodging</or:ProductName>
<or:Lodging LegacyCompatible="true">
<or:ResGlobalInfo>
<or:BookingInfo
Email="Orville.Wright@sabre.com"
RequestorID="SG000000">
<or:BookingKey>6fcba3a0-d52a-4d3a-a10c-2fe11bca63de</or:BookingKey>
</or:BookingInfo>
</or:ResGlobalInfo>
...
RS:
<or114:ProductDetails productCategory="AGTLCSSEGMENT" productType="HHL" vendorCode="RT" statusCode="HK" startPoint="SYD" startDateTime="2022-09-13T00:00:00" endPoint="SYD" endDateTime="2022-09-15T00:00:00">
<or114:ProductName type="HHL">Lodging</or114:ProductName>
<or114:Lodging LegacyCompatible="true">
<or114:ResGlobalInfo>
<or114:BookingInfo Status="39" RequestorID="SG000000" InfoSource="100" TransactionId="IHFVIK0101653055002500" Email="Orville.Wright@sabre.com">
<or114:BookingKey>6fcba3a0-d52a-4d3a-a10c-2fe11bca63de</or114:BookingKey>
...
v1.19.0 | August 16, 2018
- Ability to mark PNRs as suspicious
- Informational segment flag inclusion
- New capabilities for hotel content (CRUD)
- Ability to choose PQ (GetPriceQuoteRQ) service version
- Support for meal codes within Air segment
- Support for PrimeHostID field
- Support for FileName field
- New flexible way of using Views and Subject Areas
API Information
What's New
- Ability to mark PNRs as suspicious
- Informational segment flag inclusion
- New capabilities for hotel content (CRUD)
- Ability to choose PQ (GetPriceQuoteRQ) service version
- Support for meal codes within Air segment
- Support for PrimeHostID field
- Support for FileName field
- New flexible way of using Views and Subject Areas
Functional Updates And Enhancements
In the Request
Optional
- Parameter: PriceQuoteServiceVersion
-
Type: string
Description: Defines version of service used to obtain Price Quote content.
Sample Value:
3.2.0
In the Request/Response
Optional
- Parameter: RPH
-
Type: string
Description: The Reference Place Holder (RPH) is an index code used to identify an instance in a collection of like items (e.g. used to assign individual passengers or clients to particular itinerary items).
Sample Value:
001
In the Request/Response
Optional
- Parameter: NameNumber
-
Type: string
Description: "NameNumber" is used to associate the particular frequent flyer number to a particular passenger within the record.
In the Request/Response
Optional
- Parameter: File
-
Type: mixed
Description: "File" is used to return the file name/identifier
In the Request/Response
Optional
- Parameter: ProductCode
-
Type: string
Description: "ProductCode" is used to return the product code.
In the Response
Optional
- Parameter: FileInfo
-
Type: FileInfo.PNRB
In the Request/Response
Optional
- Parameter: Changed
-
Type: string
Description: "Changed" is used to indicate if the passenger's seat as been changed.
In the Request/Response
Optional
- Parameter: NameNumber
-
Type: string
Description: "NameNumber" is used return the passenger name number associated with the particular seat reservation.
In the Request/Response
Optional
- Parameter: PrimeHostID
-
Type: string
Description: An identification code assigned to the GDS.
Sample Value:
1S
In the Response
Optional
- Parameter: CheckInAirline
-
Type: complex type
In the Response
Optional
- Parameter: BaggageAllowance
-
Type: BaggageAllowance
In the Response
Optional
- Parameter: Number
-
Type: string
Description: "Number" is used to return the baggage allowance type associated with the particular flight segment.
In the Response
Optional
- Parameter: Informational
-
Type: boolean
Description: Informational segment indicator
In the Request/Response
Optional
- Parameter: OfferItemID
-
Type: string
Description: Offer Item Id from the offer store
In the Response
Optional
- Parameter: Candidate
-
Type: boolean
Description: Indicator for potential PNR booking for further review
In the Response
Optional
- Parameter: Reporter
-
Type: string
Description: TN or Airline Code reporting potential PNR booking for further review
In the Response
Optional
- Parameter: Value
-
Type: int
Description: TN or Airline Code reporting potential PNR booking for further review
In the Response
Optional
- Parameter: Description
-
Type: string
Description: Short description of reason for reporting potential PNR booking for further review
In the Response
Optional
- Parameter: SpecialEquipment
-
Type: string
Description: Special equipment code. ex. PHN for Mobile Phone
In the Response
Optional
- Parameter: codeContext
-
Type: string
Description: Holds context, where passenger code is defined, ex. ATPC
In the Response
Optional
- Parameter: ValidatingCarrier
-
Type: AirlineCode
Description: IATA Code of ticketing carrier (carrier issuing a ticket and holding settlements) ex. "AA". It is used for informational purposes only. To enforce Validating Carried during pricing process "ValidatingCarrier" Air qualifier should be used.
In the Request/Response
Optional
- Parameter: AncillarySequenceNumber
-
Type: string
Description: "AncillarySequenceNumber" contains ancillary sequence number. Maps to Ancillary/SequenceNumber in GAO
In the Request/Response
Optional
- Parameter: OfferItemID
-
Type: string
Description: "OfferItemID" contains information about Offer Item Id from the offer store.
In the Request/Response
Optional
- Parameter: BagOccurence
-
Type: mixed
Description: "BagOccurence" contains information about Number of occurrences of a given bag ancillary subcode within a PNR
In the Response
Optional
- Parameter: PriceQuote
-
Type: PriceQuoteType
Description: Contains PriceQuoteInfo returned from GetPriceQuoteRS
In the Request/Response
Optional
- Parameter: OfferID
-
Type: string
Description: Offer Id from the offer store
In the Request/Response
Required
- Parameter: Lodging
-
Type: LodgingProductType
In the Request/Response
Optional
- Parameter: ResGlobalInfo
-
Type: ResGlobalInfoType
In the Request/Response
Optional
- Parameter: BookingInfo
-
Type: BookingInfoRefType
In the Request/Response
Optional
- Parameter: Status
-
Type: string
Description: Uses STS OTA Code Table
In the Request/Response
Optional
- Parameter: RequestorID
-
Type: string
In the Request/Response
Optional
- Parameter: CorpDiscount
-
Type: MembershipIdType
In the Request/Response
Optional
- Parameter: PromotionalCode
-
Type: MembershipIdType
In the Request/Response
Optional
- Parameter: CreationDate
-
Type: date
In the Request/Response
Optional
- Parameter: ExistingItinerary
-
Type: boolean
In the Request/Response
Optional
- Parameter: InfoSource
-
Type: string
Description: Booking source will be 3 character numeric code
In the Request/Response
Optional
- Parameter: RateKey
-
Type: SabreKeyType
In the Request/Response
Optional
- Parameter: TransactionId
-
Type: string
Description: This is unique transaction id generated by hotels and should be provided on retries
In the Request/Response
Optional
- Parameter: RetransmissionIndicator
-
Type: boolean
In the Request/Response
Optional
- Parameter: Email
-
Type: string
In the Request/Response
Optional
- Parameter: FrequentFlyerNumber
-
Type: MembershipIdType
In the Request/Response
Optional
- Parameter: LoyaltyId
-
Type: MembershipIdType
In the Request/Response
Optional
- Parameter: HotelInfo
-
Type: HotelInfoType
In the Request/Response
Required
- Parameter: HotelCode
-
Type: string
Description: Hotel Id from SABRE hotels platform
In the Request/Response
Optional
- Parameter: GlobalChainCode
-
Type: string
In the Request/Response
Optional
- Parameter: HotelName
-
Type: string
In the Request/Response
Optional
- Parameter: CodeContext
-
Type: string
Description: SABRE OR GLOBAL
In the Request/Response
Optional
- Parameter: BrandCode
-
Type: string
In the Request/Response
Optional
- Parameter: SabreRating
-
Type: RatingType
In the Request/Response
Optional
- Parameter: CurrencyCode
-
Type: LodgingCurrencyCodeType
In the Request/Response
Optional
- Parameter: ChainName
-
Type: StringLength0to500
In the Request/Response
Optional
- Parameter: BrandName
-
Type: StringLength0to500
In the Request/Response
Optional
- Parameter: SupplierChainCode
-
Type: string
In the Request/Response
Optional
- Parameter: SourceHotelCode
-
Type: string
Description: Supplier/Source Hotel Id
In the Request/Response
Optional
- Parameter: TierLabels
-
Type: TierLabels
In the Request/Response
Optional
- Parameter: TierLabel
-
Type: string
In the Request/Response
Optional
- Parameter: Type
-
Type: StringLength0to500
In the Request/Response
Optional
- Parameter: Value
-
Type: StringLength0to500
In the Request/Response
Optional
- Parameter: LocationInfo
-
Type: LocationInfo
In the Request/Response
Optional
- Parameter: Latitude
-
Type: string
In the Request/Response
Optional
- Parameter: Longitude
-
Type: string
In the Request/Response
Optional
- Parameter: Address
-
Type: LodgingAddressType
In the Request/Response
Required
- Parameter: AddressLine1
-
Type: string
In the Request/Response
Optional
- Parameter: AddressLine2
-
Type: string
In the Request/Response
Optional
- Parameter: AddressLine3
-
Type: string
In the Request/Response
Optional
- Parameter: CityName
-
Type: CityCodeType
In the Request/Response
Optional
- Parameter: StateProv
-
Type: StateProv
In the Request/Response
Optional
- Parameter: PostalCode
-
Type: string
In the Request/Response
Required
- Parameter: CountryName
-
Type: CountryName
In the Request/Response
Optional
- Parameter: CityCode
-
Type: string
In the Request/Response
Optional
- Parameter: StateCode
-
Type: string
In the Request/Response
Required
- Parameter: Code
-
Type: CountryCodeType
In the Request/Response
Optional
- Parameter: Contact
-
Type: ContactType
In the Request/Response
Optional
- Parameter: Phone
-
Type: string
In the Request/Response
Optional
- Parameter: Mobile
-
Type: string
In the Request/Response
Optional
- Parameter: Fax
-
Type: string
In the Request/Response
Optional
- Parameter: Amenities
-
Type: Amenities
In the Request/Response
Optional
- Parameter: Amenity
-
Type: Amenity
In the Request/Response
Optional
- Parameter: Code
-
Type: OTACodeType
Description: Uses HAC table for OTA mapped codes and description. ComplimentaryInd - true : Attribute is not displayed in response as Amenity has no additional charge and it is complimentary false : Amenity has additional charge and appropriately indicated
In the Request/Response
Optional
- Parameter: Description
-
Type: OTATypeDescription
In the Request/Response
Optional
- Parameter: ComplimentaryInd
-
Type: boolean
In the Request/Response
Optional
- Parameter: StayDateRange
-
Type: string
In the Request/Response
Optional
- Parameter: StartDate
-
Type: date
In the Request/Response
Optional
- Parameter: EndDate
-
Type: date
In the Request/Response
Optional
- Parameter: Total
-
Type: TotalCharges
In the Request/Response
Optional
- Parameter: AmountAfterTax
-
Type: MoneyDataType
In the Request/Response
Optional
- Parameter: AmountBeforeTax
-
Type: MoneyDataType
In the Request/Response
Optional
- Parameter: CurrencyCode
-
Type: LodgingCurrencyCodeType
In the Request/Response
Optional
- Parameter: Changed
-
Type: boolean
Description: Denotes that total is changed since shopping
In the Request/Response
Optional
- Parameter: BalanceAmount
-
Type: MoneyDataType
Description: Some aggregators return a balance amount that needs to be paid after cancellation
In the Request/Response
Optional
- Parameter: SupplierChangedAmount
-
Type: MoneyDataType
In the Request/Response
Optional
- Parameter: AdditionalDetails
-
Type: AdditionalDetailsType
In the Request/Response
Optional
- Parameter: AdditionalDetail
-
Type: AdditionalDetailType
In the Request/Response
Optional
- Parameter: Code
-
Type: OTACodeType
In the Request/Response
Optional
- Parameter: Amount
-
Type: MoneyDataType
In the Request/Response
Optional
- Parameter: CurrencyCode
-
Type: LodgingCurrencyCodeType
In the Request/Response
Optional
- Parameter: GuestCount
-
Type: int
In the Request/Response
Optional
- Parameter: StartDate
-
Type: date
In the Request/Response
Optional
- Parameter: EndDate
-
Type: string
In the Request/Response
Optional
- Parameter: NumberOfNights
-
Type: int
In the Request/Response
Optional
- Parameter: Text
-
Type: string
In the Request/Response
Optional
- Parameter: Fees
-
Type: FeesType
In the Request/Response
Optional
- Parameter: Amount
-
Type: MoneyDataType
In the Request/Response
Optional
- Parameter: CurrencyCode
-
Type: LodgingCurrencyCodeType
In the Request/Response
Optional
- Parameter: Fee
-
Type: LodgingFeeType
In the Request/Response
Optional
- Parameter: Code
-
Type: OTACodeType
Description: OpenTravel Code List Fee Tax Type (FIT)
In the Request/Response
Optional
- Parameter: Amount
-
Type: MoneyDataType
In the Request/Response
Optional
- Parameter: CurrencyCode
-
Type: LodgingCurrencyCodeType
In the Request/Response
Optional
- Parameter: ApplyAs
-
Type: string
In the Request/Response
Optional
- Parameter: BasisType
-
Type: string
In the Request/Response
Optional
- Parameter: FeeDescription
-
Type: string
In the Request/Response
Optional
- Parameter: Text
-
Type: string
In the Request/Response
Optional
- Parameter: Taxes
-
Type: LodgingTaxesType
In the Request/Response
Optional
- Parameter: Tax
-
Type: LodgingTaxesType
In the Request/Response
Optional
- Parameter: TaxDescription
-
Type: string
In the Request/Response
Optional
- Parameter: CancelPenalties
-
Type: CancelPenalties
In the Request/Response
Optional
- Parameter: CancelPenalty
-
Type: CancelPenalty
In the Request/Response
Optional
- Parameter: Refundable
-
Type: boolean
In the Request/Response
Optional
- Parameter: Deadline
-
Type: string
In the Request/Response
Optional
- Parameter: AbsoluteDeadline
-
Type: dateTime
In the Request/Response
Optional
- Parameter: OffsetDropTime
-
Type: string
In the Request/Response
Optional
- Parameter: OffsetTimeUnit
-
Type: string
In the Request/Response
Optional
- Parameter: OffsetUnitMultiplier
-
Type: string
In the Request/Response
Optional
- Parameter: AmountPercent
-
Type: string
In the Request/Response
Optional
- Parameter: TaxInclusive
-
Type: boolean
In the Request/Response
Optional
- Parameter: FeesInclusiv
-
Type: boolean
In the Request/Response
Optional
- Parameter: NmbrOfNights
-
Type: int
In the Request/Response
Optional
- Parameter: BasisType
-
Type: string
In the Request/Response
Optional
- Parameter: Percent
-
Type: Percentage
In the Request/Response
Optional
- Parameter: Amount
-
Type: MoneyDataType
In the Request/Response
Optional
- Parameter: CurrencyCode
-
Type: LodgingCurrencyCodeType
In the Request/Response
Optional
- Parameter: ApplyAs
-
Type: string
In the Request/Response
Optional
- Parameter: PenaltyDescription
-
Type: string
In the Request/Response
Optional
- Parameter: Guarantee
-
Type: GuaranteeType
In the Request/Response
Optional
- Parameter: GuaranteeType
-
Type: string
In the Request/Response
Optional
- Parameter: GuaranteesAccepted
-
Type: GuaranteeType
In the Request/Response
Optional
- Parameter: GuaranteeAccepted
-
Type: string
In the Request/Response
Optional
- Parameter: GuaranteeTypeCode
-
Type: OTACodeType
Description: Uses OTA for PMT Table
In the Request/Response
Optional
- Parameter: PaymentCard
-
Type: string
Description: The Card like Credit card or debit card which is used to pay
In the Request/Response
Optional
- Parameter: CardCode
-
Type: PaymentCardCodeType
Description: Code identifying the card type
In the Request/Response
Optional
- Parameter: GuaranteeDescription
-
Type: string
In the Request/Response
Optional
- Parameter: Commission
-
Type: CommissionType
In the Request/Response
Optional
- Parameter: CommissionIndicator
-
Type: boolean
In the Request/Response
Optional
- Parameter: Type
-
Type: string
In the Request/Response
Optional
- Parameter: CommissionDescription
-
Type: string
In the Request/Response
Optional
- Parameter: Discounts
-
Type: Discounts
In the Request/Response
Optional
- Parameter: Discount
-
Type: Discount
In the Request/Response
Optional
- Parameter: Code
-
Type: string
In the Request/Response
Optional
- Parameter: Name
-
Type: string
In the Request/Response
Optional
- Parameter: Amount
-
Type: MoneyDataType
In the Request/Response
Optional
- Parameter: CurrencyCode
-
Type: LodgingCurrencyCodeType
In the Request/Response
Optional
- Parameter: Rooms
-
Type: Rooms
In the Request/Response
Optional
- Parameter: NumberOfRooms
-
Type: int
In the Request/Response
Optional
- Parameter: GuestCount
-
Type: int
In the Request/Response
Required
- Parameter: Room
-
Type: RoomInformation
In the Request/Response
Optional
- Parameter: NonSmoking
-
Type: boolean
In the Request/Response
Optional
- Parameter: BedTypeCode
-
Type: TACodeType
Description: OTA Type Codes , Uses BED Table
In the Request/Response
Optional
- Parameter: AccessibilityInformation
-
Type: OTACodeType
Description: OTA Types Code, Uses PHY table
In the Request/Response
Optional
- Parameter: RoomIndex
-
Type: IndexType
In the Request/Response
Optional
- Parameter: RoomTypeCode
-
Type: string
In the Request/Response
Optional
- Parameter: RoomTypeCode
-
Type: string
In the Request/Response
Optional
- Parameter: RoomType
-
Type: string
In the Request/Response
Optional
- Parameter: InvBlockCode
-
Type: string
In the Request/Response
Optional
- Parameter: RoomCategory
-
Type: string
In the Request/Response
Optional
- Parameter: RoomId
-
Type: string
In the Request/Response
Optional
- Parameter: SegmentNumber
-
Type: int
In the Request/Response
Optional
- Parameter: Floor
-
Type: string
In the Request/Response
Optional
- Parameter: RoomViewCode
-
Type: string
In the Request/Response
Optional
- Parameter: SharedRoomInd
-
Type: boolean
In the Request/Response
Optional
- Parameter: Action
-
Type: UpdateActionCodeForRoom
In the Request/Response
Optional
- Parameter: Guests
-
Type: Guests
In the Request/Response
Optional
- Parameter: Guest
-
Type: complexType
In the Request/Response
Optional
- Parameter: Title
-
Type: string
In the Request/Response
Optional
- Parameter: FirstName
-
Type: string
In the Request/Response
Optional
- Parameter: LastName
-
Type: string
In the Request/Response
Optional
- Parameter: Email
-
Type: EmailType
In the Request/Response
Optional
- Parameter: Age
-
Type: string
Description: Age is mandatory for a child
In the Request/Response
Optional
- Parameter: Index
-
Type: IndexType
In the Request/Response
Optional
- Parameter: LeadGuest
-
Type: boolean
Description: Only one lead passenger per booking
In the Request/Response
Optional
- Parameter: FrequentFlyerNumber
-
Type: MembershipIdType
In the Request/Response
Optional
- Parameter: LoyaltyId
-
Type: MembershipIdType
In the Request/Response
Optional
- Parameter: FullName
-
Type: string
Description: In response sometimes aggregator does not return first name / last name and only full name is returned
In the Request/Response
Optional
- Parameter: Type
-
Type: OTACodeType
In the Request/Response
Optional
- Parameter: Contact
-
Type: ContactType
In the Request/Response
Optional
- Parameter: RoomDescription
-
Type: string
In the Request/Response
Optional
- Parameter: Text
-
Type: string
In the Request/Response
Optional
- Parameter: Name
-
Type: string
In the Request/Response
Optional
- Parameter: RoomExtras
-
Type: RoomExtras
In the Request/Response
Optional
- Parameter: RoomExtra
-
Type: RoomExtra
Description: For adding extras to a Room
In the Request/Response
Optional
- Parameter: Quantity
-
Type: string
Description: Quantity for room extras. Mandatory for request
In the Request/Response
Optional
- Parameter: Type
-
Type: OTACodeType
Description: Uses RMA OTA Table. Only 3 supported CRIB/Rollaway bed/Extra person
In the Request/Response
Optional
- Parameter: Amount
-
Type: MoneyDataType
In the Request/Response
Optional
- Parameter: ConfirmationCode
-
Type: string
Description: Room level Booking Confirmation Code if it exists
In the Request/Response
Optional
- Parameter: CancellationCode
-
Type: string
Description: Room Level Cancellation Code if it exists
In the Request/Response
Optional
- Parameter: BookingStatus
-
Type: string
Description: Room Level Booking Status
In the Request/Response
Optional
- Parameter: RatePlan
-
Type: RatePlanType
In the Request/Response
Optional
- Parameter: RatePlanName
-
Type: string
In the Request/Response
Optional
- Parameter: RatePlanCode
-
Type: string
In the Request/Response
Optional
- Parameter: SupplierRatePlanCode
-
Type: string
In the Request/Response
Optional
- Parameter: RatePlanType
-
Type: string
In the Request/Response
Optional
- Parameter: PrepaidIndicator
-
Type: string
In the Request/Response
Optional
- Parameter: RateAssured
-
Type: string
In the Request/Response
Optional
- Parameter: RatePlanDescription
-
Type: RatePlanDescriptionType
In the Request/Response
Optional
- Parameter: RatePlanInclusions
-
Type: RatePlanInclusionsType
In the Request/Response
Optional
- Parameter: RatePlanInclusionDescription
-
Type: RatePlanInclusionDescriptionType
In the Request/Response
Optional
- Parameter: MealsIncluded
-
Type: MealsIncludedType
In the Request/Response
Optional
- Parameter: MealIncluded
-
Type: MealIncludedType
In the Request/Response
Optional
- Parameter: Breakfast
-
Type: boolean
In the Request/Response
Optional
- Parameter: Lunch
-
Type: boolean
In the Request/Response
Optional
- Parameter: Dinner
-
Type: boolean
In the Request/Response
Optional
- Parameter: MealPlanIndicator
-
Type: boolean
Description: When true Meal Plan is include
In the Request/Response
Optional
- Parameter: MealPlanCode
-
Type: string
Description: Used to Identify the types of meals included. Refer to Open Travel Code List Meal Plan Type (MPT) list of codes
In the Request/Response
Optional
- Parameter: RateInfo
-
Type: RateInfoType
In the Request/Response
Optional
- Parameter: AmountBeforeTax
-
Type: MoneyDataType
In the Request/Response
Optional
- Parameter: AmountAfterTax
-
Type: MoneyDataType
In the Request/Response
Optional
- Parameter: CurrencyCode
-
Type: LodgingCurrencyCodeType
In the Request/Response
Optional
- Parameter: AppliedDiscount
-
Type: boolean
In the Request/Response
Optional
- Parameter: NightlyRate
-
Type: MoneyDataType
In the Request/Response
Optional
- Parameter: AdditionalFeesExcludedIndicator
-
Type: boolean
In the Request/Response
Optional
- Parameter: SupplierChangedAmount
-
Type: MoneyDataType
In the Request/Response
Optional
- Parameter: Rates
-
Type: complexType
In the Request/Response
Required
- Parameter: Rates
-
Type: complexType
In the Request/Response
Optional
- Parameter: ValueAdds
-
Type: ValueAdds
In the Request/Response
Required
- Parameter: ValueAdd
-
Type: complexType
In the Request/Response
Optional
- Parameter: SpecialInstructions
-
Type: SpecialInstructions
In the Request/Response
Required
- Parameter: SpecialInstruction
-
Type: SpecialInstruction
In the Request/Response
Optional
- Parameter: SearchParameters
-
Type: LodgingSearchParameters
In the Request/Response
Required
- Parameter: SearchParameter
-
Type: AttributeType
In the Request/Response
Required
- Parameter: Value
-
Type: string
In the Request/Response
Required
- Parameter: Type
-
Type: string
In the Request/Response
Optional
- Parameter: PaymentInformation
-
Type: LodgingPaymentInformation
In the Request/Response
Required
- Parameter: FormOfPaymentReference
-
Type: complexType
In the Request/Response
Optional
- Parameter: ref
-
Type: string
In the Request/Response
Optional
- Parameter: newRef
-
Type: mixed
In the Request/Response
Optional
- Parameter: deploymentId
-
Type: string
In the Request/Response
Optional
- Parameter: POS
-
Type: LodgingPOSType
In the Request/Response
Optional
- Parameter: Source
-
Type: complexType
In the Request/Response
Optional
- Parameter: AgencyName
-
Type: string
In the Request/Response
Optional
- Parameter: AgentSine
-
Type: string
In the Request/Response
Optional
- Parameter: AgentDutyCode
-
Type: string
In the Request/Response
Optional
- Parameter: Lniata
-
Type: string
In the Request/Response
Optional
- Parameter: AgentOriginCity
-
Type: string
In the Request/Response
Optional
- Parameter: ISOCountryCode
-
Type: string
In the Request/Response
Optional
- Parameter: ISOCurrencyCode
-
Type: string
In the Request/Response
Optional
- Parameter: AuxPlaceOfOrigin
-
Type: string
In the Request/Response
Optional
- Parameter: IATAOriginatorTypeCode
-
Type: string
In the Request/Response
Optional
- Parameter: CreationDate
-
Type: date
In the Request/Response
Optional
- Parameter: CreationTime
-
Type: time
In the Request/Response
Optional
- Parameter: PseudoCityCode
-
Type: string
In the Request/Response
Optional
- Parameter: RequestorID
-
Type: IATA ID is mandatory for GDS Booking
In the Request/Response
Optional
- Parameter: Type
-
Type: OTACodeType
Description: OTA Table UIT : Value 5 for travel agency
In the Request/Response
Optional
- Parameter: Id
-
Type: string
Description: Agency IATA ID
In the Request/Response
Optional
- Parameter: IdContext
-
Type: string
Description: Value : IATA
In the Request/Response
Optional
- Parameter: AgencyAddress
-
Type: LodgingAddressType
Description: Agency Address is mandatory for GDS Booking
In the Request/Response
Optional
- Parameter: AgencyContact
-
Type: ContactType
In the Request/Response
Optional
- Parameter: VoucherInformation
-
Type: VoucherInformation
In the Request/Response
Optional
- Parameter: OfficialSupplierName
-
Type: string
In the Request/Response
Optional
- Parameter: VoucherAttributes
-
Type: complexType
In the Request/Response
Required
- Parameter: VoucherAttribute
-
Type: AttributeType
In the Request/Response
Optional
- Parameter: VoucherDetails
-
Type: complexType
In the Request/Response
Required
- Parameter: VoucherDetail
-
Type: complexType
In the Response
Optional
- Parameter: ODReevalAtETData
-
Type: string
Description: Stores the origin-destination reevaluation data provided by SSI at end transaction(ET1.5) for a given segment. Data in this element will only be available to IX via ASDS.
In the Response
Required
- Parameter: Error
-
Type: short
Description: An error code if the segment in the PNR has failed during reevaluation.
In the Response
Required
- Parameter: ReevaluationMap
-
Type: long
Description: An informational field that stores data about the reevaluation.
In the Response
Required
- Parameter: AvailableSeats
-
Type: short
Description: Availability at the time of end transaction.
v1.18.0 | February 21, 2018
- Support for new FOP type: AccountCode
- Support for Corporate ID with New Payment Card (WS)
- FCMI functionality - price validation on SellCancel
API Information
What's New
- Support for new FOP type: AccountCode
- Support for Corporate ID with New Payment Card (WS)
- FCMI functionality - price validation on SellCancel
Functional Updates And Enhancements
In the Request/Response
Optional
- Parameter: FareCalculationModeIndicator
-
Type: FCMIType
Description: 0 - system priced, 1 - Manually priced, 2 - system priced, but tax data manipulated
In the Request
Optional
- Parameter: FareCalculationPriceIndicator
-
Type: FCMIType
Description: 0 = system computer priced (without any manual modifications except for baggage allowance), 1 = manually priced, 2-9 = for individual airline/system provider use, A-Z = undefined industry use
In the Response
Optional
- Parameter: FCMIType
-
Type: int
Description: possible values: 0 / 1/ 2
In the Response
Optional
- Parameter: FCMIType
-
Type: int
Description: pattern value="[0-9A-Z]"
In the Response
Optional
- Parameter: DayOfWeekInd
-
Type: string
Description: "DayOfWeekInd" is used to return the day of the week indicator.
In the Response
Optional
- Parameter: NumberInParty
-
Type: string
Description: "NumberInParty" is used to return the number of passengers associated with the particular hotel segment.
In the Request/Response
Optional
- Parameter: AccountCode
-
Type: complex Type
In the Response
Optional
- Parameter: Custom
-
Type: string
In the Response
Optional
- Parameter: MaxDurationDays
-
Type: string
Description: Max duration associated with annual multi trip product.
In the Request
Optional
- Parameter: OpenReservationAction
-
Type: complexType
In the Request
Optional
- Parameter: PaymentCardApprovalAction
-
Type: PaymentCardApprovalAction
In the Request
Optional
- Parameter: PaymentCardCorporateIDAction
-
Type: PaymentCardCorporateIDAction
In the Request
Optional
- Parameter: PaymentCardApprovalAction
-
Type: complexType
In the Request
Optional
- Parameter: PaymentCardApproval
-
Type: PaymentCardApproval
In the Request
Required
- Parameter: fopElementId
-
Type: string
In the Request
Required
- Parameter: op
-
Type: OpenReservationOperation
In the Request
Optional
- Parameter: PaymentCardCorporateIDAction
-
Type: complexType
In the Request
Optional
- Parameter: CorporateIDNumber
-
Type: string
In the Request
Optional
- Parameter: OpenReservationOperation
-
Type: string
Description: Possible values: CREATE / UPDATE / DELETE
In the Response
Optional
- Parameter: CardHolderInfo.PNRB
-
Type: complexType
In the Response
Optional
- Parameter: AddressLines
-
Type: AddressLines.PNRB
In the Response
Optional
- Parameter: AirExtras
-
Type: boolean
Description: "AirExtras" is used to indicate whether or not air extra-related information pertains to the particular record.
In the Response
Optional
- Parameter: InhibitCode
-
Type: string
Description: "InhibitCode" is utilized to return the viewership code associated with the particular record.
In the Response
Optional
- Parameter: dayOfWeekInd
-
Type: string
Description: "DayOfWeekInd" is used to return the day of the week indicator.
In the Response
Optional
- Parameter: EquipmentType
-
Type: string
Description: "EquipmentType" is used to return the aircraft equipment type associated with the particular flight segment.
In the Response
Optional
- Parameter: Banner
-
Type: string
Description: "Air/Banner" is used to return the marketing airline name.
In the Response
Optional
- Parameter: Code
-
Type: string
Description: "Code" is used to return the operating airline code used for pricing associated with the particular flight segment.
In the Response
Optional
- Parameter: CodeShare
-
Type: boolean
Description: "CodeShare" is used to indicate if this is a codeshare flight.
In the Response
Optional
- Parameter: SpecialMeal
-
Type: boolean
Description: "SpecialMeal" is used to indicate whether or not a special meal is associated with the particular flight segment.
In the Response
Optional
- Parameter: SmokingAllowed
-
Type: boolean
Description: "SmokingAllowed" is used to indicate whether or not smoking is permitted on the particular flight segment.
Note: Set to false by default
In the Response
Optional
- Parameter: ResBookDesigCode
-
Type: string
Description: "ResBookDesigCode" is used to specify the booking class.
In the Response
Optional
- Parameter: StopQuantity
-
Type: string
Description: "StopQuantity" is used to return the number of stops associated with the particular flight segment.
In the Response
Optional
- Parameter: Code
-
Type: string
Description: "Code" is used to return the meal code associated with the particular flight segment if applicable.
In the Request
Optional
- Parameter: OtherAirlineSign
-
Type: CommonString
Description: Other airline sign information
In the Response
Optional
- Parameter: RefundResult
-
Type: RefundResult.PNRB
In the Response
Required
- Parameter: BookAndHoldResult
-
Type: complexType
In the Response
Optional
- Parameter: AirlineCode
-
Type: AirlineCode
In the Response
Optional
- Parameter: Status
-
Type: complexType
Description: Result of holding a booking for a given airline; SUCCESS, FAILURE
In the Response
Optional
- Parameter: message
-
Type: string
Description: Additional information of the holding result
In the Request
Optional
- Parameter: CarrierRefundItem.PNRB
-
Type: complexType
In the Request
Optional
- Parameter: CarrierRecordLocator
-
Type: string
Description: Determines which segments will be refunded
In the Request
Optional
- Parameter: SegmentSubset
-
Type: SegmentSubset
Description: Tries to refund all possible segments
In the Request
Optional
- Parameter: PaymentAuthorizationCode
-
Type: string
Description: Code needed to handle payment processing
In the Request
Optional
- Parameter: SegmentSubset
-
Type: string
Description: Tries to refund all possible segments
In the Response
Optional
- Parameter: RefundResult.PNRB
-
Type: complexType
In the Response
Optional
- Parameter: CarrierRefund
-
Type: CarrierRefund.PNRB
In the Response
Optional
- Parameter: WarningCarrierRefund
-
Type: WarningCarrierRefund.PNRB
In the Request
Optional
- Parameter: CarrierRefund.PNRB
-
Type: complexType
In the Request
Optional
- Parameter: Amount
-
Type: string
Description: Determines amount that will be refund
In the Request
Optional
- Parameter: CarrierCode
-
Type: string
Description: Determines segment carrier that will be refund
In the Request
Optional
- Parameter: Currency
-
Type: string
Description: Currency amount that will be refund
In the Response
Optional
- Parameter: WarningCarrierRefund.PNRB
-
Type: complexType
In the Response
Optional
- Parameter: CarrierCode
-
Type: string
Description: Determines segment carrier that will not be refund
In the Response
Optional
- Parameter: Message
-
Type: string
Description: Determines the cause, why segments for carrier can not be refund
In the Request
Optional
- Parameter: BookAndHoldType.PNRB
-
Type: complexType
In the Request
Optional
- Parameter: AirlineCode
-
Type: AirlineCode
Description: Determines airline whose segments should be held. If not provided, all eligible segments will be held.
In the Request
Optional
- Parameter: ExemptAllTaxesAndFees
-
Type: boolean
Description: Exempt all taxes and fees (/TN)
v1.17.0 | November 16, 2017
- Book and Hold functionality for Low Cost Carriers
- Extended insurance product for annual multi trip
- COS functionality - support for shortSell and longSell functionalities
- Support for Manual Update fields in RES ORR
API Information
What's New
- Book and Hold functionality for Low Cost Carriers
- Extended insurance product for annual multi trip
- COS functionality - support for shortSell and longSell functionalities
- Support for Manual Update fields in RES ORR
New Features
In the Request
Optional
- Parameter: Cabin
-
Type: CabinType
Description: Generic cabin description data
In the Request
Optional
- Parameter: MealCode
-
Type: string
Description: Meal code associated with the particular flight segment
In the Request
Optional
- Parameter: SmokingAllowed
-
Type: boolean
Description: Indicates whether or not smoking is permitted on the particular flight segment
In the Request
Optional
- Parameter: StopQuantity
-
Type: int
Description: Number of stops associated with the particular flight segment
In the Request
Optional
- Parameter: ElapsedTime
-
Type: int
Description: The elapsed time in minutes associated with the particular flight segment
In the Request
Optional
- Parameter: AirMilesFlown
-
Type: int
Description: Air miles flown associated with the particular flight segment
In the Request
Optional
- Parameter: HiddenStop
-
Type: complexType
Description: Used to return hidden stop details
In the Request
Optional
- Parameter: ArrivalDateTime
-
Type: string
Description: Arrival date and time to hidden stop
In the Request
Optional
- Parameter: DepartureDateTime
-
Type: string
Description: Departure date and time from hidden stop
In the Request
Optional
- Parameter: Airport
-
Type: string
Description: "Airport" is used to determine airport location code
In the Request
Optional
- Parameter: FunnelFlight
-
Type: boolean
Description: "FunnelFlight" is used to determine a funnel flight type for flight segment
In the Request
Optional
- Parameter: ChangeOfGauge
-
Type: boolean
Description: "ChangeOfGauge" is used to determine a change of gauge for flight segment
In the Request
Optional
- Parameter: DisclosureCarrier
-
Type: complexType
Description: Disclosure Carrier is used to return operated flight data
In the Request
Optional
- Parameter: Banner
-
Type: string
Description: "DisclosureCarrier/Banner" is used to return the disclosure carrier name
In the Request
Optional
- Parameter: Code
-
Type: string
Description: "Code" is used to return the disclosure carrier code associated with the particular vehicle segment
In the Request
Optional
- Parameter: DOT
-
Type: boolean
Description: "DOT" is optional data from DSS (DOT) it determines Banner appearance
In the Request
Optional
- Parameter: FareComponent
-
Type: FareComponentWithId
Description: Fare Component information
In the Request
Optional
- Parameter: CabinType
-
Type: complexType
Description: Cabin data form ATPCO RBD Answer Table (A02 record)
In the Request
Optional
- Parameter: code
-
Type: string
Description: Reservation Booking Designator code
In the Request
Optional
- Parameter: sabreCode
-
Type: string
Description: Reservation Booking Designator Sabre code
In the Request
Optional
- Parameter: name
-
Type: string
Description: Long name of the Reservation booking designator. Example: Premium Economy
In the Request
Optional
- Parameter: shortName
-
Type: string
Description: Short name of the Reservation booking designator. Example: PR ECON.
In the Request
Optional
- Parameter: lang
-
Type: string
Description: Language of the names
In the Request
Optional
- Parameter: BaggageInformationType
-
Type: complexType
Description: Information about baggage
In the Request
Optional
- Parameter: Allowance
-
Type: complexType
In the Request
Optional
- Parameter: passengerType
-
Type: string
Description: Type of Passenger
In the Request
Optional
- Parameter: pieces
-
Type: int
Description: Number of Pieces
In the Request
Optional
- Parameter: weight
-
Type: int
Description: Weight Limit
In the Request
Optional
- Parameter: unit
-
Type: string
Description: Units of the Weight Limit
In the Request
Optional
- Parameter: InsuranceOptOut
-
Type: InsuranceOptOut
In the Request
Optional
- Parameter: Profile
-
Type: ProfileType
In the Request
Optional
- Parameter: PriceSummary
-
Type: PriceSummaryType
In the Request
Optional
- Parameter: PriceProvider
-
Type: PricingProviderType
In the Request
Optional
- Parameter: PriceSummaryType
-
Type: complexType
In the Request
Optional
- Parameter: BasePrice
-
Type: DecimalPrice
In the Request
Optional
- Parameter: EquivPrice
-
Type: DecimalPrice
In the Request
Optional
- Parameter: TotalTaxes
-
Type: TaxesType
In the Request
Optional
- Parameter: TotalPrice
-
Type: DecimalPrice
In the Request
Optional
- Parameter: id
-
Type: int
In the Request
Optional
- Parameter: refreshTimestamp
-
Type: dateTime
In the Request
Optional
- Parameter: TaxesType
-
Type: complexType
In the Request
Optional
- Parameter: Tax
-
Type: TaxType
In the Request
Optional
- Parameter: TaxType
-
Type: complexType
In the Request
Optional
- Parameter: TaxAmount
-
Type: DecimalPrice
In the Request
Optional
- Parameter: TaxCode
-
Type: CommonString
In the Request
Optional
- Parameter: ProductSource
-
Type: ProductSourceType
In the Request
Optional
- Parameter: ProductSourceType
-
Type: complexType
In the Request
Optional
- Parameter: code
-
Type: string
In the Request
Optional
- Parameter: name
-
Type: string
In the Request
Optional
- Parameter: vendorName
-
Type: string
In the Request
Optional
- Parameter: supplierName
-
Type: string
In the Request
Optional
- Parameter: supplierCode
-
Type: string
In the Request
Optional
- Parameter: FareComponentWithId
-
Type: complexType
In the Request
Optional
- Parameter: FareComponent
-
Type: int
In the Request
Optional
- Parameter: FareComponentID
-
Type: int
Description: Numeric value identifying fare component
In the Request
Optional
- Parameter: ProfileType
-
Type: complexType
In the Request
Optional
- Parameter: ID
-
Type: string
In the Request
Optional
- Parameter: Type
-
Type: string
Description: Type of Profile, it will be having full name like TAGENCY, TAGENCT etc
In the Request
Optional
- Parameter: Source
-
Type: string
In the Request
Optional
- Parameter: ShortType
-
Type: string
Description: Type of Profile, same as above but in short, it will be having name like AGY, AGT
In the Request
Optional
- Parameter: PolicyId
-
Type: string
Description: PolicyId of the profile
In the Request
Optional
- Parameter: PreferenceId
-
Type: string
Description: PreferenceId of the profile
In the Request
Optional
- Parameter: PolicyRemovalReason
-
Type: string
Description: Reason for removing the reason
In the Request
Optional
- Parameter: OwningAgency
-
Type: string
Description: Name of the PCC where this profile is stored
In the Request
Optional
- Parameter: TierPriority
-
Type: short
In the Request
Optional
- Parameter: Acquirer
-
Type: string
Description: SabrePWS if Sabre Payment Web Services. User may enter any value for 3rd party acquirer.
In the Request
Optional
- Parameter: MaxDurationDays
-
Type: string
Description: Max duration associated with annual multi trip product.
In the Request
Optional
- Parameter: PricingProviderType
-
Type: complexType
In the Request
Optional
- Parameter: ProviderName
-
Type: string
In the Request
Optional
- Parameter: PricingOptions
-
Type: PricingRequestInformationType
In the Request
Optional
- Parameter: PricingRequestInformationType
-
Type: complexType
In the Request
Optional
- Parameter: AirPriceQualifiers
-
Type: AirPriceQualifiersType
In the Request
Optional
- Parameter: HotelRateQualifiers
-
Type: HotelRateQualifiersType
In the Request
Optional
- Parameter: CarRateQualifiers
-
Type: CarRateQualifiersType
In the Request
Optional
- Parameter: PromotionEnumtype
-
Type: string
In the Request
Optional
- Parameter: AirPriceQualifiersType
-
Type: complexType
Description: Specifies passenger numbers and types.
In the Request
Optional
- Parameter: SeatsRequested
-
Type: xsd:nonNegativeInteger
Description: The sum of all seats required by all passenger groups.
In the Request
Optional
- Parameter: AirTravelerAvail
-
Type: TravelerInformationType
Description: Specifies passenger numbers and types.
In the Request
Optional
- Parameter: PriceRequestOptions
-
Type: PriceRequestOptionsType
Description: Identify pricing source, if negotiated fares are requested and if it is a reprice request.
In the Request
Optional
- Parameter: TravelerRating
-
Type: TravelerRatingType
Description: Customer Value Scores and Frequent Flyer Tiers for one traveler. It can influence Availability results when provided.
In the Request
Optional
- Parameter: GoverningCarrierOverride
-
Type: GoverningCarrierOverrideType
Description: Airline Carrier Code - override the GOVERNING CARRIER to get the fare filed by that carrier.
In the Request
Optional
- Parameter: VoluntaryChanges
-
Type: VoluntaryChangesSMPType
Description: Identifies whether penalties associated with voluntary changes should be included in the search results.
In the Request
Optional
- Parameter: RetailerRules
-
Type: RetailerRulesType
In the Request
Optional
- Parameter: TaxRules
-
Type: TaxRulesType
Description: Contains tax depending rules.
In the Request
Optional
- Parameter: ValidatingCarrier
-
Type: ValidatingCarrierType
Description: Validating carrier rule.
In the Request
Optional
- Parameter: CabinPref
-
Type: CabinPrefType
Description: Defines preferred cabin to be used in a search for this leg level (if SegmentType is "O") or segment (if SegmentType is "X"). The cabin type specified in this element will override the cabin type specified at the request level for this leg/segment. If a cabin type is not specified for this element the cabin type at request level will be used as default for this leg or segment. If the cabin type is not specified at both the leg/segment level and request level a default cabin of "Economy" will be used
In the Request
Optional
- Parameter: specificPTC_Indicator
-
Type: boolean
Description: If true, this request is for a specific PTC and only fares applicable to that PTC will be checked and returned. It is the same as XOFares flag in Intellisell request.
In the Request
Optional
- Parameter: tripType
-
Type: AirTripType
Description: Specify air trip type.
In the Request
Optional
- Parameter: xOFares
-
Type: boolean
Description: XOFares indicator
In the Request
Optional
- Parameter: CarRateQualifiersType
-
Type: complexType
In the Request
Optional
- Parameter: Corporate
-
Type: complexType
In the Request
Optional
- Parameter: ID
-
Type: string
In the Request
Optional
- Parameter: CustLoyalty
-
Type: complexType
In the Request
Optional
- Parameter: programID
-
Type: string
Description: Identifier to indicate the company owner of the loyalty program.
In the Request
Optional
- Parameter: membershipId
-
Type: string
Description: Unique identifier of the member in the program (membership number, account number, etc.).
In the Request
Optional
- Parameter: GuaranteePrepaid
-
Type: complexType
In the Request
Optional
- Parameter: returnGuaranteedRates
-
Type: boolean
In the Request
Optional
- Parameter: returnPrepaidRates
-
Type: boolean
In the Request
Optional
- Parameter: returnRegularRates
-
Type: boolean
In the Request
Optional
- Parameter: ID
-
Type: complexType
In the Request
Optional
- Parameter: Number
-
Type: string
In the Request
Optional
- Parameter: Promotion
-
Type: complexType
In the Request
Optional
- Parameter: Code
-
Type: string
In the Request
Optional
- Parameter: type
-
Type: PromotionEnumtype
In the Request
Optional
- Parameter: RateCode
-
Type: string
In the Request
Optional
- Parameter: TourCode
-
Type: complexType
In the Request
Optional
- Parameter: Text
-
Type: string
In the Request
Optional
- Parameter: VehiclePreferences
-
Type: complexType
In the Request
Optional
- Parameter: Preference
-
Type: complexType
In the Request
Optional
- Parameter: VehicleType
-
Type: string
In the Request
Optional
- Parameter: LocationPreferences
-
Type: complexType
In the Request
Optional
- Parameter: locationCode
-
Type: string
In the Request
Optional
- Parameter: cityLocation
-
Type: string
Note: Possible values are: "E:, "N", "S", "W", "C", "R", "A", "I", "P", "X", "H"
In the Request
Optional
- Parameter: VendorPreferences
-
Type: complexType
In the Request
Optional
- Parameter: VendorPreference
-
Type: complexType
In the Request
Optional
- Parameter: code
-
Type: string
In the Request
Optional
- Parameter: exclude
-
Type: boolean
In the Request
Optional
- Parameter: SpecialEquipmentPreferences
-
Type: complexType
In the Request
Optional
- Parameter: Preference
-
Type: complexType
In the Request
Optional
- Parameter: equipType
-
Type: string
In the Request
Optional
- Parameter: ccRate
-
Type: string
In the Request
Optional
- Parameter: commission
-
Type: boolean
In the Request
Optional
- Parameter: currencyCode
-
Type: string
In the Request
Optional
- Parameter: mileagePlan
-
Type: string
In the Request
Optional
- Parameter: rateAssured
-
Type: boolean
In the Request
Optional
- Parameter: rateCategory
-
Type: string
In the Request
Optional
- Parameter: ratePlan
-
Type: string
In the Request
Optional
- Parameter: HotelRateQualifiersType
-
Type: complexType
In the Request
Optional
- Parameter: RateAccessCode
-
Type: complexType
In the Request
Optional
- Parameter: code
-
Type: string
In the Request
Optional
- Parameter: ContractNegotiatedRateCode
-
Type: string
In the Request
Optional
- Parameter: RatePlanCode
-
Type: complexType
In the Request
Optional
- Parameter: ValidatingCarrierType
-
Type: complexType
In the Request
Optional
- Parameter: Preference
-
Type: complexType
In the Request
Optional
- Parameter: code
-
Type: CarrierCode
Description: Validating Carrier code
In the Request
Optional
- Parameter: level
-
Type: ValidatingCarrierPreferLevelType
In the Request
Optional
- Parameter: TaxRulesType
-
Type: complexType
Description: Combines exemption rules connected with taxes.
In the Request
Optional
- Parameter: ExemptAllTaxes
-
Type: boolean
Description: Exempt all taxes (/TE)
In the Request
Optional
- Parameter: ExemptTax
-
Type: TaxCodeType
Description: Exempt Tax (/TE)
In the Request
Optional
- Parameter: RetailerRulesType
-
Type: complexType
In the Request
Optional
- Parameter: RetailerRule
-
Type: complexType
In the Request
Optional
- Parameter: code
-
Type: string
Description: pattern value=[0-9a-zA-Z]{2,20}
In the Request
Optional
- Parameter: force
-
Type: boolean
Description: If set to true, only fares with a matched Business Rule containing the specified Retailer Rule Qualifier will be returned
In the Request
Optional
- Parameter: VoluntaryChangesSMPType
-
Type: complexType
Description: Specifies charges and/or penalties associated with making ticket changes after purchase.
In the Request
Optional
- Parameter: Penalty
-
Type: complexType
Description: Specifies penalty charges as either a currency amount or a percentage of the fare.
In the Request
Optional
- Parameter: type
-
Type: string
Description: Indicates the type (Refund or Exchange) of penalty involved in the search or response.
Note: Possible values are: "Refund" and "Exchange"
In the Request
Optional
- Parameter: exclude
-
Type: boolean
Description: Indicate that specific penalty type should be excluded from the response.
In the Request
Optional
- Parameter: application
-
Type: string
Description: Identifier used to indicate whether the change occurs before or after departure from the origin city.
Note: Possible values are: "After" and "Before"
In the Request
Optional
- Parameter: match
-
Type: string
Description: Indicates relation between conditions.
Note: Possible values are: "All" - Conditions are joined by logical conjunction - fare needs to fulfill all the conditions to be returned in response.; "Any" - Conditions are joined by logical disjunction - fare needs to fulfill at least one of the conditions to be returned in response.; "Info" - Return penalty information
In the Request
Optional
- Parameter: GoverningCarrierOverrideType
-
Type: complexType
In the Request
Optional
- Parameter: airlineCode
-
Type: CarrierCode
Description: Airline Carrier Code - override the GOVERNING CARRIER to get the fare filed by that carrier.
In the Request
Optional
- Parameter: TravelerRatingType
-
Type: complexType
Description: Customer Value Scores and Frequent Flyer Tiers for one traveler. It can influence Availability results when provided.
In the Request
Optional
- Parameter: Score
-
Type: ScoreType
In the Request
Optional
- Parameter: FrequentFlyer
-
Type: FrequentFlyerType
In the Request
Optional
- Parameter: ScoreType
-
Type: complexType
In the Request
Optional
- Parameter: value
-
Type: integer
In the Request
Optional
- Parameter: carrier
-
Type: string
In the Request
Optional
- Parameter: FrequentFlyerType
-
Type: complexType
In the Request
Optional
- Parameter: tier
-
Type: integer
In the Request
Optional
- Parameter: NegotiatedFareCodeType
-
Type: complexType
In the Request
Optional
- Parameter: Supplier
-
Type: string
Description: This element indicates the supplier associated with a negotiated fare code.
In the Request
Optional
- Parameter: AccountCodeType
-
Type: complexType
In the Request
Optional
- Parameter: IndDefaultFalseType
-
Type: complexType
In the Request
Optional
- Parameter: ind
-
Type: boolean
In the Request
Optional
- Parameter: IndType
-
Type: complexType
In the Request
Optional
- Parameter: IndRequiredType
-
Type: complexType
In the Request
Optional
- Parameter: ind
-
Type: boolean
In the Request
Optional
- Parameter: PriorityType
-
Type: complexType
In the Request
Optional
- Parameter: priority
-
Type: int
In the Request
Optional
- Parameter: PriorityLegType
-
Type: complexType
In the Request
Optional
- Parameter: leg
-
Type: positiveInteger
In the Request
Optional
- Parameter: CarrierType
-
Type: complexType
In the Request
Optional
- Parameter: Carrier
-
Type: complexType
Description: Specifies desired order of carriers
In the Request
Optional
- Parameter: PriorityComplexType
-
Type: complexType
In the Request
Optional
- Parameter: Price
-
Type: PriorityType
Description: Prefer cheaper itineraries
In the Request
Optional
- Parameter: DirectFlights
-
Type: PriorityLegType
Description: Prefer itineraries will less connections
In the Request
Optional
- Parameter: Time
-
Type: PriorityType
Description: Prefer itineraries departing closer to requested departure time
In the Request
Optional
- Parameter: Vendor
-
Type: PriorityType
Description: Promote certain marketing carriers over all the others in returning results. (configured in rules).
In the Request
Optional
- Parameter: MarketingCarrier
-
Type: CarrierType
Description: Prefer itineraries with marketing carriers in order speciied in Carrier subtags, comparing segment-wise
In the Request
Optional
- Parameter: OperatingCarrier
-
Type: CarrierType
Description: Prefer itineraries with operating carriers in order speciied in Carrier subtags, comparing segment-wise
In the Request
Optional
- Parameter: ElapsedTime
-
Type: PriorityType
Description: Prefer itineraries with shorter travel times
In the Request
Optional
- Parameter: DepartureTime
-
Type: PriorityLegType
Description: Prefer itineraries departing earlier during the day
In the Request
Optional
- Parameter: ConnectionTime
-
Type: PriorityLegType
Description: Prefer itineraries with smaller amount of time waiting in the airports during connections
In the Request
Optional
- Parameter: IndicatorsType
-
Type: complexType
In the Request
Optional
- Parameter: RetainFare
-
Type: IndRequiredType
Description: If set to true, fares that have a min/max stay can be included in the responses. If set to false, then no fares that include a min/max stay requirement will be included in the response.
In the Request
Optional
- Parameter: RefundPenalty
-
Type: IndRequiredType
Description: If set to true, fares that have a refund penalty can be included in the responses. If set to false, then no fares that include a refund penalty requirement will be included in the response.
In the Request
Optional
- Parameter: ResTicketing
-
Type: IndRequiredType
Description: If set to true, fares that have a reservation/ticketing can be included in the responses. If set to false, then no fares that include reservation/ticketing requirement will be included in the response.
In the Request
Optional
- Parameter: TravelPolicy
-
Type: IndRequiredType
Description: This element is currently ignored whether it is true or false.
In the Request
Optional
- Parameter: CustomerComplexType
-
Type: string
Note: Possible values are: "REGULAR" - Regular customer type.; "TVLYPREF" - TVLY_PREFERRED customer type.; "PREFELITE" - PREFERED_ELITE customer type.; "LOYALTY" - LOYALTY customer type.
In the Request
Optional
- Parameter: ItinerariesPerGroupType
-
Type: complexType
In the Request
Optional
- Parameter: itinerariesPerGroup
-
Type: int
Description: Indicates desired number of itineraries to be returned in each passenger group at begining of response.
In the Request
Optional
- Parameter: BrandedFareIndicatorsType
-
Type: complexType
In the Request
Optional
- Parameter: ReturnCheapestUnbrandedFare
-
Type: IndRequiredType
In the Request
Optional
- Parameter: singleBrandedFare
-
Type: boolean
Description: Return single brand option per itin
In the Request
Optional
- Parameter: multipleBrandedFares
-
Type: boolean
Description: Return multiple brand options per itin
In the Request
Optional
- Parameter: returnBrandAncillaries
-
Type: boolean
Description: Return ancillaries from the ATPCO Branded Fares Feature
In the Request
Optional
- Parameter: PassengerStatusEnumType
-
Type: string
Description: Possible values are: "R" - Residency; "E" - Employment; "N" Nationality
In the Request
Optional
- Parameter: PassengerStatusType
-
Type: complexType
In the Request
Optional
- Parameter: StateCode
-
Type: string
In the Request
Optional
- Parameter: CountryCode
-
Type: string
In the Request
Optional
- Parameter: CityCode
-
Type: AlphaLength3
In the Request
Optional
- Parameter: type
-
Type: PassengerStatusEnumType
In the Request
Optional
- Parameter: ETicketableOverrideType
-
Type: complexType
In the Request
Optional
- Parameter: CurrencyType
-
Type: complexType
In the Request
Optional
- Parameter: dual
-
Type: AlphaLength3
Description: Dual currency
In the Request
Optional
- Parameter: mOverride
-
Type: boolean
Description: M override
In the Request
Optional
- Parameter: OBFeesType
-
Type: complexType
In the Request
Optional
- Parameter: rType
-
Type: boolean
Description: Indicator Returning R-Type OB Fees
In the Request
Optional
- Parameter: tType
-
Type: boolean
Description: Indicator Returning T-Type OB Fees
In the Request
Optional
- Parameter: FareAdjustmentType
-
Type: complexType
In the Request
Optional
- Parameter: value
-
Type: string
Description: Adjustment Value, can be positive or negative, number or percentage
In the Request
Optional
- Parameter: currency
-
Type: AlphaLength3
Description: Currency of Adjustment's Value
In the Request
Optional
- Parameter: ValueType
-
Type: complexType
In the Request
Optional
- Parameter: value
-
Type: decimal
In the Request
Optional
- Parameter: PriceRequestOptionsType
-
Type: complexType
Description: Identify pricing source, if negotiated fares are requested and if it is a reprice request.
In the Request
Optional
- Parameter: NegotiatedFareCode
-
Type: NegotiatedFareCodeType
In the Request
Optional
- Parameter: AccountCode
-
Type: AccountCodeType
In the Request
Optional
- Parameter: PublicFare
-
Type: IndDefaultFalseType
Description: This element finds only public fares.
In the Request
Optional
- Parameter: PrivateFare
-
Type: IndDefaultFalseType
Description: This element finds only private fares.
In the Request
Optional
- Parameter: IATAFare
-
Type: IndDefaultFalseType
Description: This element finds only IATA fares.
In the Request
Optional
- Parameter: WebFare
-
Type: IndType
Description: Web fare
In the Request
Optional
- Parameter: Priority
-
Type: PriorityComplexType
Description: This element governs how flights are returned. A user can uses a priority of 1-9 to make this determination.
In the Request
Optional
- Parameter: Indicators
-
Type: IndicatorsType
Description: This element restricts fares which can be returned in response. If a customer passes this element, all its children should be specified.
In the Request
Optional
- Parameter: PromoID
-
Type: string
Description: Promotional Identifier - a string which identifies a promotion, possibly giving a discount prices etc.
In the Request
Optional
- Parameter: CustomerType
-
Type: CustomerComplexType
In the Request
Optional
- Parameter: MultipleTravelerGroups
-
Type: ItinerariesPerGroupType
Description: This element governs how flights are returned when multiple passenger groups are requested.
In the Request
Optional
- Parameter: BrandedFareIndicators
-
Type: BrandedFareIndicatorsType
In the Request
Optional
- Parameter: PassengerStatus
-
Type: PassengerStatusType
In the Request
Optional
- Parameter: PointOfSaleOverride
-
Type: string
Description: Will return the fares available for specified point of sale and priced in this point of sale currency. Currency is overridden b PriceRequestInformation@CurrencyCode.
In the Request
Optional
- Parameter: PointOfTicketingOverride
-
Type: string
In the Request
Optional
- Parameter: ApplyResidentDiscount
-
Type: boolean
Description: Apply resident discount in CLFE
In the Request
Optional
- Parameter: ETicketableOverride
-
Type: ETicketableOverrideType
In the Request
Optional
- Parameter: Currency
-
Type: CurrencyType
In the Request
Optional
- Parameter: UseReducedConstructions
-
Type: IndType
Description: Use reduced constructions (simple fare paths with restrictions on the number of fare components).
In the Request
Optional
- Parameter: OBFees
-
Type: OBFeesType
In the Request
Optional
- Parameter: FareBreaksAtLegs
-
Type: IndType
Description: Force fare breaks at leg points if split taxes by leg requested. By default set to true.
In the Request
Optional
- Parameter: FareAdjustment
-
Type: FareAdjustmentType
Description: Capability to specify Plus-Up and Discount Amount and Percentage.
In the Request
Optional
- Parameter: ForceCompanion
-
Type: ValueType
Description: Force companion fare value.
In the Request
Optional
- Parameter: UsePassengerFares
-
Type: IndRequiredType
Description: At least one fare component for each passenger type must be applicable for that passenger type.
In the Request
Optional
- Parameter: UseNegotiatedFares
-
Type: IndRequiredType
Description: At least one fare component for each passenger type must be applicable for that passenger type.
In the Request
Optional
- Parameter: UseNegotiatedFares
-
Type: IndRequiredType
Description: Returned fares need to match AcccountCode/CorporateID on at least one fare component.
In the Request
Optional
- Parameter: negotiatedFaresOnly
-
Type: boolean
Description: If set to true then returned fares need to match requested AcccountCode/CorpID on all fare components
In the Request
Optional
- Parameter: currencyCode
-
Type: AlphaLength3
Description: Type of funds preferred for reviewing monetary values, in ISO 4217 codes.
In the Request
Optional
- Parameter: pricingSource
-
Type: RequestPricingSourceType
Description: It can be used to indicate whether the fare is public or private.
In the Request
Optional
- Parameter: reprice
-
Type: boolean
In the Request
Optional
- Parameter: processThruFaresOnly
-
Type: boolean
Description: Activates processing of thru fares only.
In the Request
Optional
- Parameter: purchaseDate
-
Type: date
Description: Specify purchase date. Fares returned will be based on the purchase date.
In the Request
Optional
- Parameter: purchaseTime
-
Type: string
Description: Specify purchase time. Fares returned will be based on the purchase time.
In the Request
Optional
- Parameter: netFaresUsed
-
Type: boolean
Description: Set to true when exchange ticket uses net fare.
In the Request
Optional
- Parameter: RequestPricingSourceType
-
Type: string
Description: It can be used to indicate whether the fare is public or private.
Note: Possible values are: "Published", "Private", "Both"
In the Request
Optional
- Parameter: secondaryCode
-
Type: string
Description: An additional attribute to allow flexibility for particular organizations who require an additional code.
In the Request
Optional
- Parameter: supplierCode
-
Type: string
Description: An additional attribute to allow flexibility for particular organizations who require an additional supplier code.
In the Request
Optional
- Parameter: codeContext
-
Type: string
Description: Identifies the source authority for the code.
In the Request
Optional
- Parameter: URI
-
Type: anyURI
Description: Identifies the location of the code table
In the Request
Optional
- Parameter: quantity
-
Type: int
Description: Specifies the number of items that are identified by the Code (e.g., 2 adults, 5 first class seats)
In the Request
Optional
- Parameter: TravelerInformationType
-
Type: complexType
Description: Specifies passenger numbers and types.
In the Request
Optional
- Parameter: PassengerTypeQuantity
-
Type: PassengerTypeQuantityType
Description: Specifies number of passengers using Passenger Type Codes.
In the Request
Optional
- Parameter: AirTraveler
-
Type: AirTravelerType
Description: Information profiling the person traveling Gender - the gender of the customer, if needed BirthDate - Date of Birth Currency - the preferred currency in which monetary amounts should be returned.
In the Request
Optional
- Parameter: AirTravelerType
-
Type: complexType
Description: Information about the person traveling. Gender - the gender of the customer, if needed. BirthDate - Date of Birth. Currency - the preferred currency in which monetary amounts should be returned.
In the Request
Optional
- Parameter: CustLoyalty
-
Type: CustLoyaltyType
Description: Specify a customer loyalty program.
In the Request
Optional
- Parameter: TravelerRefNumber
-
Type: TravelerRefNumberType
Description: Direct reference of traveler assigned by requesting system. Used as a cross reference between data segments.
In the Request
Optional
- Parameter: FlightSegmentRPHs
-
Type: FlightSegmentRPHsType
Description: Reference pointers to flight segments
In the Request
Optional
- Parameter: passengerTypeCode
-
Type: AlphaLength3
Description: A three-letter code representing passenger type (e.g. .ADT. for adult, .CNN. for child)
In the Request
Optional
- Parameter: accompaniedByInfant
-
Type: boolean
Description: Indicates if an infant accompanying a traveler is with or without a seat.
In the Request
Optional
- Parameter: FlightSegmentRPHsType
-
Type: complexType
In the Request
Optional
- Parameter: FlightSegmentRPH
-
Type: string
Description: Reference to the flight segments for this traveler
In the Request
Optional
- Parameter: TravelerRefNumberType
-
Type: complexType
Description: A reference place holder used as a pointer to link back to the traveler.
In the Request
Optional
- Parameter: RPH
-
Type: string
Description: Reference place holder.
In the Request
Optional
- Parameter: CustLoyaltyType
-
Type: complexType
Description: Program rewarding frequent use by accumulating credits for services provided by vendors.
In the Request
Optional
- Parameter: travelSector
-
Type: string
Description: Identifies the travel sector. Refer to OTA Code List Travel Sector (TVS).
In the Request
Optional
- Parameter: loyalLevel
-
Type: string
In the Request
Optional
- Parameter: singleVendorInd
-
Type: SingleVendorIndType
In the Request
Optional
- Parameter: signupDate
-
Type: date
In the Request
Optional
- Parameter: SingleVendorIndType
-
Type: NMTOKEN
Description: Indicates if program is affiliated with a group of related offers accumulating credits.
Note: Possible values are: "SingleVndr" and "Alliance"
In the Request
Optional
- Parameter: PassengerTypeQuantityType
-
Type: complexType
Description: Specifies a PTC (Passenger Type Code) and the associated number of PTC's - for use in specifying passenger lists.
In the Request
Optional
- Parameter: BirthDate
-
Type: BirthDateType
In the Request
Optional
- Parameter: Age
-
Type: AgeType
Description: Exchange-specific
In the Request
Optional
- Parameter: State
-
Type: StateType
Description: Exchange-specific
In the Request
Optional
- Parameter: TotalNumber
-
Type: TotalNumberType
Description: Exchange-specific
In the Request
Optional
- Parameter: changeable
-
Type: boolean
Description: Default value is "true"
In the Request
Optional
- Parameter: index
-
Type: int
Description: Allows to identify which one of requested passengers this solution relates to.
In the Request
Optional
- Parameter: requestedPassengerIndex
-
Type: nonNegativeInteger
Description: Allows to identify which one of requested passenger groups from Exchange request this solution relates to.
In the Request
Optional
- Parameter: BirthDateType
-
Type: complexType
In the Request
Optional
- Parameter: date
-
Type: date
In the Request
Optional
- Parameter: AgeType
-
Type: complexType
In the Request
Optional
- Parameter: years
-
Type: short
In the Request
Optional
- Parameter: StateType
-
Type: complexType
In the Request
Optional
- Parameter: TotalNumberType
-
Type: complexType
In the Request
Optional
- Parameter: value
-
Type: short
In the Request
Optional
- Parameter: AlphaLength3
-
Type: string
Description: Used for Alphabetic Strings, length exactly 3
Note: pattern value="[a-zA-Z]{3}"
In the Request
Optional
- Parameter: TravelerCountType
-
Type: complexType
Description: Defines the number of travelers of a specific type (e.g. a driver type can be either one of: Adult, YoungDriver, YoungerDriver, or it may be a code that is acceptable to bothTrading Partners).
In the Request
Optional
- Parameter: DecimalPrice
-
Type: complexType
Description: Provides a monetary amount and the currency code to reflect the currency in which this amount is expressed.
In the Request
Optional
- Parameter: currencyCode
-
Type: CurrencyCodeType
Description: A currency code (e.g. USD, EUR, PLN)
In the Request
Optional
- Parameter: TaxCodeType
-
Type: complexType
Description: Defines the data fields available for tax code.
In the Request
Optional
- Parameter: taxCode
-
Type: string
Description: Identifies the code for the tax.
In the Request
Optional
- Parameter: CabinPrefType
-
Type: complexType
Description: Indicates preferences for choice of airline cabin for a given travel situation.
In the Request
Optional
- Parameter: preferLevel
-
Type: PreferLevelType
Description: Used to indicate a level of preference for an associate item, only, unacceptable, preferred.
Note: Default value is "Preferred"
In the Request
Optional
- Parameter: cabin
-
Type: CabinNameType
Description: Specify cabin type.
In the Request
Optional
- Parameter: CabinNameType
-
Type: NMTOKEN
Description: A cabin is either Premium First (P), First (F), Premium Business (J), Business (C), Premium Economy (S) or Economy (Y)
Note: Possible values are: Premium First, P, First, F, Premium Business, J, Business, C, Premium Economy, S, Economy, Y
In the Request
Optional
- Parameter: PreferLevelType
-
Type: NMTOKEN
Description: Used to specify a preference level for something that is or will be requested (e.g. a supplier of a service, a type of service, a form of payment, etc.).
Note: Possible values are: "Only", "Unacceptable", "Preferred"
In the Request
Optional
- Parameter: Money
-
Type: decimal
Description: Used for amounts, max 3 decimals
In the Request
Optional
- Parameter: decimalPlaces
-
Type: nonNegativeInteger
Description: Indicates the number of decimal places for a particular currency. This is equivalent to the ISO 4217 standard "minor unit".
In the Request
Optional
- Parameter: amount
-
Type: Money
In the Request
Optional
- Parameter: CurrencyCodeType
-
Type: AlphaLength3
Description: Used for Currency Codes
In the Request
Optional
- Parameter: CarrierCode
-
Type: string
Note: pattern value="[0-9A-Z]{2,3}
In the Request
Optional
- Parameter: AirTripType
-
Type: string
Description: Identifies the trip type - one way, return, circle trip, open jaw.
Note: Possible values are: "OneWay", "Return", "Circle", "OpenJaw", "Other"
In the Request
Optional
- Parameter: ValidatingCarrierPreferLevelType
-
Type: NMTOKEN
Description: Used to specify a preference level for ValidatingCarrier. For adding new enums see PreferLevelType.
Note: Possible values are: "Unacceptable" and "Preferred"
In the Request
Optional
- Parameter: RefundResult
-
Type: RefundResult.PNRB
In the Request
Optional
- Parameter: BookAndHoldResult
-
Type: complexType
In the Request
Optional
- Parameter: AirlineCode
-
Type: AirlineCode
In the Request
Optional
- Parameter: Status
-
Type: complexType
Description: Result of holding a booking for a given airline; SUCCESS, FAILURE
In the Request
Optional
- Parameter: message
-
Type: string
Description: Additional information of the holding result
In the Request
Optional
- Parameter: OwningAgency
-
Type: AgencyName
Description: This attribute specifies the PCC, where the profile exist. It can be alphanumeric value of 4 length.
In the Request
Optional
- Parameter: AgencyName
-
Type: string
Description: pattern value = "[A-Z0-9]{4}"
In the Request
Optional
- Parameter: CarrierRefundItem.PNRB
-
Type: complexType
In the Request
Optional
- Parameter: CarrierRecordLocator
-
Type: string
Description: Determines which segment will be refunded
In the Request
Optional
- Parameter: SegmentSubset
-
Type: SegmentSubset
Description: Tries to refund all possible segments.
In the Request
Optional
- Parameter: PaymentAuthorizationCode
-
Type: string
Description: Code needed to handle payment processing
In the Request
Optional
- Parameter: SegmentSubset
-
Type: string
Description: Tries to refund all possible values
In the Request
Optional
- Parameter: RefundResult.PNRB
-
Type: complexType
In the Request
Optional
- Parameter: CarrierResult.PNRB
-
Type: complexType
In the Request
Optional
- Parameter: CarrierResult
-
Type: CarrierResult.PNRB
In the Request
Optional
- Parameter: WarningCarrierResult
-
Type: WarningCarrierResult.PNRB
In the Request
Optional
- Parameter: CarrierResult.PNRB
-
Type: complexType
In the Request
Optional
- Parameter: CarrierCode
-
Type: string
Description: Determines segment carrier that will be refund.
In the Request
Optional
- Parameter: Currency
-
Type: string
Description: Currency amount that will be refund.
In the Request
Optional
- Parameter: WarningCarrierRefund.PNRB
-
Type: complexType
In the Request
Optional
- Parameter: Message
-
Type: mmxed
Description: Determines the cause, why segments for carrier can not be refund.
In the Request
Optional
- Parameter: BookAndHoldType.PNRB
-
Type: complexType
In the Request
Optional
- Parameter: AirlineCode
-
Type: AirlineCode
Description: Determines airline whose segments should be held. If not provided, all eligible segments will be held.
v1.16.0 | May 12, 2017
- PQ Fare Component data
- Disclosure Carrier support
- Change of Gauge indicator
- Hidden Stop, Elapsed Time and Air Miles Flown for flight
- Ability to update/cancel Email Address in PNR using UpdateReservationRQ
API Information
What's New
- PQ Fare Component data
- Disclosure Carrier support
- Change of Gauge indicator
- Hidden Stop, Elapsed Time and Air Miles Flown for flight
- Ability to update/cancel Email Address in PNR using UpdateReservationRQ
New Features
In the Response
Optional
- Parameter: Language
-
Type: boolean
Description: "Language" is used to translate attributes (like Cabin name)
In the Response
Optional
- Parameter: id
-
Type: UniqueIdentifier
Description: Unique id
In the Response
Optional
- Parameter: op
-
Type: OperationType
Description: Operation Type (C = Create, U = Update, D = Delete)
In the Response
Optional
- Parameter: isDirectConnectPlatformBooking
-
Type: boolean
Description: Indicates if Direct Connect Platform (DCP) booking, created by GSA or ownership changed to DCP by RES agent
In the Response
Optional
- Parameter: isDirectConnectPlatformBooking
-
Type: boolean
Description: Indicates if Direct Connect Platform (DCP) booking, created by GSA or ownership changed to DCP by RES agent
In the Request/Response
Optional
- Parameter: AirSegmentUpdate
-
Type: complex
Description: Used to book/delete air segment
Note: This element has been deleted
In the Response
Optional
- Parameter: FareComponent
-
Type: complex
Description: Fare Component is used to return Fare Component Data
In the Response
Optional
- Parameter: Location
-
Type: complex
Description: Location is used to return Origin and Destination for Fare component
In the Response
Optional
- Parameter: Origin
-
Type: string
Description: Origin is used to return origin of Fare Component
In the Response
Optional
- Parameter: Destination
-
Type: string
Description: Destination is used to return Destination of Fare Component
In the Response
Optional
- Parameter: Dates
-
Type: complex
Description: Dates are used to return departure and arrival date and time of Fare Component
In the Response
Optional
- Parameter: DepartureDateTime
-
Type: srting
Description: Departure Date Time is used to return departure date and time of Fare Component
In the Request
Optional
- Parameter: ArrivalDateTime
-
Type: string
Description: Arrival Date Time is used to return arrival date and time of Fare Component
In the Response
Optional
- Parameter: FlightSegmentNumbers
-
Type: complex
Description: Fare Segment Numbers are used to return flights associated with Fare Component
In the Response
Optional
- Parameter: FlightSegmentNumber
-
Type: string
Description: FareSegmentNumber is used to return single flight associated with Fare Component
In the Response
Optional
- Parameter: FareBasisCode
-
Type: string
Description: Fare Basis Code is used to return Fare Basis Code of Fare Component
In the Request
Optional
- Parameter: FareDirectionality
-
Type: string
Description: Fare Directionality is used to return Directionality of Fare used for particular Fare Component (TO; FROM)
In the Response
Optional
- Parameter: Amount
-
Type: string
Description: Amount is used to return NUC amount for particular Fare Component
In the Request
Optional
- Parameter: TicketDesignator
-
Type: string
Description: TicketDesignator is used to return Ticket Designator Code attached to Fare Basis Code.
In the Response
Optional
- Parameter: GoverningCarrier
-
Type: string
Description: used to return Governing Carrier Code (e.g. EY, AA, LH)
In the Response
Optional
- Parameter: FareComponentNumber
-
Type: string
Description: used to display number of fare component stored in PQ
In the Response
Optional
- Parameter: RuleName
-
Type: string
Description: used to return rule details
In the Response
Optional
- Parameter: Deal
-
Type: complex
Description: used to return information about applied discount/markup for this ancillary
In the Response
Optional
- Parameter: Percentage
-
Type: decimal
Description: used to return information defined in RULE for percentage discounts/markups
In the Response
Optional
- Parameter: Amount
-
Type: decimal
Description: used to return information defined in RULE for monetary discounts/markups
In the Response
Optional
- Parameter: Currency
-
Type: string
Description: used to return information defined in RULE for monetary discounts/markups
In the Response
Required
- Parameter: Type
-
Type: string
Description: used to return information about deal type
In the Response
Optional
- Parameter: RuleId
-
Type: string
Description: used to return Rule Id
In the Response
Optional
- Parameter: DisclosureCarrier
-
Type: complex
Description: used to return operated flight data
In the Response
Optional
- Parameter: Banner
-
Type: string
Description: used to return the disclosure carrier message
In the Response
Optional
- Parameter: Code
-
Type: string
Description: used to return the disclosure carrier code associated with the particular flight segment
In the Response
Optional
- Parameter: DOT
-
Type: boolean
Description: DOT is optional data from DSS it determines Banner appearance
In the Response
Optional
- Parameter: ElapsedTime
-
Type: string
Description: used to return the elapsed time associated with the particular flight segment
In the Response
Optional
- Parameter: AirMilesFlown
-
Type: string
Description: used to return the air miles flown associated with the particular flight segment
In the Response
Optional
- Parameter: HiddenStop
-
Type: complex
Description: used to return Hidden stop details (Airport, Date of arrival/departure)
In the Response
Optional
- Parameter: ArrivalDateTime
-
Type: string
Description: used to return arrival date and time from Hidden Stop
In the Response
Optional
- Parameter: DepartureDateTime
-
Type: string
Description: used to return departure date and time from Hidden Stop
In the Response
Optional
- Parameter: Airport
-
Type: string
Description: used to determine airport location code
In the Response
Optional
- Parameter: FunnelFlight
-
Type: boolean
Description: used to determine if a flight is a funnel flight type
In the Response
Optional
- Parameter: ChangeOfGauge
-
Type: boolean
Description: used to determine a funnel flight type for flight segment
In the Response
Optional
- Parameter: InstantPurchase
-
Type: boolean
Description: Indication of LCC segment. (e.g. FALSE)
In the Response
Optional
- Parameter: BrandID
-
Type: BrandIDType
Description: 2 Chars string representing sold brand. (e.g. PE)
In the Response
Optional
- Parameter: Cabin
-
Type: complex
Description: is used to return cabin code
In the Response
Optional
- Parameter: Code
-
Type: string
Description: is used to return Reservation Booking Designator code for cabin
In the Response
Optional
- Parameter: SabreCode
-
Type: mixed
Description: is used to return Reservation Booking Designator sabre code for cabin
In the Response
Optional
- Parameter: Name
-
Type: string
Description: is used to return long name of the Reservation booking designator (i.e Premium Economy)
In the Request
Optional
- Parameter: ShortName
-
Type: string
Description: is used to return short name of the Reservation booking designator (i.e PR ECON)
In the Response
Optional
- Parameter: Lang
-
Type: string
Description: is used to return Language of the names for Cabin
In the Response
Optional
- Parameter: Loyalty
-
Type: Loyalty
Description: is used to return loyalty data
In the Response
Optional
- Parameter: FrequentFlayer
-
Type: FrequentFlayer
Description: is used to return FF data
In the Response
Optional
- Parameter: PriceCache
-
Type: PriceCache
Description: is used to return Pricing data
In the Response
Optional
- Parameter: TripProposalReference
-
Type: TripProposalReference
Description: is used to link Trip Proposal to PNR
In the Response
Optional
- Parameter: Loyalty
-
Type: string
Description: is used to return loyalty data
In the Response
Optional
- Parameter: ServiceRequest
-
Type: string
Description: is used to return request data
In the Response
Optional
- Parameter: Email
-
Type: string
Description: is used to return Email data
In the Response
Optional
- Parameter: PriceCache
-
Type: string
Description: is used to return Pricing data
In the Response
Optional
- Parameter: InsuranceOptOut
-
Type: string
Description: is used to return insurance data
In the Response
Optional
- Parameter: TripProposalReference
-
Type: string
Description: is used to return Trip Proposal data
In the Response
Optional
- Parameter: Visa
-
Type: VisaType
Description: is used to return Visa data
In the Response
Optional
- Parameter: Insurance
-
Type: InsuranceType
Description: is used to return insurance data
In the Response
Optional
- Parameter: Vehicle
-
Type: VehicleType
Description: is used to return car data
In the Response
Optional
- Parameter: Other
-
Type: OtherType
Description: is used to return other data
In the Response
Optional
- Parameter: Ski
-
Type: SkiType
Description: is used to return ski data
In the Response
Optional
- Parameter: comment
-
Type: string
Description: is used to return comments
In the Response
Optional
- Parameter: VisaType
-
Type: ComplexType
Description: is used to return Visa type data
In the Response
Optional
- Parameter: CustomerResponsibility ID
-
Type: string
Description: is used to return id data
In the Response
Optional
- Parameter: Rates
-
Type: complexType
Description: is used to return rate data
In the Response
Optional
- Parameter: FOP
-
Type: string
Description: is used to return form of payment data
In the Response
Optional
- Parameter: amount
-
Type: decimal
Description: is used to return rates amount
In the Response
Optional
- Parameter: currency
-
Type: string
Description: is used to return currency code for rates amount
In the Response
Optional
- Parameter: ServiceFee
-
Type: complexType
Description: is used to return fee data
In the Response
Optional
- Parameter: amount
-
Type: decimal
Description: is used to return service fee amount
In the Response
Optional
- Parameter: currency
-
Type: string
Description: is used to return service fee currency
In the Response
Optional
- Parameter: DestinationCountry
-
Type: complexType
Description: is used to return destination data
In the Response
Optional
- Parameter: code
-
Type: string
Description: is used to return destination country code
In the Response
Optional
- Parameter: name
-
Type: string
Description: is used to return Destination Country name
In the Response
Optional
- Parameter: ProcessingTime
-
Type: complexType
Description: is used to return processing time data
In the Response
Optional
- Parameter: Duration
-
Type: string
Description: is used to return duration of processing time
In the Response
Optional
- Parameter: used to return duration of processing time
-
Type: string
Description: is used to return notes
In the Response
Optional
- Parameter: Unit
-
Type: string
Description: is used to return processing time unit data
In the Response
Optional
- Parameter: Purpose
-
Type: complexType
Description: is used to return additional visa data
In the Response
Optional
- Parameter: Comments
-
Type: string
Description: is used to return additional visa data
In the Response
Optional
- Parameter: Transit
-
Type: complexType
Description: is used to return additional visa data
In the Response
Optional
- Parameter: City
-
Type: complexType
Description: is used to return additional visa data
In the Response
Optional
- Parameter: name
-
Type: string
Description: is used to return additional visa data
In the Response
Optional
- Parameter: Vendor
-
Type: complexType
Description: is used to return additional visa data
In the Response
Optional
- Parameter: Name
-
Type: string
Description: is used to return additional visa data
In the Response
Optional
- Parameter: Duration
-
Type: string
Description: is used to return additional visa data
In the Response
Optional
- Parameter: Payment
-
Type: string
Description: is used to return additional visa data
In the Response
Optional
- Parameter: Receiver
-
Type: string
Description: is used to return additional visa data
In the Response
Optional
- Parameter: PricingElements
-
Type: PricingElementsType
Description: is used to return additional visa data
In the Response
Optional
- Parameter: Ski
-
Type: complexType
Description: is used to return ski data
In the Response
Optional
- Parameter: Booking
-
Type: complexType
Description: is used to return ski data
In the Request
Optional
- Parameter: ID
-
Type: string
Description: is used to return Id of the ski booking data
In the Response
Optional
- Parameter: ChangePolicy
-
Type: complexType
Description: is used to return ski change policy data
In the Response
Optional
- Parameter: Conditions
-
Type: string
Description: is used to return ski change policy conditions data
In the Response
Optional
- Parameter: ConditionsDefault
-
Type: string
Description: is used to return additional ski data
In the Response
Optional
- Parameter: City
-
Type: complexType
Description: is used to return additional ski data
In the Request
Optional
- Parameter: code
-
Type: string
Description: is used to return additional ski data
In the Request
Optional
- Parameter: name
-
Type: string
Description: is used to return additional ski data
In the Response
Optional
- Parameter: ClothingHire
-
Type: complexType
Description: is used to return additional ski data
In the Response
Optional
- Parameter: Item
-
Type: is used to return additional ski data
Description: is used to return additional ski data
In the Response
Optional
- Parameter: EquipmentHire
-
Type: SkiCommonElementsType
Description: is used to return additional ski data
In the Response
Optional
- Parameter: Extras
-
Type: SkiCommonElementsType
Description: is used to return additional ski data
In the Response
Optional
- Parameter: Lessons
-
Type: SkiCommonElementsType
Description: is used to return additional ski data
In the Response
Optional
- Parameter: LiftPass
-
Type: SkiCommonElementsType
Description: is used to return additional ski data
In the Response
Optional
- Parameter: Location
-
Type: complexType
Description: is used to return additional ski data
In the Response
Optional
- Parameter: Regions
-
Type: complexType
Description: is used to return additional ski data
In the Response
Optional
- Parameter: name
-
Type: string
Description: is used to return additional ski data
In the Response
Optional
- Parameter: Resort
-
Type: complexType
Description: is used to return additional ski data
In the Response
Optional
- Parameter: name
-
Type: string
Description: is used to return additional ski data
In the Response
Optional
- Parameter: Vendor
-
Type: complexType
Description: is used to return additional ski data
In the Response
Optional
- Parameter: code
-
Type: string
Description: is used to return additional ski data
In the Response
Optional
- Parameter: name
-
Type: string
Description: is used to return additional ski data
In the Response
Optional
- Parameter: Transfers
-
Type: complexType
Description: is used to return additional ski data
In the Response
Optional
- Parameter: Description
-
Type: string
Description: is used to return additional ski data
In the Response
Optional
- Parameter: PricingElements
-
Type: PricingElementsType
Description: is used to return additional ski data
In the Response
Optional
- Parameter: LateDeparturePolicy
-
Type: string
Description: is used to return additional Hotel product data
In the Response
Optional
- Parameter: PricingElements
-
Type: PricingElementsType
Description: is used to return additional Hotel product data
In the Response
Optional
- Parameter: LateDepartureRequired
-
Type: boolean
Description: is used to return additional Hotel product data
In the Response
Optional
- Parameter: SeatNumber
-
Type: string
Description: is used to return additional rail product data
In the Response
Optional
- Parameter: TypeOfPass
-
Type: string
Description: is used to return additional rail product data
In the Response
Optional
- Parameter: DateOfBirth
-
Type: date
Description: is used to return additional data for ground transportation product
In the Response
Optional
- Parameter: Profile
-
Type: complexType
Description: is used to return additional ground transportation product data
In the Response
Optional
- Parameter: ID
-
Type: string
Description: is used to return additional ground transportation product data
In the Response
Optional
- Parameter: Type
-
Type: string
Description: is used to return additional ground transportation product data
In the Response
Optional
- Parameter: source
-
Type: string
Description: is used to return additional ground transportation product data
In the Response
Optional
- Parameter: PriceCache
-
Type: complexType
Description: is used to return open reservation element data
In the Response
Optional
- Parameter: ProviderName
-
Type: string
Description: is used to return open reservation element data
In the Response
Optional
- Parameter: Comment
-
Type: complexType
Description: is used to return open reservation element data
In the Response
Optional
- Parameter: name
-
Type: string
Description: is used to return open reservation element data
In the Response
Optional
- Parameter: type
-
Type: string
Description: is used to return open reservation element data
In the Response
Optional
- Parameter: ProviderRequest
-
Type: complexType
Description: is used to return open reservation element data
In the Response
Optional
- Parameter: ProviderResponse
-
Type: complexType
Description: is used to return open reservation element data
In the Response
Optional
- Parameter: Loyalty
-
Type: complexType
Description: is used to return open reservation element data
In the Response
Optional
- Parameter: ProgramName
-
Type: string
Description: is used to return open reservation element data
In the Response
Optional
- Parameter: MembershipID
-
Type: string
Description: is used to return open reservation element data
In the Response
Optional
- Parameter: LoyaltyLevel
-
Type: CodeDescription
Description: is used to return open reservation element data
In the Response
Optional
- Parameter: Code
-
Type: string
Description: is used to return open reservation element data
In the Response
Optional
- Parameter: EffectiveDate
-
Type: string
Description: is used to return open reservation element data
In the Response
Optional
- Parameter: ExpireDate
-
Type: dateTime
Description: is used to return open reservation element data
In the Response
Optional
- Parameter: Remark
-
Type: string
Description: is used to return open reservation element data
In the Response
Optional
- Parameter: Metadata
-
Type: complexType
Description: is used to return open reservation element data
In the Response
Optional
- Parameter: DisplayIndex
-
Type: int
Description: is used to return open reservation element data
In the Response
Optional
- Parameter: FrequentFlyer
-
Type: complexType
Description: is used to return open reservation element data
In the Response
Optional
- Parameter: PartnershipAirlineCodes
-
Type: string
Description: is used to return open reservation element data
In the Response
Optional
- Parameter: ActionCode
-
Type: string
Description: is used to return open reservation element data
In the Response
Optional
- Parameter: PreviousActionCode
-
Type: string
Description: is used to return open reservation element data
In the Response
Optional
- Parameter: Vendor
-
Type: string
Description: is used to return open reservation element data
In the Request
Optional
- Parameter: ReceivingCarrierCode
-
Type: string
Description: is used to return open reservation element data
In the Request
Optional
- Parameter: VitType
-
Type: short
Description: is used to return open reservation element data
In the Response
Optional
- Parameter: FrequentFlyerNumber
-
Type: string
Description: is used to return open reservation element data
In the Response
Optional
- Parameter: MembershipID
-
Type: string
Description: is used to return open reservation element data
In the Response
Optional
- Parameter: ProductType
-
Type: string
Description: is used to return open reservation element data
In the Response
Optional
- Parameter: ProgramCode
-
Type: string
Description: is used to return open reservation element data
In the Response
Optional
- Parameter: Provider
-
Type: string
Description: is used to return open reservation element data
In the Response
Optional
- Parameter: CITierLevel
-
Type: string
Description: is used to return open reservation element data
In the Response
Optional
- Parameter: ATPCOTierLevel
-
Type: string
Description: is used to return open reservation element data
In the Response
Optional
- Parameter: Indicators
-
Type: string
Description: is used to return open reservation element data
In the Response
Optional
- Parameter: Text
-
Type: string
Description: is used to return open reservation element data
In the Response
Optional
- Parameter: Banner
-
Type: string
Description: is used to return open reservation element data
In the Response
Optional
- Parameter: Tag
-
Type: string
Description: is used to return open reservation element data
In the Response
Optional
- Parameter: Tag2Char
-
Type: string
Description: is used to return open reservation element data
In the Response
Optional
- Parameter: PriceQuoteType
-
Type: complexType
Description: is used to return PQ open reservation element data
In the Request
Optional
- Parameter: AirSegmentUpdate
-
Type: AirSegmentUpdate
Description: This Element has been DELETED
v1.15 | October 1, 2016
- New schema version for v1.15 was introduced with the following main items included in the response: 1. Past date PNRs support 2. Tax Exempt Indicator support 3. Support of multiple OpenReservationElement
API Information
What's New
- New schema version for v1.15 was introduced with the following main items included in the response: 1. Past date PNRs support 2. Tax Exempt Indicator support 3. Support of multiple OpenReservationElement