listCollections - Product Module Reference

Beta

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

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

Example

To retrieve a list of product collections using their IDs:

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

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

  const collections = await productModule.listCollections({
    id: ids
  })

  // do something with the product collections or return them
}

To specify relations that should be retrieved within the product collections:

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

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

  const collections = await productModule.listCollections({
    id: ids
  }, {
    relations: ["products"]
  })

  // do something with the product collections 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:

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

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

  const collections = await productModule.listCollections({
    id: ids
  }, {
    relations: ["products"],
    skip,
    take
  })

  // do something with the product collections 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:

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

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

  const collections = await productModule.listCollections({
    $and: [
      {
        id: ids
      },
      {
        title
      }
    ]
  }, {
    relations: ["products"],
    skip,
    take
  })

  // do something with the product collections or return them
}

Parameters

filtersFilterableProductCollectionProps

The filters applied on the retrieved product collections.

configFindConfig<ProductCollectionDTO>

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

sharedContextContext

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

Returns

PromisePromise<ProductCollectionDTO[]>Required

The list of product collections.