Skip to main content
Skip to main content

list - Stock Location Module Reference

This documentation provides a reference to the list method. This belongs to the Stock Location Module.

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

Example

To retrieve a list of stock locations using their IDs:

import { 
initialize as initializeStockLocationModule,
} from "@medusajs/stock-location"

async function listStockLocations (ids: string[]) {
const stockLocationModule = await initializeStockLocationModule({})

const stockLocations = await stockLocationModule.list({
id: ids
})

// do something with the stock locations or return them
}

To specify relations that should be retrieved within the stock locations:

import { 
initialize as initializeStockLocationModule,
} from "@medusajs/stock-location"

async function listStockLocations (ids: string[]) {
const stockLocationModule = await initializeStockLocationModule({})

const stockLocations = await stockLocationModule.list({
id: ids
}, {
relations: ["address"]
})

// do something with the stock locations or return them
}

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

import { 
initialize as initializeStockLocationModule,
} from "@medusajs/stock-location"

async function listStockLocations (ids: string[], skip: number, take: number) {
const stockLocationModule = await initializeStockLocationModule({})

const stockLocations = await stockLocationModule.list({
id: ids
}, {
relations: ["address"],
skip,
take
})

// do something with the stock locations or return them
}

Parameters

The filters to apply on the retrieved stock locations.
The configurations determining how the stock locations are retrieved. Its properties, such as select or relations, accept the attributes or relations associated with a stock location.
A context used to share resources, such as transaction manager, between the application and the module.

Returns

PromisePromise<StockLocationDTO[]>Required
The list of stock locations.
Was this section helpful?