Perform an availability request for a single property with pricing per day breakdown

Table of Contents
  1. URL Endpoint
  2. Method Parameters

URL Endpoint

/availability/{propertycode}/breakdown

Method Parameters

Basic parameters

NAME TYPE RANGE / SET REQUIRED DEFAULT EXAMPLE NOTES
checkin date (ISO 8601) from today
to (today + 2 years)
YES &checkin=2017-01-22  
checkout date (ISO 8601) from (checkin + 1)
to (checkin + 30)
YES* checkin + 1 day &checkout=2017-01-29 When used, number of nights is automatically calculated. Limitations apply ( see nights ).
nights integer 1 – 30 YES* 1 &nights=2  
adults integer 1 – max capacity NO 2 &adults=2 The value is PER ROOM. Maximum value is automatically calculated based on the property's maximum possible room capacity.
children integer 0 – (max capacity-1) NO 0 &children=1 The value is PER ROOM. Maximum value equals (maximum capacity - 1).
infants integer 0 – (max capacity-1) NO 0 &infants=1 The value is PER ROOM. Maximum value equals (maximum capacity - 1).
rooms integer 1 – 5 NO 1 &rooms=2  

* Use either checkout or nights, never both. checkout parameter takes precedence if both present.


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.
bk_code string varchar(255) NO &bk_code=SPECIALRATES Returns private rates that are enabled by specified booking code
voucher string varchar(255) NO &voucher=VCH123 Unlocks special offers
rate integer NO &rate=1000 Only returns availability for specified rate

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