Skip to main content

Revalidate Itinerary

6.1.0
Air
Search
REST API
Travel Agency
Try Now
release_note
  • Flight type (A: Air Segment, K: ARUNK, O: Open Segment) has been changed from required to optional.
  • Deleted Passenger Type Code. NOTE: The below optional parameter is no longer available for our customers: PassengerType/@Code - more information available in SAN 15673 from 10th SEP 2019.
  • The Revalidate Itinerary API GIR Response has been enhanced with the new parameters and other changes listed below:
  • ElapsedTime attribute has been added at the ScheduleDesc and LegDesc levels.
  • The MandatoryInd indicates mandatory Offer Items that cannot be removed from the Offer. Added at the Fare and Passenger Information levels.
  • New attribute LastTicketTime added at FareType level.
  • Ancillaries Baggage information - For carriers migrated to new ATPCO baggage processing, new ancillaryTypeCode value "C" will occur, along with new optional elements: "subgroup", "description1", "description2", "firstOccurrence", "lastOccurrence".
  • The Parameters FareAmount and FareCurrency at FareComponentDesc level have been changed to optional.
  • The Operating Carrier Code has been changed from required to optional.

API Information

Response Format
JSON
Method/Endpoint
/v6.1.0/shop/flights/revalidate
Current Version
6.1.0
Target Audience
TN
Environment
Production

What's New

  • Flight type (A: Air Segment, K: ARUNK, O: Open Segment) has been changed from required to optional.
  • Deleted Passenger Type Code. NOTE: The below optional parameter is no longer available for our customers: PassengerType/@Code - more information available in SAN 15673 from 10th SEP 2019.
  • The Revalidate Itinerary API GIR Response has been enhanced with the new parameters and other changes listed below:
  • ElapsedTime attribute has been added at the ScheduleDesc and LegDesc levels.
  • The MandatoryInd indicates mandatory Offer Items that cannot be removed from the Offer. Added at the Fare and Passenger Information levels.
  • New attribute LastTicketTime added at FareType level.
  • Ancillaries Baggage information - For carriers migrated to new ATPCO baggage processing, new ancillaryTypeCode value "C" will occur, along with new optional elements: "subgroup", "description1", "description2", "firstOccurrence", "lastOccurrence".
  • The Parameters FareAmount and FareCurrency at FareComponentDesc level have been changed to optional.
  • The Operating Carrier Code has been changed from required to optional.

Business Value

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

New Features

In the Response

Optional

Parameter: elapsedTime

Type: integer

Description: This information allows customers to display travel time for NDC Offers.

Sample Value:

"legDescs": [
	{
		"id": 1,
		"elapsedTime": 395,
		"schedules": [
			{
				"ref": 4
			}
		]
	}
Note: The elapsedTime at legDescs level. This parameter is available on both, NDC and ATPCO path.

In the Response

Optional

Parameter: elapsedTime

Type: integer

Description: This information allows customers to display travel time for NDC Offers.

Sample Value:

"scheduleDescs": [
	{
		"id": 1,
		"stopCount": 0,
		"eTicketable": true,
		"elapsedTime": 390,
		"departure": {
			"airport": "SIN",
			"time": "08:05:00 08:00",
			"terminal": "3"
Note: The elapsedTime at the scheduleDescs level. This parameter is available on both NDC and ATPCO paths.

In the Response

Optional

Parameter: mandatoryInd

Type: boolean

Description: If set to 'true', indicates mandatory Offer Items that cannot be removed from the Offer. Mandatory Offer Items transition into Order Items. If not present or 'false', the Offer item is optional.

Sample Value:

"fare": {
	"offerItemId": "cg5fd74bdf9fwtwjsk6kloyuh0-1-1",
	"mandatoryInd": true,
	"serviceId": "cg5fd74bdf9fwtwjsk6kloyuh0-1-1-1",
	"validatingCarrierCode": "SQ",
	"vita": true,
	"eTicketable": true,
	"governingCarriers": "SQ",
	"passengerInfoList": [
		{
			"passengerInfo": {
Note: Mandatory indicator at the Fare level. Applicable for ATPCO and NDC content.

In the Response

Optional

Parameter: mandatoryInd

Type: boolean

Description: If set to 'true', indicates mandatory Offer Items that cannot be removed from the Offer. Mandatory Offer Items transition into Order Items. If not present or 'false', the Offer item is optional.

Sample Value:

{
	"passengerInfo": {
		"offerItemId": "cg5fd74bdf9fwtwjsk6kloyuh0-7-1",
		"mandatoryInd": true,
		"serviceId": "cg5fd74bdf9fwtwjsk6kloyuh0-7-1-1",
		"passengerType": "ADT",
		"passengerNumber": 1,
		"fareComponents": [
			{
Note: Mandatory indicator at the Passenger Information level. Applicable for ATPCO and NDC content.

In the Response

Optional

Parameter: lastTicketTime

Type: string

Description: New attribute added at the Fare level.

Sample Value:

"pricingInformation": [
  {
    "pricingSubsource": "MIP",
    "fare": {
    "validatingCarrierCode": "LO",
    "vita": true,
    "eTicketable": true,
    "lastTicketDate": "2020-02-15",
    "lastTicketTime": "10:28",
    "governingCarriers": "LO",
    "passengerInfoList": [
      {
Note: Pattern: HH_MM

In the Response

Optional

Parameter: subgroup

Type: string

Description: Two-letter ancillary subgroup code from ATPCO filing. This is applicable only to non-standard bags, such as SP - Sporting Equipment.

Sample Value:

"ancillaryFeeGroup": {
"ancillaryFees": [
	{
		"code": "BG",
		"name": "BAGGAGE",
		"details": [
			{
				"code": "ADT",
				"description": "PREPAID BAGGAGE 23KG",
				"origin": "SVO",
				"destination": "LHR",
				"carrier": "SU",
				"amount": 40,
				"departureDate": "2020-03-20",
				"startSegment": 1,
				"endSegment": 1,
				"ancillaryTypeCode": "C",
				"subcode": "0C3",
				"description1": "UP TO 50 POUNDS/23 KILOGRAMS",
				"description2": "UP TO 80 LINEAR INCHES/203 LINEAR CM",
				"firstOccurrence": 1,
				"lastOccurrence": 2
			},
Note: For standard baggage, this attribute will never be returned.

In the Response

Optional

Parameter: description1 description2

Type: string

Description: Ancillary Fee description lines from ATPCO filing.

Sample Value:

"ancillaryFeeGroup": {
"ancillaryFees": [
	{
		"code": "BG",
		"name": "BAGGAGE",
		"details": [
			{
				"code": "ADT",
				"description": "PREPAID BAGGAGE 23KG",
				"origin": "SVO",
				"destination": "LHR",
				"carrier": "SU",
				"amount": 40,
				"departureDate": "2020-03-20",
				"startSegment": 1,
				"endSegment": 1,
				"ancillaryTypeCode": "C",
				"subcode": "0C3",
				"description1": "UP TO 50 POUNDS/23 KILOGRAMS",
				"description2": "UP TO 80 LINEAR INCHES/203 LINEAR CM",
				"firstOccurrence": 1,
				"lastOccurrence": 2
			},
Note: Returned only for new ATPCO processing of baggage charges.

In the Response

Optional

Parameter: firstOccurrence

Type: string

Description: Ancillary Baggage Information. First occurrence for which the baggage charge applies.

Sample Value:

"ancillaryFeeGroup": {
"ancillaryFees": [
	{
		"code": "BG",
		"name": "BAGGAGE",
		"details": [
			{
				"code": "ADT",
				"description": "PREPAID BAGGAGE 23KG",
				"origin": "SVO",
				"destination": "LHR",
				"carrier": "SU",
				"amount": 40,
				"departureDate": "2020-03-20",
				"startSegment": 1,
				"endSegment": 1,
				"ancillaryTypeCode": "C",
				"subcode": "0C3",
				"description1": "UP TO 50 POUNDS/23 KILOGRAMS",
				"description2": "UP TO 80 LINEAR INCHES/203 LINEAR CM",
				"firstOccurrence": 1,
				"lastOccurrence": 2
			},
Note: Returned only for new ATPCO processing of baggage charges.

In the Response

Optional

Parameter: lastOccurrence

Type: string

Description: Ancillary Baggage Information. Last occurrence for which the baggage charge applies. If last occurrence is not returned, baggage option has no limit of pieces that can be sold.

Sample Value:

"ancillaryFeeGroup": {
"ancillaryFees": [
	{
		"code": "BG",
		"name": "BAGGAGE",
		"details": [
			{
				"code": "ADT",
				"description": "PREPAID BAGGAGE 23KG",
				"origin": "SVO",
				"destination": "LHR",
				"carrier": "SU",
				"amount": 40,
				"departureDate": "2020-03-20",
				"startSegment": 1,
				"endSegment": 1,
				"ancillaryTypeCode": "C",
				"subcode": "0C3",
				"description1": "UP TO 50 POUNDS/23 KILOGRAMS",
				"description2": "UP TO 80 LINEAR INCHES/203 LINEAR CM",
				"firstOccurrence": 1,
				"lastOccurrence": 2
			},
Note: Returned only for new ATPCO processing of baggage charges.

Functional Updates And Enhancements

In the Request

Optional

Parameter: Type

Type: string

Description: Flight type (A: Air Segment, K: ARUNK, O: Open Segment)

Sample Value:

"Flight": [
	{
		"ClassOfService": "S",
		"Number": 705,
		"DepartureDateTime": "2018-04-15T23:55:00",
		"ArrivalDateTime": "2018-04-16T08:35:00",
		"Type": "A",
		"Flown": false,
		"OriginLocation": {
			"LocationCode": "MAD"
		},
		"DestinationLocation": {
			"LocationCode": "SCL"
Note: This is an existing parameter but it has been changed from restricted to optional, and it's default value is equal to A - Air Segment. It belongs to the OriginDestinationFlightAttributeGroup.

In the Response

Optional

Parameter: Operating

Type: CarrierCode

Description: Operating airline code.

Sample Value:

"carrier": {
	"marketing": "HA",
	"marketingFlightNumber": 452,
	"operating": "HA",
	"operatingFlightNumber": 452,
	"equipment": {
		"code": "332",
		"typeForFirstLeg": "W",
		"typeForLastLeg": "W"
	}
}
Note: Parameter already present in the schema, changed from required to optional. For the NDC offers, the operating carrier value is optional and very often might not appear in the response.

In the Response

Optional

Parameter: fareAmount

Type: decimal

Description: An existing Fare Component parameter is now optional.

Sample Value:

"fareComponentDescs": [
	{
		"id": 2,
		"governingCarrier": "SQ",
		"fareAmount": 509.00,
		"fareCurrency": "USD",
		"fareBasisCode": "N15USOBA",
		"farePassengerType": "ADT",
		"publishedFareAmount": 509.00,
		"oneWayFare": true,
		"directionality": "FROM",
		"direction": "PA",
		"notValidBefore": "2020-02-28",
		"notValidAfter": "2020-02-28",
		"applicablePricingCategories": "3 4 5 6 7 8 9 10 12 15 16 18 23",
		"vendorCode": "ATP",
		"fareTypeBitmap": "00",
		"fareType": "XOX",
		"fareTariff": "3",
		"fareRule": "UW11",
		"segments": [
			{
Note: Changed from required to optional.

In the Response

Optional

Parameter: fareCurrency

Type:

Description: An existing Fare Component parameter is now optional.

Sample Value:

"fareComponentDescs": [
	{
		"id": 2,
		"governingCarrier": "SQ",
		"fareAmount": 509.00,
		"fareCurrency": "USD",
		"fareBasisCode": "N15USOBA",
		"farePassengerType": "ADT",
		"publishedFareAmount": 509.00,
		"oneWayFare": true,
		"directionality": "FROM",
		"direction": "PA",
		"notValidBefore": "2020-02-28",
		"notValidAfter": "2020-02-28",
		"applicablePricingCategories": "3 4 5 6 7 8 9 10 12 15 16 18 23",
		"vendorCode": "ATP",
		"fareTypeBitmap": "00",
		"fareType": "XOX",
		"fareTariff": "3",
		"fareRule": "UW11",
		"segments": [
			{
Note: Changed from required to optional.

Relase note ID: 14292


  • The Revalidate Itinerary API Request is now enhanced with the following new features:
  • New REST JSON API response format - Grouped Itinerary Response (GIR). Note: OTA JSON Response type is no longer available with the new version.
  • Branded Fare Attributes - request associated brand attributes.
  • Exclude Non-Branded Fares - allows for only branded fares to be returned when requesting single or multiple brands.
  • Alternate Airport Cross Border Indicator - allow alternate airports to be in other country than the main city-pair when mileage is used.
  • Shop by Fare Basis Code – exclude a fare option based on Fare Basis Code.
  • Shop by Class of Service – exclude a fare option based on Class of Service (Reservation Booking Designator).
  • Shop with Parity Mode – allows to control the brand parity mode for the lowest fare returned.
  • Enhanced Multi-Ticket – allows to specify the requested number of One-Way solutions in Multi-Ticket processing.
  • Multiple Branded Fares at Multiple Fares Per Itinerary level - the existing parameters related to Multiple Brands are now also applicable for Multiple Fares Per Itinerary.
  • The Revalidate Itinerary API GIR Response has been enhanced with the following new parameters:
  • Ancillary, Fare type descriptors - new Fare type descriptors in Revalidate Itinerary GIR Response. 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.
  • Credit Card Fee - The credit card amount returned with Low-Cost-Carriers options added at passenger level.
  • Booking Fee - The booking fee amount returned with Low-Cost-Carriers options added at passenger level.
  • Source PCC - The source PCC of the contract processed for Agency Managed Commission will be added for audit and tracking purposes. Available for AMC users only.

API Information

Response Format
JSON
Method/Endpoint
/v5.4.0/shop/flights/revalidate
Current Version
5.4.0
Target Audience
TN
Environment
Production

What's New

  • The Revalidate Itinerary API Request is now enhanced with the following new features:
  • New REST JSON API response format - Grouped Itinerary Response (GIR). Note: OTA JSON Response type is no longer available with the new version.
  • Branded Fare Attributes - request associated brand attributes.
  • Exclude Non-Branded Fares - allows for only branded fares to be returned when requesting single or multiple brands.
  • Alternate Airport Cross Border Indicator - allow alternate airports to be in other country than the main city-pair when mileage is used.
  • Shop by Fare Basis Code – exclude a fare option based on Fare Basis Code.
  • Shop by Class of Service – exclude a fare option based on Class of Service (Reservation Booking Designator).
  • Shop with Parity Mode – allows to control the brand parity mode for the lowest fare returned.
  • Enhanced Multi-Ticket – allows to specify the requested number of One-Way solutions in Multi-Ticket processing.
  • Multiple Branded Fares at Multiple Fares Per Itinerary level - the existing parameters related to Multiple Brands are now also applicable for Multiple Fares Per Itinerary.
  • The Revalidate Itinerary API GIR Response has been enhanced with the following new parameters:
  • Ancillary, Fare type descriptors - new Fare type descriptors in Revalidate Itinerary GIR Response. 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.
  • Credit Card Fee - The credit card amount returned with Low-Cost-Carriers options added at passenger level.
  • Booking Fee - The booking fee amount returned with Low-Cost-Carriers options added at passenger level.
  • Source PCC - The source PCC of the contract processed for Agency Managed Commission will be added for audit and tracking purposes. Available for AMC users only.

Business Value

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

New Features

In the Request

Optional

Parameter: NonBrandedFares

Type: complexType

Description: New Parameter to allow to exclude non-branded fares in the shopping response. When the PreferLevel is set to “Preferred" this means “Use non-branded fares”. If this is single filter (no other preferred elements) the meaning is “Use ONLY non-branded fares”. If other preferred filters are also used the meaning is “Use non-branded fares or fares with given (in filters) brands”. When the PreferLevel is set to “Unacceptable" this means “Do not use non-branded fares”. If this is single filter (no other unacceptable elements) the meaning is “Use ONLY branded fares – skip all non-branded”. If other unacceptable filters are also used the meaning is “Use only branded fares excluding fares matching given (in filters) brands”.

Sample Value:

{
	"PriceRequestInformation": {
		"TPA_Extensions": {
			"BrandedFareIndicators": {
				"SingleBrandedFare": "true",
				"BrandFilters": {
					"Brand": {
						"Code": "A3",
						"PreferLevel": "Unacceptable"
					},
					"NonBrandedFares": {
						"PreferLevel": "Preferred"
					}
				}
			}
		}
	}
}
Note: In the Revalidate Itinerary schema version 5.4.0, the NonBrandedFares were added in all 4 levels: Main fare, Main fare leg, Flex fare, Flex fare leg. This section covers Main Fare. Used to indicate a level of preference for an associate item: unacceptable or preferred.

In the Request

Optional

Parameter: NonBrandedFares

Type: complexType

Description: New Parameter to allow to exclude non-branded fares in the shopping response. When the PreferLevel is set to “Preferred" this means “Use non-branded fares”. If this is single filter (no other preferred elements) the meaning is “Use ONLY non-branded fares”. If other preferred filters are also used the meaning is “Use non-branded fares or fares with given (in filters) brands”. When the PreferLevel is set to “Unacceptable" this means “Do not use non-branded fares”. If this is single filter (no other unacceptable elements) the meaning is “Use ONLY branded fares – skip all non-branded”. If other unacceptable filters are also used the meaning is “Use only branded fares excluding fares matching given (in filters) brands”.

Sample Value:

{
	"OriginDestinationInformation": {
		"RPH": 1,
		"DepartureDateTime": "2019-10-10T00:00:00",
		"OriginLocation": {
			"LocationCode": "DFW"
		},
		"DestinationLocation": {
			"LocationCode": "KRK"
		},
		"TPA_Extensions": {
			"SegmentType": {
				"Code": "O"
			},
			"BrandFilters": {
				"Brand": {
					"Code": "A2",
					"PreferLevel": "Preferred"
				},
				"NonBrandedFares": {
					"PreferLevel": "Preferred"
				}
			}
		}
	}
}
Note: In the Revalidate Itinerary schema version 5.4.0, the NonBrandedFares were added in all 4 levels: Main fare, Main fare leg, Flex fare, Flex fare leg. This section covers Main Fare leg. Used to indicate a level of preference for an associate item: unacceptable or preferred.

In the Request

Optional

Parameter: NonBrandedFares

Type: complexType

Description: New Parameter to allow to exclude non-branded fares in the shopping response. When the PreferLevel is set to “Preferred" this means “Use non-branded fares”. If this is single filter (no other preferred elements) the meaning is “Use ONLY non-branded fares”. If other preferred filters are also used the meaning is “Use non-branded fares or fares with given (in filters) brands”. When the PreferLevel is set to “Unacceptable" this means “Do not use non-branded fares”. If this is single filter (no other unacceptable elements) the meaning is “Use ONLY branded fares – skip all non-branded”. If other unacceptable filters are also used the meaning is “Use only branded fares excluding fares matching given (in filters) brands”.

Sample Value:

{
	"FlexibleFares": {
		"FareParameters": {
			"BrandedFareIndicators": {
				"BrandFilters": {
					"NonBrandedFares": {
						"PreferLevel": "Preferred"
					}
				}
			}
		}
	}
}
Note: In the Revalidate Itinerary schema version 5.4.0, the NonBrandedFares were added in all 4 levels: Main fare, Main fare leg, Flex fare, Flex fare leg. This section covers Flex Fare. Used to indicate a level of preference for an associate item: unacceptable or preferred.

In the Request

Optional

Parameter: NonBrandedFares

Type: complexType

Description: New Parameter to allow to exclude non-branded fares in the shopping response. When the PreferLevel is set to “Preferred" this means “Use non-branded fares”. If this is single filter (no other preferred elements) the meaning is “Use ONLY non-branded fares”. If other preferred filters are also used the meaning is “Use non-branded fares or fares with given (in filters) brands”. When the PreferLevel is set to “Unacceptable" this means “Do not use non-branded fares”. If this is single filter (no other unacceptable elements) the meaning is “Use ONLY branded fares – skip all non-branded”. If other unacceptable filters are also used the meaning is “Use only branded fares excluding fares matching given (in filters) brands”.

Sample Value:

{
	"FlexibleFares": {
		"FareParameters": {
			"BrandedFareIndicators": {
				"BrandFilters": {
					"Brand": {
						"Code": "B2",
						"PreferLevel": "Unacceptable"
					},
					"NonBrandedFares": {
						"PreferLevel": "Preferred"
					}
				}
			},
			"Leg": {
				"Num": 1,
				"FareType": {
					"Code": "EU",
					"PreferLevel": "Preferred"
				},
				"BrandFilters": {
					"Brand": {
						"Code": "A2",
						"PreferLevel": " Preferred "
					},
					"NonBrandedFares": {
						"PreferLevel": "Preferred"
					}
				}
			}
		}
	}
}
Note: In the Revalidate Itinerary schema version 5.4.0, the NonBrandedFares were added in all 4 levels: Main fare, Main fare leg, Flex fare, Flex fare leg. This section covers Flex Fare leg. Used to indicate a level of preference for an associate item: unacceptable or preferred.

In the Request

Optional

Parameter: AllowBorderCross

Type: boolean

Description: New parameter set from default to true. In addition to AlternateAirportMileage it enables to cross a given country border if an alternative Airport is in the range of requested mileage radius.

Sample Value:

{
	"OriginDestinationInformation": {
		"TPA_Extensions": {
			"SisterDestinationMileage": {
				"AllowBorderCross": "true"
			}
		}
	}
}
Note: Allow to return alternate airports from other countries. Default value is true. AllowBorderCross configuration set at AlternateAirportMileage overrides values of the same parameter set at leg level.

In the Request

Optional

Parameter: ReturnBrandAncillaries

Type: boolean

Description: To request brand attributes, allows Sabre agencies to return additional brand attributes in the response it returns the structured data filed in table 166. Brand attributes is a feature within the Branded fares capabilities and will be returned with single and multiple branded fares request.

Sample Value:

{
	"TravelerInfoSummary": {
		"SeatsRequested": 1,
		"AirTravelerAvail": {
			"PassengerTypeQuantity": {
				"Code": "ADT",
				"Quantity": 1,
				"TPA_Extensions": {
					"VoluntaryChanges": {
						"Match": "Info"
					}
				}
			}
		},
		"PriceRequestInformation": {
			"CurrencyCode": "USD",
			"TPA_Extensions": {
				"BrandedFareIndicators": {
					"MultipleBrandedFares": "true",
					"ReturnBrandAncillaries": "true"
				}
			}
		}
	}
}
Note: Brand attributes is a feature within the Branded fares capabilities and will be returned with single and multiple branded fares request.

In the Request

Optional

Parameter: PreferLevel

Type: IncludeExcludePreferLevelType

Description: New parameter to support the capability for shopping to exclude a fare option based on Fare Basis Code. Allow to exclude for fares in shopping Main Fare and within MFPI (FlexFare group).

Sample Value:

 "FareParameters": [
                        {
                            "FareBasis": [
                                {
                                    "Code": "OVAJZNB3",
                                    "PreferLevel": "Preferred"
                                },
                                {
                                    "Code": "ZPLAXJFK",
                                    "PreferLevel": "Preferred"
                                },
                                {
                                    "Code": "IP7J3",
                                    "PreferLevel": "Unacceptable"
                                }
                            ]
                        }
                    ]
                }
Note: In the Revalidate Itinerary schema the PreferLevel was added in all 4 levels: Main fare, Main fare leg, Flex fare, Flex fare leg. This section covers Main fare level. Used to indicate a level of preference for an associate item: unacceptable or preferred. Default value is Preferred.

In the Request

Optional

Parameter: PreferLevel

Type: IncludeExcludePreferLevelType

Description: New parameter to support the capability for shopping to exclude a fare option based on Fare Basis Code. Allow to exclude for fares in shopping Main Fare and within MFPI (FlexFare group).

Sample Value:

"OriginDestinationInformation": [
            {
                "RPH": "1",
                "DepartureDateTime": "2020-01-01T00:00:00",
                "OriginLocation": {
                    "LocationCode": "LAX"
                },
                "DestinationLocation": {
                    "LocationCode": "JFK"
                },
                "TPA_Extensions": {
                    "FareBasis": [
                        {
                            "Code": "OVAJZNB3",
                            "PreferLevel": "Preferred"
                        },
                        {
                            "Code": "ZPLAXJFK",
                            "PreferLevel": "Unacceptable"
                        },
                        {
                            "Code": "IP7J1",
                            "PreferLevel": "Preferred"
                        }
                    ]
                }
            },
Note: In the Revalidate Itinerary schema the PreferLevel was added in all 4 levels: Main fare, Main fare leg, Flex fare, Flex fare leg. This section covers Main fare leg level. Used to indicate a level of preference for an associate item: unacceptable or preferred. Default value is Preferred.

In the Request

Optional

Parameter: PreferLevel

Type: IncludeExcludePreferLevelType

Description: New parameter to support the capability for shopping to exclude a fare option based on Fare Basis Code. Allow to exclude for fares in shopping Main Fare and within MFPI (FlexFare group).

Sample Value:

 "FareParameters": [
                        {
                            "FareBasis": [
                                {
                                    "Code": "OVAJZNB3",
                                    "PreferLevel": "Preferred"
                                },
                                {
                                    "Code": "ZPLAXJFK",
                                    "PreferLevel": "Preferred"
                                },
                                {
                                    "Code": "IP7J3",
                                    "PreferLevel": "Unacceptable"
                                }
                            ]
                        }
                    ]
                },
Note: In the Revalidate Itinerary schema the PreferLevel was added in all 4 levels: Main fare, Main fare leg, Flex fare, Flex fare leg. This section covers Flex fare level. Used to indicate a level of preference for an associate item: unacceptable or preferred. Default value is Preferred.

In the Request

Optional

Parameter: PreferLevel

Type: IncludeExcludePreferLevelType

Description: New parameter to support the capability for shopping to exclude a fare option based on Fare Basis Code. Allow to exclude for fares in shopping Main Fare and within MFPI (FlexFare group).

Sample Value:

"FlexibleFares": {
                    "FareParameters": [
                        {
                            "FareBasis": [
                                {
                                    "Code": "OVAJZNB3",
                                    "PreferLevel": "Preferred"
                                },
                                {
                                    "Code": "ZPLAXJFK",
                                    "PreferLevel": "Preferred"
                                },
                                {
                                    "Code": "IP7J3",
                                    "PreferLevel": "Unacceptable"
                                }
                            ]
                        }
                    ]
                },
Note: In the Revalidate Itinerary schema the PreferLevel was added in all 4 levels: Main fare, Main fare leg, Flex fare, Flex fare leg. This section covers Flex fare leg level. Used to indicate a level of preference for an associate item: unacceptable or preferred. Default value is Preferred.

In the Request

Optional

Parameter: PreferLevel

Type: IncludeExcludePreferLevelType

Description: New parameter to support the capability for shopping to exclude a fare option based on Class of Service (RBD). Allow to exclude for fares in shopping Main Fare and within MFPI (FlexFare group).

Sample Value:

"TravelPreferences": {
  "TPA_Extensions": {
    "ClassOfService": [{
        "Code": "J",
        "PreferLevel": "Unacceptable"
      }
    ]
  }
},
Note: In the Revalidate Itinerary schema the PreferLevel was added in all 4 levels: Main fare, Main fare leg, Flex fare, Flex fare leg. This section covers Main Fare. Used to indicate a level of preference for an associate item: unacceptable or preferred. Default value is Preferred.

In the Request

Optional

Parameter: PreferLevel

Type: IncludeExcludePreferLevelType

Description: New parameter to support the capability for shopping to exclude a fare option based on Class of Service (RBD). Allow to exclude for fares in shopping Main Fare and within MFPI (FlexFare group).

Sample Value:

"OriginDestinationInformation": [{
    "RPH": "1",
    "DepartureDateTime": "2019-10-27T00:00:00",
    "OriginLocation": {
      "LocationCode": "LAX"
    },
    "DestinationLocation": {
      "LocationCode": "JFK"
    },
    "TPA_Extensions": {
      "ClassOfService": [{
          "Code": "J",
          "PreferLevel": "Unacceptable"
        }
      ]
    }
  }
Note: In the Revalidate Itinerary schema the PreferLevel was added in all 4 levels: Main fare, Main fare leg, Flex fare, Flex fare leg. This section covers Main fare leg level. Used to indicate a level of preference for an associate item: unacceptable or preferred. Default value is Preferred.

In the Request

Optional

Parameter: PreferLevel

Type: IncludeExcludePreferLevelType

Description: New parameter to support the capability for shopping to exclude a fare option based on Class of Service (RBD). Allow to exclude for fares in shopping Main Fare and within MFPI (FlexFare group).

Sample Value:

"FlexibleFares": {
	"FareParameters": [
		{
			"ClassOfService": [
				{
					"Code": "O",
					"PreferLevel": "Preferred"
				},
				{
					"Code": "J",
					"PreferLevel": "Unacceptable"
				}
			]
		}
	]
},
Note: In the Revalidate Itinerary schema the PreferLevel was added in all 4 levels: Main fare, Main fare leg, Flex fare, Flex fare leg. This section covers Flex fare level. Used to indicate a level of preference for an associate item: unacceptable or preferred. Default value is Preferred.

In the Request

Optional

Parameter: PreferLevel

Type: IncludeExcludePreferLevelType

Description: New parameter to support the capability for shopping to exclude a fare option based on Class of Service (RBD). Allow to exclude for fares in shopping Main Fare and within MFPI (FlexFare group).

Sample Value:

"FlexibleFares": {
  "FareParameters": [{
      "Leg": [{
          "Num": 1,
          "ClassOfService": [{
              "Code": "J",
              "PreferLevel": "Unacceptable"
            }
          ]
        }
      ]
    }
  ]
},
Note: In the Revalidate Itinerary schema the PreferLevel was added in all 4 levels: Main fare, Main fare leg, Flex fare, Flex fare leg. This section covers Flex fare leg level. Used to indicate a level of preference for an associate item: unacceptable or preferred. Default value is Preferred.

In the Request

Optional

Parameter: ParityModeForLowest

Type: string

Description: Parity mode for lowest branded fare. This parameter gives the ability to apply parity mode for the main/primary fare.

Sample Value:

"PriceRequestInformation": {
                "TPA_Extensions": {
                    "BrandedFareIndicators": {
                        "SingleBrandedFare": false,
                        "ParityModeForLowest": "Leg",
                        "MultipleBrandedFares": true
                    }
                }
            }
        },
Note: If set, given parity mode will be forced on the cheapest branded fare solution. If not specified, no parity (None) is forced on the cheapest branded fare solution. It's designed to work with MultipleBrandedFares feature only.

In the Request

Optional

Parameter: RequestedOneWays

Type: positiveInteger

Description: The new parameter RequestedOneWays allows to specify the requested number of One-Way solutions in Multi-Ticket processing.

Sample Value:

 "MultiTicket": {
                "DisplayPolicy": "SOW",
                "RequestedOneWays": 30
            }
        }
    }
}
Note: Allow to set requested number of OneWays in MultiTicket processing.

In the Request

Optional

Parameter: BrandedFareIndicators

Type: boolean

Description: Return multiple brand options per itinerary.

Sample Value:

"FlexibleFares": {
	"FareParameters": [
		{
			"Cabin": {
				"Type": "Y"
			},
			"BrandedFareIndicators": {
				"MultipleBrandedFares": true,
				"UpsellLimit": 2,
				"ItinParityBrandlessLeg": true,
				"ParityMode": "Leg",
				"ItinParityFallbackMode": "LowestSingle"
			}
		},
Note: Set of branded fare switches and preferences for whole flexible fare.

In the Request

Optional

Parameter: UpsellLimit

Type: integer

Description: Indicates maximum number of requested branded upsells.

Sample Value:

"FlexibleFares": {
	"FareParameters": [
		{
			"Cabin": {
				"Type": "Y"
			},
			"BrandedFareIndicators": {
				"MultipleBrandedFares": true,
				"UpsellLimit": 2,
				"ItinParityBrandlessLeg": true,
				"ParityMode": "Leg",
				"ItinParityFallbackMode": "LowestSingle"
			}
		},
Note: Parameter to limit the number of upsell solutions to be returned.

In the Request

Optional

Parameter: ItinParityBrandlessLeg

Type: boolean

Description: Parameter to allow for brand-less leg solutions when itinerary parity is requested.

Sample Value:

"FlexibleFares": {
	"FareParameters": [
		{
			"Cabin": {
				"Type": "Y"
			},
			"BrandedFareIndicators": {
				"MultipleBrandedFares": true,
				"UpsellLimit": 2,
				"ItinParityBrandlessLeg": true,
				"ParityMode": "Leg",
				"ItinParityFallbackMode": "LowestSingle"
			}
		},
Note: Allow brand-less legs in multiple brands upsell solutions.

In the Request

Optional

Parameter: ParityMode

Type: string

Description: Multiple Branded Fares parity mode.

Sample Value:

"FlexibleFares": {
	"FareParameters": [
		{
			"Cabin": {
				"Type": "Y"
			},
			"BrandedFareIndicators": {
				"MultipleBrandedFares": true,
				"UpsellLimit": 2,
				"ItinParityBrandlessLeg": true,
				"ParityMode": "Leg",
				"ItinParityFallbackMode": "LowestSingle"
			}
		},
Note: ParityMode and ItinParityFallbackMode parameters are optional. When specifying the ParityMode=”Itin” at the request level without specifying the ItinParityFallbackMode, then the default fallback mode in the “BFM rule” level will be applied. Possible fallback modes: LowestSingle (no upsell options only lowest single possible branded solutions) or Leg (upsells generated using leg parity mode).

In the Request

Optional

Parameter: ItinParityFallbackMode

Type: string

Description: Fallback mode for Multiple Branded Fares with itin parity, when no itin parity solutions found.

Sample Value:

"FlexibleFares": {
	"FareParameters": [
		{
			"Cabin": {
				"Type": "Y"
			},
			"BrandedFareIndicators": {
				"MultipleBrandedFares": true,
				"UpsellLimit": 2,
				"ItinParityBrandlessLeg": true,
				"ParityMode": "Leg",
				"ItinParityFallbackMode": "LowestSingle"
			}
		},
Note: Possible FallBack modes to be used are: LowestSingle (no upsell options only lowest single possible branded solutions) or Leg (Upsells generated using leg parity mode).

In the Response

Optional

Parameter: FareType

Type: string

Description: New Fare type descriptors in Revalidate Itinerary. 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: New Fare type descriptors in Revalidate Itinerary. 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.

In the Response

Optional

Parameter: FareTariff

Type: string

Description: New Fare type descriptors in Revalidate Itinerary. 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: New Fare type descriptors in Revalidate Itinerary. 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.

In the Response

Optional

Parameter: FareRule

Type: string

Description:

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: New Fare type descriptors in Revalidate Itinerary. 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.

In the Response

Optional

Parameter: FareTypeBitmap

Type: string

Description: New Fare type descriptors in Revalidate Itinerary. 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).

In the Response

Optional

Parameter: CreditCardFeeAmount

Type: decimal

Description: The Creditcard Fee returned with LCC options, added at TotalFare level.

Sample Value:

],
"totalFare": {
    "totalPrice": 10,
    "totalTaxAmount": 17,
    "currency": "USD",
    "baseFareAmount": 11,
    "baseFareCurrency": "USD",
    "constructionAmount": 12,
    "constructionCurrency": "USD",
    "equivalentAmount": 14,
    "equivalentCurrency": "USD",
    "airExtrasAmount": 15,
    "totalPriceWithAirExtras": 25,
    "creditCardFeeAmount": 10,
    "bookingFeeAmount": 25
}
Note: Returned only if non-zero value.

In the Response

Optional

Parameter: BookingFeeAmount

Type: decimal

Description: The Booking Fee returned with LCC options, added at TotalFare level.

Sample Value:

],
"totalFare": {
    "totalPrice": 10,
    "totalTaxAmount": 17,
    "currency": "USD",
    "baseFareAmount": 11,
    "baseFareCurrency": "USD",
    "constructionAmount": 12,
    "constructionCurrency": "USD",
    "equivalentAmount": 14,
    "equivalentCurrency": "USD",
    "airExtrasAmount": 15,
    "totalPriceWithAirExtras": 25,
    "creditCardFeeAmount": 10,
    "bookingFeeAmount": 25
}
Note: Returned only if non-zero value.

In the Response

Optional

Parameter: SourcePCC

Type: PseudoCityCodeType

Description: The PCC of the contract processed for Agency Managed Commission which is added for audit/tracking purposes.

Sample Value:

 },
 "validatingCarrierCommissionInfo": [
   {
     "validatingCarrier": "BA",
     "commissionAmount": 9.45,
     "earnedCommissionAmount": 9.45,
     "commissionContractQualifier": "MT9FIXALLOW",
     "sourcePcc": "A1D0",
     "fareComponentBreakdowns": [
       {
Note: Source PseudoCityCode. Applicable for AMC subscribers only.

Functional Updates And Enhancements

In the Response

Optional

Parameter: Type

Type: string

Description: Flight type (A: Air Segment, K: ARUNK, O: Open Segment)

Sample Value:

"Flight": [
	{
		"ClassOfService": "S",
		"Number": 705,
		"DepartureDateTime": "2018-04-15T23:55:00",
		"ArrivalDateTime": "2018-04-16T08:35:00",
		"Type": "A",
		"Flown": false,
		"OriginLocation": {
			"LocationCode": "MAD"
		},
		"DestinationLocation": {
			"LocationCode": "SCL"
Note: This is an existing parameter but it has been changed from restricted to optional, and it's default value is equal to A - Air Segment. It belongs to the OriginDestinationFlightAttributeGroup.

Relase note ID: 13780


  • Revalidate Itinerary has been enhanced with the following new optional search parameters:
  • Shop by Fare Type Code – to support the capability for shopping to include/exclude a fare option based on Fare Type Code.
  • Shop by Brand ID Code – to support the capability for shopping to include/exclude a fare option based on Brand ID code.

API Information

Response Format
JSON
Method/Endpoint
Current Version
4.3.0
Target Audience
TN
Environment
Production

What's New

  • Revalidate Itinerary has been enhanced with the following new optional search parameters:
  • Shop by Fare Type Code – to support the capability for shopping to include/exclude a fare option based on Fare Type Code.
  • Shop by Brand ID Code – to support the capability for shopping to include/exclude a fare option based on Brand ID code.

Business Value

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

New Features

In the Request

Optional

Parameter: FareType Code

Type: FareTypePrefType

Description: New parameters to support the capability for shopping to include/exclude a fare option based on Fare Type Code. The parameter to be used in a search for the whole journey.

Sample Value:

{
	"TravelPreferences": {
		"TPA_Extensions": {
			"FareType": [
				{
					"@Code": "EOU",
					"@PreferLevel": "Preferred"
				},
				{
					"@Code": "ERU",
					"@PreferLevel": "Unacceptable"
				}
			]
		}
	}
}
Note: New parameter at the shopping, to filter fares by Fare Type Code filters out all unbundled (basic economy fares) which are fares filed with a fare type code = EOU (economy one-way unbundled) or ERU (economy return unbundled).

In the Request

Optional

Parameter: FareType Code

Type: FareTypePrefType

Description: New parameters to support the capability for shopping to include/exclude a fare option based on Fare Type Code. The parameter to be used in a search, at the leg level.

Sample Value:

{
	"OriginDestinationInformation": {
		"@RPH": 1,
		"DepartureDateTime": "2018-10-10T00:00:00",
		"OriginLocation": {
			"@LocationCode": "DFW"
		},
		"DestinationLocation": {
			"@LocationCode": "KRK"
		},
		"TPA_Extensions": {
			"SegmentType": {
				"@Code": "O"
			},
			"FareType": [
				{
					"@Code": "EOU",
					"@PreferLevel": "Preferred"
				},
				{
					"@Code": "ERU",
					"@PreferLevel": "Preferred"
				}
			]
		}
	}
}
Note: New parameter at the shopping, to filter fares by Fare Type Code filters out all unbundled (basic economy fares) which are fares filed with a fare type code = EOU (economy one-way unbundled) or ERU (economy return unbundled).

In the Request

Optional

Parameter: Brand Code

Type: BrandCodePrefType

Description: New parameter to support the capability for shopping to include/exclude a fare option based on Brand ID code. The parameter to be used in a search for the whole journey.

Sample Value:

{
	"PriceRequestInformation": {
		"TPA_Extensions": {
			"BrandedFareIndicators": {
				"@SingleBrandedFare": "true",
				"BrandFilters": {
					"Brand": [
						{
							"@Code": "A3",
							"@PreferLevel": "Preferred"
						},
						{
							"@Code": "A2",
							"@PreferLevel": "Preferred"
						}
					]
				}
			}
		}
	}
}
Note: If brand filters are used in either single brand mode or multiple brand mode both cheapest and upsells fares will be considered for filtering. If “preferred” brands are given then only branded fares matching the brand codes will be returned. If “unacceptable” brands are given then branded fares matching this brand codes will be excluded (non-branded will stay in processing).

In the Request

Optional

Parameter: Brand Code

Type: BrandCodePrefType

Description: New parameter to support the capability for shopping to include/exclude a fare option based on Brand ID code. The parameter to be used in a search, at the leg level.

Sample Value:

{
	"OriginDestinationInformation": {
		"@RPH": 1,
		"DepartureDateTime": "2018-10-10T00:00:00",
		"OriginLocation": {
			"@LocationCode": "DFW"
		},
		"DestinationLocation": {
			"@LocationCode": "KRK"
		},
		"TPA_Extensions": {
			"SegmentType": {
				"@Code": "O"
			},
			"BrandFilters": {
				"Brand": [
					{
						"@Code": "A2",
						"@PreferLevel": "Preferred"
					},
					{
						"@Code": "A3",
						"@PreferLevel": "Preferred"
					}
				]
			}
		}
	}
}
Note: If brand filters are used in either single brand mode or multiple brand mode both cheapest and upsells fares will be considered for filtering. If “preferred” brands are given then only branded fares matching the brand codes will be returned. If “unacceptable” brands are given then branded fares matching this brand codes will be excluded (non-branded will stay in processing).

Relase note ID: 13864


  • Revalidate Itinerary has been enhanced with the following new optional search parameters:
  • Revalidate Itinerary – To control the availability validation for a given itinerary.
  • Branded Fares Optimization – To control the brand parity logic preference (leg or itinerary parity, number of up-sells, allow brand-less legs and fallback modes).
  • Additionally, the following information will be returned in the Revalidate Itinerary response:
  • Forced Stopover Indicator – New indicator at the segment level to denote stopover point.
  • Revalidate Itinerary – Renamed element from "repriced" to "revalidated".

API Information

Response Format
JSON
Method/Endpoint
RevalidateItinRQPOST v4.2.0/shop/flights/revalidate
Current Version
4.2.0
Target Audience
TN
Environment
Production

What's New

  • Revalidate Itinerary has been enhanced with the following new optional search parameters:
  • Revalidate Itinerary – To control the availability validation for a given itinerary.
  • Branded Fares Optimization – To control the brand parity logic preference (leg or itinerary parity, number of up-sells, allow brand-less legs and fallback modes).
  • Additionally, the following information will be returned in the Revalidate Itinerary response:
  • Forced Stopover Indicator – New indicator at the segment level to denote stopover point.
  • Revalidate Itinerary – Renamed element from "repriced" to "revalidated".

Business Value

  • Each of these new parameters power new ways to market, shop and convert lookers to bookers.

New Features

In the Request

Optional

Parameter: AlwaysCheckAvailability

Type: Boolean

Description: This parameter allows customers to control the availability validation for a given itinerary.

Sample Value:

{
	"TravelPreferences": {
		"VendorPref": {
			"PreferLevel": "Preferred",
			"Code": "EK"
		},
		"TPA_Extensions": {
			"VerificationItinCallLogic": {
				"Value": "M",
				"AlwaysCheckAvailability": "true"
			}
		}
	}
}
Note: Applicable only to Revalidate Itinerary functionality.

In the Request

Optional

Parameter: UpsellLimit

Type: Integer

Description: New parameter to limit the number of branded fare upsell solutions to be returned.

Sample Value:

{
	"PriceRequestInformation": {
		"AccountCode": {
			"Code": "BD001"
		},
		"TPA_Extensions": {
			"BrandedFareIndicators": {
				"MultipleBrandedFares": "true",
				"SingleBrandedFare": "true",
				"ParityMode": "Leg",
				"UpsellLimit": 2
			}
		}
	}
}
Note:

In the Request

Optional

Parameter: ItinParityBrandlessLeg

Type: Boolean

Description: New parameter to allow for brand-less leg solutions when itinerary parity is requested.

Sample Value:

{
       "TPA_Extensions": {
              "BrandedFareIndicators": {
                     "MultipleBrandedFares": "true",
                     "ItinParityBrandlessLeg": "true",
                     "ParityMode": "Itin"
              }
       }
}
 
}
Note:

In the Request

Optional

Parameter: ParityMode

Type: String

Description: New parameter to control the brand parity logic preference (Leg Parity or Itinerary Parity).

Sample Value:

{
	"TPA_Extensions": {
		"Priority": {
			"Price": {
				"Priority": 2
			},
			"DirectFlights": {
				"Priority": 1
			},
			"Time": {
				"Priority": 3
			},
			"Vendor": {
				"Priority": 4
			}
		},
		"BrandedFareIndicators": {
			"MultipleBrandedFares": "true",
			"SingleBrandedFare": "true",
			"ParityMode": "Itin",
			"ItinParityFallbackMode": "LowestSingle"
		}
	}
}
Note: ParityMode and ItinParityFallbackMode parameters are optional. When specifying the ParityMode=”Itin” at the request level without specifying the ItinParityFallbackMode, then the default fallback mode in the “BFM rule” level will be applied. Possible fallback modes: LowestSingle (no upsell options only lowest single possible branded solutions) or Leg (upsells generated using leg parity mode).

In the Request

Optional

Parameter: ItinParityFallbackMode

Type: String

Description: New parameter to control the fall back mode logic when brand itinerary parity cannot be met (lowest single brand or leg parity).

Sample Value:

{
	"TPA_Extensions": {
		"Priority": {
			"Price": {
				"Priority": 2
			},
			"DirectFlights": {
				"Priority": 1
			},
			"Time": {
				"Priority": 3
			},
			"Vendor": {
				"Priority": 4
			}
		},
		"BrandedFareIndicators": {
			"MultipleBrandedFares": "true",
			"SingleBrandedFare": "true",
			"ParityMode": "Itin",
			"ItinParityFallbackMode": "LowestSingle"
		}
	}
}
Note: Possible FallBack modes to be used are: LowestSingle (no upsell options only lowest single possible branded solutions) or Leg (upsells generated using leg parity mode).

In the Response

Optional

Parameter: RequestedStopover Ind

Type: Boolean

Description: Indicator to identify which segment is the one departing from the stopover point in the Revalidate Itinerary response (within one leg).

Sample Value:

{
	"FlightSegment": {
		"DepartureDateTime": "2018-08-12T16:50:00",
		"ArrivalDateTime": "2018-08-12T20:20:00",
		"StopQuantity": 0,
		"FlightNumber": 872,
		"ResBookDesigCode": "V",
		"ElapsedTime": 150,
		"DepartureAirport": {
			"LocationCode": "LHR",
			"TerminalID": 5
		},
		"ArrivalAirport": {
			"LocationCode": "KRK"
		},
		"OperatingAirline": {
			"Code": "YY",
			"FlightNumber": 872
		},
		"Equipment": {
			"AirEquipType": 320
		},
		"MarketingAirline": {
			"Code": "YY"
		},
		"MarriageGrp": "O",
		"DepartureTimeZone": {
			"GMTOffset": 1
		},
		"ArrivalTimeZone": {
			"GMTOffset": 2
		},
		"TPA_Extensions": {
			"eTicket": {
				"Ind": "true"
			},
			"Mileage": {
				"Amount": 889
			},
			"RequestedStopover": {
				"Ind": "true"
			}
		}
	}
}
Note:

Functional Updates And Enhancements

In the Response

Optional

Parameter: Revalidated

Type: Boolean

Description: Indicator to identify the itinerary offer that was validated.

Sample Value:

{
	"AirItineraryPricingInfo": {
		"PricingSource": "WPNI1_ITIN",
		"PricingSubSource": "MIP",
		"Revalidated": "true",
		"FareReturned": "true",
		"ItinTotalFare": {
			"BaseFare": {
				"Amount": 9254.00,
				"CurrencyCode": "EUR",
				"DecimalPlaces": 2
			},
			"FareConstruction": {
				"Amount": 11364.48,
				"CurrencyCode": "NUC",
				"DecimalPlaces": 2
			},
			"EquivFare": {
				"Amount": 11070.00,
				"CurrencyCode": "USD",
				"DecimalPlaces": 2
			},
			"Taxes": {
				"Tax": {
					"TaxCode": "TOTALTAX",
					"Amount": 1256.40,
					"CurrencyCode": "USD",
					"DecimalPlaces": 2
				}
			},
			"TotalFare": {
				"Amount": 12326.40,
				"CurrencyCode": "USD",
				"DecimalPlaces": 2
			}
		}
	}
}
Note: When the @Revalidated parameter is included with the ‘true’ value in the response this means the system revalidated the given itinerary with the specified flight schedule, RBD, date of travel and city-pair.

Relase note ID: 12928


  • Revalidate Itinerary has been enhanced to enable more flexibility within the request and return additional information in the response as follows:
  • Return only options with at least one free bag.
  • Exclude codeshare flights.
  • Also, the following information will be returned in the response:
  • More details in the Selling Fare Data applicable to Agency Retailer.
  • Extended Ancillary Fee Groups with ancillary subcode(s), type(s) and hints for up to 10 standard bags.

API Information

Response Format
JSON
Method/Endpoint
RevalidateItinRQv4.1.0/shop/flights/revalidate
Current Version
4.1.0
Target Audience
TN
Environment
Production

What's New

  • Revalidate Itinerary has been enhanced to enable more flexibility within the request and return additional information in the response as follows:
  • Return only options with at least one free bag.
  • Exclude codeshare flights.
  • Also, the following information will be returned in the response:
  • More details in the Selling Fare Data applicable to Agency Retailer.
  • Extended Ancillary Fee Groups with ancillary subcode(s), type(s) and hints for up to 10 standard bags.

Business Value

  • These enhancements drive greater transparency for baggage allowance and charges and a better schedule filtering options with the exclude codeshares parameter.

New Features

In the Request

Optional

Parameter: FreePieceRequired

Type: Boolean

Description: Indicator to specify only fare options that include a bag in the fare filed to be returned. Exclude any fares that do not include at least one free bag. The parameter to be used in a search, at the leg level.

Sample Value:

{
	"TravelPreferences": {
		"TPA_Extensions": "",
		"Baggage": {
			"FreePieceRequired": "false",
			"RequestType": "A"
		}
	}
}
Note: Only options with free pieces will be returned. It is required to specify the baggage Request type “A” - Allowance or “C” - Charges in the request, to shop for a free bag.

In the Request

Optional

Parameter: FreePieceRequired

Type: Boolean

Description: Indicator to specify whether only fare options that include a bag in the fare filed should be returned. Exclude any fares that do not include at least one free bag. The parameter to be used in a search for the whole journey.

Sample Value:

{
	"TravelPreferences": {
		"TPA_Extensions": {
			"Baggage": {
				"RequestType": "A",
				"FreePieceRequired": "true"
			}
		}
	}
}
Note: Only options with free pieces will be returned. It is required to specify the baggage Request type “A” - Allowance or “C” - Charges in the request, to shop for a bag.

In the Request

Optional

Parameter: CodeShareIndicator

Type: CodeShareIndicator

Description: Ability to filter out codeshare flights. This new option is available with two attributes: “ExcludeCodeshare” removes codeshare flights. The same Marketing/Operating (base flights), can be combined with “KeepOnlines” to also return the online flights that are codeshare, for more diversity.

Sample Value:

{
	"TravelPreferences": {
		"TPA_Extensions": {
			"CodeShareIndicator": {
				"ExcludeCodeshare": "true",
				"KeepOnlines": "false"
			}
		}
	}
}
Note:

In the Response

Optional

Parameter: NoMarkupBaseFare

Type: Boolean

Description: Applicable to Agency Retailer subscribers. Indicates the original base selling fare, which can include any Fare Retailer Net fare Mark ups plus any Fare Retailer Handling Fees. Excludes all Fare Retailer Selling rule adjustments.

Sample Value:

{
	"NoMarkupBaseFare": {
		"Amount": 161.00,
		"CurrencyCode": "USD"
	}
}
Note:

In the Response

Optional

Parameter: HiddenHandlingFee

Type: Boolean

Description: Applicable to Agency Retailer subscribers. Indicates whether a Fare Retailer hidden Handling fee rule was applied.

Sample Value:

{
	"SellingFareData": {
		"LayerTypeName": "ART",
		"HiddenHandlingFee": "true",
		"HandlingMarkupSummary": [
			{
				"TypeCode": "A",
				"Description": "3PCT",
				"ExtendedDescription": "HAND BSE",
				"MonetaryAmountValue": 0.56,
				"HiddenHandlingFee": "true"
			},
			{
				"TypeCode": "C",
				"Description": "HAND PTK",
				"ExtendedDescription": "HAND PTK",
				"MonetaryAmountValue": 15.00,
				"HiddenHandlingFee": "true"
			},
			{
				"TypeCode": "E",
				"Description": "2PCT",
				"ExtendedDescription": "HAND TTL",
				"MonetaryAmountValue": 0.97,
				"HiddenHandlingFee": "true"
			}
		]
	}
}
Note:

In the Response

Optional

Parameter: NonHiddenHandlingFee

Type: Boolean

Description: Applicable to Agency Retailer subscribers. Indicates whether a Fare Retailer non-hidden Handling Fee rule was applied.

Sample Value:

{
	"SellingFareData": {
		"LayerTypeName": "ART",
		"NonHiddenHandlingFee": "true",
		"HandlingMarkupSummary": {
			"TypeCode": "B",
			"Description": "5PCT",
			"ExtendedDescription": "HAND BSE",
			"MonetaryAmountValue": 1.00,
			"NonHiddenHandlingFee": "true"
		}
	}
}
Note:

In the Response

Optional

Parameter: FareRetailerRule

Type: Boolean

Description: Applicable to Agency Retailer subscribers. Indicates whether a Fare Retailer-Selling level rule was applied.

Sample Value:

{
	"HandlingMarkupSummary": {
		"TypeCode": "J",
		"Description": "ADJT AMT",
		"ExtendedDescription": "ADJT AMT",
		"MonetaryAmountValue": 6.04,
		"FareRetailerRule": "true"
	}
}
Note:

In the Response

Optional

Parameter: AncillaryTypeCode

Type: String

Description: AncillaryTypeCode that corresponds to a type of ancillary, type F or P (treated as F) and is being displayed for all ancillary groups.

Sample Value:

{
	"AncillaryFeeGroup": {
		"Code": "BG",
		"Name": "BAGGAGE",
		"AncillaryFeeItem": [
			{
				"Amount": 25.00,
				"Description": "1ST ADDITIONAL BAG",
				"OriginAirport": "AMS",
				"DestinationAirport": "LHR",
				"Carrier": "K0",
				"PassengerCode": "ADT",
				"Date": "2018-04-10",
				"StartSegment": 1,
				"EndSegment": 1,
				"AncillaryTypeCode": "F",
				"Subcode": "0CC",
				"BaggageID": 1
			},
			{
				"Amount": 45.00,
				"Description": "2ND ADDITIONAL BAG",
				"OriginAirport": "AMS",
				"DestinationAirport": "LHR",
				"Carrier": "K0",
				"PassengerCode": "ADT",
				"Date": "2018-04-10",
				"StartSegment": 1,
				"EndSegment": 1,
				"AncillaryTypeCode": "F",
				"Subcode": "0CD",
				"BaggageID": 2
			},
			{
				"Amount": 45.00,
				"Description": "3RD OR MORE ADDITIONAL BAG",
				"OriginAirport": "AMS",
				"DestinationAirport": "LHR",
				"Carrier": "K0",
				"PassengerCode": "ADT",
				"Date": "2018-04-10",
				"StartSegment": 1,
				"EndSegment": 1,
				"AncillaryTypeCode": "F",
				"Subcode": "0CE",
				"BaggageID": 3
			},
			{
				"Amount": 30.80,
				"Description": "RUCKSACK OR KNAPSACK",
				"OriginAirport": "AMS",
				"DestinationAirport": "LHR",
				"Carrier": "K0",
				"PassengerCode": "ADT",
				"Date": "2018-04-10",
				"StartSegment": 1,
				"EndSegment": 1,
				"AncillaryTypeCode": "F",
				"Subcode": "0EB",
				"BaggageID": 4
			}
		]
	}
}
Note: If one of the records is F type and another P (treated as F) and both have the same subcode, P type will take precedence.

In the Response

Optional

Parameter: Subcode

Type: String

Description: Optional service industry subcodes that are being displayed for all ancillary groups.

Sample Value:

{
	"AncillaryFeeGroup": {
		"Code": "BG",
		"Name": "BAGGAGE",
		"AncillaryFeeItem": [
			{
				"Amount": 25.00,
				"Description": "1ST ADDITIONAL BAG",
				"OriginAirport": "AMS",
				"DestinationAirport": "LHR",
				"Carrier": "KL",
				"PassengerCode": "ADT",
				"Date": "2018-04-10",
				"StartSegment": 1,
				"EndSegment": 1,
				"AncillaryTypeCode": "F",
				"Subcode": "0CC",
				"BaggageID": 1
			},
			{
				"Amount": 45.00,
				"Description": "2ND ADDITIONAL BAG",
				"OriginAirport": "AMS",
				"DestinationAirport": "LHR",
				"Carrier": "KL",
				"PassengerCode": "ADT",
				"Date": "2018-04-10",
				"StartSegment": 1,
				"EndSegment": 1,
				"AncillaryTypeCode": "F",
				"Subcode": "0CD",
				"BaggageID": 2
			},
			{
				"Amount": 45.00,
				"Description": "3RD OR MORE ADDITIONAL BAG",
				"OriginAirport": "AMS",
				"DestinationAirport": "LHR",
				"Carrier": "KL",
				"PassengerCode": "ADT",
				"Date": "2018-04-10",
				"StartSegment": 1,
				"EndSegment": 1,
				"AncillaryTypeCode": "F",
				"Subcode": "0CE",
				"BaggageID": 3
			},
			{
				"Amount": 30.80,
				"Description": "RUCKSACK OR KNAPSACK",
				"OriginAirport": "AMS",
				"DestinationAirport": "LHR",
				"Carrier": "KL",
				"PassengerCode": "ADT",
				"Date": "2018-04-10",
				"StartSegment": 1,
				"EndSegment": 1,
				"AncillaryTypeCode": "F",
				"Subcode": "0EB",
				"BaggageID": 4
			}
		]
	}
}
Note: List of standard ATPCO subcodes: 0CC, 0CD, 0CE, 0CF, 0CG, 0CH, 0CI, 0CJ, 0CK, 0EN.

In the Response

Optional

Parameter: BaggageID

Type: BaggageIDType

Description: Baggage ID number that follows the current hierarchy in sorting Air Extras.

Sample Value:

{
	"AncillaryFeeGroup": {
		"Code": "BG",
		"Name": "BAGGAGE",
		"AncillaryFeeItem": [
			{
				"Amount": 25.00,
				"Description": "1ST ADDITIONAL BAG",
				"OriginAirport": "AMS",
				"DestinationAirport": "LHR",
				"Carrier": "KL",
				"PassengerCode": "ADT",
				"Date": "2018-04-10",
				"StartSegment": 1,
				"EndSegment": 1,
				"AncillaryTypeCode": "F",
				"Subcode": "0CC",
				"BaggageID": 1
			},
			{
				"Amount": 45.00,
				"Description": "2ND ADDITIONAL BAG",
				"OriginAirport": "AMS",
				"DestinationAirport": "LHR",
				"Carrier": "KL",
				"PassengerCode": "ADT",
				"Date": "2018-04-10",
				"StartSegment": 1,
				"EndSegment": 1,
				"AncillaryTypeCode": "F",
				"Subcode": "0CD",
				"BaggageID": 2
			},
			{
				"Amount": 45.00,
				"Description": "3RD OR MORE ADDITIONAL BAG",
				"OriginAirport": "AMS",
				"DestinationAirport": "LHR",
				"Carrier": "KL",
				"PassengerCode": "ADT",
				"Date": "2018-04-10",
				"StartSegment": 1,
				"EndSegment": 1,
				"AncillaryTypeCode": "F",
				"Subcode": "0CE",
				"BaggageID": 3
			},
			{
				"Amount": 30.80,
				"Description": "RUCKSACK OR KNAPSACK",
				"OriginAirport": "AMS",
				"DestinationAirport": "LHR",
				"Carrier": "KL",
				"PassengerCode": "ADT",
				"Date": "2018-04-10",
				"StartSegment": 1,
				"EndSegment": 1,
				"AncillaryTypeCode": "F",
				"Subcode": "0EB",
				"BaggageID": 4
			}
		]
	}
}
Note:

In the Response

Optional

Parameter: Code

Type: PassengerCodeType

Description: Passenger type code related to a specific baggage sequence order with applicable hints.

Sample Value:

{
	"OrderStandardBag": {
		"PassengerBags": {
			"Code": "ADT",
			"BaggageSequenceOrder": [
				{
					"BaggageID": 1,
					"StandardBag": 1
				},
				{
					"BaggageID": 2,
					"StandardBag": 2
				},
				{
					"BaggageID": 3,
					"StandardBag": 3
				}
			]
		}
	}
}
Note:

In the Response

Required

Parameter: BaggageID

Type: BaggageIDType

Description: Baggage ID number for the applicable baggage hints.

Sample Value:

{
	"OrderStandardBag": {
		"PassengerBags": {
			"Code": "ADT",
			"BaggageSequenceOrder": [
				{
					"BaggageID": 1,
					"StandardBag": 1
				},
				{
					"BaggageID": 2,
					"StandardBag": 2
				},
				{
					"BaggageID": 3,
					"StandardBag": 3
				}
			]
		}
	}
}
Note:

In the Response

Required

Parameter: StandardBag

Type: Short

Description: Standard baggage hint: for example, “1” is the first standard baggage, “2” is the second standard baggage.

Sample Value:

{
	"OrderStandardBag": {
		"PassengerBags": {
			"Code": "ADT",
			"BaggageSequenceOrder": [
				{
					"BaggageID": 1,
					"StandardBag": 1
				},
				{
					"BaggageID": 2,
					"StandardBag": 2
				},
				{
					"BaggageID": 3,
					"StandardBag": 3
				}
			]
		}
	}
}
Note:

Relase note ID: 12914


  • Ability to recheck availability and price for a specific itinerary option without booking the itinerary, so the up-to-date content can be presented.
  • A wide range of user-specified criteria can be applied. For the complete list, please consult the request and response design documentation.

API Information

Response Format
JSON
Method/Endpoint
/v3.3.0/shop/flights/revalidate
Current Version
3.3.0
Target Audience
TN
Environment
Production

What's New

  • Ability to recheck availability and price for a specific itinerary option without booking the itinerary, so the up-to-date content can be presented.
  • A wide range of user-specified criteria can be applied. For the complete list, please consult the request and response design documentation.

Relase note ID: 12982