Rich Content and Branding in Low Fare Shopping

Basic details for Branded and Upsell fares are returned, when available, in responses for:

Details for Upsell fares must be requested specifically in the Low Fare Shopping and Asynchronous Low Fare Shopping requests. Brand details are returned by default. See the request for details.

Important!

You may not see all brands associated to a carrier in the Low Fare Shopping response. The Low Fare Shopping response has not changed with the addition of Brands—it continues to ONLY return the lowest fares. If a brand is NOT returned, it may be because the fare associated with that brand does not meet the Low Fare Shopping criteria.

Upsell fare functionality links one brand to the next available brand—both brands will be linked to the fare that is associated to those brands. In the Low Fare Shopping response, this means that you will never see more than two linked brands. E.g., A carrier has Brand Economy, Brand Flex, and Brand First. In a LowFareSearchRsp that includes Upsell fares, you may see Brand Economy and Brand Flex linked, or you may see Brand Flex and Brand First linked. You may see all three in the LowFareSearchRsp. HOWEVER, all three brands will never be linked together in the response, even when all three are returned.

Inhibit Rich Content and Branding

Rich Content and Branding can be inhibited for Worldspan and ACH providers in the Low Fare Shopping and Asynchronous Low Fare Shopping responses by setting LowFareSearch(Asynch)Req @ReturnBrandedFares="false". If a request contains both ReturnBrandedFares="false" and ReturnUpsellFare="true" for providers 1P, or ACH, the ReturnUpsellFare value is ignored and a warning is returned.

Schema

See the following transactions for Low Fare Shopping (Synchronous and Asynchronous) and Retrieve Low Fare Search:

Request

  1. Send one of the following requests:
  2. Set @ReturnUpsellFare="true" to return Upsell details. Brand details are returned by default.

  3. In Release 17.3 (Air v42.0 and greater), the optional Boolean attribute AirPricingModifiers @ReturnFareAttributes was added to support requesting the return of any optional services that are part of a branded fare. In release 17.4, alpha customers can send ReturnFareAttributes="True" to return optional services or ReturnFareAttributes="False" to not return optional services.

    4. Note: @ReturnUpsellFare is ignored if it is used with flexible shopping searches.

Response

The LowFareSearchRsp or LowFareSearchAsynchRsp is returned.

With Universal API Release 20.2.3, the following Upsell attributes return, which allow customers to display complete fare details to the traveler: Release 20.2

When available, the response contains the BrandList/Brand element which shows basic details, including:

BrandList also returns:

The FareInfoList/FareInfo/Brand element returns the Brand ID and Upsell Brand ID, if applicable, based on carrier provisioning:

Upsell Fare information is returned in FareInfoList/FareInfo/Brand/UpsellBrand element. The UpsellBrand element includes the Fare Basis of the Upsell Fare and FareInfoRef which references the FareInfo of the Upsell Fare.

Release 19.1

Prior to Air v43.0, fare penalties were not included for any upsell fares. As a result, upsell fares were unused. Air 44.0 and later provides the same penalty and refund data for the upsell fares as related fares, returning the most restrictive fare penalty details (refundable, change, and cancel), so that agents and/or OTAs can display accurate penalty details when ReturnUpsellFare="true"

For example, if LowFareSearchReq/@SolutionResult="false" and LowFareSearchReq/@ReturnUpsellFare="true", details for Upsell / Price Points are returned in:

LowFareSearchRsp/AirPricePointList/AirPricePoint/AirPricingInfo

  • @Refundable=”true”
  • /ChangePenalty
  • /CancelPenalty

Brand Optional Services Release 17.4

Note: The schema changes necessary to support brand optional services were made in release 17.3 (Air v42.0) but the functionality was implemented in release 17.4. This feature is in Alpha-testing and you need to be provisioned to activate it. Contact your Travelport API representative to activate this feature.

To return a list of optional services (or fare attributes) that are part of a branded fare, send @ReturnFareAttributes="true" in Low Fare Shopping and Low Fare Shopping Asynchronous requests. If ReturnFareAttributes="false" (default), optional services that are part of a branded fare are not returned.

When ReturnFareAttributes="true" in the request, the response contains a new element FareAttributes, which returns a list of all associated fare attributes and charge indicators in a comma-separated list.

When @ReturnFareAttributes="true" in the request, the response contains a list of fare attributes and their associated charge indicators in FareInfoList/FareInfo/FareAttributes.

Fare attributes include:

Chargeable indicators include:

The fare attribute and chargeable indicator are separated by a comma; each grouping of fare attribute and chargeable indicator are separated by a pipe (|). If ReturnFareAttributes="true" in the request, the response could return:

<air:FareAttributes>1,A|2,I|3,N|4,N|5,N|6,A|7,A</air:FareAttributes>

In the example above,

Notes:

Errors and Warnings

If basic details of the Branded Fare or Upsell Fare are not found, a warning is returned: No basic details of Brand ID [Brand ID Number] found.

The following warning messages may be returned: