v1

latestOpenAPI 3.0.32026-07-23183961.3 KB

Cancel an existing confirmed reservation. This endpoint allows you to cancel a confirmed reservation that has a free cancellation policy.

Important Business Rules:

  • Only reservations with policyType: "free-cancellation" can be cancelled via this endpoint
  • Non-refundable reservations (policyType: "non-refundable") cannot be cancelled and will result in a 400 error
  • Cancellation must be requested within the free cancellation period (before freeCancellationUntilDays prior to check-in)
  • Attempts to cancel outside the cancellation period will result in a 400 error
  • Pending reservations (not yet confirmed) will return a 404 error
  • Already cancelled reservations will return a 404 error

Cancellation Policy Calculation: The cancellation deadline is calculated in the property's local timezone based on the freeCancellationUntilDays value from the cancellation policy. For example, if a reservation has a check-in date of 2024-01-15 and freeCancellationUntilDays: 7, the last day to cancel is 2024-01-08 (in the property's timezone).

Successful Cancellation: A 200 response indicates the cancellation was successful. The reservation status will be updated to "Cancelled".

post/reservations/{bookingReferenceId}/cancellation

Path parameters

bookingReferenceIdstring required

The unique identifier of the reservation to be cancelled

Headers

x-sm-api-idstring required

The api id for channel

x-sm-api-keystring required

The api key for channel

Response

Successful response. The reservation has been cancelled successfully. Note that a successful cancellation does not necessarily mean a full refund will be issued. Refunds are subject to the property's cancellation policy.