UTAs
The Routehappy API endpoint provides access to UTAs (as well as UPAs and Amenities). UTAs (Universal Ticket Attributes) are benefits and restrictions by fare, in plain, simple language that make it easy for travel agents and customers to understand. UTAs are sourced from airline ATPCO fare, branded fare and optional service filings and then processed into clear and concise merchandising content.
UTA Data Types
All UTA data types are sourced from ATPCO rules data. Filed data is reflected in the final response structure for each type
(e.g., in the assessment
, fee
, headline
, and description
fields).
Headline/Description templates and assessments are sourced from the UTA DataKit.
attention
The charge amounts and/or weight amounts in UTAs' headlines/descriptions in the response may vary depending on the filed rules data, ICER conversion rates, and requested currency, etc. Additionally, the headlines and descriptions will be in the request's locale. For simplicity, we are using USD100.00
and 20kg
for all amounts in the examples below and all headlines and descriptions are shown in English.
Type | Definition | Source | Example Headline/Description Pairs |
---|---|---|---|
Advance Change | Represents the fare's Change policy conditions and any potential fees associated with them. This aligns to the Modern Airline Retailing Attributes (MARA) Change category name. When no Record 2 and/or Record 3 data is available for Category 31, then the Change policy conditions are dictated by the System Assumption* for Change. |
Category 31 | examples |
Cancellation | Represents the fare's Refundability conditions and any potential fees associated with them. This aligns to the Modern Airline Retailing Attributes (MARA) Refundability category name. When no Record 2 and/or Record 3 data is available for Category 33, then the Refund policy conditions are dictated by the System Assumption* for Refundability. |
Category 33 | examples |
Checked Baggage | Does the fare include any checked baggage? If so, are there any fees associated with checked baggage? | Record S5 & Record S7 | examples |
Carry-on Baggage | Does the fare include carry-on baggage? If so, are there any fees associated with carry-on baggage? | Record S5 & Record S7 | examples |
Boarding Priority | Does the fare include a higher or lower boarding priority compared to a standard fare? This aligns to the Modern Airline Retailing Attributes (MARA) Priority Boarding category name. | Branded Fares, Features Table 166, & Record S5 | examples |
Check-in Priority | Does the fare include a higher or lower check-in priority compared to a standard fare? This aligns to the Modern Airline Retailing Attributes (MARA) Priority Check-in category name. | Branded Fares, Features Table 166, & Record S5 | examples |
Lounge Access | Does the fare include access to a lounge? If so, is there a fee associated with this access? | Branded Fares, Features Table 166, & Record S5 | examples |
Same-day Change | Does the fare allow a change to the flight itinerary within 24 hours of flight departure time? If so, are there any fees that would apply to this change? | Branded Fares, Features Table 166, & Record S5 | examples |
Seat Selection | Does the fare include the ability to choose a particular seat ahead of check-in? If so, are there any fees associated with selecting seats? | Branded Fares, Features Table 166, & Record S5 | examples |
Loyalty Rewards | What are the potential benefits that can be earned from booking with an airline? | Branded Fares, Features Table 166, & Record S5 | examples |
Transferable Funds | Does the fare include the ability for shoppers to transfer their flight credit funds to another if they need to cancel their reservation | Branded Fares, Features Table 166, & Record S5 | examples |
Upgrade | Does the fare include the ability to request an upgraded cabin selection? | Branded Fares, Features Table 166, & Record S5 | examples |
* The System Assumption for Changes and Refunds dictates that the respective policy's conditions are permitted free of charge with no restrictions.
Example Headline/Description Pairs
Below are the possible Headlines and Descriptions that you receive for each UTA category.
Advance Change
Headline | Description |
---|---|
"Not allowed" | "Change not allowed" |
"Free" | "Change allowed for free" |
"For a fee" | "Change allowed for USD100.00" |
"For a fee" | "Change fee is 25%" |
"For a fee" | "Change fee is USD100.00 or 25% whichever is lower" |
"For a fee" | "Change fee is USD100.00 or 25% whichever is higher" |
Cancellation
Headline | Description |
---|---|
"Non-refundable" | "Non-refundable" |
"Full refund" | "Fully refundable ticket" |
"Refund for a fee" | "Ticket refund for USD100.00" |
"Refund for a fee" | "Refundability fee is 25%" |
"Refund for a fee" | "Refundability fee is USD100.00 or 25% whichever is lower" |
"Refund for a fee" | "Refundability fee is USD100.00 or 25% whichever is higher" |
Checked Baggage
Headline | Description |
---|---|
"2 Free" | "Up to 2 pieces of checked baggage" |
"2 free up to 20kg" | "2 checked baggage allowed free up to a maximum weight of 20kg" |
"1 free up to 20kg total" | "First checked bag free per passenger up to maximum weight 20kg" |
"1st for USD100.00 - 2nd for USD100.00" | "First checked bag for USD100.00 and Second checked bag for USD100.00 per passenger" |
"1st free" | "1st checked bag free per passenger" |
"1st free & 2nd for USD100.00" | "First checked bag free and second checked for a fee USD100.00" |
"For a fee" | "1st checked bag for a fee per passenger" |
"Up to 20kg total" | "Free bags are allowed up to a maximum weight of 20kg" |
Carry-on Baggage
Headline | Description |
---|---|
"1 Free up to 20kg & personal item" | "1 free carry on up to a maximum weight of 20kg" |
"1 free & personal item" | "1 carry on bag & personal item" |
"1 personal item" | "1 personal carry on item" |
"2 free & personal item" | "2 carry on bags & 1 personal item" |
"2 free up to 20kg" | "2 free carry on items up to a maximum weight of 20kg & a personal item" |
"For a fee" | "Carry on bags allowed for a fee" |
"Free up to 20kg" | "Free carry on bags up to 20kg per passenger" |
Boarding Priority
Headline | Description |
---|---|
"Last" | "Last to board" |
"Overhead bin limited" | "Overhead bin limited" |
"Priority" | "Priority boarding provided for free" |
"Standard" | "Standard boarding" |
Check-in Priority
Headline | Description |
---|---|
"Priority" | "Priority check-in provided for free" |
"Standard" | "Standard check-in priority" |
Lounge Access
Headline | Description |
---|---|
"For a fee" | "Lounge access for a fee" |
"Free" | "Free lounge access" |
"Not allowed" | "Lounge access not allowed" |
"Not available" | "Lounge access not available" |
Same-day Change
Headline | Description |
---|---|
"For a fee" | "Same-day change for a fee" |
"Free" | "Same-day change for free" |
"Not allowed" | "Same-day change not allowed" |
Seat Selection
Headline | Description |
---|---|
"Anytime" | "Select seat anytime" |
"Assigned or for a fee" | "Seat assigned or select anytime for a fee" |
"At check-in" | "Select seat at check-in" |
"At check-in or for a fee" | "Select seat at check-in or anytime for a fee" |
Upgrade Eligibility
Headline | Description |
---|---|
"Eligible" | "Eligible for upgrade" |
"For a fee" | "Upgrade for a fee" |
"Not allowed" | "Upgrade not allowed" |
"Not applicable" | "Upgrade not applicable" |
Loyalty Rewards
Headline | Description |
---|---|
"115 Percent Miles Earned" | "115 Percent Miles Earned" |
"250 Percent Miles Earned" | "250 Percent Miles for a fee" |
"2000 Miles Earned" | "2000 Miles for a fee" |
"10 Percent Miles Earned" | "10 Percent Miles Earned" |
"30 Percent Miles Earned" | "30 Percent Miles for a fee" |
"125 Miles Earned" | "125 Miles Earned" |
"175 Percent Miles Earned" | "175 Percent Miles for a fee" |
"200 Percent Miles Earned" | "200 Percent Miles for a fee" |
"375 Miles Earned" | "375 Miles Earned" |
"35 Percent Miles Earned" | "35 Percent Miles for a fee" |
"50 Percent Miles Earned" | "50 Percent Miles for a fee" |
"175 Percent Miles Earned" | "175 Percent Miles Earned" |
"15 Percent Miles Earned" | "15 Percent Miles Earned" |
"115 Percent Miles Earned" | "115 Percent Miles for a fee" |
"2000 Miles Earned" | "2000 Miles Earned" |
"125 Percent Miles Earned" | "125 Percent Miles for a fee" |
"35 Percent Miles Earned" | "35 Percent Miles Earned" |
"Bonus Miles" | "Bonus Miles for a fee" |
"1000 Miles Earned" | "1000 Miles Earned" |
"250 Miles Earned" | "250 Miles Earned" |
"120 Percent Miles Earned" | "120 Percent Miles for a fee" |
"Point Accrual" | "Points Accrual not available" |
"30 Percent Miles Earned" | "30 Percent Miles Earned" |
"200 Percent Miles Earned" | "200 Percent Miles Earned" |
"110 Percent Miles Earned" | "110 Percent Miles for a fee" |
"125 Percent Miles Earned" | "125 Percent Miles Earned" |
"110 Percent Miles Earned" | "110 Percent Miles Earned" |
"500 Miles Earned" | "500 Miles Earned" |
"375 Miles Earned" | "375 Miles for a fee" |
"75 Percent Miles Earned" | "75 Percent Miles for a fee" |
"500 Miles Earned" | "500 Miles for a fee" |
"150 Percent Miles Earned" | "150 Percent Miles for a fee" |
"400 Miles Earned" | "400 Miles for a fee" |
"70 Percent Miles Earned" | "70 Percent Miles Earned" |
"Bonus Miles" | "Free Bonus Miles" |
"15 Percent Miles Earned" | "15 Percent Miles for a fee" |
"70 Percent Miles Earned" | "70 Percent Miles for a fee" |
"250 Percent Miles Earned" | "250 Percent Miles Earned" |
"100 Percent Miles Earned" | "100 Percent Miles for a fee" |
"120 Percent Miles Earned" | "120 Percent Miles Earned" |
"Mileage Accrual" | "Mileage Accrual available" |
"10 Percent Miles Earned" | "10 Percent Miles for a fee" |
"Point Accrual" | "Points Accrual for a fee" |
"1000 Miles Earned" | "1000 Miles for a fee" |
"750 Miles Earned" | "750 Miles Earned" |
"50 Percent Miles Earned" | "50 Percent Miles Earned" |
"190 Percent Miles Earned" | "190 Percent Miles Earned" |
"75 Percent Miles Earned" | "75 Percent Miles Earned" |
"190 Percent Miles Earned" | "190 Percent Miles for a fee" |
"400 Miles Earned" | "400 Miles Earned" |
"130 Percent Miles Earned" | "130 Percent Miles Earned" |
"1500 Miles Earned" | "1500 Miles for a fee" |
"130 Percent Miles Earned" | "130 Percent Miles for a fee" |
"1500 Miles Earned" | "1500 Miles Earned" |
"750 Miles Earned" | "750 Miles for a fee" |
"125 Miles Earned" | "125 Miles for a fee" |
"Purchase Bonus Miles" | "Bonus Miles for a fee" |
"25 Percent Miles Earned" | "25 Percent Miles Earned" |
"250 Miles Earned" | "250 Miles for a fee" |
"150 Percent Miles Earned" | "150 Percent Miles Earned" |
"25 Percent Miles Earned" | "25 Percent Miles for a fee" |
"Mileage Accrual" | "Mileage Accrual for a fee" |
"100 Percent Miles Earned" | "100 Percent Miles Earned" |
Transferable Funds
Headline | Description |
---|---|
"For a fee" | "Transferable funds for eligible members for a fee" |
"Free" | "Transferable funds for eligible members for free" |
"Not allowed" | "Transferable funds not allowed" |
"Not available" | "Transferable funds not available" |
attention
Expanding categories for UTAs is possible. If you have a need or an idea for an additional UTA category, please contact your ATPCO Sales Channel Retailing manager to initiate the process.
Requesting UTAs
You can specify a request for UTAs using the includes
parameter and filter the attributes in that response using the ticket_attributes_filter
. You can also set os_override
to request using data from branded fares for advance change, baggage, and cancellation, instead of baggage engine.
{
"control": {
"includes": [
"uta"
],
"ticket_attributes_filter": [ // include the attributes
"advance_change", // you'd like in the response
"boarding_priority",
"brand",
"cancellation",
"carry_on_baggage",
"checked_baggage",
"check_in_priority",
"lounge_access",
"upgrade_eligibility",
"loyalty_rewards",
"transferable_funds"
],
// ...
},
// ...
}
Data Hierarchy
Advance change and Cancellation data in both the Routehappy API and Hub Backwards Compatible endpoints is sourced from Fare Rules. Fare Rules provides the most granular form of the data, which will be returned as a “policy” (e.g. “change_policy” or “cancel_policy”).
Carry-on baggage allowance and Checked baggage allowance data in both the Routehappy API and Hub Backwards Compatible endpoints are sourced from Optional Services.
For the remaining 8 categories, Same-day Change, Seat Selection, Check-in Priority, Boarding Priority, Upgrade Eligibility, Lounge Access, Loyalty Rewards, Transferable Funds, data will be sourced from Branded Fares for airlines who file these categories. Airlines are not required to file data across all categories, so coverage will vary by category by airline. For a full breakdown of UTA coverage by category and airline, please see our Coverage page. Additionally, Airlines can restrict who they share their data with by electing to only share with Channels using certain fare sources. For instance, an airline may choose to only share data if a Channel’s indicated fare source is Sabre rather than Amadeus or Worldspan.
UTA Data Accuracy
UTAs return the most currently available data the airlines have provided to ATPCO. Any change an airline makes to their ATPCO fare filings should be reflected in UTA data within an hour of being updated.
Icons
Icons are generic and included in each UTA as a pointer URL. Partner can choose whether or not to utilize them for display.
Language Translation
The Routehappy UTA API display text is available for the following languages/regions.
Language | Language Code | Region |
---|---|---|
Arabic | ar | (any) |
Danish | da | (any) |
Dutch | nl | (any) |
English (Int’l) | en | (any) |
English (USA) | en | US |
Finnish | fi | (any) |
French (Canada) | fr | CA |
French (France) | fr | (any) |
German | de | (any) |
Greek | el | (any) |
Indonesian | id, in | (any) |
Italian | it | (any) |
Japanese | ja | (any) |
Korean | ko | (any) |
Norwegian | no | (any) |
Polish | pl | (any) |
Portuguese (Brazil) | pt | BR |
Portuguese (Europe) | pt | (any) |
Russian | ru | (any) |
Simplified Chinese | zh | (any) |
Spanish (Latin America) | es | (any) |
Spanish (Spain) | es | ES |
Swedish | sv | (any) |
Thai | th | (any) |
Traditional Chinese | zh | HK, TW |
Turkish | tr | (any) |
Vietnamese | vi | (any) |
Units of Measurement
Measurement is dictated by the language/localization indicated. For the U.S. English, all measurements follow the United States customary system (USCS) for units of measurement. For all other languages/localizations, measurements are provided in metric units.