softDelete - Cart Module Reference
This documentation provides a reference to the softDelete
method. This belongs to the Cart Module.
This method soft deletes carts by their IDs.
Example
Parameters
ids
string[]RequiredThe IDs of the carts.
config
SoftDeleteReturn<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.
config
SoftDeleteReturn<TReturnableLinkableKeys>Returns
Promise
Promise<void | Record<TReturnableLinkableKeys, string[]>>RequiredAn object that includes the IDs of related records that were also soft deleted, such as the ID of the associated line item.
The object's keys are the ID attribute names of the cart 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 cart through this relation, such as the IDs of associated line item.
If there are no related records, the promise resolves to void
.
Promise
Promise<void | Record<TReturnableLinkableKeys, string[]>>Requireditem_id
, and its value is an array of strings, each being the ID of a record associated
with the cart through this relation, such as the IDs of associated line item.
If there are no related records, the promise resolves to void
.Was this section helpful?