Perform an extras availability request
/availability/{propertycode}/extras/{rateid}
NAME | TYPE | RANGE / SET | REQUIRED | DEFAULT | EXAMPLE | NOTES |
---|---|---|---|---|---|---|
checkin | date (ISO 8601) | from today to (today + 2 years) |
YES | – | &checkin=<2021-01-04 | |
checkout | date (ISO 8601) |
from (checkin + 1) to (checkin + 30) |
YES | checkin + 1 day | &checkout=2021-01-11 | When used, number of nights is automatically calculated. Limitations apply (see nights). |
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 |
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. |
device | string | MOBILE DESKTOP |
NO* | – | &device=MOBILE |
Specified user device. Used to unlock special pricing policies. |
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 |
† You can use remote_country or remote_ip. If you use both, remote_country takes precedence and remote_ip is ignored.
This method returns a response with the following structure (inside data):
... extras: [ { "name":STRING, "description":STRING, "html":STRING, "id":INTEGER, "extra_price":MONEY, // Price per unit "price":MONEY, // Total price for the stay "per_day":BOOLEAN, // Pricing per day "per_adult":BOOLEAN, // Pricing per adult "per_child":BOOLEAN, // Pricing per child "per_infant":BOOLEAN, // Pricing per infant "per_room":BOOLEAN, // Pricing per room "required":BOOLEAN, // 1=It is required and already calculated in the stay's price "max_quantity":INTEGER, // Cannot book more than this number "excl":Array, // An array of extras ids that this extra cannot be booked with "from":ISO 8601, "to":ISO 8601 } ] ...