# Stores

## List Stores

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

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

Retrieves a paginated list of stores.

### Parameters

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

### Returns

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

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

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

  - `Long PageSize`

    Maximum number of items returned per page.

  - `Long PageStart`

    Current page number (1-based).

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

  - `string? TaskLastModifiedDate`

    Last modified date/time of the task.

  - `Long TotalCount`

    Total number of records matching the query across all pages.

### Example

```csharp
StoreListStoresParams parameters = new();

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

Console.WriteLine(response);
```

## Create Stores

`StoreCreateStoresResponse Stores.CreateStores(StoreCreateStoresParams?parameters, CancellationTokencancellationToken = default)`

**post** `/api/v2/public/stores`

Creates or updates stores.

### Parameters

- `StoreCreateStoresParams parameters`

  - `Boolean flush`

    Query param: When true, removes existing stores before inserting.

  - `IReadOnlyList<Store>? stores`

    Body param: The list of stores to create or update.

    - `required Boolean IsActive`

    - `required Boolean IsActiveDataExchange`

    - `required Boolean IsWarehouse`

    - `required string StoreName`

      Display name of the store.

    - `required string StoreNumber`

      Unique store number identifier.

    - `string? Address`

    - `string? AreaDescription`

    - `string? AreaID`

    - `Long? AreaManagerUserID`

    - `string? City`

    - `string? ContactDetails`

    - `string? CostCenter`

    - `string? CountryCode`

    - `string? CountryName`

    - `string? EslServerPath`

    - `IReadOnlyList<FreeField>? FreeFields`

      - `string? Key`

      - `Int SortOrder`

      - `string? Value`

    - `string? IPRangeBegin`

    - `string? IPRangeEnd`

    - `string? LocalServerPath`

    - `IReadOnlyList<OpeningHour>? OpeningHours`

      - `string? Key`

      - `Int SortOrder`

      - `string? Value`

    - `IReadOnlyList<OrderingSchema>? OrderingSchema`

      - `required Int Day`

      - `required Int DeliveryOffset`

      - `required DateTimeOffset Time`

      - `string? CategoryCode`

      - `Int OrderingOffset`

      - `string? WeekNumbers`

    - `string? PhoneNumber`

    - `string? PostalCode`

    - `Int? PriceLineID`

    - `string? StoreGln`

    - `DateTimeOffset? StoreNextDeliveryDatetime`

    - `DateTimeOffset? StoreNextOrderingDatetime`

    - `IReadOnlyList<StorePrinter>? StorePrinters`

      - `required Boolean IsBluetooth`

      - `string? PrinterIP`

      - `string? PrinterName`

      - `string? PrinterSerial`

      - `Int PrinterType`

      - `string? Vendor`

    - `string? StoreStockPool1`

    - `string? StoreStockPool10`

    - `string? StoreStockPool2`

    - `string? StoreStockPool3`

    - `string? StoreStockPool4`

    - `string? StoreStockPool5`

    - `string? StoreStockPool6`

    - `string? StoreStockPool7`

    - `string? StoreStockPool8`

    - `string? StoreStockPool9`

    - `string? StoreTypeCode`

    - `string? StoreTypeDescription`

### Returns

- `class StoreCreateStoresResponse:`

  Standard success response returned by mutation endpoints.

  - `string? Data`

    Optional data payload returned by the operation.

  - `string? Message`

    Human-readable message describing the result.

  - `Boolean Success`

    Indicates whether the operation completed successfully.

### Example

```csharp
StoreCreateStoresParams parameters = new();

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

Console.WriteLine(response);
```