liteapi-node-sdk v4.3.1

Table of Contents

• Table of Contents
• Introduction
• Installing
• Usage
• Static data
  • Suggest a list of places
  • List of cities
  • List of Countries
  • List of available currencies
  • List of hotels
  • Hotel details
  • Hotel reviews
  • IATA code list
  • Hotel facilities
  • Hotel types
  • Hotel chains
• Booking flow
  • Search
    • Hotel full rates availability
  • Book
    • Hotel rate prebook
    • Hotel rate book
  • Booking management
    • Booking list
    • Booking retrieve
    • Booking cancel
• Vouchers
  • Retrieve vouchers
  • Voucher Details
  • Create Voucher
  • Update Voucher
  • Update Voucher status
• Loyalty
  • Loyalty Program
  • Enable loyalty program
  • Update loyalty program
  • Fetch specific guest
  • Fetch guest's bookings
• Analytics
  • Retrieve weekly analytics
  • Retrieve detailed analytics report
  • Retrieve market analytics
  • Most booked hotels
• Example Project

Introduction

liteAPI is an innovative and robust collection of infrastructure APIs that cater to the travel industry. It is designed to empower developers, offering them the fastest way to build and launch comprehensive travel applications.

At the heart of LiteAPI's power is its extensive network of over 2 million properties worldwide. By incorporating LiteAPI into an app, developers can effortlessly tap into the vast inventory, allowing users to search and book accommodations at these properties.

But that's not all. With LiteAPI, monetization is made even more simple. Developers can generate revenue through their hospitality products by selling accommodations from LiteAPI's broad portfolio of properties. This means that not only can developers launch their products quickly, they can also start generating profits in no time.

LiteAPI opens up a range of powerful functions for travel and hospitality applications. Its features include:

Don't have an account yet? Sign Up Here.

Installing

Install the package using the following npm or yarn commands:

npm install liteapi-node-sdk
# or
yarn add liteapi-node-sdk

Usage

After you have installed the LiteAPI package, you need to configure it with your API key. The API key is available in the liteAPI Dashboard. Here's the step to add the API key to the package.

const liteApi = require('liteapi-node-sdk')(YOUR_API_KEY);

Static data

Static data can be directly fetched from the functions below. Alternatively, LiteAPI also provides an option to download static data directly from the Github URL.

Suggest a list of places

The getPlaces function look up for a list of places and areas, given a search query. Places can be used to search for hotels within a location and restrict the list to results within the boundaries of a selected place.

const result = await liteApi.getPlaces('Manhattan');

An array of city objects containing the following properties:

List of cities

The getCitiesByCountryCode function returns a list of city names from a specific country. The country codes must be in ISO-2 format. To get the country codes in ISO-2 for all countries please use the getCountries function.

    const countryCode = "IT";
    const result = await liteApi.getCitiesByCountryCode(countryCode);

An array of city objects containing the following properties:

List of Countries

The getCountries function returns the list of countries available along with its ISO-2 code.

      const result = await liteApi.getCountries();

The function does not need any additional parameter.

An array of country objects containing the following properties:

List of available currencies

The getCurrencies function returns all available currency codes along with its name and the list of supported countries that the currency applies to.

    const result = await liteApi.getCurrencies();

This function does not need any additional parameters.

An array of currency objects containing the following properties:

List of hotels

The getHotels function returns a list of hotels available based on different search criterion. The API supports additional search criteria such as city name, geo coordinates, and radius. This function provides detailed hotel metadata, including names, addresses, ratings, amenities, and images, facilitating robust hotel search and display features within applications.

const result = await liteApi.getHotels({
    countryCode: 'IT',
    cityName: 'Rome'
});

Please refer to the documentation of this endpoint for the full list of parameters and their descriptions.

An array of hotel objects containing the following properties:

Hotel details

The getHotelDetails function returns all the static contents details of a hotel or property when given a hotel ID. The static content includes name, description, address, amenities, cancellation policies, images and more.

    const hotelID = "lp24373";
    const result = await liteApi.getHotelDetails(hotelID);

Hotel reviews

The getHotelReviews function returns a list of reviews for a specific hotel identified by hotelId. The number of reviews returned is limited by the limit parameter.

    const result = await liteApi.getHotelReviews("lp24373", 200, true);

IATA code list

The getIataCodes function returns the IATA (International Air Transport Association) codes for all available airports along with the name of the airport, geographical coordinates and country code in ISO-2 format.

    const result = await liteApi.getIataCodes();

This function does not need any additional parameters.

An array of IATA objects with the following properties:

Hotel facilities

The API returns the list of hotel facilities available in the system.

    const result = await liteApi.getHotelFacilities();

This function does not need any additional parameters.

An array of facilities with the following properties:

Hotel types

The API returns a list of available hotel types

    const result = await liteApi.getHotelTypes();

This function does not need any additional parameters.

An array of hotel types with the following properties:

Hotel chains

The API returns a list of available hotel chains

    const result = await liteApi.getHotelChains();

This function does not need any additional parameters.

An array of hotel chains with the following properties:

liteAPI offers a comprehensive and simple way to implement Hotel Booking flow. The booking flow consists of 3 sections: Search, Book, and booking management.

Search

Hotel full rates availability

The getFullRates function return the rates of all available rooms along with its cancellation policies for a list of hotel ID's based on the search dates.

    const result = await liteApi.getFullRates({
        checkin: "2023-07-15",
        checkout: "2023-07-16",
        currency: "USD",
        guestNationality: "US",
        hotelIds: ["lp3803c", "lp1f982", "lp19b70", "lp19e75"],
        occupancies: [
            {
                rooms: 1,
                adults: 2,
                children: [2, 3]
            }
        ]
    });

An array of hotel full rates with the following properties for each roomType:

Book

Hotel rate prebook

The preBook function is used to confirm if the room rates are still available before a booking function can be called. The input to the function is an object that maps to the available options in the API documentation for the prebook endpoint. The function returns a prebook Id, a new rate Id and also contains information if the price, cancellation policy or boarding information changed.

    const offerId = ["abcde123"];
    const result = await liteApi.preBook({ offerId, usePaymentSdk: true, voucherCode: "1234" });

An object containing prebook information and room type details.

Hotel rate book

The book function confirms a booking when the prebook Id and the rate Id from the pre book stage along with the guest and payment information are passeed.

The guest information is an object that should include the guest first name, last name and email.

The payment information is an object that should include the name, credit card number, expiry and CVC number.

The response will confirm the booking along with a booking Id and a hotel confirmation code. It will also include the booking details including the dates, price and the cancellation policies.

const result = await liteApi.book({
  holder: {
    firstName: 'Steve',
    lastName: 'Doe',
    email: 's.doe@liteapi.travel'
  },
  payment: {
    method: 'TRANSACTION_ID',
    transactionId: '456'
  },
  prebookId: '123',
  guests: [
    {
      occupancyNumber: 1,
      firstName: 'Sunny',
      lastName: 'Mars',
      email: 's.mars@liteapi.travel'
    }
  ]
});

An object containing booking information and room details.

Booking management

Booking list

The getBookingListByGuestID function returns the list of all booking Id's for a given guest Id.

    const guestId = "FrT56hfty";
    const result = await liteApi.getBookingListByGuestId(guestId)

An array containing objects with the following properties:

Booking retrieve

The retrieveBooking function returns the status and the details of a specific booking Id.

    const bookingId = "uSQ6Zsc5R";
    const result = await liteApi.retrieveBooking(bookingId);

An object containing booking information and room details.

Booking cancel

The cancelBooking function is used to request a cancellation of an existing confirmed booking. Cancellation policies and conditions will be used to determine the success of the cancellation. For example a booking with non-refundable (NRFN) tag or a booking with a cancellation policy that was requested past the cancellation date will not be able to cancel the confirmed booking.

const bookingId = "K8Hvb-85O";
const result = await liteApi.cancelBooking(bookingId);

Vouchers

LiteAPI provides straightforward access to voucher details, including codes and discounts, along with current loyalty program status and cashback rates.

Retrieve vouchers

The getVouchers function retrieves a list of all available vouchers. This endpoint provides details such as the voucher code, discount type and value, validity period, and other relevant information.

const result = await liteApi.getVouchers();

This function does not need any additional parameters.

An object containing the following properties: name | Type | Description ------|------|------------ status | string | Status of the operation. data | array | List of available vouchers.

Voucher Details

The getVoucherById function retrieves details of a specific voucher by its ID. This includes the voucher code, discount details, usage limits, and more.

const voucherID = "your_voucher_id";
const result = await liteApi.getVoucherById(voucherID);

An object containing the following properties: name | Type | Description ------|------|------------ status | string | Status of the operation. data | object | Details of the specific voucher.

Create voucher

Create a new voucher with the specified details, including the voucher code, discount type, value, and validity period. This voucher can then be used by customers.

const result = await liteApi.CreateVoucher ({voucher_code: "em8d5d7l", 
                                             discount_type: "percentage", 
                                             discount_value: 12,
                                             minimum_spend: 60, 
                                             maximum_discount_amount: 20, 
                                             currency: "USD", 
                                             validity_start: "2024-06-03", 
                                             validity_end: "2024-07-30", 
                                             usages_limit: 10, 
                                             status: "active"});

An object containing the following properties: name | Type | Description ------------|------------|------------ message | string | Voucher created successfully.

Update Voucher

Update the details of an existing voucher, including the voucher code, discount value, validity period, and more.

const result = await liteApi.UpdateVoucher('68',{voucher_code: "em8d5d7l", 
                                                 discount_type: "percentage", 
                                                 discount_value: 12,
                                                 minimum_spend: 60, 
                                                 maximum_discount_amount: 20, 
                                                 currency: "USD", 
                                                 validity_start: "2024-06-03", 
                                                 validity_end: "2024-07-30", 
                                                 usages_limit: 10, 
                                                 status: "active"});

An object containing the following properties: name | Type | Description ------------|------------|------------ message | string | Voucher updated successfully.

Update Voucher status

Update the status of a voucher, typically to activate or deactivate it.

const result = await liteApi.UpdateVoucherStatus('68', {status: "inactive"});

An object containing the following properties: name | Type | Description ------------|------------|------------ message | string | Voucher status updated successfully.

Loyalty

Loyalty Program

The getLoyalty function retrieves information about current loyalty program settings, including status and cashback rates.

const result = await liteApi.getLoyalty();

This function does not need any additional parameters.

An object containing the following properties: name | Type | Description ------|------|------------ status | string | Status of the operation. data | object | Details of the loyalty program.

Enable loyalty program

Once enable the loyalty program with specified status enabled/disabled and cashback rate (e.g. 0.03 = 3% cashback).

const result = await liteApi.EnableLoyalty({status: "disabled", cashbackRate: 0.03 });

An object containing the following properties: name | Type | Description -----------|------------|------------ status | string | Status of the operation. data | object | Details of the loyalty program.

Update loyalty program

Updates the loyalty program settings, including status and cashback rates.

const result = await liteApi.UpdateLoyalty({status: "disabled", cashbackRate: 0.03 });

An object containing the following properties: name | Type | Description -----------|------------|------------ status | string | Status of the operation. data | object | Details of the loyalty program.

Fetch specific guest

Fetches detailed information about a guest, including personal data, loyalty points, and booking history.

const result = await liteApi.getGuestsIds(8);

An object containing the following properties: name | Type | Description -----------|------------|------------ status | string | Status of the operation. data | object | Details of specific guest.

Fetch guest's bookings

Retrieves a list of all bookings associated with a specific guest, including details about the points earned and cashback applied for each booking.

const result = await liteApi.getGuestsBokings(8);

An object containing the following properties: name | Type | Description -----------|------------|------------ status | string | Status of the operation. data | object | Details of guest's bookings.

Analytics

Retrieve weekly analytics

Fetch weekly analytics data for the specified date range.

const result = await liteApi.RetrieveWeeklyAanalytics( {from: "2024-01-01", to: "2024-01-07"});

An object containing the following properties: name | Type | Description -----------|------------|------------ status | string | Status of the operation. data | object | Details of weekly analytics.

Retrieve detailed analytics report

Fetch a detailed analytics report for the specified date range.

const result = await liteApi.RetrieveAanalyticsReport( {from: "2024-01-01", to: "2024-01-07"});

An object containing the following properties: name | Type | Description -----------|------------|------------ status | string | Status of the operation. data | object | Details of analytics report.

Retrieve market analytics

Fetch market analytics data for the specified date range.

const result = await liteApi.RetrieveMarketAanalytics ( {from: "2024-01-01", to: "2024-01-07"});

An object containing the following properties: name | Type | Description -----------|------------|------------ status | string | Status of the operation. data | object | Details of market analytics.

Most booked hotels

Fetch hotel analytics data for most booked hotels the specified date range.

const result = await liteApi.RetrieveMostBookedHotels( {from: "2024-01-01", to: "2024-01-07"});

An object containing the following properties: name | Type | Description -----------|------------|------------ status | string | Status of the operation. data | object | Details of Most booked hotels.