Start building travel apps with liteAPI. Instantly access millions of hotels to build new or existing apps and platforms.
npm install liteapi-node-sdkAt 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.
Install the package using the following npm or yarn commands:
``sh`
npm install liteapi-node-sdkor
yarn add liteapi-node-sdk
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.
`js`
const liteApi = require('liteapi-node-sdk')(YOUR_API_KEY);
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.
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.*
Example :
`js
const result = await liteApi.getPlaces('Manhattan');
`*
Parameters :
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
textQuery | string| Search query. e.g. 'Manhattan' | [required]
type | string| Restricts the results to places matching the specified type. e.g. 'hotel' | [optional]
language | string| The language code, indicating in which language the results should be returned. e.g. 'en' | [optional]
*
Return type :
An array of city objects containing the following properties:
Field | Type | Description
------|------|------------
data | object | An array of the suggested places.
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.
*
Example :
js
const countryCode = "IT";
const result = await liteApi.getCitiesByCountryCode(countryCode);
`
* Parameters :
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
countryCode | string| Country code in iso-2 format (example: US) | [required]
*
Return type :
An array of city objects containing the following properties:
Field | Type | Description
------|------|------------
city | string | The name of the city.
List of Countries
The getCountries function returns the list of countries available along with its ISO-2 code.
*
Example :
js
const result = await liteApi.getCountries();
`
* Parameters :
The function does not need any additional parameter.
*
Return type :
An array of country objects containing the following properties:
Field | Type | Description
------|------|------------
code | string | The country code in iso-2 format.
name | string | The name of the country.
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.
*
Example :
js
const result = await liteApi.getCurrencies();
`
* Parameters :
This function does not need any additional parameters.
*
Return type :
An array of currency objects containing the following properties:
| Name | Type | Description |
| -------- | ----- | ----------------------------------------------------------- |
| code | string | The currency code. |
| currency | string | The name of the currency. |
| countries | Array | An array of countries where the currency is used. |
List of hotels
The
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.*
Example :
`js
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.
*
Return type :
An array of hotel objects containing the following properties:
| Name | Type | Description |
| --------------- | ------ | --------------------------------------------------------------------------------------------------------- |
| id | string | The unique identifier of the hotel. |
| name | string | The name of the hotel. |
| hotelDescription| string | The description of the hotel. |
| currency | string | The currency used in the hotel. |
| country | string | The country code of the hotel. |
| city | string | The city where the hotel is located. |
| latitude | number | The latitude coordinates of the hotel's location. |
| longitude | number | The longitude coordinates of the hotel's location. |
| address | string | The address of the hotel. |
| zip | string | The postal code of the hotel. |
| main_photo | string | The URL of the main photo of the hotel. |
| stars | number | The star rating of the hotel. |
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.
*
Example :
js
const hotelID = "lp24373";
const result = await liteApi.getHotelDetails(hotelID);
`
* Parameters :
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
hotelId | string| Unique ID of a hotel | [required]*
Return type :
| Name | Type | Description |
| --------------- | ------ | --------------------------------------------------------------------------------------------------------- |
| id | string | The unique identifier of the hotel. |
| name | string | The name of the hotel. |
| hotelDescription | string | The description of the hotel. |
| checkinCheckoutTimes | Object | An object containing the check-in and check-out times of the hotel. |
| checkout | string | The check-out time of the hotel. |
| checkin | string | The check-in time of the hotel. |
| hotelImages | Array | An array of hotel image objects containing the following properties: |
| url | string | The URL of the hotel image. |
| thumbnailUrl | string | The thumbnail URL of the hotel image. |
| caption | string | The caption of the hotel image. |
| order | string | The order of the hotel image (null if not applicable). |
| defaultImage | boolean | Indicates whether the hotel image is the default image or not. |
| currency | string | The currency used in the hotel. |
| country | string | The country code of the hotel. |
| city | string | The city where the hotel is located. |
| starRating | number | The star rating of the hotel. |
| location | Object | An object containing the latitude and longitude coordinates of the hotel's location. |
| latitude | number | The latitude coordinate of the hotel's location. |
| longitude | number | The longitude coordinate of the hotel's location. |
| address | string | The address of the hotel. |
| zip | string | The postal code of the hotel. |
| chainId | string | The unique identifier of the hotel chain. |
| hotelFacilities | Array | An array of hotel facilities offered by the hotel. |
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.
*
Example :
js
const result = await liteApi.getHotelReviews("lp24373", 200, true);
`*
Parameters :
Name | Type | Description | Notes
-------------------- | ------------- | -------------------------------------------------------------------------- | -------------
hotelId | string | Unique ID of a hotel | [required]
limit | number | Number of reviews to retrieve | [required]
getSentiment | boolean | If set to true, the sentiment analysis of the review text will be returned | [required]
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.
*
Example :
js
const result = await liteApi.getIataCodes();
`
* Parameters :
This function does not need any additional parameters.
*
Return type :
An array of IATA objects with the following properties:
| Name | Type | Description |
| ----------- | ------ | ------------------------------------------------ |
| code | string | The IATA code. |
| name | string | The name of the IATA. |
| latitude | number | The latitude coordinates of the IATA. |
| longitude | number | The longitude coordinates of the IATA. |
| countryCode | string | The country code of the IATA. |
Hotel facilities
The API returns the list of hotel facilities available in the system.
*
Example :
js
const result = await liteApi.getHotelFacilities();
`
* Parameters :
This function does not need any additional parameters.
*
Return type :
An array of facilities with the following properties:
name | Type | Description
-----------|------------|------------
status | string | Status of the operation.
data | object | Details of the hotel facilities.
Hotel types
The API returns a list of available hotel types
*
Example :
js
const result = await liteApi.getHotelTypes();
`
* Parameters :
This function does not need any additional parameters.
*
Return type :
An array of hotel types with the following properties:
name | Type | Description
-----------|------------|------------
status | string | Status of the operation.
data | object | Details of the hotel types.
Hotel chains
The API returns a list of available hotel chains
*
Example :
js
const result = await liteApi.getHotelChains();
`
* Parameters :
This function does not need any additional parameters.
*
Return type :
An array of hotel chains with the following properties:
name | Type | Description
-----------|------------|------------
status | string | Status of the operation.
data | object | Details of the hotel chains.
Booking flow
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
$3
------
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.*
Example :
js
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]
}
]
});
`*
Parameters :
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
hotelIds | array of strings| List of hotelIds | [required]
checkin | string| Check in data in YYYY-MM-DD format | [required]
checkout | string| Check out data in YYYY-MM-DD format | [required]
currency | string| Currency code - example (USD) | [required]
guestNationality | string| Guest nationality ISO-2 code - example (SG) | [required]
occupancies | array of objects| Occupancies | [required]
guestId | string| Unique traveler ID if available | [optional]
*
Return type :
An array of hotel full rates with the following properties for each
:| Name | Type | Description |
| ------------ | ------ | ------------------------------------------------ |
| offerId | string | The offer for this rate. To be used when calling the prebook endpoint |
| roomTypeId | string | The ID of the room type. |
| supplier | string | The name of the supplier. |
| supplierId | number | The ID of the supplier. |
| rates | Array | An array of rate objects containing the pricing and details for each rate within the room type. |
| rateId | string | The ID of the rate. |
| name | string | The name of the rate. |
| maxOccupancy | number | The maximum occupancy of the room. |
| boardType | string | The type of board included (e.g., Bed Only). |
| boardName | string | The name of the board (e.g., Bed Only). |
| priceType | string | The type of pricing (e.g., commission). |
| commission | Array | An array of commission objects containing the commission amount and currency. |
| retailRate | Object | An object containing the retail rate information, including total price, MSP (Marked Selling Price), and taxes and fees. |
| total | Array | An array of total price objects containing the amount and currency. |
| msp | Array | An array of MSP (Marked Selling Price) objects containing the amount and currency. |
| taxesAndFees | Array | An array of taxes and fees objects containing information about included or additional charges. |
| cancellationPolicies | Object | An object containing cancellation policy information. |
| cancelPolicyInfos | Array | An array of cancellation policy info objects containing information about cancellation time, amount, currency, and type. |
| hotelRemarks | Array | An array of hotel remarks. |
| refundableTag | string | The tag indicating if the rate is refundable or non-refundable. |
Book
$3
------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.
*
Example :
`js
const offerId = ["abcde123"];
const result = await liteApi.preBook({ offerId, usePaymentSdk: true, voucherCode: "1234" });
`
* Parameters :
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
data | object | the input parameters for the API request | [required]
*
Return type :
An object containing prebook information and room type details.
| Name | Type | Description |
| ------------------------- | ------ | ------------------------------------------------------------------------------------------------------ |
| prebookId | string | The ID of the prebook. |
| hotelId | string | The ID of the hotel. |
| currency | string | The currency used for pricing. |
| termsAndConditions | string | The terms and conditions (if available). |
| roomTypes | Array | An array of room type objects containing the following properties: |
| rates | Array | An array of rate objects containing pricing and details for each rate within the room type. |
| rateId | string | The ID of the rate. |
| name | string | The name of the rate. |
| maxOccupancy | number | The maximum occupancy of the room. |
| boardType | string | The type of board included (e.g., Bed Only). |
| boardName | string | The name of the board (e.g., Bed Only). |
| priceType | string | The type of pricing (e.g., commission). |
| commission | Object | An array of commission objects containing the commission amount and currency. |
| retailRate | Object | An object containing the retail rate information, including total price, MSP (Marked Selling Price), and taxes and fees. |
| total | Object | An array of total price objects containing the amount and currency. |
| msp | Object | An array of MSP (Marked Selling Price) objects containing the amount and currency. |
| taxesAndFees | Object | An array of taxes and fees objects containing information about included or additional charges. |
| cancellationPolicies | Object | An object containing cancellation policy information. |
| cancelPolicyInfos | Object | An array of cancellation policy info objects containing information about cancellation time, amount, and type. |
| hotelRemarks | Array | An array of hotel remarks. |
| refundableTag | string | The tag indicating if the rate is refundable or non-refundable. |
| msp | number | The Marked Selling Price (MSP) for the prebook. |
| commission | number | The commission amount for the prebook. |
| price | number | The price of the prebook. |
| priceType | string | The type of pricing (e.g., commission). |
| priceDifferencePercent| number | The percentage difference between the retail rate and the Marked Selling Price (MSP). |
| cancellationChanged | boolean | Indicates if there were changes to the cancellation policy. |
| boardChanged | boolean | Indicates if there were changes to the board type. |
| supplier | string | The name of the supplier. |
| supplierId | number | The ID of the supplier. |
$3
------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.
*
Example :
js
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'
}
]
});
`
* Parameters :
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
prebookId | string| prebook id retrieved from prebook response| [required]
guestInfo | object| traveler informations| [required]|
| guestFirstName | string| traveler first name | [required]|
| guestLastName | string| traveler last name | [required]|
| guestEmail | string| traveler email | [required]|
paymentMethod | string| methodEnum: "CREDIT_CARD" or "STRIPE_TOKEN" | [required]
holderName | string| name of the cardholder | [required]
paymentInfo | object| payment informations | [required]
card_number | string| the card number associated with the credit card| [required if paymentMethod is CREDIT_CARD]
exp_month | number| the expiration month of the credit card | [required if paymentMethod is CREDIT_CARD]
exp_year | number| the expiration year of the credit card | [required if paymentMethod is CREDIT_CARD]
cvc | number| the card verification code (CVC) associated with the credit card | [required if paymentMethod is CREDIT_CARD]
token | string| token provided by Stripe for the payment method. | [required if paymentMethod is STRIPE_TOKEN]
*
Return type :
An object containing booking information and room details.
| Name | Type | Description |
| ------------------------- | ------- | ------------------------------------ |
| bookingId | string | The ID of the booking. |
| clientReference | string | The client reference. |
| supplierBookingId | string | The supplier booking ID. |
| supplierBookingName | string | The supplier booking name. |
| supplier | string | The supplier. |
| supplierId | number | The ID of the supplier. |
| status | string | The status of the booking. |
| hotelConfirmationCode | string | The hotel confirmation code. |
| checkin | string | The check-in date. |
| checkout | string | The check-out date. |
| hotel | object | An object containing hotel details. |
| bookedRooms | array | An array of booked room objects. |
| roomType | object | An object containing room type details. |
| adults | number | The number of adults. |
| children | number | The number of children. |
| rate | object | An object containing rate details. |
| maxOccupancy | number | The maximum occupancy. |
| retailRate | object | An object containing the retail rate information, including total price. |
| guestInfo | object | An object containing guest details. |
| createdAt | string | The creation date of the booking. |
| cancellationPolicies | object | An object containing cancellation policies information.
| cancelPolicyInfos | Object | An array of cancellation policy info objects containing information about cancellation time, amount, and type. |
| hotelRemarks | Array | An array of hotel remarks. |
| refundableTag | string | The tag indicating if the rate is refundable or non-refundable.
| price | number | The price of the booking. |
| msp | number | The MSP (Merchant Service Provider) price. |
| commission | number | The commission amount. |
| currency | string | The currency of the booking. |
Booking management
$3
------
The getBookingListByGuestID function returns the list of all booking Id's for a given guest Id.*
Example :
js
const guestId = "FrT56hfty";
const result = await liteApi.getBookingListByGuestId(guestId)
`
* Parameters :
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
guestId | string | The Guest Id of the user | [required]
*
Return type :
An array containing objects with the following properties:
| Name | Type | Description |
| ----------- | ------ | ------------------ |
| bookingId | string | The booking ID. |
$3
------
The retrieveBooking function returns the status and the details of a specific booking Id.*
Example :
js
const bookingId = "uSQ6Zsc5R";
const result = await liteApi.retrieveBooking(bookingId);
`
* Parameters :
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
bookingId | string | The Booking Id that needs to be retrieved | [required]
*
Return type :
An object containing booking information and room details.
| Name | Type | Description |
| --------------------- | ------ | -------------------------------- |
| bookingId | string | The booking ID. |
| clientReference | string | The client reference. |
| status | string | The booking status. |
| hotelConfirmationCode | string | The hotel confirmation code. |
| checkin | string | The check-in date. |
| checkout | string | The check-out date. |
| hotel | object | An object containing hotel details. |
| bookedRooms | array | An array of booked room objects. |
| roomType | object | An object containing room type details. |
| adults | number | The number of adults. |
| children | number | The number of children. |
| rate | object | An object containing rate details. |
| maxOccupancy | number | The maximum occupancy. |
| boardType | string | The board type. |
| boardName | string | The board name. |
| retailRate | object | An object containing the retail rate information, including total price. |
| guestInfo | object | An object containing guest information. |
| createdAt | string | The creation date of the booking. |
| cancellationPolicies | object | An object containing cancellation policy details. |
| cancelPolicyInfos | Object | An array of cancellation policy info objects containing information about cancellation time, amount, and type. |
| hotelRemarks | Array | An array of hotel remarks. |
| refundableTag | string | The tag indicating if the rate is refundable or non-refundable.
| currency | string | The currency code. |
| price | number | The price of the booking. |
$3
------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.
*
Example :
js
const bookingId = "K8Hvb-85O";
const result = await liteApi.cancelBooking(bookingId);
`
* Parameters :
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
bookingId | string | The booking Id of the booking you would like to cancel. | [required]
*
Return type :
| Name | Type | Description |
| ---------------- | ------ | --------------------------- |
| bookingId | string | The booking ID. |
| status | string | The booking status. |
| cancellation_fee | number | The cancellation fee. |
| refund_amount | number | The refund amount. |
| currency | string | The currency of the booking. |
Vouchers
LiteAPI provides straightforward access to voucher details, including codes and discounts, along with current loyalty program status and cashback rates.
Retrieve vouchers
The
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.*
Example :
`js
const result = await liteApi.getVouchers();
`
* Parameters :
This function does not need any additional parameters.
*
Return type :
An object containing the following properties:
name | Type | Description
------|------|------------
status | string | Status of the operation.
data | array | List of available vouchers.
Voucher Details
The
function retrieves details of a specific voucher by its ID. This includes the voucher code, discount details, usage limits, and more.*
Example :
`js
const voucherID = "your_voucher_id";
const result = await liteApi.getVoucherById(voucherID);
`*
Parameters :
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
voucherID | string| The unique ID of the voucher. | [required]
*
Return type :
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.
*
Example :
js
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"});
`*
Parameters :
Name | Type | Description | Notes
------------------------- | ------------ | ---------------------------------------------------------------------------------- | -------------
voucherCode | string | The unique code for the new voucher. | [required]
discountType | string | Type of discount, such as percentage. | [required]
discountValue | number | Value of the discount applied by the voucher. | [required]
minimumSpend | number | Minimum rate to apply the discount voucher in the voucher currency. | [required]
maximumDiscountAmount | number | Maximum discount amount that can be applied using the voucher in voucher currency. | [required]
currency | string | Currency in which the discount is offered. | [required]
validityStart | date | Date from which the voucher becomes valid. | [required]
validityEnd | date | Date until which the voucher remains valid. | [required]
usagesLimit | number | Maximum number of times the voucher can be redeemed. | [required]
Status | string | The unique code for the new voucher. | [required]
*
Return type :
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.
*
Example :
js
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"});
`*
Parameters :
Name | Type | Description | Notes
------------------------- | ------------ | ---------------------------------------------------------------------------------- | -------------
id | number | Unique identifier of the voucher to update. | [required]
voucherCode | string | The unique code for the new voucher. | [required]
discountType | string | Type of discount, such as percentage. | [required]
discountValue | number | Value of the discount applied by the voucher. | [required]
minimumSpend | number | Minimum rate to apply the discount voucher in the voucher currency. | [required]
maximumDiscountAmount | number | Maximum discount amount that can be applied using the voucher in voucher currency. | [required]
currency | string | Currency of the discount. | [required]
validityStart | date | Updated start date of the voucher's validity. | [required]
validityEnd | date | Updated end date of the voucher's validity. | [required]
usagesLimit | number | Updated usage limit for the voucher. | [required]
Status | string | Updated status of the voucher (e.g., active, inactive). | [required]
*
Return type :
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.
*
Example :
js
const result = await liteApi.UpdateVoucherStatus('68', {status: "inactive"});
`*
Parameters :
Name | Type | Description | Notes
------------------------- | ------------ | ------------------------------------------------------------------------ | -------------
id | number | Unique identifier of the voucher for which the status is being updated. | [required]
Status | string | New status of the voucher. | [required]
*
Return type :
An object containing the following properties:
name | Type | Description
------------|------------|------------
message | string | Voucher status updated successfully.
Loyalty
Loyalty Program
The
function retrieves information about current loyalty program settings, including status and cashback rates.
*
Example :
`js
const result = await liteApi.getLoyalty();
`
* Parameters :
This function does not need any additional parameters.
*
Return type :
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).
*
Example :
js
const result = await liteApi.EnableLoyalty({status: "disabled", cashbackRate: 0.03 });
`*
Parameters :
Name | Type | Description | Notes
------------------------- | ------------ | ---------------------------------------------------------- | -------------
Status | string | Loyalty program status, either enabled or disabled. | [required]
cashbackRate | float | Cashback rate in percentage, e.g. 0.1 = 10% | [required]
*
Return type :
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.
*
Example :
js
const result = await liteApi.UpdateLoyalty({status: "disabled", cashbackRate: 0.03 });
`*
Parameters :
Name | Type | Description | Notes
------------------------- | ------------ | ---------------------------------------------------------- | -------------
Status | string | Loyalty program status, either enabled or disabled. | [required]
cashbackRate | float | Cashback rate in percentage, e.g. 0.1 = 10%. | [required]
*
Return type :
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.
*
Example :
js
const result = await liteApi.getGuestsIds(8);
`*
Parameters :
Name | Type | Description | Notes
------------------------- | ------------ | ---------------------------------------------------------- | -------------
guestId | number | Numeric ID of the guest to fetch. | [required]
*
Return type :
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.
*
Example :
js
const result = await liteApi.getGuestsBokings(8);
`*
Parameters :
Name | Type | Description | Notes
------------------------- | ------------ | ---------------------------------------------------------- | -------------
guestId | number | Numeric ID of the guest to fetch. | [required]
*
Return type :
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.
*
Example :
js
const result = await liteApi.RetrieveWeeklyAanalytics( {from: "2024-01-01", to: "2024-01-07"});
`*
Parameters :
Name | Type | Description | Notes
------------ | ---------- | ---------------------------------------------------------- | -------------
from | date | Start date for the analytics data YYYY-MM-DD (ISO 8601). | [required]
to | date | Start date for the analytics data YYYY-MM-DD (ISO 8601). | [required]
*
Return type :
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.
*
Example :
js
const result = await liteApi.RetrieveAanalyticsReport( {from: "2024-01-01", to: "2024-01-07"});
`*
Parameters :
Name | Type | Description | Notes
------------ | ---------- | ---------------------------------------------------------- | -------------
from | date | Start date for the analytics data YYYY-MM-DD (ISO 8601). | [required]
to | date | Start date for the analytics data YYYY-MM-DD (ISO 8601). | [required]
*
Return type :
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.
*
Example :
js
const result = await liteApi.RetrieveMarketAanalytics ( {from: "2024-01-01", to: "2024-01-07"});
`*
Parameters :
Name | Type | Description | Notes
------------ | ---------- | ---------------------------------------------------------- | -------------
from | date | Start date for the analytics data YYYY-MM-DD (ISO 8601). | [required]
to | date | Start date for the analytics data YYYY-MM-DD (ISO 8601). | [required]
*
Return type :
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.
*
Example :
js
const result = await liteApi.RetrieveMostBookedHotels( {from: "2024-01-01", to: "2024-01-07"});
``*
Name | Type | Description | Notes
------------ | ---------- | ---------------------------------------------------------- | -------------
from | date | Start date for the analytics data YYYY-MM-DD (ISO 8601). | [required]
to | date | Start date for the analytics data YYYY-MM-DD (ISO 8601). | [required]
*
An object containing the following properties:
name | Type | Description
-----------|------------|------------
status | string | Status of the operation.
data | object | Details of Most booked hotels.