listAndCountStockLocations - Stock Location Next Module Reference

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

Note: You should only use this methods when implementing complex customizations. For common cases, check out available workflows instead.

This method retrieves 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:

Code
1const [stockLocations, count] =2  await stockLocationModuleService.listandCountStockLocations({3    id: ["sloc_123", "sloc_321"],4  })

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

Code
1const [stockLocations, count] =2  await stockLocationModuleService.listandCountStockLocations(3    {4      id: ["sloc_123", "sloc_321"],5    },6    {7      relations: ["address"],8    }9  )

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

Code
1const [stockLocations, count] =2  await stockLocationModuleService.listandCountStockLocations(3    {4      id: ["sloc_123", "sloc_321"],5    },6    {7      relations: ["address"],8      take: 20,9      skip: 2,10    }11  )

Parameters#

selectorFilterableStockLocationProps

The filters to apply on the retrieved stock locations.

configFindConfig<StockLocationDTO>Optional

The configurations determining how the stock location is retrieved. Its properties, such as select or relations, accept the attributes or relations associated with a stock location.

contextContextOptional

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

Returns#

PromisePromise<[StockLocationDTO[], number]>

The list of stock locations along with their total count.

Was this page helpful?