retrieveProductTag - Product Module Reference

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

Example#

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

Code
const tag = await productModuleService.retrieveProductTag("ptag_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 tag = await productModuleService.retrieveProductTag(2  "ptag_123",3  {4    relations: ["products"],5  }6)

Parameters#

tagIdstring

The ID of the tag to retrieve.

configFindConfig<ProductTagDTO>Optional

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

sharedContextContextOptional

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

Returns#

PromisePromise<ProductTagDTO>

The retrieved product tag.