cancel - Order Module Reference

This documentation provides a reference to the cancel method. This belongs to the Order Module.

Note: You should only use this methods when implementing complex customizations. For common cases, check out available workflows instead.

cancel(orderId, sharedContext?): Promise<OrderDTO[]>#

This method sets the status of orders to canceled.

Code
const orders = await orderModuleService.cancel(["123", "321"])

orderIdstring[]

The orders' IDs.

sharedContextContextOptional

A context used to share resources, such as transaction manager, between the application and the module.

PromisePromise<OrderDTO[]>

The canceled orders.

This method sets the status of an order to canceled.

Code
const orders = await orderModuleService.cancel("123")

orderIdstring

The order's ID.

sharedContextContextOptional

A context used to share resources, such as transaction manager, between the application and the module.

PromisePromise<OrderDTO>

Represents the completion of an asynchronous operation

Was this page helpful?