After a fare quote has been stored, Ticketing modifiers can be included that apply only to the ticket issued from a stored fare and not the price. The Ticketing modifiers are associated to the AirPricingInfo that they modify. They include:
- Tour and Bulk Tickets
- Plating Carrier
- Commission
- Endorsement Box
- Tour Code
Most of these modifiers are valid in any country/BSP, but there may be minor exceptions.
Each entry that contains updated ticketing modifiers acts as an overwrite for the entire list of modifiers stored with that fare. For example: If a commission override and a plating carrier have been stored with the fare, and an endorsement needs to be added, the entry must re-state the commission amount and the plating carrier along with the new endorsement. If only the endorsement data is sent in, the commission and plating carrier information are removed. Modifiers are removed in the same way: by submitting all existing modifiers and omitting the modifier which is no longer needed.
Commission can be added at the time of booking through the Commission ticketing modifier in AirCreateReservationReq. Commission is the only ticketing modifier supported at the time of booking. See Commission below for more information.
Request
Ticketing modifiers can be:
- Added using UniversalRecordModifyReq/UniversalModifyCmd/AirAdd/AirPricingTicketingModifiers/TicketingModifiers
- Deleted using UniversalRecordModifyReq/UniversalModifyCmd/AirDelete/TicketingModifiersRef (this message removes all modifiers associated with TicketModifiersRef). For example,
<univ:UniversalRecordModifyReq ReturnRecord="true" Version="2" TargetBranch="A9876543" xmlns:air="http://www.travelport.com/schema/air_v50_0" xmlns:univ="http://www.travelport.com/schema/universal_v50_0" xmlns:com="http://www.travelport.com/schema/common_v50_0">
<BillingPointOfSaleInfo OriginApplication="UAPI" xmlns="http://www.travelport.com/schema/common_v50_0" /> <com:ContinuityCheckOverride>yes</com:ContinuityCheckOverride>
<univ:RecordIdentifier ProviderCode="1G" ProviderLocatorCode="ABCDE7" UniversalLocatorCode="GQAAAA"/>
<univ:UniversalModifyCmd Key="1">
<univ:AirDelete ReservationLocatorCode="GQBBBB" Element="TicketingModifiers" Key="0W123==" />
</univ:UniversalModifyCmd>
</univ:UniversalRecordModifyReq>Note: Since this request will delete all the ticketing modifiers including PlatingCarrier, any fare that has plating carrier restrictions will return error “FARE HAS PLATING CARRIER RESTRICTION - CANNOT DELETE MODIFIER”. If this is case, Ticketing Modifier/s will have to be deleted manually or in TerminalCommand.
- Updated incrementally
To add Ticketing modifiers to multiple stored fares using a single Universal API request, use multiple UniversalModifyCmds, and specify the data separately for each stored fare. For a particular stored fare, all the AirPricingTicketingModifiers/AirPricingInfoRef must be specified or an error is returned. A stored fare is identified by the value of AirPricingInfoGroup, and all AirPricingInfos that have the same AirPricingInfoGroup belong to the same stored fare in the provider reservation. Refer to the UniversalRecordModifyReq schema to view TicketingModifiers elements and attributes.
TourCode (Group Tour) and Bulk Ticket
GroupTour allows an agency to update the fare as a Group Tour (inclusive tour) ticket. BulkTicket allows an agency to update the fare as a Bulk ticket.
The SuppressOnFareCalc attribute controls how the fare calculation is printed on the ticket for both elements. If SuppressOnFareCalc is not set, the default is print Fare Calculation. Check to ensure the provider supports this functionality.
Plating Carrier
PlatingCarrier allows an agency to specify the Plating Carrier for ticketing. For example,
<univ:UniversalRecordModifyReq xmlns:com="http://www.travelport.com/schema/common_v50_0" xmlns:univ="http://www.travelport.com/schema/universal_v50_0" xmlns:air="http://www.travelport.com/schema/air_v50_0" ReturnRecord="true" TargetBranch="P1234567" Version="1">
<com:ContinuityCheckOverride>yes</com:ContinuityCheckOverride>
<univ:RecordIdentifier ProviderCode="1G" ProviderLocatorCode="AB1CDE" UniversalLocatorCode="ABC123" />
<univ:UniversalModifyCmd Key="1">
<univ:AirAdd ReservationLocatorCode="ABC123">
<air:AirPricingTicketingModifiers>
<air:AirPricingInfoRef Key="+ABcdEFg123456==" />
<air:TicketingModifiers PlatingCarrier="VA">
</air:TicketingModifiers>
</air:AirPricingTicketingModifiers>
</univ:AirAdd>
</univ:UniversalModifyCmd>
</univ:UniversalRecordModifyReq>-
Any fare that has plating carrier restrictions will return the message:
ERROR 5659 - FARE HAS PLATING CARRIER RESTRICTION - CANNOT DELETE MODIFIER
Commission
Commission is typically used for Net Remittance.
As of Universal v35.0 and later, the common Commission element is also in AirCreateReservationReq and can be used to specify commission at the time of booking. Commission is the only ticketing modifier supported in AirCreateReservationReq.
Example of a standalone Commission in AirCreateReservationReq:
<air:AirPricingTicketingModifiers>
<air:AirPricingInfoRef Key="0AA/BDAA==" />
<air:TicketingModifiers>
<com:Commission Level="Fare" Type="PercentBase" Percentage="3.00" />
</air:TicketingModifiers>
</air:AirPricingTicketingModifiers>
</univ:AirCreateReservationReq>
Note: In theTicketingModifier element, the TicketEndorsement, TourCode, and GroupTour elements can be added in combination with Commission for Galileo (1G). These modifier cannot be added as standalone in AirCreateReservationReq, except the Commission ticketing modifier. For example, a combination of Commission, TourCode and TicketEndorsement in a single request:
Request
<univ:UniversalRecordModifyReq xmlns:com="http://www.travelport.com/schema/common_v50_0" xmlns:univ="http://www.travelport.com/schema/universal_v50_0" xmlns:air="http://www.travelport.com/schema/air_v50_0" ReturnRecord="true" TargetBranch="P1234567" Version="1">
<com:BillingPointOfSaleInfo OriginApplication="UAPI" />
<com:ContinuityCheckOverride>yes</com:ContinuityCheckOverride>
<univ:RecordIdentifier ProviderCode="1G" ProviderLocatorCode="RSTUVW" UniversalLocatorCode="GABCDE" />
<univ:UniversalModifyCmd Key="1">
<univ:AirAdd ReservationLocatorCode="GABCDG">
<air:AirPricingTicketingModifiers>
<air:AirPricingInfoRef Key="vJAA==" />
<air:TicketingModifiers><com:Commission Level="Fare" Percentage="5.00" Type="PercentBase" />
<air:TourCode Value="A0000000F"/>
<air:TicketEndorsement Value="MAX 29 CHAR PER LINE INC SPCE" />
<air:TicketEndorsement Value="MAX 3 ENDORSEMENTS" />
<air:TicketEndorsement Value="PER TICKET" />
</air:TicketingModifiers>
</air:AirPricingTicketingModifiers>
</univ:AirAdd>
</univ:UniversalModifyCmd>
</univ:UniversalRecordModifyReq>
Response:
A successful response returns message “Universal record successfully modified” and added element is shown in UniversalRecord:
<air:TicketingModifiersRef Key="vJAA==" />
</air:AirPricingInfo>
<air:TicketingModifiers PlatingCarrier="VA" Key="vJAA==" ElStat="A">
<common_v50_0:Commission Level="Fare" Type="PercentBase" Percentage="5.0" />
<air:TourCode Value="A0000000F" />
<air:TicketEndorsement Value="MAX 29 CHAR PER LINE INC SPCE" />
<air:TicketEndorsement Value="MAX 3 ENDORSEMENTS" />
<air:TicketEndorsement Value="PER TICKET" />
<air:DocumentSelect IssueElectronicTicket="true" />
</air:TicketingModifiers>
</air:AirReservation>
Level
@Level must be "Fare" or an error is returned. For example, Level="Fare"
Type
@Type can be either "Flat", "PercentBase", or "PercentTotal".
-
If "Flat", then Amount or Value must be present or an error is returned. Decimal point in Amount is optional. For example,
-
Commission Level="Fare" Type="Flat" Amount="10.00"
-
Commission Level="Fare" Type="Flat" Value="100"
-
- If "PercentBase" or "PercentTotal", then Percentage must be present or an error is returned. Percentage value must include a decimal point or an error is returned. For example.
- Commission Level="Fare" Type="PercentBase" Percentage="5.0”
- Commission Level="Fare" Type="PercentTotal" Percentage="10.0"
-
@Amount is used for Net Remit ticketing, and documents how the commission is to be calculated/reported. Amount is an optional string. Either the Value or the Amount attribute must be populated, but are mutually exclusive.
-
@Value is used for Net Remit ticketing, and documents how the commission is to be calculated/reported. The Value is supported only if the BSP permits a Net Remit scheme. A Value that is valid for the scheme/method for customer’s BSP must be entered.
Special characters and spaces are not supported in @Value because they are not accepted by Galileo. Value supports non-numeric commission values. When the Value attribute is populated, additional Commission attributes must have the following values:
- Level="Fare"
- Type="Flat"
Value is an optional string. Either the Value or the Amount attribute must be populated, but are mutually exclusive. Additionally, if the Value attribute is populated, a valid value must be supplied in the Modifier attribute.
Modifier enumeration values: FarePercent, FareAmount, CommissionAmount, LessStandardCommission, StandardPlusSupplementaryPercent, SupplementaryPercent, SupplementaryAmount
Endorsement
TicketEndorsement allows endorsements to be added to the ticket. Only the first 29 characters of each endorsement are added to the stored fare and saved in the Universal Record. Up to three manually-entered endorsements are allowed. For example:
Request
<univ:UniversalRecordModifyReq xmlns:com="http://www.travelport.com/schema/common_v50_0" xmlns:univ="http://www.travelport.com/schema/universal_v50_0" xmlns:air="http://www.travelport.com/schema/air_v50_0" ReturnRecord="true" TargetBranch="P1234567" TraceId="21-66" Version="0">
<com:BillingPointOfSaleInfo OriginApplication="UAPI" />
<com:ContinuityCheckOverride>yes</com:ContinuityCheckOverride>
<univ:RecordIdentifier ProviderCode="1G" ProviderLocatorCode="ABCDE7" UniversalLocatorCode="ABCDEO" />
<univ:UniversalModifyCmd Key="1">
<univ:AirAdd ReservationLocatorCode="ABCDEP">
<air:AirPricingTicketingModifiers>
<air:AirPricingInfoRef Key="0WAA==" />
<air:TicketingModifiers>
<air:TicketEndorsement Value="MAX 29 CHAR PER LINE INC SPCE" />
<air:TicketEndorsement Value="MAX 3 ENDORSEMENTS" />
<air:TicketEndorsement Value="PER TICKET" />
</air:TicketingModifiers>
</air:AirPricingTicketingModifiers>
</univ:AirAdd></univ:UniversalModifyCmd>
</univ:UniversalRecordModifyReq>
Response
A successful response returns message “Universal record successfully modified” and added element is shown in UniversalRecord.
<air:TicketingModifiersRef Key="0WAA==" />
</air:AirPricingInfo>
<air:TicketingModifiers PlatingCarrier="VA" Key="0WAA==" ElStat="A">
<air:TicketEndorsement Value="MAX 29 CHAR PER LINE INC SPCE" />
<air:TicketEndorsement Value="MAX 3 ENDORSEMENTS" />
<air:TicketEndorsement Value="PER TICKET" />
<air:DocumentSelect IssueElectronicTicket="true" />
</air:TicketingModifiers>
</air:AirReservation>
Note: TicketEndorsement modifier cannot be added as standalone in AirCreateReservationReq
Tour Code
TourCode modifies the tour code information on the ticket. Galileo allows up to 14 characters, and Apollo allows up to 15 characters. If the TourCode/Value is exceeded on the Galileo Host, an error is returned. For example:
Request<univ:UniversalRecordModifyReq xmlns:com="http://www.travelport.com/schema/common_v50_0"
xmlns:univ="http://www.travelport.com/schema/universal_v50_0" xmlns:air="http://www.travelport.com/schema/air_v50_0"
ReturnRecord="true" TargetBranch="P1234567" TraceId="21-66" Version="1">
<com:BillingPointOfSaleInfo OriginApplication="UAPI" />
<com:ContinuityCheckOverride>yes</com:ContinuityCheckOverride>
<univ:RecordIdentifier ProviderCode="1G" ProviderLocatorCode="STUVWX" UniversalLocatorCode="ABCDEO" />
<univ:UniversalModifyCmd Key="1">
<univ:AirAdd ReservationLocatorCode="ABCDEP">
<air:AirPricingTicketingModifiers>
<air:AirPricingInfoRef Key="0WAA==" />
<air:TicketingModifiers>
<air:TourCode Value="AB111111F" />
</air:TicketingModifiers>
</air:AirPricingTicketingModifiers>
</univ:AirAdd>
</univ:UniversalModifyCmd>
</univ:UniversalRecordModifyReq>
Response
A successful response returns message “Universal record successfully modified” and added element is shown in UniversalRecord.
<air:TicketingModifiersRef Key="0WAA==" />
</air:AirPricingInfo>
<air:TicketingModifiers PlatingCarrier="VA" Key="0W17yiE0nDKAWZtSSAAAAA==" ElStat="A">
<air:TourCode Value="AB111111F" />
<air:DocumentSelect IssueElectronicTicket="true" />
</air:TicketingModifiers>
</air:AirReservation>
Note: TourCode cannot be added as standalone in AirCreateReservationReq.
Response
A successful response includes the UniversalRecordModifyRsp.
Document Instruction (DI) Lines (1P)
UniversalRecord/AirReservation/TicketingModifiers DI information, such as FreeText, DocumentInstructionNumber, Status, and NameNumber, is returned in
-
AirRetrieveDocumentRsp/
-
AirExchangeRsp/
-
BookingDisplayRsp/
-
BookingRetrieveDocumentRsp/
-
UniversalRecordImportRsp/
-
UniversalRecordRetrieveRsp/
With the Universal v48.0 Release, the request retrieves all the DI line Lines present in the PNR from the provider and returns the DI lines as Free Text in the response. For example:
<air:TicketingModifiers Key="ZmWi5d/Y3BKATfiAAAAAAA==" ElStat="A" FreeText=" N1.1|K8.5" DocumentInstructionNumber="1" Status=”Ticketed” NameNumber="1.1" IsPrimaryDI="false" >
<BookingTravelerRef Key="iqYs30Z+TtSh9xXV6q50yA=="/>
<common_v47_0:Commission Level="Fare" Type="PercentBase" Percentage="8.5"/>
</air:TicketingModifiers>
Prior schema versions continue to support the old format of displaying DI without the "status" information.
Exceptions
Galileo
- Galileo allows Baggage, Ticket Designator and Validity Dates only on manual fares, not system-generated fares.
- The following modifiers are not supported on Galileo:
- Net Remit Override (NR$)
- Non Refundable Bulk Ticket (GBN)
- ApolloFax (DFX and GFX). These will be supported in a future release.
- The Key attribute in UniversalRecordModifyReq/UniversalModifyCmd/AirAdd/AirPricingTicketingModifiers/AirPricingInfoRef is mandatory.
Apollo
- Apollo allows all ticket modifiers to be entered at any time, and all modifiers can be applied to a system-generated fare or a manual fare.
- The following ticketing modifiers are not supported on Apollo:
- Net Remit (NR)
- Net Fare (NF)
- Invoice Fare (IF)
- Accountancy Information; CAR code (AI)
- Value Code (VC)
- Actual Selling Fare (ASF)
- Corporate Discount (CD)
- Print Fare construction on Tour Tickets (IT*PC)
- Print Fare Construction in Bulk Tickets (BT*PC)
- VAT Exempt (VX)
- Commission/@Value
- The Key attribute in UniversalRecordModifyReq/UniversalModifyCmd/AirAdd/AirPricingTicketingModifiers/AirPricingInfoRef is mandatory.
Worldspan
- Worldspan supports Ticketing Modifiers with BookingTravelerRef for the DI line with Name Select.
- The Key attribute in UniversalRecordModifyReq/UniversalModifyCmd/AirAdd/AirPricingTicketingModifiers/AirPricingInfoRef is optional.
- Worldpspan does not support Commission/@Value.
ACH
- ACH does not support Commission/@Value.
