Skip to main content

cancelOrder

Cancel an order, update payment and shipment status, and restock inventory.

Import​

import { cancelOrder } from "@evershop/evershop/oms/services";

Syntax​

cancelOrder(uuid: string, reason?: string): Promise<void>

Parameters​

uuid

Type: string

Order UUID.

reason (optional)

Type: string

Cancellation reason.

Return Value​

Returns Promise<void>.

Examples​

import { cancelOrder } from "@evershop/evershop/oms/services";

await cancelOrder('order-uuid-123', 'Customer requested cancellation');

See Also​