Beta version
This API endpoint is currently in beta. Make sure to direct any questions during the beta phase to your Booking.com contact person via the appropriate channels.
Retrieving missed reservations¶
Use the GET /reservations-flow-control/missed-reservations
endpoint to retrieve missed reservations for all your properties.
When to implement Reservations Recovery API?¶
You can use this endpoint to retrieve missed reservations in two ways, depending on the problem you are facing:
-
Temporary outage or other issue: Filter by time of communication failure by using the
from
anduntil
parameters. After retrieving missed reservations, you must use thereservation_id
from the response and set it to theid
parameter in Reservations API to retry retrieving the complete reservation data. -
Issue with reservations integration with check-in dates approaching: Filter by check-in date by using the
check_in_start
andcheck_in_end
parameters. After retrieving missed reservations, you must use thecheckin
data from the response to alert the affected properties about incoming reservations.
When processing reservations using OTA endpoints, after processing the missed reservations in your system, make sure to send an acknowledgement for those reservations so that Booking.com's records are updated as well:
- To acknowledge missed confirmation messages, see Acknowledging new reservations.
- To acknowledge missed modification or cancellation messages, see Acknowledging modified or cancelled reservations.
URL¶
GET https://supply-xml.booking.com/reservations-flow-control/missed-reservations
Query parameters¶
You can use the following query parameters to further filter your search.
Including query parameters
Note that you must either include the check_in_start
and check_in_end
parameters, or the from
and until
parameters.
Element | Description | Type | Required/Optional | Notes |
---|---|---|---|---|
check_in_start |
Specifies the beginning of the check-in date range. | string | optional* | You can use this element to search by check-in date range. Follows YYYY-MM-DD . |
check_in_end |
Specifies the end of the check-in date range. | string | optional* | You can use this element to search by check-in date range. Follows YYYY-MM-DD . |
from |
Specifies the beginning of a time range. | string | optional* | You can use this to search by time range. Refers to the deadline time when the data was "missed." Follows YYYY-MM-DDThh:mm:ss.mmmZ . |
until |
Specifies the end of a time range. | string | optional* | You can use this to search by time range. Refers to the deadline time when the data was "missed." Follows YYYY-MM-DDThh:mm:ss.mmmZ . |
property_id |
Specifies the ID(s) of the property or properties you want to retrieve missed reservations for. | array of integers | optional | For example, ?property_id=8011855&property_id=8011866, |
page_size |
Specifies the maximum number of pages you would like to retrieve the missed reservations. | integer | optional | Default: 50 |
reference_type |
Specifies the reservation type you want to retrieve. | string | optional | Possible values are confirmation , modification , and cancellation . |
reservation_id |
Specifies the reservation ID(s) you want to retrieve. | array of integers | optional |
* You must either include the check_in_start
and check_in_end
parameters, or the from
and until
parameters.
Query parameter example¶
The following query parameter retrieves missed reservations that pass the following criteria:
- from: 2022-09-15 12:00:00, until: 2022-09-25 12:00:00.
- reference-type: confirmation (only new reservations).
- page-size: 10.
https://supply-xml.booking.com/reservations-flow-control/missed-reservations?from=2022-09-15T12:00:00.000Z&until=2022-09-25T12:00:00.000Z&page_size=10&reference_type=modification
Response body example¶
The following is a successful response body example:
{
"errors": [],
"meta": {
"ruid": "UmFuZG9tSVYkc2RlIyh9Yd0WFcve+ZivWBM8f5y1eDuTQ6kPzK1s9Xtyi8wmRT+gQY17XPjWHHjy3HnlCFl1u8LKl7K8PEfoUK6yTkovVzo5sY6jW1LWMggCgqE2n/Lku1ibBWZdLR1/VPJT8rPZ9g==",
"next_page": "https://supply-xml.booking.com/reservations-flow-control/missed-reservations?property_id=8011855&property_id=8135188&check_in_start=2022-09-18&from=2022-09-15T12%3A00%3A00.000Z&until=2022-09-25T12%3A00%3A00.000Z&limit=1&page_size=10&reference_type=confirmation&cursor=Ukt0Ez9wQVLR3KCdWyoXCqwhfU37eCC9N_CcSyKFr0e34tBEbz55wzkeIO3AeyBgH3UEo8DT4jZW3JbcIRSfUYdXMZ3k0baf0KjHLsE"
},
"warnings": [],
"data": [
{
"last_communicated_by": "late_query",
"reason": null,
"checkin": "2022-09-18",
"reservation_id": 2392162915,
"reservation_status": "active",
"hotel_id": 8011855,
"reference_type": "confirmation",
"failure_type": "missed_reservation",
"reference_timestamp": "2022-09-16T09:38:38Z",
"uri": "https://secure-supply-xml.booking.com/hotels/ota/OTA_HotelResNotif?id=2392162915&hotel_id=8011855"
}
]
Response body elements¶
The following table describes the response elements:
Element | Description | Type | Notes |
---|---|---|---|
data |
Contains the response object. | object | |
> failure_type |
Specifies the type of failure. | enumerated string | Possible values are - missed_deadline : Retrieved the reservations after the timeout period. - missed_reservation : Missed retrieving the reservation. No calls were made. - missed_confirmation : [Only applicable for OTA XML ] Retrieved the reservations message before the timeout period but did not acknowledge it in time. |
> hotel_id |
Specifies the property ID. | integer | |
> reference_timestamp |
Specifies the time when the reservation reference was sent. | string | Follows YYYY-MM-DDThh:mm:ss.mmmZ . |
> reservation_id |
Specifies the ID of the reservation. | integer | |
> checkin |
Specifies the check-in date. | string | |
> reference_type |
Specifies the reservation type you retrieved. | string | |
> uri |
Specifies the link to the full reservation object. | string | This link refers to the OTA endpoint of the Reservations API. |
> last_communicated_by |
Specifies the last time when the API encountered the reservation message. | enumerated string | Can contain the following values: - late_ack : Provider acknowledged the message late. - late_query : Provider queried the message after the end of the 30-minute timeout period. - xml : The message was made available by Booking.com so the provider can retrieve again after an outage. - email : The message was sent to the property in a fallback email. |
> reservations_status |
Specifies a status from a list of reservation status. | enumerated string | Can contain the following values: - active : The reservation is open for stay or stayed. - cancelled : The reservation was cancelled. - archived : The reservation was archived because the checkin date was far back in the past. |
> reason |
Specifies the reason for the missed reservation. | string | Currently only has the value null . You can ignore this for now. |
meta |
Contains the meta data that comes with the response. | object | |
> next_page |
Specifies the URL with the next page of results. | string | |
> ruid |
Specifies the unique id of the request. | string | You can share this ID with the Booking.com Connectivity Support team when you run into an issue. This can help in understanding what went wrong. |
warnings |
Contains potential warnings. These can help you improve your requests. | array | |
errors |
Contains potential errors. These can help you understand what went wrong with your request. | array |
Quick Actions¶
→ To retrieve new reservations using the OTA solution, see Retrieving new reservations.
→ To acknowledge missed confirmation messages using the OTA solution, see Acknowledging new reservations.
→ To retrieve modified or cancelled reservations using the OTA solution, see Retrieving modified or cancelled reservations.
→ To acknowledge missed modification or cancellation messages using the OTA solution, see Acknowledging modified or cancelled reservations.
→ To process reservations using the B.XML endpoint, see Retrieving reservations using B.XML