POST /best-fare-offers/all-deals v1

POST /best-fare-offers/all-deals v1

The /best-fare-offers/all-deals endpoint provides the complete list of deals proposed by AF/KL (the most attractive offers) 

HOW TO USE

The POST method should be used to find the list of deals per origin.

HEADERS TO USE FOR REQUEST

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)


POST

POST https://api.airfranceklm.com/travel/offers/v1/best-fare-offers/all-deals

QUERY PARAMETERS

n/a

POST PARAMETERS

Level Name Type Multiplicity Description
1 origin Object 0..1 Origin of the deals
2 code String 1

The code in 3-letters of the origin

Ex: CDG
2 type Enum 1 The type of the origin code : CITY, AIRPORT, BUS_STATION, HELIPORT, RAILWAY_STATION, FERRY_STATION.
1 zoneCode String 0..1 Zone of the deals

 

RESPONSE PARAMETERS

Level Name Type Multiplicity  Description
1 market String 0..1
 market code where the deals are defined
2 currency String 0..1
 The currency used for prices in response. Three letter currency code according to ISO 4217.
2 origin Object 0..1
 Origin of the connection
3 code String 1

The code in 3-letters of the origin

Ex: CDG
3 type String 1 The type of the origin code : CITY, AIRPORT, BUS_STATION, HELIPORT, RAILWAY_STATION, FERRY_STATION.
3 label String 1 label of the origin
3 deals Array of Objects 0..n List of deals in the destination zone
4 destination Object 1 Destination
5 code String 1

The code in 3-letters of the destination

Ex: CDG
5 type String 1 The type of the destination code : CITY, AIRPORT, BUS_STATION, HELIPORT, RAILWAY_STATION, FERRY_STATION.
5 label String 1 Destination label
4 price Object 1 Deal's information ordered by cabin
5 byCabin Array of Objects 1..n Deal's information for a specific cabin
6 cabin Object 1 Cabin
7 code String 1 Cabin code : ECONOMY, PREMIUM, BUSINESS, FIRST
7 label String 1 Cabin label
7 byTripType Array of Objects 1..n
 Deal's information for a specific cabin ordered by trip type
8 relevance String 1 Relevance (priority) of the deal
8 tripType Object 1 Deal's trip type info
9 code String 1 Deal's trip type : RT(RoundTrip) - OW (OneWay)
9 label String 1 Deal's trip type label
8
fareType
 String 1

Deal's fare type : PROMO_FARE / LOWEST_FARE

PROMO_FARE : the deal is a promo fare from pricing point of view

LOWEST_FARE : the deal is the lowest price available for the OD
8 displayPicture boolean 1 true if a picture should be displayed with the deal (data set in FFT admin tool)
8 bestPrice Number 1 Deal's price
8 bookingDateInterval Object 1 Booking date interval associated to the deal
9 from Date 1 Start of the booking date interval - Format : YYYY-MM-DD
9 to Date 1 End of the booking date interval - Format : YYYY-MM-DD
8 tripDuration Object 0..2 Trip duration information associated to the deal
9 minimumStay Object 0..1 Minimum stay condition of the deal
10 duration Number 1 Duration
10 stayUnit Object 1 Duration unit : Templated
9 maximumStay Object 0..1 Maximum stay condition of the deal
10 duration Number 1 Duration
10 stayUnit Object 1 Duration unit : DAY / HOUR/ MONTH
8 travelDateIntervalsByConnection Object 0..n Travel date condition associated to the deal
9 connection Number 1 Connection id
10 travelDateIntervals Object 0..n Traveldate interval associated to the connection
11 from Date 0..1 Start of the travel date interval
11 to Date 0..1 End of the travel date interval
8 _links Object 0..1 Hateoas links available from this deal
9 lowestFareOffers Object 0..1

Hateoas link to lowestOffers : the lowest price for a given period
10 href String 1 Hateoas link to target lowestOffers calendar by day
10 templated boolean 1 Templated
9 ticketConditions Object 0..1 Hateoas link to ticketConditions
10 href String 1 Hateoas link to target ticketConditions from tripidentifier
10 templated boolean 1 Templated
2 disclaimer Object 0..1 The texts to be shown as legal disclaimers regarding fare, tax, fee, credit card surcharges etc.
3 displayPriceText String 0..1
 Disclaimer text
3 displayPriceTextRJF Object 0..1 Disclaimer text on RJF format to be able to handle text with link properly
4 type String 1 Object type
4 depth Number 1 depth
4 text String 1 text
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
2 description String 1 Description of the warning
3 errorinInputPath String 1 Description of the input Path where the warning occured
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)

1302 - No deals found
2 name String 1 Name of the error. 
Ex: OFA/TECHNICAL/INVALID_VALUE - logger/Typology/name
2 description String 1 Description of the error
3 errorinInputPath String 1 Description of the input Path where the error occured

 

HTTP STATUS CODES

HTTP status

Type
200 OK

400

BAD REQUEST

500

INTERNAL_SERVER_ERROR

 

Request



{


    "origin": {


        "code": "MRS",


        "type": "AIRPORT"


    },


    "zoneCode": "EUR"


}
   

version 1 as of 2 years ago by Sebastien BARBARA

Docs Navigation