CANCEL RESERVATION
CancelReservation()
CancelReservation() allows cancelling an existing reservation. CancelReservation() supports POST with a JSON request body that details the reservation to be cancelled. Cancellations are subject to any agreement made with the property by the guest and/or by the partner. Partners may only cancel reservations that they created.
Request
Endpoint
https://www.availabilityexchange.com/gateway/cancelreservation
Parameters
None
Request Body
business_id
(64-bit integer)
the unique identifier for the property
external_id
(string)
the unique identifier of the reservation in your system
Request Example
>curl -X POST https://www.availabilityexchange.com/gateway/cancelreservation
--user username:accesskey
-H 'Content-Type: application/json'
-d '{
"business_id":"16609",
"external_id":"FakeReservation001"
}'
Response
response_errors (See Response Errors)
external_id (string)
the unique identifier of the reservation in your system
reservation_id
(32-bit integer)
the reservation's unique id in the property's reservation system
Response Example
{
"response_errors": [],
"action": Cancel
"external_id": "FakeReservation001",
"reservation_id": "244995",
}
Response Errors
401
The credentials supplied are incorrect or you do not have access to this resource
500
Something went wrong (Internal Server Error)
503
Server in maintenance mode
Response Error Example
>curl -X POST https://www.availabilityexchange.com/gateway/cancelreservation
--user username:accesskey
-H 'Content-Type: application/json'
-d '{
"business_id":"9999",
"external_id":"FakeReservation001"
}'
business not found