restoreVariants - Product Module Reference

Beta

This documentation provides a reference to the restoreVariants method. This belongs to the Product Module.

This method is used to restore product varaints that were soft deleted. Product variants are soft deleted when they're not provided in a product's details passed to the update method.

Example

import {
  initialize as initializeProductModule,
} from "@medusajs/product"

async function restoreProductVariants (ids: string[]) {
  const productModule = await initializeProductModule()

  await productModule.restoreVariants(ids)
}

Type Parameters

TReturnableLinkableKeysstringRequired

Parameters

variantIdsstring[]Required

The IDs of the variants to restore.

configRestoreReturn<TReturnableLinkableKeys>

Configurations determining which relations to restore along with each of the product variants. You can pass to its returnLinkableKeys property any of the product variant's relation attribute names.

sharedContextContext

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

Returns

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

An object that includes the IDs of related records that were restored. The object's keys are the ID attribute names of the product variant entity's relations and its value is an array of strings, each being the ID of the record associated with the product variant through this relation. If there are no related records that were restored, the promise resolved to void.