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.
Admin Method
This function requires elevated permissions and runs only on the backend and on dashboard pages.
Permission Scopes
For app development, you must have one of the following permission scopes:Manage Stores - all permissions
Manage eCommerce - all permissions
Manage Orders
Learn more about permission scopes.
Method Declaration
Copy
Method Parameters
_idstringRequired
Order ID.
optionsCancelOrderOptions
Returns
Return Type:Promise<CancelOrderResponse>
Was this helpful?
Yes
No