Skip to main content
All CollectionsFront Desk Setup
Implement the rates API
Implement the rates API
Updated over a year ago

Important : This information is provided for individuals or organisations with the technical capacity to implement it without further support. Little Hotelier is unable to offer additional support for the use of this API, other than incidental items such as providing Little Hotelier Channel Codes or Hotel Group Codes.

About the Little Hotelier Rates API

Little Hotelier Rates API is available for hotels or hotel groups that wish to build their own availability page, utilising the rate and availability information provided by Little Hotelier for their hotels.

LittleHotelier rates API is available as a RESTful web service, which uses the HTTP protocol. The API can return data in one of the two formats: XML and JSON.
HTTP Method: The web service responds to HTTP GET requests.


Base URI for a Property

Base URI for Property The base URI for the web service is:[BASE_SITE_URI]/api/v1/properties/[CHANNEL_CODE]/rates[.FORMAT]

Where:
[BASE_SITE_URI] - Is either http://apac.littlehotelier.com (APAC) or http://emea.littlehotelier.com (EMEA) dependent on your region.

[.FORMAT] - Is either xml or json, if omitted then default to XML

[CHANNEL_CODE] - Is the Little Hotelier Channel Code used for the property's public page (and appears as part of the URL). If you are unsure of your Hotel's Channel Code, contact the Little Hotelier Support team.

For example: for the demo hotel in Australian site, the base URI to return date in the XML format is: http://apac.littlehotelier.com/api/v1/properties/myhoteldirect/rates


Base URI for a Property Group

Base URI for a Property Group: The base URI for the web service is:
[BASE_SITE_URI]/api/v1/property_groups/[CODE]/rates[.FORMAT]

Where:
[BASE_SITE_URI] - Is either https://apac.littlehotelier.com (APAC) or https://emea.littlehotelier.com (EMEA) dependent on your region.

[.FORMAT] - Is either xml or json if omitted then default to XML

[CODE] - Is the Little Hotelier Hotel Group Code used for the property group's public page (and appears as part of the URL). If you are unsure of your Hotel group's Code, contact Little Hotelier Support.

For example: for the demo group in Australian site, the base URI to return date in the XML format is: https://apac.littlehotelier.com/api/v1/property_groups/myhotelgroup/rates


Query Parameters

Query parameters are supplied by appending a question mark (?) to the base URI, followed by a sequence of parameter names and values separated by an ampersand (&).

The available query parameters are:

start_date

Optional

Format is YYYY-MM-DD

Defaults to today's date.

If it is in the past, the value will be changed to todays date.

Used to indicate the first date for which the data should be returned.

end_date

Optional

Format is YYYY-MM-DD

Defaults to 14 days after the start date.

If it is before the start date, the value will be changed to 14 days after the start date.

Used to indicate the last date that a rate is required.

Note: The date range is limited to the first 28 days from the start date.


Response data format

The response returns data in the following structure:

  • properties - wraps all the properties

  • property - an individual property

  • name - the name of this property

  • rate-plans - wraps all the rate plans for the enclosing property

  • rate-plan - an individual room type

  • id - the id of the room

  • name - the name of this room type

  • rate-plan-dates - wraps all the rate plan dates for the enclosing room type

  • rate-plan-date - an individual record which wraps all the values for the enclosing rate plan for a given date

  • date - the date for the enclosing room type date

  • available - the number of rooms for the enclosing room type date

  • rate - the rate for the enclosing room type date

  • close-to-arrival - whether or not the enclosing room type date is closed for arrivals

  • close-to-departure - whether or not the enclosing room type date is closed for departures

  • min-stay - the minimum number of nights allowed for bookings which start on this date

  • max-stay - the maximum number of nights allowed for bookings which start on this date

  • stop-online-sell - whether or not this date is available for bookings

Response Examples:

Did this answer your question?