## Retrieves a paginated list of stores. `stores.list_stores(StoreListStoresParams**kwargs) -> StoreListStoresResponse` **get** `/api/v2/public/stores` Retrieves a paginated list of stores. ### Parameters - `is_warehouse: Optional[bool]` - `page_size: Optional[str]` - `page_start: Optional[str]` - `search_text: Optional[str]` - `secondary_key: Optional[str]` ### Returns - `class StoreListStoresResponse: …` Generic paginated response wrapper. - `page_size: int` Maximum number of items returned per page. - `page_start: int` Current page number (1-based). - `total_count: int` Total number of records matching the query across all pages. - `list: Optional[List[List]]` Collection of items for the current page. - `id: int` Internal store identifier. - `is_active: bool` Whether the store is active. - `is_active_data_exchange: bool` Whether data exchange is active for this store. - `is_warehouse: bool` Whether the store is a warehouse. - `area_description: Optional[str]` Description of the area. - `area_id: Optional[str]` Area identifier the store belongs to. - `area_manager_user_id: Optional[int]` - `city: Optional[str]` City the store is located in. - `cost_center: Optional[str]` - `country_code: Optional[str]` ISO country code. - `country_name: Optional[str]` Country name. - `esl_server_path: Optional[str]` - `free_fields: Optional[List[ListFreeField]]` - `label: Optional[str]` - `sort_order: Optional[int]` - `value: Optional[str]` - `ip_range_begin: Optional[str]` - `ip_range_end: Optional[str]` - `local_server_path: Optional[str]` - `opening_hours: Optional[str]` - `ordering_schema: Optional[List[ListOrderingSchema]]` - `day: int` - `delivery_offset: int` - `ordering_offset: int` - `time: str` - `category_code: Optional[str]` - `week_numbers: Optional[str]` - `phone_number: Optional[str]` - `price_line_id: Optional[int]` Price line applied to the store. - `printers: Optional[List[ListPrinter]]` - `is_bluetooth: bool` - `printer_ip: Optional[str]` - `printer_name: Optional[str]` - `printer_type: Optional[int]` - `secondary_key: Optional[str]` - `store_gln: Optional[str]` - `store_name: Optional[str]` Display name of the store. - `store_next_delivery_datetime: Optional[datetime]` - `store_next_ordering_datetime: Optional[datetime]` - `store_number: Optional[str]` Unique store number. - `store_stock_pool_1: Optional[str]` - `store_stock_pool_10: Optional[str]` - `store_stock_pool_2: Optional[str]` - `store_stock_pool_3: Optional[str]` - `store_stock_pool_4: Optional[str]` - `store_stock_pool_5: Optional[str]` - `store_stock_pool_6: Optional[str]` - `store_stock_pool_7: Optional[str]` - `store_stock_pool_8: Optional[str]` - `store_stock_pool_9: Optional[str]` - `store_type_code: Optional[str]` - `store_type_description: Optional[str]` - `tertiary_key: Optional[str]` - `warehouse_id: Optional[str]` - `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. - `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 (asc or desc). - `task_last_modified_date: Optional[str]` Last modified date/time of the task. ### 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) ``` #### Response ```json { "page_size": 0, "page_start": 0, "total_count": 0, "list": [ { "id": 0, "is_active": true, "is_active_data_exchange": true, "is_warehouse": true, "area_description": "area_description", "area_id": "area_id", "area_manager_user_id": 0, "city": "city", "cost_center": "cost_center", "country_code": "country_code", "country_name": "country_name", "esl_server_path": "esl_server_path", "free_fields": [ { "label": "label", "sort_order": 0, "value": "value" } ], "ip_range_begin": "ip_range_begin", "ip_range_end": "ip_range_end", "local_server_path": "local_server_path", "opening_hours": "opening_hours", "ordering_schema": [ { "day": 0, "delivery_offset": 0, "ordering_offset": 0, "time": "time", "category_code": "category_code", "week_numbers": "week_numbers" } ], "phone_number": "phone_number", "price_line_id": 0, "printers": [ { "is_bluetooth": true, "printer_ip": "printer_ip", "printer_name": "printer_name", "printer_type": 0 } ], "secondary_key": "secondary_key", "store_gln": "store_gln", "store_name": "store_name", "store_next_delivery_datetime": "2019-12-27T18:11:19.117Z", "store_next_ordering_datetime": "2019-12-27T18:11:19.117Z", "store_number": "store_number", "store_stock_pool_1": "store_stock_pool_1", "store_stock_pool_10": "store_stock_pool_10", "store_stock_pool_2": "store_stock_pool_2", "store_stock_pool_3": "store_stock_pool_3", "store_stock_pool_4": "store_stock_pool_4", "store_stock_pool_5": "store_stock_pool_5", "store_stock_pool_6": "store_stock_pool_6", "store_stock_pool_7": "store_stock_pool_7", "store_stock_pool_8": "store_stock_pool_8", "store_stock_pool_9": "store_stock_pool_9", "store_type_code": "store_type_code", "store_type_description": "store_type_description", "tertiary_key": "tertiary_key", "warehouse_id": "warehouse_id" } ], "list_body": { "foo": "bar" }, "list_filters": { "foo": [ "string" ] }, "next_page": 0, "previous_page": 0, "project_last_modified_date": "project_last_modified_date", "scroll_id": "scroll_id", "server_time": "server_time", "sort_column": "sort_column", "sort_order": "sort_order", "task_last_modified_date": "task_last_modified_date" } ```