# Stores

## List Stores

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

Retrieves a paginated list of stores.

### Query Parameters

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

### Returns

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

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

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

- `page_size: optional number`

  Maximum number of items returned per page.

- `page_start: optional number`

  Current page number (1-based).

- `previous_page: optional number`

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

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

### Example

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

## Create Stores

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

Creates or updates stores.

### Query Parameters

- `flush: optional boolean`

  When true, removes existing stores before inserting.

### Body Parameters

- `stores: optional array of object { is_active, is_active_data_exchange, is_warehouse, 37 more }`

  The list of stores to create or update.

  - `is_active: boolean`

  - `is_active_data_exchange: boolean`

  - `is_warehouse: boolean`

  - `store_name: string`

    Display name of the store.

  - `store_number: string`

    Unique store number identifier.

  - `address: optional string`

  - `area_description: optional string`

  - `area_id: optional string`

  - `area_manager_user_id: optional number`

  - `city: optional string`

  - `contact_details: optional string`

  - `cost_center: optional string`

  - `country_code: optional string`

  - `country_name: optional string`

  - `esl_server_path: optional string`

  - `free_fields: optional array of object { key, sort_order, value }`

    - `key: optional string`

    - `sort_order: optional number`

    - `value: optional string`

  - `ip_range_begin: optional string`

  - `ip_range_end: optional string`

  - `local_server_path: optional string`

  - `opening_hours: optional array of object { key, sort_order, value }`

    - `key: optional string`

    - `sort_order: optional number`

    - `value: optional string`

  - `ordering_schema: optional array of object { day, delivery_offset, time, 3 more }`

    - `day: number`

    - `delivery_offset: number`

    - `time: string`

    - `category_code: optional string`

    - `ordering_offset: optional number`

    - `week_numbers: optional string`

  - `phone_number: optional string`

  - `postal_code: optional string`

  - `price_line_id: optional number`

  - `store_gln: optional string`

  - `store_next_delivery_datetime: optional string`

  - `store_next_ordering_datetime: optional string`

  - `store_printers: optional array of object { is_bluetooth, printer_ip, printer_name, 3 more }`

    - `is_bluetooth: boolean`

    - `printer_ip: optional string`

    - `printer_name: optional string`

    - `printer_serial: optional string`

    - `printer_type: optional number`

    - `vendor: optional string`

  - `store_stock_pool_1: optional string`

  - `store_stock_pool_10: optional string`

  - `store_stock_pool_2: optional string`

  - `store_stock_pool_3: optional string`

  - `store_stock_pool_4: optional string`

  - `store_stock_pool_5: optional string`

  - `store_stock_pool_6: optional string`

  - `store_stock_pool_7: optional string`

  - `store_stock_pool_8: optional string`

  - `store_stock_pool_9: optional string`

  - `store_type_code: optional string`

  - `store_type_description: optional string`

### Returns

- `data: optional string`

  Optional data payload returned by the operation.

- `message: optional string`

  Human-readable message describing the result.

- `success: optional boolean`

  Indicates whether the operation completed successfully.

### Example

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