- Previous: Offers API
- Up: Offers API
- Next: GET /reference-data/deals v1
GET /reference-data v1
GET /REFERENCE-DATA V1
The ReferenceData endpoint provides the reference data a consumer needs to support a customer to search for offers.
How to use?
The reference data is typically requested at the start of the use case to know which data can be used in request.
Headers to use for requests:
| Parameter | Value |
| Authorization | Bearer {{token}} |
| Content-Type | application/json |
| Accept | application/hal+json;profile=com.afklm.offers.reference.data.v1;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/reference-data?bookingFlow=
QUERY PARAMETERS
| Name | Type | Multiplicity | Description |
| bookingFlow | String | 1 | Indicates the flow LEISURE/CORPORATE/REWARD/SUBSCRIBER |
Response Parameters
| Level | Name | Type | Multiplicity | Description |
| 1 | market | String | 1 | Code for the market given in input |
| 2 | country | Array | 1 | Settings applicable to the booking process for the specific market/country. |
| 3 | code | String | 1 | Country code associated to the market |
| 3 | label | String | 1 | Country label in the language specified in ContentLanguage header |
| 3 | maximumNumberOfSeats | Integer | 1 | Maximum number of seats that can be in a single booking from the requested country. Note that e.g. infants do not have their own seat. |
| 3 | minimumNumberOfAdults | Integer | 1 | Minimum number of adults that must be in a single booking from the specific country. |
| 3 | defaultAirport | String | 1 | IATA code for the default airport for the specific country. |
| 3 | origins | Array of Strings | 0-n | List of origins that are allowed for the specific country. |
| 3 | destinations | Array of Strings | 0-n | List of destinations that are allowed for the specific country. |
| 3 | passengerTypes | Array of Objects | 1-n | Types of passenger that can be used to search for this context (market/bookingFlow) |
| 4 | code | String | 1 | Code identifying the passenger type : ADT/CHD/INF/YCD/YTH/C14/STU |
| 4 | label | String | 1 | Passenger type label |
| 3 | areas | Array of Objects | 1-n | List of IATA area |
| 4 | code | String | 1 | Code identifying an area. |
| 4 | label | String | 1 | Area label in the language specified in ContentLanguage header. |
| 4 | countries | Array of Objects | 1-n | List available countries |
| 5 | code | String | 1 | Code identifying a country. |
| 5 | label | String | 1 | Country label in the language specified in ContentLanguage header. |
| 5 | cities | Array of Objects | 0-n | List of available cities in country. |
| 6 | code | String | 1 | Code identifying a city. |
| 6 | label | String | 1 | City label in the language specified in ContentLanguage header. |
| 6 | stopover | Array of Objects | 1-n | List of available stopovers in city. |
| 7 | code | String | 1 | Code identifying a stopover. |
| 7 | label | String | 1 | Stopover label in the language specified in ContentLanguage header. |
| 7 | type | Boolean | 1 | Airport/train/bus/… see complete list below |
| 3 | commercialCabins | Array of Objects | 1-n | Cabin classes that can be used to search for flight offers. |
| 4 | code | String | 1 | Code identifying the transport cabin : ECONOMY / BUSINESS/PREMIUM/FIRST |
| 4 | label | String | 1 | Cabin label in the language specified in ContentLanguage header. |
Stopover type
|
A |
AIRPORT |
|
R |
RAILWAY STATION |
|
H |
HELIPORT |
|
B |
BUS STATION |
Http status code
|
HTTP status |
Type |
| 200 | OK |
|
500 |
INTERNAL_SERVER_ERROR |
Sample Response
{
"market": "US",
"countries": [
{
"code": "US",
"label": "Verenigde Staten",
"maximumNumberOfSeats": 9,
"minimumNumberOfAdults": 1,
"redirectionByMarket": false,
"defaultAirport": "JFK",
"origins": [
"AUS",
"BHM",
"DIK",
"CMH",
"EWN",
"UBS",
"OAJ",
"AMA",
"PSP",
"SIT",
"VLD",
],
"destinations": [
"EWN",
"SKB",
"GTR",
"UBS",
"OAJ",
"OER",
"GYN",
"
],
"commercialCabins": [
{
"code": "ECONOMY",
"label": "Economy Class"
},
{
"code": "BUSINESS",
"label": "Business Class"
}
],
"passengerTypes": [
{
"code": "ADT",
"label": "volwassene"
},
{
"code": "CHD",
"label": "kind"
},
{
"code": "INF",
"label": "baby"
},
{
"code": "C14",
"label": "Jongvolwassene"
},
{
"code": "YTH"
},
{
"code": "YCD"
}
],
"areas": [
{
"code": "WORLD",
"label": "location.area.WORLD.long",
"countries": [
{
"code": "SD",
"label": "Soedan",
"cities": [
{
"code": "KRT",
"label": "Khartoum",
"stopovers": [
{
"code": "KRT",
"label": "Civil Airport",
"type": "stopover"
}
]
}
]
},
{
"code": "CZ",
"label": "Tsjechië",
"cities": [
{
"code": "PRG",
"label": "Praag",
"stopovers": [
{
"code": "PRG",
"label": "Václav Havel Airport",
"type": "stopover"
}
]
},
{
"code": "OSR",
"label": "Ostrava",
"stopovers": [
{
"code": "OSR",
"label": "Leos Janacek",
"type": "stopover"
}
]
}
]
},
{
"code": "PY",
"label": "Paraguay",
"cities": [
{
"code": "ASU",
"label": "Asunción",
"stopovers": [
{
"code": "ASU",
"label": "Asunción",
"type": "stopover"
}
]
}
]
},
……
} - Previous: Offers API
- Up: Offers API
- Next: GET /reference-data/deals v1
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