cancelOrder( )

Developer Preview

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

Changes the order status to CANCELED.

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Manage Bookings Services and Settings
Manage Orders
Manage Events
Manage Portfolio
Access Verticals by Automations
Manage Restaurants - all permissions
Learn more about app permissions.
Method Declaration
Copy
function cancelOrder(
  _id: string,
  options: CancelOrderOptions,
): Promise<CancelOrderResponse>;
Method Parameters
_idstringRequired

ID of the order to mark as CANCELED.

optionsCancelOrderOptions
Returns
Return Type:Promise<CancelOrderResponse>
JavaScript
import { orders } from "@wix/restaurants";

async function cancelOrder(id, options) {
  const response = await orders.cancelOrder(id, options);
}
Errors

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

Did this help?