cancelExchange - Order Module Reference

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

This method cancels an exchange.

Example#

Code
1const exchange = await orderModuleService.cancelExchange({2  exchange_id: "123"3})

The cancelation details.

sharedContextContextOptional

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

PromisePromise<OrderExchangeDTO>

The canceled order exchange.

Was this page helpful?