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
.
This function requires elevated permissions and runs only on the backend and on dashboard pages.
function cancelOrder(
_id: string,
options: CancelOrderOptions,
): Promise<CancelOrderResponse>;
Order ID.
import { orders } from "wix-ecom-backend";
async function cancelOrder(id, options) {
try {
const result = await orders.cancelOrder(id, options);
return result;
} catch (error) {
console.error(error);
// Handle the error
}
}
There is 1 error with this status code.
This method may also return standard errors. Learn more about standard Wix errors.