softDelete - Inventory Next Module Reference

This documentation provides a reference to the softDelete method. This belongs to the Inventory Next Module.

This method soft deletes inventory items by their IDs.

Example

await inventoryModuleService.softDelete(
  ["iitem_123", "iitem_321"],
  {
    returnLinkableKeys: ["location_level"],
  }
)

Parameters

inventoryItemIdsstring[]Required

The inventory items' IDs.

configSoftDeleteReturn<TReturnableLinkableKeys>

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

sharedContextContext

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

Returns

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

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