Dida API # BookingSearch
This API allows you to search for bookings by using either the booking ID or other parameters. It's designed to provide a flexible way to locate specific booking information quickly and easily. Booking search can be searched by booking ID or other params.
Please note, all booking data for "DidaApiTestID" is used for testing purposes only. This data is not representative of actual bookings and is simply used to test the functionality of the booking search feature.Important Notice: A booking should be considered in a final state only when the Booking Search API response explicitly returns one of the following status codes. Any other result (e.g., empty response or status values other than 2, 3, or 4) must not be interpreted as the final booking status.
- Status = 2: The booking is successfully confirmed in Dida’s system — this is the only valid confirmation of a successful booking.
- Status = 3: The booking is successfully cancelled in Dida’s system — this is the only valid confirmation of a cancellation.
- Status = 4: The booking has failed in Dida’s system — this is the only valid confirmation of a failed booking.
| Status | Name | Description |
|---|---|---|
| 0 | PreBook | - |
| 1 | Booked | PreBook + awating for payment |
| 2 | Confirmed | Final status |
| 3 | Canceled | Final status |
| 4 | Failed | Final status |
| 5 | Pending | The transition between the PreBook (Booked) phase and the final booking status can be completed within a span of three minutes. |
| 6 | OnRequest | For On-request Inventories, the finalization of the booking status may take up to 120 minutes, a duration which is customizable based on individual requirements. |
https://apiint.didatravel.com/api/booking/HotelBookingSearch?$format=json
- Search by Dida Booking ID: It is recommended to search for bookings using the Dida Booking ID.
{
"Header": {
"ClientID": "DidaApiTestID",
"LicenseKey": "TestKey"
},
"SearchBy": {
"BookingID": "1674000176857108480"
}
}
<HotelBookingSearchRQ>
<Header>
<ClientID>DidaApiTestID</ClientID>
<LicenseKey>TestKey</LicenseKey>
</Header>
<SearchBy>
<BookingID>1674000176857108480</BookingID>
</SearchBy>
</HotelBookingSearchRQ>
- Search by Client Booking ID: It is also recommended to search for bookings using the Client Booking ID.
{
"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>
- Search by Check-in Date Range: This feature allows you to search for bookings within a specific range of check-in dates.
{
"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>
- Search by Check-out Date Range: This feature allows you to search for bookings within a specific range of check-out dates.
{
"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>
- Search by Booking Create Date Range: This feature allows you to search for bookings within a specific range of creation dates.
{
"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>
- Search by Combined Condition: This feature allows you to search for bookings using multiple criteria at once. This could include a combination of booking ID, check-in date range, booking creation date range, and other parameters. By using combined conditions, you can narrow down your search results and locate specific bookings more accurately and quickly. This is particularly useful when you're dealing with a large volume of bookings and need to find specific ones based on a variety of factors.
{
"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>