Fare Rules API Reference

The base path for all of the following endpoints is the same:

Base path:

Pre-production https://api.pp.travelport.net/11/air/

Production https://api.travelport.net/11/air/

Fare rules request after Search

Get

farerule/farerules/fromcatalogproductofferings?catalogProductOfferingsIdentifier={responseIdentifier}&catalogProductOfferingID={offerID}&productIDs={productID}&fareRuleType={value}

For {responseIdentifier} send the Search response identifier in CatalogProductOfferings/Identifier/value. For {offerID} send the offer identifier from the Search response for the offer to request fare rules for.

Fare rules request after AirPrice

Get

farerule/farerules/fromoffer?offerIdentifier={offerID}&fareRuleType={value}

For {offerID} send the offer identifier from the AirPrice response for the offer to request fare rules for.

Fare rules request for existing reservation (after booking)

Get

farerule/farerules/fromreservation?reservationIdentifier={LocatorCode}&fareRuleType={value}

For {LocatorCode} send the locator code of the reservation.

Fare rules request after Fare Display
GDS only; NDC does not support fare display functionality. Supports only short text and long text fare rules, not structured fare rules

Get

farerule/farerules/fromfaredisplay?fareRuleIdentifier={responseIdentifier}&fareID={sequence}&fareRuleType={value}

For {responseIdentifier} send the value from FareDisplayResponse/Identifier/value for the Fare Display response. For {sequence} send the value from fareDisplay/fare/sequence for the fare to request fare rules for.

Related Content: Fare Rules Guide

Fare rules are the conditions and restrictions that apply to any booking based on its fare type. These determine the price of the fare. Generally, less expensive fares have more restrictions and more expensive fares have fewer restrictions. Fare rules can include blackout dates, advanced reservation requirements, minimum and maximum stay requirements, and cancellation and change penalties.

See the Fare Rules Guide for details on where in the workflow these requests are supported for NDC and GDS.

Requests

As part of the request requirements, also see Authentication and Common Air Headers.

Query Parameters for Fare Rules Request after Search

Parameter Description Required/Optional

catalogProductOfferingsIdentifier

Value from Search response in CatalogProductOfferings/Identifier/value..

Required

catalogProductOfferingID

Value from Search response in CatalogProductOffering/id for the offer to return fare rules for.

Required

productIDs

Value from Search response in
CatalogProductOffering/ProductBrandOptions/ProductBrandOffering/Product/productRef for the product to return fare rules for.

Fare rules can be requested for one and only one product per request, using the productIDs query parameter. Multiple product IDs are not supported when requested after Search.

Required

fareRuleType

Enumeration for the type of fare rules requested. Supported values:

  • ShortText
  • LongText (GDS only)
  • Structured (for NDC, structured fare rules are supported only for Penalties; warning message returned if no penalties are applicable to the fare)

Required

fareRuleCategories

Enumeration. Send only if requesting structured fare rules. If fareRuleType=Structured and fareRuleCategories is not sent, all structured fare rules are returned. Supported values:

  • AdvanceReservationTicketing (GDS only)
  • MinimumStay (GDS only)
  • MaximumStay (GDS only)
  • Stopovers (GDS only)
  • Penalties

Optional

Query Parameters for Fare Rules Request after AirPrice

Parameter Description Required/Optional

offerIdentifier

Value from AirPrice response for the offer to return fare rules for.

Required

productIDs

Value from AirPrice response for the product to return fare rules for, if fare rules are desired for only one product (aka leg).

Optional

fareRuleType

Enumeration for the type of fare rules requested.

Supported values:

  • ShortText
  • LongText (GDS only)
  • Structured (for NDC, structured fare rules are supported only for Penalties; warning message returned if no penalties are applicable to the fare)

Required

fareRuleCategories

Enumeration. Send only if requesting structured fare rules. If fareRuleType=Structured and fareRuleCategories is not sent, all structured fare rules are returned. Supported values:

  • AdvanceReservationTicketing (GDS only)
  • MinimumStay (GDS only)
  • MaximumStay (GDS only)
  • Stopovers (GDS only)
  • Penalties

Optional

Query Parameters for Fare Rules Request for existing reservation

Parameter Description Required/Optional

reservationIdentifier

Reservation locator code.

Required

fareRuleType

Enumeration for the type of fare rules requested.

Supported values:

  • ShortText
  • LongText (GDS only)
  • Structured (for NDC, structured fare rules are supported only for Penalties; warning message returned if no penalties are applicable to the fare)

Required

fareRuleCategories

Enumeration. Send only if requesting structured fare rules. If fareRuleType=Structured and fareRuleCategories is not sent, all structured fare rules are returned. Supported values:

  • AdvanceReservationTicketing (GDS only)
  • MinimumStay (GDS only)
  • MaximumStay (GDS only)
  • Stopovers (GDS only)
  • Penalties

Optional

Query Parameters for Fare Rules Request after Fare Display

GDS only; NDC does not support fare display functionality. Supports only short text and long text fare rules, not structured fare rules
Parameter Description Required/Optional

fareRuleIdentifier

Send the value from FareDisplayResponse/Identifier from the Fare Display response.

Required

FareID

Send the value from fareDisplay/fare/sequence from the Fare Display response for the fare to request fare rules for.

Required

fareRuleType

Enumeration for the type of fare rules requested. Supported values:

  • ShortText
  • LongText

Required

Request Body

None.

Response

Example Requests

Example GET Request for fare rules after Search response

This example requests structured fare rules without specifying fare rule categories, so all fare rule categories are returned:

https://api.travelport.com/11/air/farerule/farerules/fromcatalogproductofferings?catalogProductOfferingsIdentifier=dbbf8d3e-4a90-4ab1-bdbf-5e89e937cd2b&catalogProductOfferingID=o1&productIDs=p5&fareRuleType=Structured

Example GET Request for fare rules after AirPrice response

This example requests short text fare rules for an offer after pricing:

https://api.travelport.com/11/air/farerule/farerules/fromoffer?offerIdentifier=o0&fareRuleType=ShortText

Example GET Request for fare rules for existing reservation (after booking)

This example requests long text fare rules for a held booking:

https://api.travelport.com/11/air/farerule/farerules/fromreservation?reservationIdentifier=2BPWLP&fareRuleType=LongText

Example Responses

The response format is the same regardless of where in the workflow the request is sent.

The following response returns short text fare rules for a split ticketing itinerary. While there is no difference in the fare rules request, because the itinerary includes two one-way offers, the response is subject to the limitations noted in the Fare Rules Guide.

For NDC, structured fare rules are supported only for Penalties.