Check availability
check_availabilityRead-only. Returns room types that fit the stay, with nightly and total NZD rates from public rate plans only. By default a public title starts with "BAR - "; a non-empty explicit rate-plan id list in config overrides that. A room with no public plan for the stay is no_public_rate. Respects stop_sell, closed_to_arrival, min_stay_arrival, and occupancy. Dates are ISO dates in Pacific/Auckland, check-out must be after check-in, the stay cannot exceed 30 nights, and check-in cannot be in the past. Does not create a booking and does not accept payment card data.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| adults | Yes | Number of adults, from 1 to 20. | |
| infants | No | Infants under 1 year. They do not count toward occupancy. One cot is available to hire. | |
| check_in | Yes | Check-in date YYYY-MM-DD, interpreted in Pacific/Auckland. | |
| children | Yes | Number of children aged 1 or over, from 0 to 20. Do not count infants under 1 here. | |
| check_out | Yes | Check-out date YYYY-MM-DD. Must be after check-in. Maximum 30 nights. |