- Previous: GET /tax-breakdown
- Up: Offers API
- Next: GET /ticket-conditions with Reservation ID
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/travel/offers/v1/flight-products/{id}/ticket-conditions
QUERY PARAMETERS
n/a
RESPONSE PARAMETERS
Level | Name | Type | Multiplicity | Description |
1 | sameConditions | Boolean | 1 | Indicates whether the same conditions apply to all connections of the flight product. |
1 | connections | Array of Objects | 1-n | Chronologically ordered list of connections applicable to the FlightProduct. Maximum of 6 connections. |
2 | travelClassText | String | 1 | Text travel classes for display purposes in the language as specified in ContentLanguage header. |
2 | tripText | String | 1 | Text trip for display purposes in the language as specified in ContentLanguage header. |
2 | fareFamily | Object | 1 | Specifies the farefamily applicable to the connection. |
3 | code | Integer | 1 | Farefamily code for the connection. |
3 | hierarchy | Integer | 1 | Integer that identifies the hierarchy of the fare family. Used to determine order for displaying upsell options. |
3 | commercialDescription | String | 1 | Commercial description of the fare family in the language as specified in ContentLanguage header. |
3 | title | String | 1 | Title of the fare family in the language as specified in ContentLanguage header. |
2 | flyingBlue | Object | 0-1 | Specifies the conditions for earning frequent flyer miles. |
3 | earned | Integer | 1 | Number of miles that can be earned when booking the flight. |
3 | detailsText | String | 1 | Text for details of flying blue in the language as specified in ContentLanguage header. |
3 | commercialText | String | 1 | Commercial text for flying blue in the language as specified in ContentLanguage header. |
3 | qualifyingPoints | Integer | 1 | Number of Qualifying Points XP that can be earned when booking the flight. |
3 | detailsTextQualPoints | Integer | 1 | Text for details of Qualifying Points XP in the language as specified in ContentLanguage header |
3 | flyingBlueAdvantages | Object | 01 | Advantages linked to flying blue tier level |
4 | extraBagQuantity | Integer | 1 | extra checkin baggage available due to tier level |
4 | skyPriority | Boolean | 1 | skyPriority available due to tier level |
2 | baggageAllowance | Object | 0-1 | Specifies the conditions for baggage allowance |
3 | quantity | Integer | 1 | Quantity of baggage allowed. |
3 | type | Integer | 1 | Type of the amount in quantity : PIECES / WEIGHT |
3 | handBaggageDetailstext | String | 1 | Text for details of hand baggage in the language as specified in ContentLanguage header. |
3 | detailsText | String | 1 | Text for details of baggage allowance in the language as specified in ContentLanguage header. |
3 | commercialText | String | 1 | Commercial text for baggage allowance in the language as specified in ContentLanguage header. |
2 | conditions | Object | 1 | Conditions applicable to the connection. |
3 | 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. |
4 | code | String | 1 | Code of the condition. |
4 | text | String | 1 | Text of the condition in English. |
4 | title | String | 1 | Title of the condition in English. |
3 | noShowCondition | Object | 0-1 | Specifies the conditions for not showing up for the flight booked. |
4 | allowed | Boolean | 1 | Indicates whether it is allowed to not show up for the booked flight. |
4 | detailsText | String | 1 | Text for details of no show in the language as specified in ContentLanguage header. |
4 | commercialText | String | 1 | Commercial text for no show in the language as specified in ContentLanguage header. |
4 | fee | Object | 0-1 | Fee applicable to the condition. |
5 | currency | String | 1 | The currency used for the fee. Three letter currency code according to ISO 4217. |
5 | amount | Number | 1 | The amount of the fee. |
3 | changeCondition | Object | 0-1 | Specifies the conditions for changing the booked flight. |
4 | allowedBeforeDeparture | Boolean | 1 | Indicates whether it is allowed to change the booked flight. |
4 | allowedAfterDeparture | Boolean | 1 | Indicates whether it is allowed to change the booked flight after departure of the outbound flight. |
4 | beforeDepartureDetailsText | String | 1 | Text for details of change condition in the language as specified in ContentLanguage header. |
4 | afterDepartureDetailsText | String | 1 | Text for details of change condition after departure of outbound flight in the language as specified in ContentLanguage header. |
4 | feeAfterTaxText | String | 0-1 | Text for fee after tax when changing ticket in the language as specified in ContentLanguage header. |
4 | taxChangeText | String | 0-1 | Text for tax change when changing ticket in the language as specified in ContentLanguage header. |
4 | phoneAdminFeeText | String | 0-1 | Text for phone admin fee when changing ticket by phone in the language as specified in ContentLanguage header. |
4 | commercialText | String | 1 | Commercial text for change condition in the language as specified in ContentLanguage header. |
4 | feeBeforeDeparture | Object | 0-1 | Fee applicable to the condition. |
5 | currency | String | 1 | The currency used for the fee. Three letter currency code according to ISO 4217. |
5 | amount | Number | 1 | The amount of the fee. |
4 | feeAfterDeparture | Object | 0-1 | Fee applicable to the condition after departure of outbound flight. |
5 | currency | String | 1 | The currency used for the fee. Three letter currency code according to ISO 4217. |
5 | amount | Number | 1 | The amount of the fee. |
4 | phoneAdminFee | Object | 0-1 | Fee applicable when changing ticket by phone. |
5 | currency | String | 1 | The currency used for the fee. Three letter currency code according to ISO 4217. |
5 | amount | Number | 1 | The amount of the fee. |
3 | cancelCondition | Object | 0-1 | Specifies the conditions for canceling the booked flight. |
4 | allowedBeforeDeparture | Boolean | 1 | Indicates whether it is allowed to cancel the booked flight. |
4 | allowedAfterDeparture | Boolean | 1 | Indicates whether it is allowed to cancel the booked flight after departure of the outbound flight. |
4 | beforeDepartureDetailsText | String | 1 | Text for details of cancel condition in the language as specified in ContentLanguage header. |
4 | afterDepartureDetailsText | String | 1 | Text for details of cancel condition after departure of outbound flight in the language as specified in ContentLanguage header. |
4 | commercialText | String | 1 | Commercial text for cancel condition in the language as specified in ContentLanguage header. |
4 | extraCostsText | String | 1 | Text wrt extra costs when canceling ticket in the language as specified in ContentLanguage header. |
4 | refundText | String | 1 | Text wrt refund when canceling ticket in the language as specified in ContentLanguage header. |
4 | taxRefundText | String | 1 | Text wrt tax refund when canceling ticket in the language as specified in ContentLanguage header. |
4 | feeBeforeDeparture | Object | 0-1 | Fee applicable to the condition. |
5 | currency | String | 1 | The currency used for the fee. Three letter currency code according to ISO 4217. |
5 | amount | Number | 1 | The amount of the fee. |
4 | feeAfterDeparture | Object | 0-1 | Fee applicable to the condition after departure of outbound flight. |
5 | currency | String | 1 | The currency used for the fee. Three letter currency code according to ISO 4217. |
5 | amount | Number | 1 | The amount of the fee. |
4 | minimumStayCondition | Object | 0-1 | Minimum stay condition applicable. |
5 | detailsText | String | 1 | Text for details of minimum stay in the language as specified in ContentLanguage header. |
5 | commercialText | String | 1 | Commercial text for minimum stay in the language as specified in ContentLanguage header. |
5 | dayOfWeekIncluded | String | 0-1 | Indicates that specified day is mandatory to be included in the duration MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY or SUNDAY. |
5 | stayDuration | Object | 0-1 | Duration that applies to the stay condition. |
6 | duration | Integer | 1 | The duration specifying the minimum/maximum stay allowed. The duration is an integer value related to the durationType specified. |
6 | stayUnit | String | 1 | The duration type used for specifying the minimum/maximum stay allowed. DAY, MONTH, MINUTE, WEEK, NIGHT, HOUR. |
4 | maximumStayCondition | Object | 0-1 | Maximum stay condition applicable. |
5 | detailsText | String | 1 | Text for details of maximum stay in the language as specified in ContentLanguage header. |
5 | commercialText | String | 1 | Commercial text for maximum stay in the language as specified in ContentLanguage header. |
5 | dayOfWeekIncluded | String | 0-1 | Indicates that specified day is mandatory to be included in the duration MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY or SUNDAY. |
5 | stayDuration | Object | 0-1 | Duration that applies to the stay condition. |
6 | duration | Integer | 1 | The duration specifying the minimum/maximum stay allowed. The duration is an integer value related to the durationType specified. |
6 | stayUnit | String | 1 | The duration type used for specifying the minimum/maximum stay allowed. DAY, MONTH, MINUTE, WEEK, NIGHT, HOUR. |
3 | advancePurchaseCondition | Object | 0-1 | Advance purchase condition applicable. |
4 | detailsText | String | 1 | Text for details of advance purchase in the language as specified in ContentLanguage header. |
4 | commercialText | String | 1 | Commercial text for advance purchase in the language as specified in ContentLanguage header. |
4 | stayDuration | Object | 0-1 | Duration that applies to the advance purchase condition. |
5 | duration | Integer | 1 | The duration specifying the period the advance purchase is applicable. The duration is an integer value related to the durationType specified. |
5 | stayUnit | String | 1 | The duration type used for specifying the period the advance purchase is applicable. DAY, MONTH, MINUTE, WEEK, NIGHT, HOUR. |
3 | infantDiscountCondition | Object | 0-1 | Specifies the fare discount applying to infants compared to adults. |
4 | detailsText | String | 1 | Text for details of infant discount in the language as specified in ContentLanguage header. |
4 | farePercentage | Integer | 1 | The percentage of the adult fare that is applicable for an infant (0-100). |
3 | childrenDiscountCondition | Object | 0-1 | Specifies the fare discount applying to children compared to adults. |
4 | detailsText | String | 1 | Text for details of children discount in the language as specified in ContentLanguage header. |
4 | farePercentage | Integer | 1 | The percentage of the adult fare that is applicable for a child (0-100). |
1 | warning | Object | 0-99 | Warning details |
2 | code | Number | 1 | Functional warning codes (1000-1999) |
2 | name | String | 1 |
Name of the warning. Ex :OFA/FUNCTIONAL/INVALID_VALUE - logger/Typology/name |
2 | description | String | 1 |
Description of the warning |
2 | errorinInputPath | String | 1 | Description of the input Path where the warning occurred |
1 | errors | Object | 0-1 |
Error details |
2 | code | Number | 1 | Functional error codes (1000-1999) Technical error codes (2000-2999) Internal error codes (3000-3999) |
2 | name | String | 1 |
Name of the error . Ex :OFA/TECHNICAL/INVALID_VALUE - logger/Typology/name |
2 | description | String | 1 | Description of the error. |
2 | errorinInputPath | String | 1 | Description of the input Path where the error occurred |
HTTP STATUS CODE
HTTP status |
Type |
500 |
INTERNAL_SERVER_ERROR |
400 |
FOA/UNKNOWN_RESERVATION |
400 |
FOA/DISCOUNT_CODE_INELIGIBLE |
200 | OK |
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 } } ] } ] }
- Previous: GET /tax-breakdown
- Up: Offers API
- Next: GET /ticket-conditions with Reservation ID
Docs Navigation
- Air France-KLM Documentation
- Open Data
- Baggage allowance API Process flow - Pre-booking (inspiration) context
- Introduction
- Data scope
- Quick peak
- How to use
- Services overview
- Header
- GET All Allowances without Loyalty
- V1- All Allowances without Loyalty- Request
- V1- All Allowances without Loyalty- Response
- GET Base Allowances
- V1- Base Allowance - Request
- V1- Base Allowance - Response
- GET Loyalty Allowances
- V1- Loyalty Allowance - Request
- V1- Loyalty Allowance - Response
- GET Paid Options with Loyalty
- V1- GET Paid Options with Loyalty - Request
- V1- GET Paid Options with Loyalty - Response
- GET Paid Options without Loyalty
- V1- GET Paid Options without Loyalty - Request
- V1- GET Paid Options without Loyalty - Response
- GET All Allowances with Loyalty
- V1- All Allowances with Loyalty- Request
- V1- All Allowances with Loyalty- Response
- Get Started
- Offers API
- GET /reference-data v1
- GET /reference-data/deals v1
- GET /search-context v1
- POST /lowest-fare-offers v1
- GET /lowest-fare-offers v1
- POST /available-offers v1
- GET /available-offers v1
- GET /flightDetails
- POST /upsell-offers v1
- GET /upsell-offers v1
- GET /priceDetails v1
- GET /tax-breakdown
- GET /ticket-conditions
- GET /ticket-conditions with Reservation ID
- GET /ticket-conditions with Trip Parameters
- POST /shopping-carts
- GET /related-products
- POST /related-products/shopping-carts
- POST /mail-my-search
- POST /flights-availability v1
- POST /best-fare-offers v1
- POST/ bestOffers/feed
- Errors Code
- POST /available-offers/all v1
- POST /best-fare-offers/all-deals v1
- Inspire API / Amenities
- Flight Status API
- Network and Schedule API
- Baggage allowance API Process flow - Pre-booking (inspiration) context
- Metasearch API
- Cargo API
- All Other APIS