---
displayed_sidebar: productReference
badge:
  variant: orange
  text: Beta
slug: /references/product/listTypes
sidebar_label: listTypes
---

import ParameterTypes from "@site/src/components/ParameterTypes"

# listTypes - Product Module Reference

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

This method is used to retrieve a paginated list of product types based on optional filters and configuration.

## Example

To retrieve a list of product types using their IDs:

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

async function retrieveProductTypes (ids: string[]) {
  const productModule = await initializeProductModule()

  const productTypes = await productModule.listTypes({
    id: ids
  })

  // do something with the product types or return them
}
```

To specify attributes that should be retrieved within the product types:

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

async function retrieveProductTypes (ids: string[]) {
  const productModule = await initializeProductModule()

  const productTypes = await productModule.listTypes({
    id: ids
  }, {
    select: ["value"]
  })

  // do something with the product types or return them
}
```

By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:

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

async function retrieveProductTypes (ids: string[], skip: number, take: number) {
  const productModule = await initializeProductModule()

  const productTypes = await productModule.listTypes({
    id: ids
  }, {
    select: ["value"],
    skip,
    take
  })

  // do something with the product types or return them
}
```

You can also use the `$and` or `$or` properties of the `filter` parameter to use and/or conditions in your filters. For example:

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

async function retrieveProductTypes (ids: string[], value: string, skip: number, take: number) {
  const productModule = await initializeProductModule()

  const productTypes = await productModule.listTypes({
    $and: [
      {
        id: ids
      },
      {
        value
      }
    ]
  }, {
    select: ["value"],
    skip,
    take
  })

  // do something with the product types or return them
}
```

## Parameters

<ParameterTypes parameters={[
  {
    "name": "filters",
    "type": "[FilterableProductTypeProps](../../product/interfaces/product.FilterableProductTypeProps.mdx)",
    "description": "The filters to apply on the retrieved product types.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": [
      {
        "name": "$and",
        "type": "([FilterableProductTypeProps](../../product/interfaces/product.FilterableProductTypeProps.mdx) \\| [BaseFilterable](../../product/interfaces/product.BaseFilterable.mdx)&#60;[FilterableProductTypeProps](../../product/interfaces/product.FilterableProductTypeProps.mdx)&#62;)[]",
        "description": "An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "$or",
        "type": "([FilterableProductTypeProps](../../product/interfaces/product.FilterableProductTypeProps.mdx) \\| [BaseFilterable](../../product/interfaces/product.BaseFilterable.mdx)&#60;[FilterableProductTypeProps](../../product/interfaces/product.FilterableProductTypeProps.mdx)&#62;)[]",
        "description": "An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "id",
        "type": "`string` \\| `string`[]",
        "description": "The IDs to filter product types by.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "value",
        "type": "`string`",
        "description": "The value to filter product types by.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      }
    ]
  },
  {
    "name": "config",
    "type": "[FindConfig](../../product/interfaces/product.FindConfig.mdx)&#60;[ProductTypeDTO](../../product/interfaces/product.ProductTypeDTO.mdx)&#62;",
    "description": "The configurations determining how the product types are retrieved. Its properties, such as `select` or `relations`, accept the\nattributes or relations associated with a product type.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": [
      {
        "name": "order",
        "type": "`object`",
        "description": "An object used to specify how to sort the returned records. Its keys are the names of attributes of the entity, and a key's value can either be `ASC`\nto sort retrieved records in an ascending order, or `DESC` to sort retrieved records in a descending order.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "relations",
        "type": "`string`[]",
        "description": "An array of strings, each being relation names of the entity to retrieve in the result.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "select",
        "type": "(`string` \\| keyof `Entity`)[]",
        "description": "An array of strings, each being attribute names of the entity to retrieve in the result.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "skip",
        "type": "`null` \\| `number`",
        "description": "A number indicating the number of records to skip before retrieving the results.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "take",
        "type": "`null` \\| `number`",
        "description": "A number indicating the number of records to return in the result.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "withDeleted",
        "type": "`boolean`",
        "description": "A boolean indicating whether deleted records should also be retrieved as part of the result. This only works if the entity extends the\n`SoftDeletableEntity` class.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      }
    ]
  },
  {
    "name": "sharedContext",
    "type": "[Context](../../product/interfaces/product.Context.mdx)",
    "description": "A context used to share resources, such as transaction manager, between the application and the module.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": [
      {
        "name": "enableNestedTransactions",
        "type": "`boolean`",
        "description": "A boolean value indicating whether nested transactions are enabled.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "isolationLevel",
        "type": "`string`",
        "description": "A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "manager",
        "type": "`TManager`",
        "description": "An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "transactionId",
        "type": "`string`",
        "description": "A string indicating the ID of the current transaction.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "transactionManager",
        "type": "`TManager`",
        "description": "An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      }
    ]
  }
]} />

## Returns

<ParameterTypes parameters={[
  {
    "name": "Promise",
    "type": "Promise&#60;[ProductTypeDTO](../../product/interfaces/product.ProductTypeDTO.mdx)[]&#62;",
    "optional": false,
    "defaultValue": "",
    "description": "The list of product types.",
    "expandable": false,
    "children": [
      {
        "name": "ProductTypeDTO[]",
        "type": "[ProductTypeDTO](../../product/interfaces/product.ProductTypeDTO.mdx)[]",
        "optional": false,
        "defaultValue": "",
        "description": "",
        "expandable": false,
        "children": [
          {
            "name": "ProductTypeDTO",
            "type": "`object`",
            "description": "A product type's data.",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          }
        ]
      }
    ]
  }
]} />
