道旅开发文档 # 订单搜索
查询订单接口，可以以订单号或者其他参数搜索订单。
以下 "DidaApiTestID" 这个账号的所有订单数据均为测试数据。请注意：仅当查单接口（Booking Search）返回的订单状态（Status）为以下三种之一时，才视为订单已达到最终状态。其他任何返回结果（如空返回、或Status为非2/3/4的其他数值）均不能视为订单的最终处理结果：
- Status=2：表示订单已在Dida系统中成功确认，这是该状态的唯一有效确认方式。
- Status=3：表示订单已在Dida系统中成功取消，这是该状态的唯一有效确认方式。
- Status=4：表示订单已在Dida系统中处理失败，这是该状态的唯一有效确认方式。
| Status | Name | Description |
|---|---|---|
| 0 | PreBook | - |
| 1 | Booked | PreBook + 待支付 |
| 2 | Confirmed | 最终状态 |
| 3 | Canceled | 最终状态 |
| 4 | Failed | 最终状态 |
| 5 | Pending | 处于 PreBook (Booked) 和 最终状态 之间 - 订单状态会在 3 分钟内到达最终状态 |
| 6 | OnRequest | 见 On-request Inventories - 订单状态会在 120 (可配置) 分钟内到达最终状态 |
https://api.didatravel.com/api/booking/HotelBookingSearch?$format=json
- 使用道旅订单号搜索 推荐
{
"Header": {
"ClientID": "DidaApiTestID",
"LicenseKey": "TestKey"
},
"SearchBy": {
"BookingID": "1674000176857108480"
}
}
<HotelBookingSearchRQ>
<Header>
<ClientID>DidaApiTestID</ClientID>
<LicenseKey>TestKey</LicenseKey>
</Header>
<SearchBy>
<BookingID>1674000176857108480</BookingID>
</SearchBy>
</HotelBookingSearchRQ>
- 使用客户订单号搜索 推荐
{
"Header": {
"ClientID": "DidaApiTestID",
"LicenseKey": "TestKey"
},
"SearchBy": {
"BookingInfo": {
"ClientReference": "v-test-2023-06-28"
}
}
}
<HotelBookingSearchRQ>
<Header>
<ClientID>DidaApiTestID</ClientID>
<LicenseKey>TestKey</LicenseKey>
</Header>
<SearchBy>
<BookingInfo>
<ClientReference>v-test-2023-06-28</ClientReference>
</BookingInfo>
</SearchBy>
</HotelBookingSearchRQ>
- 使用入住时间范围搜索
{
"Header": {
"ClientID": "DidaApiTestID",
"LicenseKey": "TestKey"
},
"SearchBy": {
"BookingInfo": {
"CheckInDateRange":{
"from": "2023-06-26",
"to": "2023-06-26"
}
}
}
}
<HotelBookingSearchRQ>
<Header>
<ClientID>DidaApiTestID</ClientID>
<LicenseKey>TestKey</LicenseKey>
</Header>
<SearchBy>
<BookingInfo>
<CheckInDateRange from="2023-06-26" to="2023-06-26" />
</BookingInfo>
</SearchBy>
</HotelBookingSearchRQ>
- 使用离店时间范围搜索
{
"Header": {
"ClientID": "DidaApiTestID",
"LicenseKey": "TestKey"
},
"SearchBy": {
"BookingInfo": {
"CheckOutDateRange":{
"from": "2023-06-27",
"to": "2023-06-27"
}
}
}
}
<HotelBookingSearchRQ>
<Header>
<ClientID>DidaApiTestID</ClientID>
<LicenseKey>TestKey</LicenseKey>
</Header>
<SearchBy>
<BookingInfo>
<CheckOutDateRange from="2023-06-27" to="2023-06-27" />
</BookingInfo>
</SearchBy>
</HotelBookingSearchRQ>
- 使用订单创建时间范围来搜索
{
"Header": {
"ClientID": "DidaApiTestID",
"LicenseKey": "TestKey"
},
"SearchBy": {
"BookingInfo": {
"BookDateRange":{
"from": "2023-06-26",
"to": "2023-06-26"
}
}
}
}
<HotelBookingSearchRQ>
<Header>
<ClientID>DidaApiTestID</ClientID>
<LicenseKey>TestKey</LicenseKey>
</Header>
<SearchBy>
<BookingInfo>
<BookDateRange from="2023-06-26" to="2023-06-26" />
</BookingInfo>
</SearchBy>
</HotelBookingSearchRQ>
- 使用复杂的组合条件来搜索
{
"Header": {
"ClientID": "DidaApiTestID",
"LicenseKey": "TestKey"
},
"SearchBy": {
"BookingInfo": {
"CheckInDateRange":{
"from": "2023-06-26",
"to": "2023-06-27"
},
"CheckOutDateRange":{
"from": "2023-06-26",
"to": "2023-06-27"
},
"BookDateRange":{
"from": "2023-06-26",
"to": "2023-06-26"
}
}
}
}
<HotelBookingSearchRQ>
<Header>
<ClientID>DidaApiTestID</ClientID>
<LicenseKey>TestKey</LicenseKey>
</Header>
<SearchBy>
<BookingInfo>
<CheckInDateRange from="2023-06-26" to="2023-06-27" />
<CheckOutDateRange from="2023-06-26" to="2023-06-27" />
<BookDateRange from="2023-06-26" to="2023-06-26" />
</BookingInfo>
</SearchBy>
</HotelBookingSearchRQ>
In the following example, the code parameters inside are modifiable.
Use the following method to test API:
Use the following method to test API:
{
"Header": {
"ClientID": "DidaApiTestID",
"LicenseKey": "TestKey"
},
"SearchBy": {
"BookingID": "1674000176857108480"
}
}
In the following example, the code parameters inside are modifiable.
Use the following method to test API:
Use the following method to test API:
<HotelBookingSearchRQ>
<Header>
<ClientID>DidaApiTestID</ClientID>
<LicenseKey>TestKey</LicenseKey>
</Header>
<SearchBy>
<BookingID>1674000176857108480</BookingID>
</SearchBy>
</HotelBookingSearchRQ>