Retrieves a paginated list of stores.

StoreListStoresResponse Stores.ListStores(, )

GET/api/v2/public/stores

ParametersExpand Collapse

StoreListStoresParams parameters

Boolean isWarehouse

When set, filters stores by warehouse status.

string pageSize

The number of items per page.

string pageStart

The starting page index for pagination.

string searchText

Optional text to search stores by name or number.

string secondaryKey

Optional secondary search key (max 500 characters).

maxLength500

ReturnsExpand Collapse

class StoreListStoresResponse:

Generic paginated response wrapper.

required IReadOnlyList<List> List

Collection of items for the current page.

required string StoreName

Display name of the store.

required string StoreNo

Unique store number.

Long ID

Internal store identifier.

formatint64

string? AreaDescription

Description of the area.

string? AreaID

Area identifier the store belongs to.

string? CountryCode

ISO country code.

string? InventLocation

Inventory location code.

Boolean IsWarhouse

Indicates whether this store is a warehouse.

DateTimeOffset? LastOrderLineExportedOn

Date/time of the last exported order line.

formatdate-time

string? LegalEntity

Legal entity the store belongs to.

string? StoreStockPool1

Name of stock pool 1.

string? StoreStockPool10

Name of stock pool 10.

string? StoreStockPool2

Name of stock pool 2.

string? StoreStockPool3

Name of stock pool 3.

string? StoreStockPool4

Name of stock pool 4.

string? StoreStockPool5

Name of stock pool 5.

string? StoreStockPool6

Name of stock pool 6.

string? StoreStockPool7

Name of stock pool 7.

string? StoreStockPool8

Name of stock pool 8.

string? StoreStockPool9

Name of stock pool 9.

IReadOnlyDictionary<string, JsonElement>? ListBody

Additional body-level metadata for the list.

IReadOnlyDictionary<string, IReadOnlyList<string>>? ListFilters

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

Int? NextPage

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

formatint32

Long PageSize

Maximum number of items returned per page.

formatint64

Long PageStart

Current page number (1-based).

formatint64

Long? PreviousPage

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

formatint64

string? ProjectLastModifiedDate

Last modified date/time of the project.

string? ScrollID

Opaque scroll identifier for deep-pagination scenarios.

string? ServerTime

Server UTC date/time when the response was generated.

string? SortColumn

Column name the results are sorted by.

string? SortOrder

Sort direction.

string? TaskLastModifiedDate

Last modified date/time of the task.

Long TotalCount

Total number of records matching the query across all pages.

formatint64

Retrieves a paginated list of stores.

StoreListStoresParams parameters = new();

var response = await client.Stores.ListStores(parameters);

Console.WriteLine(response);

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