retrieveProductVariant - Product Module Reference

This documentation provides a reference to the retrieveProductVariant 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 product variant by its ID.

Example#

A simple example that retrieves a product variant by its ID:

Code
1const variant =2  await productModuleService.retrieveProductVariant("variant_123")

To specify relations that should be retrieved:

Code
1const variant = await productModuleService.retrieveProductVariant(2  "variant_123",3  {4    relations: ["options"],5  }6)

Parameters#

productVariantIdstring

The ID of the product variant to retrieve.

configFindConfig<ProductVariantDTO>Optional

The configurations determining how the product variant is 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>

The retrieved product variant.

Was this page helpful?