restoreLineItems - Cart Module Reference
This documentation provides a reference to the restoreLineItems
method. This belongs to the Cart Module.
This method restores soft deleted line items by their IDs.
Example
Parameters
ids
string[]RequiredThe IDs of the line items.
config
RestoreReturn<TReturnableLinkableKeys>Configurations determining which relations to restore along with each of the line items. You can pass to its returnLinkableKeys
property any of the line item's relation attribute names, such as tax_lines
.
config
RestoreReturn<TReturnableLinkableKeys>returnLinkableKeys
property any of the line item's relation attribute names, such as tax_lines
.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 tax line.
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 the record associated with the line item through this relation,
such as the IDs of associated tax line.
If there are no related records restored, the promise resolves to void
.
Promise
Promise<void | Record<TReturnableLinkableKeys, string[]>>Requiredtax_line_id
,
and its value is an array of strings, each being the ID of the record associated with the line item through this relation,
such as the IDs of associated tax line.
If there are no related records restored, the promise resolves to void
.Was this section helpful?