listVariants - Product Module Reference

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

This method is used to retrieve a paginated list of product variants based on optional filters and configuration.

Example

To retrieve a list of product variants using their IDs:

const variants = await productModuleService.listVariants({
  id: ["variant_123", "variant_321"],
})

To specify relations that should be retrieved within the product variants:

const variants = await productModuleService.listVariants(
  {
    id: ["variant_123", "variant_321"],
  },
  {
    relations: ["options"],
  }
)

By default, only the first 15 records are retrieved. You can control pagination by specifying the skip and take properties of the config parameter:

const variants = await productModuleService.listVariants(
  {
    id: ["variant_123", "variant_321"],
  },
  {
    relations: ["options"],
    take: 20,
    skip: 2,
  }
)

Parameters

filtersFilterableProductVariantProps

The filters applied on the retrieved product variants.

configFindConfig<ProductVariantDTO>

The configurations determining how the product variants are retrieved. Its properties, such as select or relations, accept the attributes or relations associated with a product variant.

sharedContextContext

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

Returns

PromisePromise<ProductVariantDTO[]>Required

The list of product variants.