Single-Property Offer Search - API

Search available offers for a specific property.

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

URL Endpoint

/offers/{propertycode}

Method Parameters

Output settings

NAME TYPE RANGE / SET REQUIRED DEFAULT EXAMPLE NOTES
order_by string PERIOD
PRICE		 NO Manual ordering &order_by=PRICE  
period_breakdown boolean NO false &period_breakdown=1 Output contains offer period breadown with price for each subperiod
display boolean NO &display=1 Return only offers with display flag enabled

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.

Display flag

Some offers may have the display flag set to 0 (false). This means they are not meant to be shown publicly. They are probably inactive, temporarily unavailable or hidden.

JSON Response Schema

{
	"method": "https://rest.reserve-online.net/offers/DEMO"
	"http_method": "GET",
	"http_code": 200,
	"error_code": "OK",
	"error_msg": "",
	"params": [
		{
			type: "URL"
			name: "period_breakdown"
			value: "1"
		}
	],
	"data":{
		"offers":[
			{
				"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
					}
				],
				"display":BOOLEAN // 1=Offer should be displayed publicly, 0=Offer is inactive, hidden or temporarily unavailable
			}
		]
	}
}

JSON Response Example