Bỏ qua để đến nội dung

Get Bookings

API cho đối tácAdd-on
GET
/properties/{tenant_id}/bookings

Retrieve a list of bookings within a specified date range. Query bookings based on check-in date falling within the provided range.

Scope Required: bookings:read

Query Parameters:

  • start_date (required): Start date in YYYY-MM-DD format
  • end_date (required): End date in YYYY-MM-DD format
  • status (optional): Filter by booking status (new, confirmed, in_progress, finished, no_show, cancelled)
  • per_page (optional): Number of items per page (default: 10, max: 50)
  • page (optional): Page number (default: 1)

Important Notes:

  • Maximum date range: 30 days
  • Bookings are filtered by checkin_date within the range [start_date, end_date]
  • Results are paginated
  • Includes related data: customer, booking source, and occupancy information
  • Each booking room has the same fields as in Get Booking Detail (without guests), including services (services used) and service_fee/service_discount/service_charge; the booking has the same three totals. The booking_rooms shape below lists only the service-related fields
tenant_id
required
string
start_date
required
string format: date
Example
2025-11-01
end_date
required
string format: date
Example
2025-11-30
status
string | null
Allowed values: new confirmed in_progress finished no_show cancelled merged
per_page
integer | null
>= 1 <= 50
page
integer | null
>= 1

Return paginated response — attach each master (merged) booking’s rooms from its children (see BookingService::attachMasterRooms()) so đơn đoàn rows aren’t returned with empty booking_rooms.

object
data
required
Any of:
string
pagination
required
object
current_page
required
Any of:
string
from
required
string | null
last_page
required
Any of:
string
per_page
required
string
to
required
string | null
total
required
Any of:
string
links
required
object
first
required
string | null
last
required
string | null
prev
required
string | null
next
required
string | null
success
required
boolean

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>
Bài này có giúp được bạn không?