Get Started
Product
Resources
Tools & SDKs
Framework
Reference

softDeleteOrders - Order Module Reference

This documentation provides a reference to the softDeleteOrders 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 soft deletes orders by their IDs.

Example#

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

Parameters#

orderIdsstring[]

The list of order IDs.

configSoftDeleteReturn<TReturnableLinkableKeys>Optional

An object that is used to specify an entity's related entities that should be soft-deleted when the main entity is soft-deleted.

sharedContextContextOptional

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

Returns#

PromisePromise<void | Record<string, string[]>>

An object that includes the IDs of related records that were also soft deleted, such as the ID of the associated items. The object's keys are the ID attribute names of the order entity's relations, such as item_id, and its value is an array of strings, each being the ID of a record associated with the order through this relation, such as the IDs of associated item. If there are no related records, the promise resolves to void.

Was this page helpful?