API Information

Response Format
JSON
Method/Endpoint
GroupedItineraryResponse/v1/offers/shop
Current Version
1.0.0
Target Audience
TN
Environment
Production
Documentation
Go to the Bargain Finder Max documentation

What's New

  • Bargain Finder Max Response has been enhanced with the following new parameters:
  • Ancillary, Fare type descriptors - new Fare type descriptors in Bargain Finder Max. Exposure of new elements in the response to describe the fare type, the fare rule and fare tariff. The most relevant is return Fare type code descriptor in the response that indicates Basic Economy fares from the response.

Business Value

  • Each of these enhancements enable greater personalization and efficiency to further refine the search.

New Features

In the Response

Optional

Parameter: FareComponentFareType

Type: string

Description: New Fare type descriptors in BargainFinderMax. Provides exposure of new elements in the response to describe the fare type, the fare rule, fare tariff and fare bitmap. The most relevant is return Fare type code descriptor in the response that indicates Basic Economy fares from the response. Fare type (e.g. FIT, RU).

Sample Value:

"fareComponentDescs": [ { "id": 1, "governingCarrier": "AA", "fareAmount": 79.44, "fareCurrency": "USD", "fareBasisCode": "OVAJZNB3/DRB", "farePassengerType": "ADT", "ticketDesignator": "DRB", "publishedFareAmount": 79.44, "oneWayFare": true, "privateFare": true, "directionality": "FROM", "direction": "WH", "notValidBefore": "2020-01-01", "notValidAfter": "2020-01-01", "applicablePricingCategories": "10 15 18 25", "vendorCode": "ATP", "fareTypeBitmap": "0A", "fareType": "EOU", "fareTariff": "770", "fareRule": "XX26", "segments": [ { "segment": {} } ] } ]
Note: Elements "FareType", "ATPCO_FareTariff", "ATPCO_FareRule", "FareIndicator", "PrivateTariffIndicator", and "FareTypeBitmap" are rare. They are part of fare pricing. They should be sent if the carrier uses them also in ancillaries’ records (for example, if a carrier uses private/public fare indicator in the S7 rules).
Parameter: FareComponentFareTariff

Type: string

Description: New Fare type descriptors in BargainFinderMax. Provides exposure of new elements in the response to describe the fare type, the fare rule, fare tariff and fare bitmap. The most relevant is return Fare type code descriptor in the response that indicates Basic Economy fares from the response. Fare tariff (e.g. 21).

Sample Value:

"fareComponentDescs": [ { "id": 1, "governingCarrier": "AA", "fareAmount": 79.44, "fareCurrency": "USD", "fareBasisCode": "OVAJZNB3/DRB", "farePassengerType": "ADT", "ticketDesignator": "DRB", "publishedFareAmount": 79.44, "oneWayFare": true, "privateFare": true, "directionality": "FROM", "direction": "WH", "notValidBefore": "2020-01-01", "notValidAfter": "2020-01-01", "applicablePricingCategories": "10 15 18 25", "vendorCode": "ATP", "fareTypeBitmap": "0A", "fareType": "EOU", "fareTariff": "770", "fareRule": "XX26", "segments": [ { "segment": {} } ] } ]
Note: Elements "FareType", "ATPCO_FareTariff", "ATPCO_FareRule", "FareIndicator", "PrivateTariffIndicator", and "FareTypeBitmap" are rare. They are part of fare pricing. They should be sent if the carrier uses them also in ancillaries’ records (for example, if a carrier uses private/public fare indicator in the S7 rules).
Parameter: FareComponentFareRule

Type: string

Description: New Fare type descriptors in BargainFinderMax. Provides exposure of new elements in the response to describe the fare type, the fare rule, fare tariff and fare bitmap. The most relevant is return Fare type code descriptor in the response that indicates Basic Economy fares from the response. FareRule, part of the fare pricing (e.g. 62DD, K0ST), expected if carrier uses them also in ancillaries’ records.

Sample Value:

"fareComponentDescs": [ { "id": 1, "governingCarrier": "AA", "fareAmount": 79.44, "fareCurrency": "USD", "fareBasisCode": "OVAJZNB3/DRB", "farePassengerType": "ADT", "ticketDesignator": "DRB", "publishedFareAmount": 79.44, "oneWayFare": true, "privateFare": true, "directionality": "FROM", "direction": "WH", "notValidBefore": "2020-01-01", "notValidAfter": "2020-01-01", "applicablePricingCategories": "10 15 18 25", "vendorCode": "ATP", "fareTypeBitmap": "0A", "fareType": "EOU", "fareTariff": "770", "fareRule": "XX26", "segments": [ { "segment": {} } ] } ]
Note: Elements "FareType", "ATPCO_FareTariff", "ATPCO_FareRule", "FareIndicator", "PrivateTariffIndicator", and "FareTypeBitmap" are rare. They are part of fare pricing. They should be sent if the carrier uses them also in ancillaries’ records (for example, if a carrier uses private/public fare indicator in the S7 rules).