## Retrieves a paginated list of stores.

`StoreListStoresResponse Stores.ListStores(StoreListStoresParams?parameters, CancellationTokencancellationToken = default)`

**get** `/api/v2/public/stores`

Retrieves a paginated list of stores.

### Parameters

- `StoreListStoresParams parameters`

  - `Boolean isWarehouse`

  - `string pageSize`

  - `string pageStart`

  - `string searchText`

  - `string secondaryKey`

### Returns

- `class StoreListStoresResponse:`

  Generic paginated response wrapper.

  - `required Int PageSize`

    Maximum number of items returned per page.

  - `required Int PageStart`

    Current page number (1-based).

  - `required Long TotalCount`

    Total number of records matching the query across all pages.

  - `IReadOnlyList<List>? List`

    Collection of items for the current page.

    - `required Long ID`

      Internal store identifier.

    - `required Boolean IsActive`

      Whether the store is active.

    - `required Boolean IsActiveDataExchange`

      Whether data exchange is active for this store.

    - `required Boolean IsWarehouse`

      Whether the store is a warehouse.

    - `string? AreaDescription`

      Description of the area.

    - `string? AreaID`

      Area identifier the store belongs to.

    - `Long? AreaManagerUserID`

    - `string? City`

      City the store is located in.

    - `string? CostCenter`

    - `string? CountryCode`

      ISO country code.

    - `string? CountryName`

      Country name.

    - `string? EslServerPath`

    - `IReadOnlyList<FreeField>? FreeFields`

      - `string? Label`

      - `Int? SortOrder`

      - `string? Value`

    - `string? IPRangeBegin`

    - `string? IPRangeEnd`

    - `string? LocalServerPath`

    - `string? OpeningHours`

    - `IReadOnlyList<OrderingSchema>? OrderingSchema`

      - `required Int Day`

      - `required Int DeliveryOffset`

      - `required Int OrderingOffset`

      - `required string Time`

      - `string? CategoryCode`

      - `string? WeekNumbers`

    - `string? PhoneNumber`

    - `Int? PriceLineID`

      Price line applied to the store.

    - `IReadOnlyList<Printer>? Printers`

      - `required Boolean IsBluetooth`

      - `string? PrinterIP`

      - `string? PrinterName`

      - `Int? PrinterType`

    - `string? SecondaryKey`

    - `string? StoreGln`

    - `string? StoreName`

      Display name of the store.

    - `DateTimeOffset? StoreNextDeliveryDatetime`

    - `DateTimeOffset? StoreNextOrderingDatetime`

    - `string? StoreNumber`

      Unique store number.

    - `string? StoreStockPool1`

    - `string? StoreStockPool10`

    - `string? StoreStockPool2`

    - `string? StoreStockPool3`

    - `string? StoreStockPool4`

    - `string? StoreStockPool5`

    - `string? StoreStockPool6`

    - `string? StoreStockPool7`

    - `string? StoreStockPool8`

    - `string? StoreStockPool9`

    - `string? StoreTypeCode`

    - `string? StoreTypeDescription`

    - `string? TertiaryKey`

    - `string? WarehouseID`

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

  - `Long? PreviousPage`

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

  - `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 (asc or desc).

  - `string? TaskLastModifiedDate`

    Last modified date/time of the task.

### Example

```csharp
StoreListStoresParams parameters = new();

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

Console.WriteLine(response);
```

#### 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"
}
```