查询订单

get

https://api.myhostex.com/v3/reservations

您可以通过向此端点发出请求来查询订单。

Query Params

reservation_code

string

按指定的订单代码过滤结果。

channel_id

string

按渠道中的预留 ID 过滤结果（与响应中返回的 channel_id 字段匹配）。

property_id

integer

按指定的房间 ID 过滤结果。

status

string

enum

按指定的订单状态过滤结果。

Allowed:

start_check_in_date

date

过滤结果以包含入住日期从该日期（含该日期）开始的订单。

end_check_in_date

date

筛选结果以包含入住日期在此日期（含当日）之前的订单。

start_check_out_date

date

过滤结果以包含退房日期从该日期（含该日期）开始的订单。默认情况下，返回 180 天内的订单。

end_check_out_date

date

过滤结果以包含退房日期在此日期（含当日）之前的订单。

order_by

string

enum

Defaults to booked_at

按指定字段对结果进行排序（始终降序）。默认值为 booked_at。 created_at 按行创建时间戳排序（即订单首次同步到百居易的时间）。

Allowed:

channel_type

string

enum

按指定渠道类型过滤结果。

offset

integer

Defaults to 0

指定应返回结果的起始索引。默认值：0

limit

integer

Defaults to 20

确定要返回的最大结果数，最多 100 个。默认值：20。

Response

200