Sign in

v1

latestOpenAPI 3.0.02026-07-26866217.8 KB
Reservations

Query Reservations

You can query reservations by making a request to this endpoint.

get/reservations

Query parameters

reservation_codestring

Filters the results by the specified reservation code.

channel_idstring

Filters the results by the reservation ID in the channel (matches the channel_id field returned in the response).

property_idinteger

Filters the results by the specified property ID.

status'wait_accept' | 'wait_pay' | 'accepted' | 'cancelled' | 'denied' | 'timeout'

Filters the results by the specified reservation status.

start_check_in_datestring date

Filters the results to include reservations with check-in dates starting from this date (inclusive).

end_check_in_datestring date

Filters the results to include reservations with check-in dates up to this date (inclusive).

start_check_out_datestring date

Filters the results to include reservations with check-out dates starting from this date (inclusive). By default, reservations within 180 days are returned.

end_check_out_datestring date

Filters the results to include reservations with check-out dates up to this date (inclusive).

order_by'booked_at' | 'check_in_date' | 'check_out_date' | 'cancelled_at' | 'created_at'

Sorts the results by the specified field (always descending). Default is booked_at. created_at sorts by the row creation timestamp (i.e. when the reservation was first synced into Hostex).

channel_type'airbnb' | 'booking.com' | 'agoda' | 'expedia' | 'vrbo' | 'trip.com' | 'booking_site' | 'tujia_intl' | 'hostex_direct' | 'tujia' | 'xiaozhu' | 'meituan_bnb' | 'meituan_hotel' | 'muniao' | 'fliggy' | 'zhukeyun' | 'tiktok' | 'xiaohongshu' | 'ctrip' | 'houfy'

The type of the channel. See Supported Channels for more information.

Filters the results by the specified channel type.

offsetinteger

Specifies the starting index from which the results should be returned. Default: 0

limitinteger

Determines the maximum number of results to be returned, up to a maximum of 100. Default: 20.

Response

request_idstring required

Unique identifier for the request.

error_codeinteger required

Numeric error code representing the status of the response. A value of 200 indicates success. <br> See the Error Codes section for more information.

error_msgstring required

Message detailing the status of the response.

Example response

{
  "error_msg": "Done."
}