I/O DOCS: INTERACTIVE API DOCUMENTATION

OAuth 2.0 Flow: Select OAuth 2.0 Flow

Existing Client Credentials: Manual Input

API Key:

App/Key: Select Application Key Manually provide key information

Shared Secret:

Client ID:

Client Secret: Authorize

Client ID: Get Access Token

Client ID:

Client Secret:

---

Username:

Password: Get Access Token

Client ID:

Client Secret: Get Access Token

Authorization Code: Get Access Token

Access Token:

Username:

Password:

Username:

Binary Security Token:

Username:

Password:

• awb

  • List Methods
  • Expand Methods

  • GET getShipmentStatusByAWBUsingGET /awb/{awbNumber}

    Get the shipment status by an AWB

    Parameter	Value	Type	Description
    Content-Type	application/json	string	Content type of the request payload
    Accept	application/hal+json	string	Content type of the response payload
    {awbNumber}		string	awbNumber

• Flight Offers

  • List Methods
  • Expand Methods

  • POST AvailableOffers /offers/available-offers

    Parameter	Value	Type	Description
    AFKL-TRAVEL-Country		string	Please use country code. E.g. NL (overrides Accept-Language country)
    Accept		string	Please use 'application/hal+json;profile=com.afklm.b2c.flightoffers.available-offers.v1;charset=utf8'
    AFKL-TRAVEL-Host		string	Please use 'KL' or 'AF'.
    Accept-Language		string	Indicates the response language and country expected. e.g. nl-NL indicates language=nl (Dutch) & country=NL (Netherlands)
    Content-Type		string	Please use 'application/json'.

    Request Body
  • POST LowestFareOffers /offers/lowest-fare-offers

    Parameter	Value	Type	Description
    expand-suggested-flights		string	Boolean value either 'true' or 'false' (For True: Detailed suggested flight details will be displyed in response; For false, Less flight details will be displayed in response).
    Accept		string	Accepts tells the server what formats it is allowed to send back to you. e.g. 'Accept: application/hal+json or Accept: */*'
    AFKL-TRAVEL-Country		string	Specifies the country of end-user the consumer is requesting for
    AFKL-TRAVEL-Host		string	Either 'AF' (AirFrance) or 'KL' (KLM)
    Accept-Language		string	Indicates the response language and country expected. e.g. nl-NL indicates language=nl (Dutch) & country=NL (Netherlands)
    Content-Type		string	Please use 'application/json'.

    Request Body
  • GET Create AvailableOffers /offers/available-offers

    Parameter	Value	Type	Description
    AFKL-TRAVEL-Country		string	Specifies the country of end-user the consumer is requesting for
    d		string	Encrypted Flight product ID. To get the value either call POST Available offers/lowest fare offers
    Accept		string	Use 'Accept: application/hal+json or Accept: */*'
    AFKL-TRAVEL-Host		string	Either 'AF' (AirFrance) or 'KL' (KLM)
    Accept-Language		string	Indicates the response language and country expected. e.g. nl-NL indicates language=nl (Dutch) & country=NL (Netherlands)
    minimumAccuracy		string	Specifies the minimum requested accuracy. Will override the default minimum accuracy. Low minimum accuracy will enforce TripPlanner GetDayData to be used instead of FareFlexPricerUpsell

  • GET ReferenceData /offers/reference-data

    Parameter	Value	Type	Description
    country		string
    Accept		string	Use 'Accept: application/hal+json or Accept: */*'
    AFKL-TRAVEL-Country		string	Specifies the country of end-user the consumer is requesting for
    AFKL-TRAVEL-Host		string	Either 'AF' (AirFrance) or 'KL' (KLM)
    station		string
    host		string
    Accept-Language		string	Indicates the response language and country expected. e.g. nl-NL indicates language=nl (Dutch) & country=NL (Netherlands)

  • GET Create LowestFareOffers /offers/lowest-fare-offers

    Parameter	Value	Type	Description
    AFKL-TRAVEL-Country		string	Specifies the country of end-user the consumer is requesting for
    d		string	Encrypted Flight product ID. To get the value either call POST Available offers/lowest fare offers
    AFKL-TRAVEL-Host		string	Either 'AF' (AirFrance) or 'KL' (KLM)
    Accept		string	Use 'Accept: application/hal+json or Accept: */*'
    Accept-Language		string	Indicates the response language and country expected. e.g. nl-NL indicates language=nl (Dutch) & country=NL (Netherlands)
    dateInterval		string	Format: YYYY-MM-DD/YYYY-MM-DD NB Currently only support for one dateInterval, so for RETURN offers only. Maximum 60 days interval interval if Type is 'Day'

  • GET FP/TaxBreakdown /offers/flight-products/id/tax-breakdown

    Parameter	Value	Type	Description
    AFKL-TRAVEL-Country		string	Specifies the country of end-user the consumer is requesting for
    id		string	Encrypted Flight product ID. To get the value either call POST Available offers/lowest fare offers
    AFKL-TRAVEL-Host		string	Either 'AF' (AirFrance) or 'KL' (KLM)
    Accept		string	Use 'Accept: application/hal+json or Accept: */*'
    Accept-Language		string	Indicates the response language and country expected. e.g. nl-NL indicates language=nl (Dutch) & country=NL (Netherlands)

  • GET FP/UpsellOffers /offers/flight-products/id/upsell-offers

    Parameter	Value	Type	Description
    AFKL-TRAVEL-Country		string	Specifies the country of end-user the consumer is requesting for
    id		string	Encrypted Flight product ID. To get the value either call POST Available offers/lowest fare offers
    AFKL-TRAVEL-Host		string	Either 'AF' (AirFrance) or 'KL' (KLM)
    Accept		string	Use 'Accept: application/hal+json or Accept: */*'
    Accept-Language		string	Indicates the response language and country expected. e.g. nl-NL indicates language=nl (Dutch) & country=NL (Netherlands)

  • POST UpsellOffers /offers/upsell-offers

    Parameter	Value	Type	Description
    AFKL-TRAVEL-Host		string	Either 'AF' (AirFrance) or 'KL' (KLM)
    Accept		string	Use 'Accept: application/hal+json or Accept: */*'
    Accept-Language		string	Indicates the response country and language expected. e.g. nl-NL indicates language=nl (Ducth) & country=NL (Netherlands)

    Request Body
  • GET FP/TicketConditions /offers/flight-products/id/ticket-conditions

    Parameter	Value	Type	Description
    AFKL-TRAVEL-Country		string	Specifies the country of end-user the consumer is requesting for
    id		string	Encrypted Flight product ID. To get the value either call POST Available offers/lowest fare offers
    AFKL-TRAVEL-Host		string	Either 'AF' (AirFrance) or 'KL' (KLM)
    Accept		string	Use 'Accept: application/hal+json or Accept: */*'
    Accept-Language		string	Indicates the response country and language expected. e.g. nl-NL indicates language=nl (Ducth) & country=NL (Netherlands)

  • GET TicketConditions (trip) /offers/ticket-conditions/tripIdentifier

    Parameter	Value	Type	Description
    AFKL-TRAVEL-Country		string	Specifies the country of end-user the consumer is requesting for
    tripIdentifier		string	Provide the information in this format, origin:departuredate@time:flightnumber:selligclass>destination Eg., AMS:20150130@1630:KL1234:Y>BCN
    discountCode		string	Internet discount code
    AFKL-TRAVEL-Host		string	Either'AF' (AirFrance) or 'KL' (KLM)
    Accept		string	Use 'Accept: application/hal+json or Accept: */*'
    ticketedDate		string	Date of ticketing when requesting conditions for reservation.
    Accept-Language		string	Indicates the response country and language expected. e.g. nl-NL indicates language=nl (Ducth) & country=NL (Netherlands)

  • GET TicketConditions (shop) /offers/ticket-conditions

    Parameter	Value	Type	Description
    AFKL-TRAVEL-Country		string	Specifies the country of end-user the consumer is requesting for
    reservationId		string	Id of the conversation state where the selected Flight Product is stored in.
    Accept		string	Use 'Accept: application/hal+json or Accept: */*'
    AFKL-TRAVEL-Host		string	Either 'AF' (AirFrance) or 'KL' (KLM)
    Accept-Language		string	Indicates the response country and language expected. e.g. nl-NL indicates language=nl (Ducth) & country=NL (Netherlands)

  • GET FP/RelatedProducts /offers/flight-products/id/related-products

    Parameter	Value	Type	Description
    AFKL-TRAVEL-Country		string	Specifies the country of end-user the consumer is requesting for
    id		string	Encrypted Flight product ID. To get the value either call POST Available offers/lowest fare offers
    AFKL-TRAVEL-Host		string	Either 'AF' (AirFrance) or 'KL' (KLM)
    Accept		string	Use 'Accept: application/hal+json or Accept: */*'
    Accept-Language		string	Indicates the response country and language expected. e.g. nl-NL indicates language=nl (Ducth) & country=NL (Netherlands)

• amenities

  • List Methods
  • Expand Methods

  • GET getAmenitiesUsingGET /inspire/amenities

    Get aircraft amenities

    Parameter	Value	Type	Description
    AFKL-TRAVEL-Country		string	Please use country code. E.g. NL (overrides Accept-Language country)
    AFKL-TRAVEL-Host		string	Please use 'KL' or 'AF'.
    Accept-Language		string	Indicates the response language and country expected. e.g. nl-NL indicates language=nl (Dutch) & country=NL (Netherlands)
    Content-Type	application/json	string	Content type of the request payload
    Accept	application/hal+json;charset=UTF-8;profile=com.afklm.inspire.amenities.v2	string	Content type of the response payload
    acv		string	Aicraft Configuration Version, 3 alphanumeric characters. Example : 38C, 38C, 77B, A42
    flight		string	Flight airline, number and date (yyyy-MM-dd), separated by an underscore.Can provide mutiple flights with comma separated values. Example : AF_7021_2017-05-18
    cabinClass		string	Cabin class, string (ECONOMY,PREMIUM,BUSINESS,FIRST). Example : ECONOMY
    limit		string	Limit (>= 0)
    response_sample	{ "acv": {}, "amenities": {}, "categories": {}, "errors": [ { "code": -11321488, "message": "proident" }, { "code": -11317573, "message": "adipisicing exercitation ea dolor" } ] }	textarea	Sample response payload