Get Started
Product
Resources
Tools & SDKs
Framework
Reference

softDeleteOrderClaims - Order Module Reference

This documentation provides a reference to the softDeleteOrderClaims 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 order claims by their IDs.

Example#

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

Parameters#

idsstring[]

The IDs of the order claims.

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. The object's keys are the ID attribute names of the order claim entity's relations, and its value is an array of strings, each being the ID of a record associated with the order claim through this relation. If there are no related records, the promise resolves to void.

Was this page helpful?