listAndCount - Stock Location Module Reference
This documentation provides a reference to the listAndCount
method. This belongs to the Stock Location Module.
This method is used to retrieve a paginated list of stock locations along with the total count of available stock locations satisfying the provided filters.
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, count] = await stockLocationModule.listAndCount({
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, count] = await stockLocationModule.listAndCount({
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, count] = await stockLocationModule.listAndCount({
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.
config
FindConfig<StockLocationDTO>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.
config
FindConfig<StockLocationDTO>select
or relations
, accept the
attributes or relations associated with a stock location.context
SharedContextA context used to share resources, such as transaction manager, between the application and the module.
context
SharedContextReturns
The list of stock locations along with the total count.
Was this section helpful?