Fare Rules API Reference

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.

Base path:

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

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

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.

Base path:

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

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

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.

Base path:

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

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

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

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
  • Structured

Only short text fare rules are currently supported for NDC. The fareRuleType parameter is not supported for NDC and is ignored if sent.

Required

fareRuleCategories

Enumeration. Send only if requesting structured fare rules.

Supported values:

  • AdvanceReservationTicketing
  • MinimumStay
  • MaximumStay
  • Stopovers
  • Penalties
If you request structured fare rules but do not specify a fare rule category, all rules in these categories are returned.

Optional

Query Parameters for Fare Rules Request after AirPrice

Parameter Description Required/Optional

offerIdentifier

Value from AirPrice response in OfferListResponse/OfferID/id for the offer to return fare rules for

Required

productIDs

Value from AirPrice response in OfferListResponse/OfferID/Product/id for the product to return fare rules for, if you want to return fare rules for only one product

Optional

fareRuleType

Enumeration for the type of fare rules requested.

Supported values:

  • ShortText
  • LongText (not supported for NDC; most NDC carriers do not support long text fare rules)
  • Structured (not supported for NDC)

Required

fareRuleCategories

Enumeration. Send only if requesting structured fare rules. GDS only; structured fare rules not supported for NDC for existing reservation.

Supported values:

  • AdvanceReservationTicketing
  • MinimumStay
  • MaximumStay
  • Stopovers
  • Penalties
If you request structured fare rules but do not specify a fare rule category, all rules in these categories are returned.

Optional

Query Parameters for Fare Rules Request for existing reservation (after booking)

Parameter Description Required/Optional

reservationIdentifier

reservation locator code.

Required

fareRuleType

Enumeration for the type of fare rules requested.

Supported values:

  • ShortText
  • LongText (not supported for NDC; most NDC carriers do not support long text fare rules)
  • Structured (not supported for NDC)

Required

fareRuleCategories

Enumeration. Specifies the categories of fare rules to return. If not sent, all applicable fare rule categories are returned.

Supported values:

  • AdvanceReservationTicketing
  • MinimumStay
  • MaximumStay
  • Stopovers
  • Penalties
  • VoluntaryRefunds
  • VoluntaryChanges

Optional

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.