softDeleteLineItems - Cart Module Reference

This documentation provides a reference to the softDeleteLineItems method. This belongs to the Cart Module.

This method soft deletes line items by their IDs.

Example

await cartModuleService.softDeleteLineItems([
  "cali_123",
  "cali_321",
])

Parameters

idsstring[]Required

The IDs of the line items.

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<TReturnableLinkableKeys, string[]>>Required

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