Retrieves a paginated list of stores.

stores.list_stores() -> StoreListStoresResponse

GET/api/v2/public/stores

ParametersExpand Collapse

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).

maxLength500

ReturnsExpand Collapse

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.

formatint64

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.

formatdate-time

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.

formatint32

page_size: Optional[int]

Maximum number of items returned per page.

formatint64

page_start: Optional[int]

Current page number (1-based).

formatint64

previous_page: Optional[int]

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

formatint64

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.

formatint64

Retrieves a paginated list of stores.

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)

{
  "list": [
    {
      "storeName": "Amsterdam Central",
      "storeNo": "STORE001",
      "id": 42,
      "areaDescription": "Netherlands West Region",
      "areaId": "AREA-NL-WEST",
      "countryCode": "NL",
      "inventLocation": "INV-001",
      "isWarhouse": false,
      "lastOrderLineExportedOn": "2019-12-27T18:11:19.117Z",
      "legalEntity": "Colleqtive BV",
      "storeStockPool1": "Shopfloor",
      "storeStockPool10": "storeStockPool10",
      "storeStockPool2": "Backroom",
      "storeStockPool3": "storeStockPool3",
      "storeStockPool4": "storeStockPool4",
      "storeStockPool5": "storeStockPool5",
      "storeStockPool6": "storeStockPool6",
      "storeStockPool7": "storeStockPool7",
      "storeStockPool8": "storeStockPool8",
      "storeStockPool9": "storeStockPool9"
    }
  ],
  "list_body": {
    "foo": "bar"
  },
  "list_filters": {
    "foo": [
      "string"
    ]
  },
  "next_page": 4,
  "page_size": 25,
  "page_start": 3,
  "previous_page": 2,
  "project_last_modified_date": "2025-06-10T08:00:00Z",
  "scroll_id": "DXF1ZXJ5QW5kRmV0Y2g",
  "server_time": "2025-06-15T14:30:00Z",
  "sort_column": "name",
  "sort_order": "asc",
  "task_last_modified_date": "2025-06-12T10:15:00Z",
  "total_count": 142
}

Returns Examples

{
  "list": [
    {
      "storeName": "Amsterdam Central",
      "storeNo": "STORE001",
      "id": 42,
      "areaDescription": "Netherlands West Region",
      "areaId": "AREA-NL-WEST",
      "countryCode": "NL",
      "inventLocation": "INV-001",
      "isWarhouse": false,
      "lastOrderLineExportedOn": "2019-12-27T18:11:19.117Z",
      "legalEntity": "Colleqtive BV",
      "storeStockPool1": "Shopfloor",
      "storeStockPool10": "storeStockPool10",
      "storeStockPool2": "Backroom",
      "storeStockPool3": "storeStockPool3",
      "storeStockPool4": "storeStockPool4",
      "storeStockPool5": "storeStockPool5",
      "storeStockPool6": "storeStockPool6",
      "storeStockPool7": "storeStockPool7",
      "storeStockPool8": "storeStockPool8",
      "storeStockPool9": "storeStockPool9"
    }
  ],
  "list_body": {
    "foo": "bar"
  },
  "list_filters": {
    "foo": [
      "string"
    ]
  },
  "next_page": 4,
  "page_size": 25,
  "page_start": 3,
  "previous_page": 2,
  "project_last_modified_date": "2025-06-10T08:00:00Z",
  "scroll_id": "DXF1ZXJ5QW5kRmV0Y2g",
  "server_time": "2025-06-15T14:30:00Z",
  "sort_column": "name",
  "sort_order": "asc",
  "task_last_modified_date": "2025-06-12T10:15:00Z",
  "total_count": 142
}