Skip to content
/
Fare Rules for Existing R...

Fare Rules for Existing Reservation (after Booking)

Request

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.

Security
bearerAuth
Query
reservationIdentifierstring, <= 128 charactersrequired

Reservation locator code.

Example:reservationIdentifier=49f58f5f-c443-43b4-9f5d-be405fd00a01
offerIDsArray of stringsdeprecated

Deprecated. Not supported in rules from reservation.

Example:offerIDs=["offer_1"]
productIDsArray of stringsdeprecated

Deprecated. Not supported in rules from reservation.

Example:productIDs=["product_1"]
flightIDsArray of stringsdeprecated

Deprecated. Not supported in rules from reservation.

Example:flightIDs=["flight_1"]
fareRuleCategoriesArray of strings

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.

fareRuleTypestring, <= 32 charactersrequired

The type of fare rules requested. Supported values: ShortText, LongText (GDS only), Structured. (For NDC, structured fare rules are supported only for Penalties. A warning message returned if no penalties are applicable to the fare).

Example:fareRuleType=Structured
Headers
travelportPlusSessionIdentifierstring, [ 0 .. 100 ] characters([a-zA-Z-0-9-_]*)

travelportPlusSessionIdentifier used to maintain an established agency session

Example:49f58f5f-c443-43b4-9f5d-be405fd00a01
TraceIdstring, [ 10 .. 89 ] characters

Identifier used to correlate Air API invocations across a multi-call business flows.

Example:TraceID_123456789
XAUTH_TRAVELPORT_ACCESSGROUPstring, = 36 characters([a-zA-Z-0-9-_]*)

Identifies the Travelport access group with which the caller is associated

Example:19Y88702-C27A-4E5D-829A-89D7016688B1
TVP-PCC-Corestring^[a-zA-Z\d]{3,4}_\w{2}$

Allows user to pass PCC instead of Access Group ID

Example:DU7_1G
curl -i -X GET \
  'https://developer.travelport.com/_mock/apis/flights/air/farerule/farerules/fromreservation?reservationIdentifier=49f58f5f-c443-43b4-9f5d-be405fd00a01&offerIDs=%5B%22offer_1%22%5D&productIDs=%5B%22product_1%22%5D&flightIDs=%5B%22flight_1%22%5D&fareRuleCategories=%5B%22Penalties%22%5D&fareRuleType=Structured' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'TVP-PCC-Core: DU7_1G' \
  -H 'TraceId: TraceID_123456789' \
  -H 'XAUTH_TRAVELPORT_ACCESSGROUP: 19Y88702-C27A-4E5D-829A-89D7016688B1' \
  -H 'travelportPlusSessionIdentifier: 49f58f5f-c443-43b4-9f5d-be405fd00a01'

Responses

OK - Successful Response - 200

Bodyapplication/json
FareRuleListResponseobject(FareRuleListResponse)

The response of a Fare rule list endpoint request.

Response
{
  "FareRuleListResponse": {
    "@type": "FareRuleListResponse",
    "FareRule": [
      { … }
    ],
    "transactionId": "6570ed7b-89fe-4334-9c78-af282a977ba6",
    "traceId": "c009a53c-48f6-4084-b7b6-3043fa9fec67",
    "Result": {
      "@type": "Result",
      "status": "Complete",
      "Error": [ … ],
      "Warning": [ … ]
    },
    "Identifier": {
      "value": "A0656EFF-FAF4-456F-B061-0161008D7C4E",
      "authority": "TVPT"
    },
    "ReferenceList": [
      { … }
    ]
  }
}