Search Room Type

GET

/properties/{tenant_id}/room_types/search

Check which room types are available for specific check-in and check-out dates. Returns available room types with quantity and applicable rate plans including pricing breakdown.

Scope Required: properties:read

Query Parameters:

• checkin_date (required): Check-in date in YYYY-MM-DD format
• checkout_date (required): Check-out date in YYYY-MM-DD format
• room_type_id (optional): Specific room type code (UUID) to check (if not provided, checks all room types)
• occ_adults (optional): Number of adults staying (filters room types that can accommodate this many adults)
• occ_children (optional): Number of children staying (filters room types that can accommodate this many children)
• occ_infant (optional): Number of infants staying (filters room types that can accommodate this many infants)

Important Notes:

• Maximum stay period: 30 days
• checkin_date and checkout_date must be different dates (checkout must be strictly after checkin)
• Availability calculation considers:
  • Existing bookings (confirmed, checked-in)
  • Room maintenance schedules
  • Out-of-order rooms
  • Occupancy requirements (when occ_adults, occ_children, or occ_infant are provided)
• Rate plans returned are “direct rate plans” only (not derived/seasonal)
• Rate plans include days_breakdown with daily rates (uses restrictions data first, then default_rates)
• Rate plans include estimated_total_price (sum of daily rates)
• Rate plans include has_breakfast (boolean flag whether breakfast is included in the rate)

Authorizations

• http

Parameters

Path Parameters

tenant_id

required

string

Query Parameters

room_type_id

string | null format: uuid

Example

550e8400-e29b-41d4-a716-446655440000

checkin_date

required

string format: date

Example

2025-11-19

checkout_date

required

string format: date

Example

2025-11-21

occupancy_adults

integer | null

>= 1

occupancy_children

integer | null

occupancy_infant

integer | null

Responses

200

object

success

required

boolean

data

required

Array<object>

object

room_types

required

object

id

required

string

title

required

string

quantity

required

integer

occ_adults

required

integer

occ_children

required

integer

occ_infants

required

integer

rate_plans

required

Array<object>

object

id

required

string

title

required

string

currency

required

string

sell_mode

required

string

has_breakfast

required

boolean

days_breakdown

required

Array<object>

object

day

required

string

price

required

number

estimated_total_price

required

number

422

Validation error

object

message

required

Errors overview.

string

errors

required

A detailed description of each field that failed validation.

object

key

additional properties

Array<string>