## List Stores

`stores.list_stores(StoreListStoresParams**kwargs)  -> StoreListStoresResponse`

**get** `/api/v2/public/stores`

Retrieves a paginated list of stores.

### Parameters

- `is_warehouse: Optional[bool]`

  When set, filters stores by warehouse status.

- `page_size: Optional[str]`

  The number of items per page.

- `page_start: Optional[str]`

  The starting page index for pagination.

- `search_text: Optional[str]`

  Optional text to search stores by name or number.

- `secondary_key: Optional[str]`

  Optional secondary search key (max 500 characters).

### Returns

- `class StoreListStoresResponse: …`

  Generic paginated response wrapper.

  - `list: List[List]`

    Collection of items for the current page.

    - `store_name: str`

      Display name of the store.

    - `store_no: str`

      Unique store number.

    - `id: Optional[int]`

      Internal store identifier.

    - `area_description: Optional[str]`

      Description of the area.

    - `area_id: Optional[str]`

      Area identifier the store belongs to.

    - `country_code: Optional[str]`

      ISO country code.

    - `invent_location: Optional[str]`

      Inventory location code.

    - `is_warhouse: Optional[bool]`

      Indicates whether this store is a warehouse.

    - `last_order_line_exported_on: Optional[datetime]`

      Date/time of the last exported order line.

    - `legal_entity: Optional[str]`

      Legal entity the store belongs to.

    - `store_stock_pool1: Optional[str]`

      Name of stock pool 1.

    - `store_stock_pool10: Optional[str]`

      Name of stock pool 10.

    - `store_stock_pool2: Optional[str]`

      Name of stock pool 2.

    - `store_stock_pool3: Optional[str]`

      Name of stock pool 3.

    - `store_stock_pool4: Optional[str]`

      Name of stock pool 4.

    - `store_stock_pool5: Optional[str]`

      Name of stock pool 5.

    - `store_stock_pool6: Optional[str]`

      Name of stock pool 6.

    - `store_stock_pool7: Optional[str]`

      Name of stock pool 7.

    - `store_stock_pool8: Optional[str]`

      Name of stock pool 8.

    - `store_stock_pool9: Optional[str]`

      Name of stock pool 9.

  - `list_body: Optional[Dict[str, Optional[object]]]`

    Additional body-level metadata for the list.

  - `list_filters: Optional[Dict[str, Optional[List[str]]]]`

    Active filter criteria applied to the result set, keyed by field name.

  - `next_page: Optional[int]`

    Next page number, or null when on the last page.

  - `page_size: Optional[int]`

    Maximum number of items returned per page.

  - `page_start: Optional[int]`

    Current page number (1-based).

  - `previous_page: Optional[int]`

    Previous page number, or null when on the first page.

  - `project_last_modified_date: Optional[str]`

    Last modified date/time of the project.

  - `scroll_id: Optional[str]`

    Opaque scroll identifier for deep-pagination scenarios.

  - `server_time: Optional[str]`

    Server UTC date/time when the response was generated.

  - `sort_column: Optional[str]`

    Column name the results are sorted by.

  - `sort_order: Optional[str]`

    Sort direction.

  - `task_last_modified_date: Optional[str]`

    Last modified date/time of the task.

  - `total_count: Optional[int]`

    Total number of records matching the query across all pages.

### Example

```python
import os
from colleqtive_sdk import Colleqtive

client = Colleqtive(
    bearer_token=os.environ.get("COLLEQTIVE_BEARER_TOKEN"),  # This is the default and can be omitted
)
response = client.stores.list_stores()
print(response.scroll_id)
```