Search available offers for a set of properties.

Warning

This method is only accessible using a Source-bound API account.

Table of Contents
  1. URL Endpoint
  2. Method Parameters
  3. Usage
  4. Example Response

URL Endpoint

/offers

Method Parameters

Filters

NAME TYPE RANGE / SET REQUIRED DEFAULT EXAMPLE NOTES
name string varchar(255) NO &name=Cavo%20Tagoo Hotel name. Supports substring search e.g. name=Cavo
rating integer 1 – 5 NO &rating=5
&rating=3,4,5
Filters result based on rating ( stars, diamonds, etc )

Output settings

NAME TYPE RANGE / SET REQUIRED DEFAULT EXAMPLE NOTES
order_by string PERIOD
PRICE
NAME(Refers to property name)
NO Manual ordering &order_by=PRICE  
period_breakdown boolean NO false &period_breakdown=1 Output contains offer period breadown with price for each subperiod

Geolocation

NAME TYPE RANGE / SET REQUIRED DEFAULT EXAMPLE NOTES
location string varchar(255) NO &location=Athens Any location text will be recognized and geolocation will be performed.
Quota limits apply
country string ISO 3166-1-alpha-2 NO &country=GB Restrict geolocation results in a single country
lat decimal(18,15) -90.0 – 90.0 NO &lat=37.9404933&lon=23.7138433 Latitude / Longitude in decimal degrees.
Radius Mode (REQUIRED):
Location to search from when using radius search.
Bounding Box Mode (OPTIONAL):
Central point ( distances will be calculated from this ) on bounding box searches.
lon decimal(18,15) -180.0 – 180.0
radius double 1-100 NO 5 &radius=10 Value in kilometers
lat1 decimal(18,15) -90.0 – 90.0 NO &lat1=37.0&lon1=23.0 Latitude / Longitude in decimal degrees.
Bottom left corner (southwest) on bounding box searches.
lon1 decimal(18,15) -180.0 – 180.0
lat2 decimal(18,15) -90.0 – 90.0 NO &lat2=38.0&lon2=24.0 Latitude / Longitude in decimal degrees.
Top right corner (northeast) on bounding box searches.
lon2 decimal(18,15) -180.0 – 180.0
region string ISO 3166-1-alpha-2 NO GR &region=GB Specifies geocoding region bias. Default value is subject to change

Advanced parameters

NAME TYPE RANGE / SET REQUIRED DEFAULT EXAMPLE NOTES
remote_country string ISO 3166-1-alpha-2 NO* &remote_country=US Specifies remote user's country.
Use ip address geolocation.
Required for working with markets.
remote_ip string Dot-decimal notation NO* &remote_ip=94.71.170.105 Specifies remote user's ip address.
Alternative to country.
Required for working with markets.
Only IPv4 supported.
lang_strict boolean   NO &lang_strict=1 Return only offers that have name and description translation in the requested language

* You can use remote_country or remote_ip. If you use both, remote_country takes precedence and remote_ip is ignored.


Usage

Each offer record includes all necessary data such as the date period, minimum price, minimum stay, board, name, photo, description, etc in order to build a list of available offers in your website or application.

Book URL

Each offer record includes a book url link to the booking engine. Use this url for the system to automatically launch availability with all the necessary parameters to enable the offer. It is not necessary to append any more parameters to the book url unless you want to override the default values.

Offer Expiration

This method returns only active offers at the time of request. New offers may activated each day, or existing offers may expire. Do not cache the result of this method for more than 24 hours, in order to always have up-to-date data.

Example JSON Response

{
	"method": "https://rest.reserve-online.net/offers"
	"http_method": "GET",
	"http_code": 200,
	"error_code": "OK",
	"error_msg": "",
	"params": [
		{
			type: "URL"
			name: "period_breakdown"
			value: "1"
		}
	],
	"data":{
		"offers":[
			{
				"htl_code":STRING, // Hotel code
				"htl_name":STRING, // Hotel name
				"htl_location":STRING, // Hotel location(free text as provided by the hotel)
				"htl_country":ISO 3166-1-alpha-2, // Hotel country code
				"id":INTEGER, // Offer id
				"name":STRING, // Offer name
				"description":STRING, // Offer short description ( optional )
				"fromd":ISO 8601, // Stay from date
				"tod":ISO 8601, // Stay to date
				"active_fromd":ISO 8601, // Booking from date ( optional )
				"active_tod":ISO 8601, // Booking to date ( optional )
				"min_price":MONEY, // Minimum price
				"currency":ISO 4217, // Price currency
				"min_stay":INTEGER, // Minimum stay in days
				"board_id":INTEGER, // Board ID: see Data Types
				"adults":INTEGER,
				"children":INTEGER,
				"infants":INTEGER,
				"photourl":URL, // Avatar photo url - Extra small size ( optional )
				"photourlS":URL, // Avatar photo url - Small size ( optional )
				"photourlM":URL, // Avatar photo url - Medium size ( optional )
				"photourlL":URL, // Avatar photo url - Large size ( optional )
				"bookurl":URL, // Offer book url
				"subperiods":[
					{
						"fromd":ISO 8601, // Subperiod start date
						"tod":ISO 8601, // Subperiod end date
						"price":MONEY, // Minimum price within subperiod
					}
				]
			}
		]
	}
}