UPAs
The Hub Backwards Compatible (UTAs and UPAs) endpoint is intended for users of the legacy Routehappy Hub API who are not yet prepared to migrate to the upcoming Routehappy API endpoint.
UPAs (Universal Product Attributes) bring unique airline fares, products and services to life with messaging, images, videos and cabin tours. UPA content can be highly targeted by aircraft, cabin, route, fare, and more, giving travel agents and customers time sensitive and relevant content as they shop.
The Hub Backwards Compatible (UTAs and UPAs) endpoint of the Routehappy API maintains the functionality of the legacy Routehappy Hub API while improving response speed. Users of the legacy Routehappy Hub API will be able to use the same request structure and can expect the same response structure from this newer, faster API.
Schema
Schema
The table below contains the URLs for the Gold and Production environments of the Backwards Compatible endpoint's and schemas, respectively.
API Endpoint | Schema | UPA DS* | UTA DS* | Amenities DS* |
---|---|---|---|---|
https://gold.retailing.apis.atpco.net/routehappy/amenities | Gold Schema | N/A | N/A | Amenities Prod |
https://retailing.apis.atpco.net/routehappy/amenities | Production Schema | N/A | N/A | Amenities Prod |
https://gold.retailing.apis.atpco.net/routehappy/itineraries | Gold Schema | N/A | N/A | Amenities Prod |
https://retailing.apis.atpco.net/routehappy/itineraries | Production Schema | N/A | N/A | Amenities Prod |
https://gold.retailing.apis.atpco.net/routehappy/segments | Gold Schema | N/A | N/A | Amenities Prod |
https://retailing.apis.atpco.net/routehappy/segments | Production Schema | N/A | N/A | Amenities Prod |
https://gold.retailing.apis.atpco.net/routehappy/hub | Gold Schema | Hub Prod | ATPCO Subs Prod | N/A |
https://retailing.apis.atpco.net/routehappy/hub | Production Schema | Hub Prod | ATPCO Subs Prod | N/A |
* DS - Data Source within ATPCO from which the system is processing the data it displays.
UPA Content Types
Airlines can provide visual content such as photos, graphics, videos, and 360 tours as well as corresponding textual content for use in creating the UPA rich content. For every visual content type, UPAs will return both a headline and a description/caption that can be displayed along with the visual content.
Visual Content
Each is returned as a pointer URL:
- Photos/Graphics – still photographs and graphic images.
- Videos – branded video content (for example, a video showing previews of entertainment options for the current month).
- 360 Tours – immersive virtual tours for exploration (for example, a 360-degree tour of a first-class cabin experience).
Textual Content
Returned for each type of visual content listed above:
- Headline – a brief line of text used to grab the flight shopper's attention to the UPA.
- Description/Caption – more extensive text that fully describes and defines the visual content to the flight shopper.
attention
Although there are two types of textual content, ATPCO strongly recommends that BOTH types of textual content be used in conjunction with each other. However, if a channel decides to only implement one of the textual content types rather than both, ATPCO recommends that the channel use description/caption text as this is more explanatory than using only the headline text.
Targeting
UPA targeting is powered by Routehappy's flight product attribute database. This extensive database is continually and carefully updated with detailed information on routes, schedules, airline subfleets, cabins, branded fares and seat characteristics. It also includes data regarding the availability of meals, beverages, in-flight entertainment (IFE), Wi-Fi, power outlets and USB ports for specific subfleets.
This enables UPA content to be specifically targeted to aircraft, subfleet, cabin, route, fare, as well as other attributes, such as specific seat characteristics or optional services, which gives flight shoppers the most relevant and useful merchandising content possible while they shop for flights. As an example, Beverage UPAs for an early morning flight might focus on the quality of coffee being served, whereas Beverage UPAs for an evening flight might instead focus on the premium alcohol options that are offered.
attention
The level of specificity is dependent on availability of media from the airline.
UPA Standard Categories
Standard categories for a particular flight:
- Aircraft – content relating to the aircraft type.
- Seat – content covering a particular seat or row of seats or cabin.
- Meals – content for any food (snacks and meals) provided and/or available for purchase.
- Beverages – content for any non-alcoholic and/or alcoholic beverages provided and/or available for purchase.
- Entertainment – content related to all forms of passenger entertainment options
- Power – content covering AC power outlets, USB ports, etc.
- Wi-Fi - content related to Wi-Fi coverage and availability for a particular flight.
- Inflight service – content related to the quality of inflight service.
attention
ATPCO can add categories for UPAs. If you have a need or an idea for an additional UPA category, please contact your ATPCO Sales Channel Retailing manager to initiate the process.
Codeshare UPAs
Codeshare UPAs give flight shoppers greater transparency about what is included in flights sold by one carrier but operated by another. Beginning with the ‘Overview UPA’, which is a display of both marketing and operating logos to show the flight is a codeshare. UPAs are created using media and information specifically targeted to the operating carrier’s flight. Other common topics explained in codeshare UPAs include mileage accrual, bag check, and airport security.
There is an approvals process for getting access to codeshare UPAs. Although the approvals process for codeshare UPAs can vary depending on the partners involved, generally it is conducted in a spirit of mutual interest and cooperation. If you are interested in consuming codeshare UPAs in your channel, please ensure that you meet minimum display requirements (provided below) and contact your ATPCO Sales Channel Retailing manager.
Accuracy
UPA content is sourced directly from airlines and therefore is aligned with the airline’s product offerings and individual brand voice; this content is never generated by passengers.
Imagery and other media are provided to ATPCO by participating airlines. Headlines and captions/descriptions are then crafted by the ATPCO Merchandising Strategy team to complement airline-provided media. This team strives to create accurate expectations and/or generate excitement among flight shoppers by creating as detailed and accurate of a portrayal as possible of the products showcased.
UPAs are regularly refreshed or updated in accordance with changes in subfleets, product experience, when there is new airline-provided media, etc. These changes automatically flow through to channels with UPA integrations.
Icons
Although icons are returned in each UPA response (small_icon_url
and large_icon_url
), these are a relic of a much earlier version of the UPA API. ATPCO highly recommends pairing UPA headlines and descriptions/captions with the provided rich visual content (photos, videos, and tours) and NOT with the more generic icons that are returned by the API.
Language Translation
UPAs are always created in English. However, airlines can also provide UPA text translations for 41 different languages at this discretion. This capability allows UPAs to be delivered in the appropriate language by point of sale. The media and targeting portions of the UPA remain the same; only the text is translated. If UPAs are requested in a language that UPAs are not available for, then UPAs will be returned in English.
This differs from translations of UTAs and Amenities, where the content is static, factual, and uniform, and where translations do not require approval by individual airlines.
If you would like to see new translations for a particular airline or particular language, please reach out your ATPCO Sales Channel Retailing manager.
UPA Display Guidelines
Non-codeshare UPAs
- Please ensure that UPAs are clearly mapped to their correct flight segment in your display. There have been a number of cases in which integrations did not make it clear which UPAs mapped to which flight segments of a given itinerary, which caused confusion for flight shoppers.
- Please ensure that your integration allows for special characters to be recognized. Special characters, such as the trademark symbol, are often used in UPA headlines or descriptions/captions and should be displayed in your channel as they are in the original headline or description/caption text.
- If your integration includes text, we recommend using both the headlines and the descriptions/captions together. However, if you must choose only 1 text field, please use the descriptions/captions, as these are much more descriptive than using headline alone.
- If you must alter the size of images provided by our API, please scale images rather than cropping them. Airlines craft the media that they share with us to be displayed in full. Cropping could leave out important elements in the media.
Codeshare UPAs
warning
Please note, the guidelines below are mandatory in order for us to request access to codeshare UPA content for your channel. It is also mandatory that you provide access to your channel to ATPCO and all involved airlines so that all parties can conduct quality assurance testing on the planned integration.
- Both headline and description/caption textual content must be displayed. Due to the more complex nature of codeshare flights, airlines and ATPCO rely on both text fields working together to communicate all required information for codeshare UPAs.
- All UPAs must be clearly mapped to the correct flight segment in your display. There should be no confusion about which UPAs map to which segment in a given itinerary.
- UPA categories must be displayed in the following order: Overview UPA first, followed by Connection or any other joint codeshare UPA categories.
- Again, if you must alter the size of provided images, scale instead of cropping. This is especially important for codeshare UPAs, as the media often includes brand elements from 2 or more brands. Logos for all brands must be visible when the UPAs are displayed.
- Please ensure that UPAs are clearly mapped to their correct flight segment in your display. There have been a number of cases in which integrations did not make it clear which UPAs mapped to which flight segments of a given itinerary, which caused confusion for flight shoppers.