GET /ticket-conditions

GET /ticket-conditions

The TicketConditions endpoint provides the ticket conditions that apply to a specific flight product. It includes the number of Flying Blue miles that can be earned. Flying Blue is the loyalty program of Air France - KLM.

HOW TO USE?

Use case flow can be followed by the consumer by requesting the GET method supplied as HATEOAS link in the response body of AvailableOffers & UpsellOffers.

HEADERS TO USE FOR REQUESTS

Parameter

Value

Authorization 

Bearer {{token}}

Content-Type 

application/json

Accept 

application/hal+json; charset=utf8

Accept-Language 

{{language}}-{{country}}

AFKL-TRAVEL-Host 

KL or AF

AFKL-TRAVEL-Country 

Country (overrides Accept-Language country)

GET

GET https://api.klm.com/opendata/flightoffers/v3/flight-products/{id}/ticket-conditions

QUERY PARAMETERS

n/a

RESPONSE PARAMETERS

Name Type Multiplicity    Description
sameConditions Boolean 1 Indicates whether the same conditions apply to all connections of the flight product.
connections Array of Objects 1-n Chronologically ordered list of connections applicable to the FlightProduct. Maximum of 6 connections.
..travelClassText String 1 Text wrt travel classes for display purposes in the language as specified in ContentLanguage header.
..tripText String 1 Text wrt trip for display purposes in the language as specified in ContentLanguage header.
..fareFamily Object 1 Specifies the farefamily applicable to the connection.
….code Integer 1 Farefamily code for the connection.
….hierarchy Integer 1 Integer that identifies the hierarchy of the fare family. Used to determine order for displaying upsell options.
….commercialDescription String 1 Commercial description of the fare family in the language as specified in ContentLanguage header.
….title String 1 Title of the fare family in the language as specified in ContentLanguage header.
..flyingBlue Object 0-1 Specifies the conditions for earning frequent flyer miles.
….earned Integer 1 Number of miles that can be earned when booking the flight.
….detailsText String 1 Text for details of flying blue in the language as specified in ContentLanguage header.
….commercialText String 1 Commercial text for flying blue in the language as specified in ContentLanguage header.
…...relevance Integer 1 Relevance on the flying blue for display purpose.
……text String 1 Commercial text for flying blue in the language as specified in ContentLanguage header.
….qualifyingPoints Integer 1 Number of Qualifying Points XP that can be earned when booking the flight.
….detailsTextQualPoints Integer 1 Text for details of Qualifying Points XP in the language as specified in ContentLanguage header
..blueBiz Object 0-1 Specifies the conditions for earning bluebiz miles.
….earned Integer 1 Number of miles that can be earned when booking the flight.
….detailsText String 1 Text for details of bluebiz in the language as specified in ContentLanguage header.
….commercialText String 1 Commercial text for bluebiz in the language as specified in ContentLanguage header.
..baggageAllowance Object 0-1 Specifies the conditions for baggage allowance
….quantity Integer 1 Quantity of baggage allowed.
….type Integer 1 Type of the amount in quantity. E.g. Pieces, Kilos, Pounds.
….handBaggageDetailstext String 1 Text for details of hand baggage in the language as specified in ContentLanguage header.
….detailsText String 1 Text for details of baggage allowance in the language as specified in ContentLanguage header.
….commercialText String 1 Commercial text for baggage allowance in the language as specified in ContentLanguage header.
…...relevance Integer 1 Relevance on the baggageAllowance for display purpose.
……text String 1 Commercial text for baggage allowance in the language as specified in ContentLanguage header.
..conditions Object 1 Conditions applicable to the connection.
..….iATAConditions Array of Objects 0-n The IATA conditions that apply to the connection.
Conditional: Either IATA conditions apply or a set of other conditions as mentioned below apply.
..……code String 1 Code of the condition.
..……text String 1 Text of the condition in English.
..……title String 1 Title of the condition in English.
..….noShowCondition Object 0-1 Specifies the conditions for not showing up for the flight booked.
..……allowed Boolean 1 Indicates whether it is allowed to not show up for the booked flight.
…..…detailsText String 1 Text for details of no show in the language as specified in ContentLanguage header.
…..…commercialText String 1 Commercial text for no show in the language as specified in ContentLanguage header.
..……fee Object 0-1 Fee applicable to the condition.
..……..currency String 1 The currency used for the fee.
Three letter currency code according to ISO 4217.
..……..amount Number 1 The amount of the fee.
..….changeCondition Object 0-1 Specifies the conditions for changing the booked flight.
..……allowedBeforeDeparture Boolean 1 Indicates whether it is allowed to change the booked flight.
..……allowedAfterDeparture Boolean 1 Indicates whether it is allowed to change the booked flight after departure of the outbound flight.
…..…beforeDepartureDetailsText String 1 Text for details of change condition in the language as specified in ContentLanguage header.
…..…afterDepartureDetailsText String 1 Text for details of change condition after departure of outbound flight in the language as specified in ContentLanguage header.
…..…feeAfterTaxText String 0-1 Text for fee after tax when changing ticket in the language as specified in ContentLanguage header.
…..…taxChangeText String 0-1 Text for tax change when changing ticket in the language as specified in ContentLanguage header.
…..…phoneAdminFeeText String 0-1 Text for phone admin fee when changing ticket by phone in the language as specified in ContentLanguage header.
…..…commercialText String 1 Commercial text for change condition in the language as specified in ContentLanguage header.
..……feeBeforeDeparture Object 0-1 Fee applicable to the condition.
..……..currency String 1 The currency used for the fee.
Three letter currency code according to ISO 4217.
..……..amount Number 1 The amount of the fee.
..……feeAfterDeparture Object 0-1 Fee applicable to the condition after departure of outbound flight.
..……..currency String 1 The currency used for the fee.
Three letter currency code according to ISO 4217.
..……..amount Number 1 The amount of the fee.
..……phoneAdminFee Object 0-1 Fee applicable when changing ticket by phone.
..……..currency String 1 The currency used for the fee.
Three letter currency code according to ISO 4217.
..……..amount Number 1 The amount of the fee.
..….cancelCondition Object 0-1 Specifies the conditions for canceling the booked flight.
..……allowedBeforeDeparture Boolean 1 Indicates whether it is allowed to cancel the booked flight.
..……allowedAfterDeparture Boolean 1 Indicates whether it is allowed to cancel the booked flight after departure of the outbound flight.
…..…beforeDepartureDetailsText String 1 Text for details of cancel condition in the language as specified in ContentLanguage header.
…..…afterDepartureDetailsText String 1 Text for details of cancel condition after departure of outbound flight in the language as specified in ContentLanguage header.
…..…commercialText String 1 Commercial text for cancel condition in the language as specified in ContentLanguage header.
……..extraCostsText String 1 Text wrt extra costs when canceling ticket in the language as specified in ContentLanguage header.
……..refundText String 1 Text wrt refund when canceling ticket in the language as specified in ContentLanguage header.
……..taxRefundText String 1 Text wrt tax refund when canceling ticket in the language as specified in ContentLanguage header.
..……feeBeforeDeparture Object 0-1 Fee applicable to the condition.
..……..currency String 1 The currency used for the fee.
Three letter currency code according to ISO 4217.
..……..amount Number 1 The amount of the fee.
..……feeAfterDeparture Object 0-1 Fee applicable to the condition after departure of outbound flight.
..……..currency String 1 The currency used for the fee.
Three letter currency code according to ISO 4217.
..……..amount Number 1 The amount of the fee.
..….minimumStayCondition Object 0-1 Minimum stay condition applicable.
…..…detailsText String 1 Text for details of minimum stay in the language as specified in ContentLanguage header.
…..…commercialText String 1 Commercial text for minimum stay in the language as specified in ContentLanguage header.
..……dayOfWeekIncluded String 0-1 Indicates that specified day is mandatory to be included in the duration
MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY or SUNDAY.
..……stayDuration Object 0-1 Duration that applies to the stay condition.
..……..duration Integer 1 The duration specifying the minimum/maximum stay allowed. The duration is an integer value related to the durationType specified.
..……..stayUnit String 1 The duration type used for specifying the minimum/maximum stay allowed.
DAY, MONTH, MINUTE, WEEK, NIGHT, HOUR.
..….maximumStayCondition Object 0-1 Maximum stay condition applicable.
…..…detailsText String 1 Text for details of maximum stay in the language as specified in ContentLanguage header.
…..…commercialText String 1 Commercial text for maximum stay in the language as specified in ContentLanguage header.
..……dayOfWeekIncluded String 0-1 Indicates that specified day is mandatory to be included in the duration
MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY or SUNDAY.
..……stayDuration Object 0-1 Duration that applies to the stay condition.
..……..duration Integer 1 The duration specifying the minimum/maximum stay allowed. The duration is an integer value related to the durationType specified.
..……..stayUnit String 1 The duration type used for specifying the minimum/maximum stay allowed.
DAY, MONTH, MINUTE, WEEK, NIGHT, HOUR.
….advancePurchaseCondition Object 0-1 Advance purchase condition applicable.
…..…detailsText String 1 Text for details of advance purchase in the language as specified in ContentLanguage header.
…..…commercialText String 1 Commercial text for advance purchase in the language as specified in ContentLanguage header.
……stayDuration Object 0-1 Duration that applies to the advance purchase condition.
……..duration Integer 1 The duration specifying the period the advance purchase is applicable. The duration is an integer value related to the durationType specified.
……..stayUnit String 1 The duration type used for specifying the period the advance purchase is applicable.
DAY, MONTH, MINUTE, WEEK, NIGHT, HOUR.
….infantDiscountCondition Object 0-1 Specifies the fare discount applying to infants compared to adults.
…..…detailsText String 1 Text for details of infant discount in the language as specified in ContentLanguage header.
……farePercentage Integer 1 The percentage of the adult fare that is applicable for an infant (0-100).
….childrenDiscountCondition Object 0-1 Specifies the fare discount applying to children compared to adults.
…..…detailsText String 1 Text for details of children discount in the language as specified in ContentLanguage header.
……farePercentage Integer 1 The percentage of the adult fare that is applicable for a child (0-100).
flyingBlue Object 0-1 Specifies the conditions for earning frequent flyer miles.
..earned Integer 1 Number of miles that can be earned when booking the flight.
..detailsText String 1 Text for details of flying blue in the language as specified in ContentLanguage header.
..commercialText String 1 Commercial text for flying blue in the language as specified in ContentLanguage header.
….relevance Integer  1 Relevance on the flying blue for display purpose.
….text String 1 Commercial text for flying blue in the language as specified in ContentLanguage header.
..qualifyingPoints Integer  1 Number of Qualifying Points XP that can be earned when booking the flight.
..detailsTextQualPoints Integer  1 Text for details of Qualifying Points XP in the language as specified in ContentLanguage header
blueBiz Object 0-1 Specifies the conditions for earning bluebiz miles.
..earned Integer  1 Number of miles that can be earned when booking the flight.
..detailsText String 1 Text for details of bluebiz in the language as specified in ContentLanguage header.
..commercialText String 1 Commercial text for bluebiz in the language as specified in ContentLanguage header.

ERROR CODES

HTTP status

Type

500

INTERNAL_SERVER_ERROR

400

FOA/UNKNOWN_RESERVATION

400

FOA/DISCOUNT_CODE_INELIGIBLE

SAMPLE RESPONSE

{
    "sameConditions": false, 
    "connections": [
        {
            "conditions": [
                {
                    "CancelCondition": {
                        "allowed": false
                    }
                }, 
                {
                    "ChangeCondition": {
                        "fee": {
                            "amount": 120, 
                            "currency": "EUR"
                        }, 
                        "allowed": true
                    }
                }, 
                {
                    "MinimumStayCondition": {
                        "dayOfWeekIncluded": "SUNDAY"
                    }
                }, 
                {
                    "MaximumStayCondition": {
                        "stayDuration": {
                            "amount": 12, 
                            "stayUnit": "MONTH"
                        }
                    }
                }, 
                {
                    "NoShowCondition": {
                        "allowed": false
                    }
                }, 
                {
                    "FrequentFlyerCondition": {
                        "earned": 1820
                    }
                }
            ]
        }, 
        {
            "conditions": [
                {
                    "CancelCondition": {
                        "allowed": false
                    }
                }, 
                {
                    "ChangeCondition": {
                        "allowed": false
                    }
                }, 
                {
                    "MinimumStayCondition": {
                        "dayOfWeekIncluded": "SUNDAY"
                    }
                }, 
                {
                    "MaximumStayCondition": {
                        "stayDuration": {
                            "amount": 12, 
                            "stayUnit": "MONTH"
                        }
                    }
                }, 
                {
                    "NoShowCondition": {
                        "allowed": false
                    }
                }, 
                {
                    "FrequentFlyerCondition": {
                        "earned": 1285
                    }
                }
            ]
        }
    ]
}

Docs Navigation