listAndCountProductVariants - Product Module Reference

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

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

This method is used to retrieve a paginated list of product variants along with the total count of available product variants satisfying the provided filters.

Example#

To retrieve a list of product variants using their IDs:

Code
1const [variants, count] =2  await productModuleService.listAndCountProductVariants({3    id: ["variant_123", "variant_321"],4  })

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

Code
1const [variants, count] =2  await productModuleService.listAndCountProductVariants(3    {4      id: ["variant_123", "variant_321"],5    },6    {7      relations: ["options"],8    }9  )

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

Code
1const [variants, count] =2  await productModuleService.listAndCountProductVariants(3    {4      id: ["variant_123", "variant_321"],5    },6    {7      relations: ["options"],8      take: 20,9      skip: 2,10    }11  )

Parameters#

filtersFilterableProductVariantPropsOptional

The filters applied on the retrieved product variants.

configFindConfig<ProductVariantDTO>Optional

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.

sharedContextContextOptional

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

Returns#

PromisePromise<[ProductVariantDTO[], number]>

The list of product variants along with their total count.

Was this page helpful?