retrieveType - Product Module Reference

Beta

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

This method is used to retrieve a product type by its ID.

Example

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

import { 
  initialize as initializeProductModule,
} from "@medusajs/product"

async function retrieveProductType (id: string) {
  const productModule = await initializeProductModule()

  const productType = await productModule.retrieveType(id)

  // do something with the product type or return it
}

To specify attributes that should be retrieved:

import { 
  initialize as initializeProductModule,
} from "@medusajs/product"

async function retrieveProductType (id: string) {
  const productModule = await initializeProductModule()

  const productType = await productModule.retrieveType(id, {
    select: ["value"]
  })

  // do something with the product type or return it
}

Parameters

typeIdstringRequired

The ID of the product type to retrieve.

configFindConfig<ProductTypeDTO>

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

sharedContextContext

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

Returns

PromisePromise<ProductTypeDTO>Required

The retrieved product type.