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. Example Response

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=2017-01-01 overlapped rates will be returned
( ending after fromd )
tod date (ISO 8601) NO &tod=2017-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 boolean NO false &verbose=1 Return full rate information when true

Example JSON Response

{
	"method": "https://rest.reserve-online.net/rate/demo"
	"http_method": "GET",
	"http_code": 200,
	"error_code": "OK",
	"error_msg": "",
	"params": [
		{
			type: "URL"
			name: "active"
			value: "1"
		}
	],
	"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 )
				"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
				}
			}
		]
	}
}