# Stores ## 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) ``` ## Create Stores `stores.create_stores(StoreCreateStoresParams**kwargs) -> StoreCreateStoresResponse` **post** `/api/v2/public/stores` Creates or updates stores. ### Parameters - `flush: Optional[bool]` When true, removes existing stores before inserting. - `stores: Optional[Iterable[Store]]` The list of stores to create or update. - `is_active: bool` - `is_active_data_exchange: bool` - `is_warehouse: bool` - `store_name: str` Display name of the store. - `store_number: str` Unique store number identifier. - `address: Optional[str]` - `area_description: Optional[str]` - `area_id: Optional[str]` - `area_manager_user_id: Optional[int]` - `city: Optional[str]` - `contact_details: Optional[str]` - `cost_center: Optional[str]` - `country_code: Optional[str]` - `country_name: Optional[str]` - `esl_server_path: Optional[str]` - `free_fields: Optional[Iterable[StoreFreeField]]` - `key: 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[Iterable[StoreOpeningHour]]` - `key: Optional[str]` - `sort_order: Optional[int]` - `value: Optional[str]` - `ordering_schema: Optional[Iterable[StoreOrderingSchema]]` - `day: int` - `delivery_offset: int` - `time: Union[str, datetime]` - `category_code: Optional[str]` - `ordering_offset: Optional[int]` - `week_numbers: Optional[str]` - `phone_number: Optional[str]` - `postal_code: Optional[str]` - `price_line_id: Optional[int]` - `store_gln: Optional[str]` - `store_next_delivery_datetime: Optional[Union[str, datetime, null]]` - `store_next_ordering_datetime: Optional[Union[str, datetime, null]]` - `store_printers: Optional[Iterable[StoreStorePrinter]]` - `is_bluetooth: bool` - `printer_ip: Optional[str]` - `printer_name: Optional[str]` - `printer_serial: Optional[str]` - `printer_type: Optional[int]` - `vendor: Optional[str]` - `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]` ### Returns - `class StoreCreateStoresResponse: …` Standard success response returned by mutation endpoints. - `data: Optional[str]` Optional data payload returned by the operation. - `message: Optional[str]` Human-readable message describing the result. - `success: Optional[bool]` Indicates whether the operation completed successfully. ### 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.create_stores() print(response.data) ```