restoreCarts - Cart Module Reference

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

Note: You should only use this methods when implementing complex customizations. For common cases, check out available workflows instead.

This method restores soft deleted carts by their IDs.

Example#

Code
await cartModuleService.restoreCarts(["cart_123", "cart_321"])

Parameters#

idsstring[]

The IDs of the carts.

configRestoreReturn<TReturnableLinkableKeys>Optional

Configurations determining which relations to restore along with each of the carts. You can pass to its returnLinkableKeys property any of the cart's relation attribute names, such as items.

sharedContextContextOptional

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

Returns#

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

An object that includes the IDs of related records that were restored, such as the ID of 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 the record associated with the cart through this relation, such as the IDs of associated line item. If there are no related records restored, the promise resolves to void.