cancelOrderChange - Order Module Reference

This documentation provides a reference to the cancelOrderChange 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.

cancelOrderChange(orderId, sharedContext?): Promise<void>#

This method cancels an order's change.

Code
await orderModuleService.cancelOrderChange("123")

orderIdstring

The order's ID.

sharedContextContextOptional

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

PromisePromise<void>

Resolves when the order's change is canceled successfully.

This method cancels orders' changes.

Code
await orderModuleService.cancelOrderChange(["123", "321"])

orderIdstring[]

The orders IDs.

sharedContextContextOptional

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

PromisePromise<void>

Resolves when the orders' changes are canceled successfully.

This method cancels an order's change, providing cancelation details.

Code
1await orderModuleService.cancelOrderChange({2  id: "123",3  canceled_by: "user_123"4})

The cancelation details of the order's change.

sharedContextContextOptional

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

PromisePromise<void>

Resolves when the order's change is canceled successfully.

This method cancels orders' changes, providing cancelation details.

Code
1await orderModuleService.cancelOrderChange([{2  id: "123",3  canceled_by: "user_123"4}])

The cancelation details of the orders' changes.

sharedContextContextOptional

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

PromisePromise<void>

Resolves when the orders' changes are canceled successfully.

Was this page helpful?