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

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

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 is 1 error with this status code.

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

Did this help?