Query Reservations

get https://api.hostex.io/v3/reservations

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

Query Params

reservation_code

string

Filters the results by the specified reservation code.

property_id

integer

Filters the results by the specified property ID.

status

string

Filters the results by the specified reservation status.

start_check_in_date

date

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

end_check_in_date

date

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

start_check_out_date

date

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

end_check_out_date

date

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

order_by

string

Defaults to booked_at

Sorts the results by the specified field. Default is booked_at.

offset

integer

Defaults to 0

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

limit

integer

Defaults to 20

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

Response

Response body

object

request_id

string

required

Unique identifier for the request.

error_code

integer

required

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

error_msg

string

required

Message detailing the status of the response.

data

object

required

reservations

array of objects

required

List of the properties

reservations*

object

reservation_code

string

required

The reservation code. Multiple stays are allowed for the same reservation. In the case of multiple stays, all stays will share the same reservation code. For example: 0-1234567-abcdef

stay_code

string

required

The stay code of the reservation. For example: 0-1234567-abcdef or 0-1234567_1-abcdef(if there are multiple stays for the same reservation)

property_id

integer

required

The property ID. If an reservation fails to be allocated to a property, 0 will be returned.

channel_type

string

required

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

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

listing_id

string

required

The unique identifier for different channels.
For example, the listing id for Airbnb is the Airbnb listing id, and the listing id for Booking.com is the Booking.com room id - rateplan id.

check_in_date

date

required

The check-in date of the reservation in YYYY-MM-DD format. Example: 2019-01-01

check_out_date

date

required

The check-out date of the reservation in YYYY-MM-DD format. Example: 2019-01-01

number_of_guests

integer

required

The total number of guests for the reservation

number_of_adults

integer

The number of adults for the reservation

number_of_children

integer

The number of children for the reservation

number_of_infants

integer

The number of infants for the reservation

number_of_pets

integer

The number of pets for the reservation

status

string

required

wait_accept wait_pay accepted cancelled denied timeout

cancelled_at

date-time | null

The datetime when the reservation was cancelled, null will be returned if the reservation is not cancelled in ISO 8601 format. Example: 2019-01-01T00:00:00+00:00

booked_at

date-time

required

The datetime when the reservation was booked in ISO 8601 format. Example: 2019-01-01T00:00:00+00:00

created_at

date-time

required

The datetime when the reservation was created in Hostex in ISO 8601 format. Example: 2019-01-01T00:00:00+00:00

creator

string

The creator name of the reservation

rates

object

check_in_details

object

The check-in details of the reservation

remarks

string

Remarks from the Hostex Host Portal

channel_remarks

string

Remarks from the channel

conversation_id

string

The conversation ID of the reservation. If not specified, null will be returned.