Amadeus Node SDK

If an endpoint supports pagination, the SDK provides .next(), .previous(), .last(), and .first() methods to access subsequent or previous pages. You pass the current response object into these methods. If no page is available, the promise resolves to null.

amadeus.referenceData.locations.get({
  keyword: 'LON',
  subType: 'AIRPORT,CITY'
}).then(function(response){
  console.log(response.data); // first page
  return amadeus.next(response);
}).then(function(nextResponse){
  if (nextResponse) {
    console.log(nextResponse.data); // second page
  }
});

You can initialize the Amadeus client in three ways:

1. Explicitly: Pass clientId and clientSecret in the configuration object.
2. Environment Variables: If AMADEUS_CLIENT_ID and AMADEUS_CLIENT_SECRET are set in your environment, you can initialize without arguments.
3. Environment Selection: By default, the SDK uses the test environment. To use the production (pay-as-you-go) environment, set the hostname to 'production'.

You can also provide a custom logger and set the logLevel (silent, warn, or debug) during initialization.

const Amadeus = require('amadeus');

// Initialize with credentials and production hostname
const amadeus = new Amadeus({
  clientId: 'REPLACE_BY_YOUR_API_KEY',
  clientSecret: 'REPLACE_BY_YOUR_API_SECRET',
  hostname: 'production',
  logLevel: 'debug'
});

Install the amadeus package using npm. The module has been tested with Node LTS versions.

npm install amadeus --save

You can customize logging by providing a logger instance (compatible with the default console) or by setting the logLevel during initialization. Alternatively, use the AMADEUS_LOG_LEVEL environment variable.

Available logLevel options:

• silent (default)
• warn
• debug

const amadeus = new Amadeus({
  clientId: 'REPLACE_BY_YOUR_API_KEY',
  clientSecret: 'REPLACE_BY_YOUR_API_SECRET',
  logLevel: 'debug'
});

The Client acts as a wrapper that automates the lifecycle of an API call. When a request is made (e.g., via .get() or .post()):

1. Authentication: The client uses an internal AccessToken mechanism to retrieve a Bearer Token.
2. Request Building: It constructs a Request object containing the verb, path, parameters, and connection details (host, port, SSL, etc.).
3. Execution: It uses the configured http client to execute the request.
4. Lifecycle Management: It uses an EventEmitter and a Listener to handle the asynchronous response or error, wrapping the entire process in a Promise that resolves with the response or rejects with a ResponseError.

Note: You can use amadeus.client.get(...) directly, but it is semantically equivalent to using the namespaced API: amadeus.amadeus.reference_data.urls.checkin_links.get(...).

Once you have priced a flight offer, you can create a flight order using amadeus.booking.flightOrders.post. This requires the priced offers and traveler information.

amadeus.booking.flightOrders.post(
  {
    'type': 'flight-order',
    'flightOffers': [priced-offers],
    'travelers': []
  }
);

The SDK supports searching for, booking, and managing ground transfers.

• Search: amadeus.shopping.transferOffers.post(body).
• Book: amadeus.ordering.transferOrders.post(body, { offerId: '...' }).
• Cancel: amadeus.ordering.transferOrder('ORDER_ID').transfers.cancellation.post({}, { confirmNbr: '...' }).

// Book a transfer
amadeus.ordering.transferOrders.post(body, { offerId: '2094123123' });

// Cancel a transfer
amadeus.ordering.transferOrder('XXX').transfers.cancellation.post({}, { confirmNbr: '12345' });

Seat maps can be retrieved in two ways:

1. From a flight offer: Pass the flight offer data to amadeus.shopping.seatmaps.post(body).
2. From a flight order: Use the order ID with amadeus.shopping.seatmaps.get({ 'flight-orderId': 'XXX' }).

// From flight offers
amadeus.shopping.flightOffersSearch.get({
  originLocationCode: 'SYD',
  destinationLocationCode: 'BKK',
  departureDate: '2022-11-01',
  adults: '1'
}).then(function(response){
    return amadeus.shopping.seatmaps.post({
      'data': [response.data[0]]
    });
}).then(function(response){
    console.log(response.data);
});

// From a flight order ID
amadeus.shopping.seatmaps.get({
  'flight-orderId': 'XXX'
});

Hotel workflows involve searching for offers and then booking them.

• Search by ID: amadeus.shopping.hotelOffersSearch.get({ hotelIds, adults }).
• Check Offer Conditions: amadeus.shopping.hotelOfferSearch('ID').get().
• Booking (v2): amadeus.booking.hotelOrders.post(body).
• Booking (v1): amadeus.booking.hotelBookings.post(body).

Hotel lists can also be retrieved by city code (amadeus.referenceData.locations.hotels.byCity.get), geocode, or specific hotel IDs.

// Search available offers in specific hotels
amadeus.shopping.hotelOffersSearch.get({
    hotelIds: 'RTPAR001',
    adults: '2'
})

// Hotel Booking API v2
amadeus.booking.hotelOrders.post(
  {
    'data': {
        'type': 'hotel-order',
        'guests': [],
        'travelAgent': {},
        'roomAssociations': [],
        'payment': {}
    }
  }
)

You can manage existing flight orders using their unique ID. Note that in the test environment, these IDs are temporary.

• Retrieve: Use amadeus.booking.flightOrder('ID').get().
• Cancel: Use amadeus.booking.flightOrder('ID').delete().

// Retrieve flight order
amadeus.booking.flightOrder('XXX').get()

// Cancel flight order
amadeus.booking.flightOrder('XXX').delete()