---
displayed_sidebar: stockLocationReference
slug: /references/stock-location/listAndCount
sidebar_label: listAndCount
---

import ParameterTypes from "@site/src/components/ParameterTypes"

# 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:

```ts
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:

```ts
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:

```ts
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

<ParameterTypes parameters={[
  {
    "name": "selector",
    "type": "[FilterableStockLocationProps](../../stock_location/interfaces/stock_location.FilterableStockLocationProps.mdx)",
    "description": "The filters to apply on the retrieved stock locations.",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": [
      {
        "name": "id",
        "type": "`string` \\| `string`[]",
        "description": "The IDs to filter stock locations by.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "name",
        "type": "`string` \\| `string`[] \\| [StringComparisonOperator](../../stock_location/interfaces/stock_location.StringComparisonOperator.mdx)",
        "description": "The names to filter stock locations by.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      }
    ]
  },
  {
    "name": "config",
    "type": "[FindConfig](../../stock_location/interfaces/stock_location.FindConfig.mdx)&#60;[StockLocationDTO](../../stock_location/types/stock_location.StockLocationDTO.mdx)&#62;",
    "description": "The configurations determining how the stock locations are retrieved. Its properties, such as `select` or `relations`, accept the\nattributes or relations associated with a stock location.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": [
      {
        "name": "order",
        "type": "`object`",
        "description": "An object used to specify how to sort the returned records. Its keys are the names of attributes of the entity, and a key's value can either be `ASC`\nto sort retrieved records in an ascending order, or `DESC` to sort retrieved records in a descending order.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "relations",
        "type": "`string`[]",
        "description": "An array of strings, each being relation names of the entity to retrieve in the result.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "select",
        "type": "(`string` \\| keyof `Entity`)[]",
        "description": "An array of strings, each being attribute names of the entity to retrieve in the result.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "skip",
        "type": "`null` \\| `number`",
        "description": "A number indicating the number of records to skip before retrieving the results.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "take",
        "type": "`null` \\| `number`",
        "description": "A number indicating the number of records to return in the result.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "withDeleted",
        "type": "`boolean`",
        "description": "A boolean indicating whether deleted records should also be retrieved as part of the result. This only works if the entity extends the\n`SoftDeletableEntity` class.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      }
    ]
  },
  {
    "name": "context",
    "type": "[SharedContext](../../stock_location/interfaces/stock_location.SharedContext.mdx)",
    "description": "A context used to share resources, such as transaction manager, between the application and the module.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": [
      {
        "name": "manager",
        "type": "`EntityManager`",
        "description": "An instance of an entity manager.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "transactionManager",
        "type": "`EntityManager`",
        "description": "An instance of a transaction manager.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      }
    ]
  }
]} />

## Returns

<ParameterTypes parameters={[
  {
    "name": "Promise",
    "type": "Promise&#60;[[StockLocationDTO](../../stock_location/types/stock_location.StockLocationDTO.mdx)[], number]&#62;",
    "optional": false,
    "defaultValue": "",
    "description": "The list of stock locations along with the total count.",
    "expandable": false,
    "children": [
      {
        "name": "StockLocationDTO[]",
        "type": "[StockLocationDTO](../../stock_location/types/stock_location.StockLocationDTO.mdx)[]",
        "optional": false,
        "defaultValue": "",
        "description": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "number",
        "type": "`number`",
        "optional": true,
        "defaultValue": "",
        "description": "",
        "expandable": false,
        "children": []
      }
    ]
  }
]} />
