restore - Cart Module Reference
This documentation provides a reference to the restore
method. This belongs to the Cart Module.
This method restores soft deleted carts by their IDs.
Example
Parameters
ids
string[]RequiredThe IDs of the carts.
config
RestoreReturn<TReturnableLinkableKeys>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
.
config
RestoreReturn<TReturnableLinkableKeys>returnLinkableKeys
property any of the cart's relation attribute names, such as items
.Returns
Promise
Promise<void | Record<TReturnableLinkableKeys, string[]>>RequiredAn 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
.
Promise
Promise<void | Record<TReturnableLinkableKeys, string[]>>Requireditem_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
.Was this section helpful?