Sign in

v1

latestOpenAPI 3.0.02026-08-061029011.1 MB
Pricing and Fare Rules

Fare Rules after Fare Display

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.

get/air/farerule/farerules/fromfaredisplay

Query parameters

fareRuleIdentifierstring uuid

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

fareIDstring[]

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

fareRuleCategoriesstring[]

List of fare rule categories required

[
  "[\"Penalties\"]"
]
fareRuleTypestring required
Example:LongText

The type of fare rules requested. Supported values: ShortText, LongText

Headers

travelportPlusSessionIdentifierstring
Example:49f58f5f-c443-43b4-9f5d-be405fd00a01

travelportPlusSessionIdentifier used to maintain an established agency session

TraceIdstring
Example:TraceID_123456789

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

XAUTH_TRAVELPORT_ACCESSGROUPstring
Example:19Y88702-C27A-4E5D-829A-89D7016688B1

Identifies the Travelport access group with which the caller is associated

TVP-PCC-Corestring
Example:DU7_1G

Allows user to pass PCC instead of Access Group ID

Response

OK - Successful Response - 200

Example response

{
  "FareRuleListResponse": {
    "@type": "FareRuleListResponse",
    "FareRule": [
      {
        "@type": "FareRuleText",
        "Identifier": {
          "value": "A0656EFF-FAF4-456F-B061-0161008D7C4E",
          "authority": "TVPT"
        },
        "ruleNumber": "34",
        "tariffNumber": "56",
        "Flight": [
          {
            "@type": "FlightDetail",
            "id": "126",
            "FlightRef": "s1",
            "Identifier": {
              "value": "A0656EFF-FAF4-456F-B061-0161008D7C4E",
              "authority": "TVPT"
            }
          }
        ]
      }
    ],
    "transactionId": "6570ed7b-89fe-4334-9c78-af282a977ba6",
    "traceId": "c009a53c-48f6-4084-b7b6-3043fa9fec67",
    "Result": {
      "@type": "Result",
      "status": "Complete",
      "Error": [
        {
          "@type": "ErrorDetail",
          "StatusCode": 200,
          "Message": "No flights found.",
          "NameValuePair": [
            {
              "value": "Sunday",
              "id": "6",
              "name": "Day1"
            }
          ]
        }
      ],
      "Warning": [
        {
          "@type": "WarningDetail",
          "StatusCode": 200,
          "Message": "Customer Loyalty could not be applied.",
          "NameValuePair": [
            {
              "value": "Sunday",
              "id": "6",
              "name": "Day1"
            }
          ]
        }
      ]
    },
    "Identifier": {
      "value": "A0656EFF-FAF4-456F-B061-0161008D7C4E",
      "authority": "TVPT"
    },
    "ReferenceList": [
      {
        "@type": "ReferenceListFlight"
      }
    ]
  }
}