cancelOrder( )

Cancels an order.

The cancelOrder() function returns a Promise that resolves when the specified order is canceled and the order.status field changes to CANCELED.

Authentication
  • When developing websites or building an app with Blocks, this method may require elevated permissions, depending on the identity of the user calling it and the calling user’s permissions.
  • When building apps without Blocks or for headless projects, you can only call this method directly when authenticated as a Wix app or Wix user identity. When authenticated as a different identity, you can call this method using elevation.
  • Elevation permits users to call methods they typically cannot access. Therefore, you should only use it intentionally and securely.
Permissions
Manage eCommerce - all permissions
Manage Stores - all permissions
Manage Orders
Manage Restaurants - all permissions
Learn more about app permissions.
Method Declaration
Copy
function cancelOrder(
  _id: string,
  options: CancelOrderOptions,
): Promise<CancelOrderResponse>;
Method Parameters
_idstringRequired

Order ID.

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

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

There are 3 errors with this status code.

This method may also return standard errors. Learn more about standard Wix errors.

Did this help?