cancelReservation( )

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Cancels a reservation.

Sets the reservation status to CANCELED.

Permissions
Manage Reservations (Basic)
Manage Reservations (Full)
Manage Reservations (Medium)
Manage Restaurants - all permissions
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
reservationIdstringRequired

Reservation ID.

revisionstringRequired

Revision number.

Specify the existing revision to prevent conflicting updates to reservations.

optionsCancelReservationOptions

Options for canceling the reservation.

Returns
Return Type:Promise<CancelReservationResponse>
Errors
428Failed Precondition

There are 2 errors with this status code:

See the entire list and learn more about Wix errors.

Did this help?