Skip to main content
Skip to main content

cancelOrderChange - Order Module Reference

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

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

This method Represents the completion of an asynchronous operation

Example

await orderModuleService.cancelOrderChange("orderId123");

Parameters

orderIdstringRequired
The order's ID.
sharedContextContext
A context used to share resources, such as transaction manager, between the application and the module.

Returns

PromisePromise<void>Required
Resolves when {summary}

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

This method Represents the completion of an asynchronous operation

Example

await orderModuleService.cancelOrderChange(["1234ABCD"]);

Parameters

orderIdstring[]Required
The order's ID.
sharedContextContext
A context used to share resources, such as transaction manager, between the application and the module.

Returns

PromisePromise<void>Required
Resolves when {summary}

cancelOrderChange(data, sharedContext?): Promise<void>

This method Represents the completion of an asynchronous operation

Example

const cancelOrderChangeData: CancelOrderChangeDTO = {
id: "orderChangeId",
};

await orderModuleService.cancelOrderChange(cancelOrderChangeData);

Parameters

The cancel order change details.
sharedContextContext
A context used to share resources, such as transaction manager, between the application and the module.

Returns

PromisePromise<void>Required
Resolves when {summary}

cancelOrderChange(data, sharedContext?): Promise<void>

This method Represents the completion of an asynchronous operation

Example

await orderModuleService.cancelOrderChange([{ id: "orderChangeId" }]);

Parameters

dataCancelOrderChangeDTO[]Required
The cancel order change details.
sharedContextContext
A context used to share resources, such as transaction manager, between the application and the module.

Returns

PromisePromise<void>Required
Resolves when {summary}
Was this section helpful?