The rate listing method return a list of active rates for a specific property. The results can be filtered based on name or date. You can also supply a booking code to unlock private rates.

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

URL Endpoint

You can request all rates of a property or all rates of a specific room type in a property.

/rate/{propertycode}
/rate/{propertycode}/{roomcode}

Room Codes

You can use the property API to retrieve room type codes.

Method Parameters

NAME TYPE RANGE / SET REQUIRED DEFAULT EXAMPLE NOTES
name string varchar(255) NO &name=Best%20Available name of rate
fromd date (ISO 8601) NO &fromd=2019-01-01 overlapped rates will be returned
(ending after fromd)
tod date (ISO 8601) NO &tod=2019-12-31 overlapped rates will be returned
(starting before tod)
bk_code string varchar(255) NO &bk_code=SPECIALRATES returns private rates that are enabled by specified booking code
public boolean NO ALL for PMS, 1 of other accounts &public=0 only available to Hotelier API accounts
active boolean NO ALL for PMS, 1 of other accounts &active=0 only available to Hotelier API accounts
verbose integer 0
1
2
NO 0 &verbose=1 0: Basic info
1: Full info
2: Full info + policies

JSON Response Schema

{
	"method": "https://rest.reserve-online.net/rate/DEMO"
	"http_method": "GET",
	"http_code": 200,
	"error_code": "OK",
	"error_msg": "",
	"params": [],
	"data":{
		"rates":[
			{
				"id":INTEGER, // Rate id
				"room":STRING, // Rate room code (each rate belongs to only one room)
				"name":STRING, // Rate name
				"board":INTEGER, // Board ID: see Data Types
				"active":BOOLEAN, // Indicates if rate is active
				"public":BOOLEAN, // Indicates if rate is public or private
				"parent":INTEGER, // Parent rate id. If this value is > 0, it means this rate is a child rate.
				"virtual":BOOLEAN, // Indicates if rate is virtual (imported from 3d party systems e.g Channel Manager)
				"currency":ISO 4217, // Rate currency ISO code
				"url":URL, // API URL for rate info request
				"roomurl":URL, // API URL for room info request
				"roomName":STRING, // Rate room name (only in verbose=1 mode)
				"fromd":ISO 8601, // Rate start date (only in verbose=1 mode)
				"tod":ISO 8601, // Rate end date (only in verbose=1 mode)
				"description":STRING, // Rate short description (only in verbose=1 mode)
				"presentation":STRING, // Rate full html presentation (only in verbose=2 mode)
				"constraints": { (only in verbose=1 mode)
					"expiration":ISO 8601, // Rate expiry date (optional)
					"freeCancelDays":INTEGER, // Days before checkin this rate can be cancelled without cancellation fees
					"earlyBookLimit":INTEGER // Days before checkin this rate can be booked
				},
				(only in verbose=2 mode)
				"policies": {
					"cancellation":STRING, // Cancellation policy text
					"payment":STRING // Payment policy text
				}
			}
		]
	}
}

JSON Response Example

{
	"method": "http://rest.reserve-online.net/rate/DEMO",
	"http_method": "GET",
	"http_code": 200,
	"error_code": "OK",
	"error_msg": "",
	"params": [],
	"data": {
		"rates": [
			{
				"id": 21830,
				"room": "JSUI",
				"name": "Standard Rate",
				"board": 0,
				"active": 1,
				"public": 1,
				"parent": 0,
				"virtual": 0,
				"currency": "EUR",
				"url": "http://rest.reserve-online.net/rate/demo/JSUI/21830",
				"roomurl": "http://rest.reserve-online.net/property/demo/JSUI"
			},
			{
				"id": 28153,
				"room": "FML",
				"name": "Fully Flexible Rate",
				"board": 4,
				"active": 1,
				"public": 1,
				"parent": 0,
				"virtual": 0,
				"currency": "EUR",
				"url": "http://rest.reserve-online.net/rate/demo/FML/28153",
				"roomurl": "http://rest.reserve-online.net/property/demo/FML"
			},
			{
				"id": 181503,
				"room": "FML",
				"name": "Make your offer",
				"board": 4,
				"active": 1,
				"public": 1,
				"parent": 179983,
				"virtual": 0,
				"currency": "EUR",
				"url": "http://rest.reserve-online.net/rate/demo/FML/181503",
				"roomurl": "http://rest.reserve-online.net/property/demo/FML"
			},
			{
				"id": 75222,
				"room": "FML",
				"name": "Special Prepaid Rate",
				"board": 4,
				"active": 1,
				"public": 1,
				"parent": 0,
				"virtual": 0,
				"currency": "EUR",
				"url": "http://rest.reserve-online.net/rate/demo/FML/75222",
				"roomurl": "http://rest.reserve-online.net/property/demo/FML"
			},
			{
				"id": 116052,
				"room": "REG",
				"name": "Standard rate",
				"board": 0,
				"active": 1,
				"public": 1,
				"parent": 0,
				"virtual": 0,
				"currency": "EUR",
				"url": "http://rest.reserve-online.net/rate/demo/REG/116052",
				"roomurl": "http://rest.reserve-online.net/property/demo/REG"
			}
		],
		"summary": {
			"records": 5
		}
	}
}

In the example below the request was submitted with verbose=1



	

RIn the example below the request was submitted with verbose=2