retrieveTag - Product Module Reference

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

This method is used to retrieve a tag by its ID.

Example

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

const tag = await productModuleService.retrieveTag("ptag_123")

To specify relations that should be retrieved:

const tag = await productModuleService.retrieveTag(
  "ptag_123",
  {
    relations: ["products"],
  }
)

Parameters

tagIdstringRequired

The ID of the tag to retrieve.

configFindConfig<ProductTagDTO>

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.

sharedContextContext

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

Returns

PromisePromise<ProductTagDTO>Required

The retrieved product tag.