Retrieves a paginated list of stores.

GET/api/v2/public/stores

Query ParametersExpand Collapse

is_warehouse: optional boolean

When set, filters stores by warehouse status.

page_size: optional string

The number of items per page.

page_start: optional string

The starting page index for pagination.

search_text: optional string

Optional text to search stores by name or number.

secondary_key: optional string

Optional secondary search key (max 500 characters).

maxLength500

ReturnsExpand Collapse

list: array of object { storeName, storeNo, id, 17 more }

Collection of items for the current page.

storeName: string

Display name of the store.

storeNo: string

Unique store number.

id: optional number

Internal store identifier.

formatint64

areaDescription: optional string

Description of the area.

areaId: optional string

Area identifier the store belongs to.

countryCode: optional string

ISO country code.

inventLocation: optional string

Inventory location code.

isWarhouse: optional boolean

Indicates whether this store is a warehouse.

lastOrderLineExportedOn: optional string

Date/time of the last exported order line.

formatdate-time

legalEntity: optional string

Legal entity the store belongs to.

storeStockPool1: optional string

Name of stock pool 1.

storeStockPool10: optional string

Name of stock pool 10.

storeStockPool2: optional string

Name of stock pool 2.

storeStockPool3: optional string

Name of stock pool 3.

storeStockPool4: optional string

Name of stock pool 4.

storeStockPool5: optional string

Name of stock pool 5.

storeStockPool6: optional string

Name of stock pool 6.

storeStockPool7: optional string

Name of stock pool 7.

storeStockPool8: optional string

Name of stock pool 8.

storeStockPool9: optional string

Name of stock pool 9.

list_body: optional map[unknown]

Additional body-level metadata for the list.

list_filters: optional map[array of string]

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

next_page: optional number

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

formatint32

page_size: optional number

Maximum number of items returned per page.

formatint64

page_start: optional number

Current page number (1-based).

formatint64

previous_page: optional number

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

formatint64

project_last_modified_date: optional string

Last modified date/time of the project.

scroll_id: optional string

Opaque scroll identifier for deep-pagination scenarios.

server_time: optional string

Server UTC date/time when the response was generated.

sort_column: optional string

Column name the results are sorted by.

sort_order: optional string

Sort direction.

task_last_modified_date: optional string

Last modified date/time of the task.

total_count: optional number

Total number of records matching the query across all pages.

formatint64

Retrieves a paginated list of stores.

curl https://api.colleqtive.net/api/v2/public/stores \
    -H "Authorization: $COLLEQTIVE_BEARER_TOKEN"

{
  "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
}