retrieveProduct - Product Module Reference

This documentation provides a reference to the retrieveProduct 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 by its ID

Example#

A simple example that retrieves a product by its ID:

Code
1const product =2  await productModuleService.retrieveProduct("prod_123")

To specify relations that should be retrieved:

Note: You can only retrieve data models defined in the same module. To retrieve linked data models from other modules, use Query instead.

Code
1const product = await productModuleService.retrieveProduct(2  "prod_123",3  {4    relations: ["categories"],5  }6)

Parameters#

productIdstring

The ID of the product to retrieve.

configFindConfig<ProductDTO>Optional

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

sharedContextContextOptional

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

Returns#

PromisePromise<ProductDTO>

The retrieved product.