listPriceLists - Pricing Module Reference

Beta

This documentation provides a reference to the listPriceLists method. This belongs to the Pricing Module.

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

Example

To retrieve a list of price lists using their IDs:

import {
  initialize as initializePricingModule,
} from "@medusajs/pricing"

async function listPriceLists (priceListIds: string[]) {
  const pricingService = await initializePricingModule()

  const priceLists = await pricingService.listPriceLists(
    {
      id: priceListIds
    },
  )

  // do something with the price lists or return them
}

To specify relations that should be retrieved within the price lists:

import {
  initialize as initializePricingModule,
} from "@medusajs/pricing"

async function listPriceLists (priceListIds: string[]) {
  const pricingService = await initializePricingModule()

  const priceLists = await pricingService.listPriceLists(
    {
      id: priceListIds
    },
    {
      relations: ["price_set_money_amounts"]
    }
  )

  // do something with the price lists 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 initializePricingModule,
} from "@medusajs/pricing"

async function listPriceLists (priceListIds: string[], skip: number, take: number) {
  const pricingService = await initializePricingModule()

  const priceLists = await pricingService.listPriceLists(
    {
      id: priceListIds
    },
    {
      relations: ["price_set_money_amounts"],
      skip,
      take
    }
  )

  // do something with the price lists 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 initializePricingModule,
} from "@medusajs/pricing"

async function listPriceLists (priceListIds: string[], titles: string[], skip: number, take: number) {
  const pricingService = await initializePricingModule()

  const priceLists = await pricingService.listPriceLists(
    {
      $and: [
        {
          id: priceListIds
        },
        {
          title: titles
        }
      ]
    },
    {
      relations: ["price_set_money_amounts"],
      skip,
      take
    }
  )

  // do something with the price lists or return them
}

Parameters

filtersFilterablePriceListProps

The filters to apply on the retrieved price lists.

configFindConfig<PriceListDTO>

The configurations determining how the price lists are retrieved. Its properties, such as select or relations, accept the attributes or relations associated with a price list.

sharedContextContext

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

Returns

PromisePromise<PriceListDTO[]>Required

The list of price lists.