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 (Medium)
Manage Reservations (Full)
Manage Restaurants - all permissions
Manage Reservations (Basic)
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
reservationIdstringRequired

Reservation ID.

revisionstringRequired

Revision number.

Include the existing revision to prevent conflicting updates to reservations.

optionsCancelReservationOptions

Options for canceling the reservation.

Returns
Return Type:Promise<CancelReservationResponse>
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?