# Store Products

## List Store Products Stock

**get** `/api/v2/public/storeproducts/stock`

Retrieves a paged list of store products with stock, optionally including locations.

### Query Parameters

- `article_no: optional string`

  Optional article number filter.

- `barcode: optional string`

  Optional barcode filter.

- `category_code: optional string`

  Optional category code filter.

- `exclude_customer_order_stock: optional boolean`

  When true, excludes stock already reserved for customer orders.

- `from_id: optional number`

  Optional lower bound id for cursor-style paging.

- `include_locations: optional boolean`

  When true, includes location-level stock details for each product.

- `last_modified_date: optional string`

  Filter by last modified date (ISO 8601).

- `last_stock_modified_datetime: optional string`

  Filter by last stock modified datetime (ISO 8601).

- `page_size: optional number`

  The number of items per page.

- `page_start: optional number`

  The starting page index for pagination.

- `parent_category_code: optional string`

  Optional parent category code filter.

- `product_number: optional string`

  Optional product number filter.

- `search_text: optional string`

  Optional text to search products by name or barcode.

- `store_number: optional string`

  Optional store number filter.

- `to_id: optional number`

  Optional upper bound id for cursor-style paging.

### Returns

- `list: array of object { id, adjusted_order_level, attention_codes, 50 more }`

  Collection of items for the current page.

  - `id: optional number`

  - `adjusted_order_level: optional number`

  - `attention_codes: optional string`

  - `average_array: optional string`

  - `barcode: optional string`

  - `category_code: optional string`

  - `category_name: optional string`

  - `category_order: optional number`

  - `demand_until_delivery: optional number`

  - `forecast: optional number`

  - `forecast_array: optional string`

  - `group_code: optional string`

  - `history_array: optional string`

  - `is_replenishment: optional boolean`

  - `is_stock: optional boolean`

  - `last_counted_datetime: optional string`

  - `last_expiry_datetime: optional string`

  - `last_expiry_updatedby: optional string`

  - `last_loss_updatedby: optional string`

  - `last_minmax_updatedby: optional string`

  - `last_receipt_updatedby: optional string`

  - `max: optional number`

  - `min: optional number`

  - `most_likely_datetime: optional string`

  - `most_likely_pool_1: optional number`

  - `most_likely_pool_10: optional number`

  - `most_likely_pool_2: optional number`

  - `most_likely_pool_3: optional number`

  - `most_likely_pool_4: optional number`

  - `most_likely_pool_5: optional number`

  - `most_likely_pool_6: optional number`

  - `most_likely_pool_7: optional number`

  - `most_likely_pool_8: optional number`

  - `most_likely_pool_9: optional number`

  - `most_likely_quantity: optional number`

  - `next_delivery_datetime: optional string`

  - `next_ordering_datetime: optional string`

  - `order_level: optional number`

  - `original_max: optional number`

  - `original_min: optional number`

  - `price: optional number`

  - `product_description: optional string`

  - `product_number: optional string`

  - `promotion_week: optional string`

  - `purchase_unit_name: optional string`

  - `purchase_unit_quantity: optional number`

  - `referral_product: optional string`

  - `smallest_item_quantity: optional number`

  - `smallest_product_number: optional string`

  - `store_locations: optional array of object { carrier_code, default_stock_pool, quantity, 12 more }`

    - `carrier_code: optional string`

    - `default_stock_pool: optional string`

    - `quantity: optional number`

    - `stock_pool_1: optional number`

    - `stock_pool_10: optional number`

    - `stock_pool_2: optional number`

    - `stock_pool_3: optional number`

    - `stock_pool_4: optional number`

    - `stock_pool_5: optional number`

    - `stock_pool_6: optional number`

    - `stock_pool_7: optional number`

    - `stock_pool_8: optional number`

    - `stock_pool_9: optional number`

    - `store_location_code: optional string`

    - `tags: optional array of string`

  - `store_number: optional string`

  - `storeproduct_attention_codes: optional string`

  - `validate_expiry_datetime: optional string`

- `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/storeproducts/stock \
    -H "Authorization: $COLLEQTIVE_BEARER_TOKEN"
```

## Retrieve Store Product Stock

**get** `/api/v2/public/stores/{store_number}/products/{product_number}/stock`

Retrieves stock for a single product at a store, optionally including locations.

### Path Parameters

- `store_number: string`

- `product_number: string`

### Query Parameters

- `exclude_customer_order_stock: optional boolean`

  When true, excludes stock already reserved for customer orders.

- `include_locations: optional boolean`

  When true, includes location-level stock details.

- `include_zero_lines: optional boolean`

  When true, includes lines with zero stock.

### Returns

- `products: optional array of object { most_likely_stock, product_number, stock_pool_1, 11 more }`

  - `most_likely_stock: optional number`

  - `product_number: optional string`

  - `stock_pool_1: optional number`

  - `stock_pool_10: optional number`

  - `stock_pool_2: optional number`

  - `stock_pool_3: optional number`

  - `stock_pool_4: optional number`

  - `stock_pool_5: optional number`

  - `stock_pool_6: optional number`

  - `stock_pool_7: optional number`

  - `stock_pool_8: optional number`

  - `stock_pool_9: optional number`

  - `store_locations: optional array of object { carrier_code, default_stock_pool, quantity, 12 more }`

    - `carrier_code: optional string`

    - `default_stock_pool: optional string`

    - `quantity: optional number`

    - `stock_pool_1: optional number`

    - `stock_pool_10: optional number`

    - `stock_pool_2: optional number`

    - `stock_pool_3: optional number`

    - `stock_pool_4: optional number`

    - `stock_pool_5: optional number`

    - `stock_pool_6: optional number`

    - `stock_pool_7: optional number`

    - `stock_pool_8: optional number`

    - `stock_pool_9: optional number`

    - `store_location_code: optional string`

    - `tags: optional array of string`

  - `store_number: optional string`

### Example

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

## Retrieve Store Product Surrounding

**get** `/api/v2/public/stores/{store_number}/storeproducts/{product_number}/surrounding`

Retrieves aggregate surrounding stock for a product across nearby stores/warehouses.

### Path Parameters

- `store_number: string`

- `product_number: string`

### Returns

- `area_description: optional string`

- `area_id: optional string`

- `is_warehouse: optional boolean`

- `most_likely_pool_1: optional number`

- `most_likely_pool_10: optional number`

- `most_likely_pool_2: optional number`

- `most_likely_pool_3: optional number`

- `most_likely_pool_4: optional number`

- `most_likely_pool_5: optional number`

- `most_likely_pool_6: optional number`

- `most_likely_pool_7: optional number`

- `most_likely_pool_8: optional number`

- `most_likely_pool_9: optional number`

- `most_likely_quantity: optional number`

- `store_name: optional string`

- `store_number: optional string`

### Example

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

## Update Store Products

**put** `/api/v2/public/stores/{store_number}/storeproducts`

Updates store product properties (min/max, prices, forecast, attention codes, replenishment, etc.) for one or more products at a store.

### Path Parameters

- `store_number: string`

### Body Parameters

- `body: optional array of object { product_number, attention_codes, average_array, 18 more }`

  - `product_number: string`

  - `attention_codes: optional array of string`

  - `average_array: optional array of number`

  - `average_keys: optional array of string`

  - `default_salesorder_type: optional string`

  - `demand_until_delivery: optional number`

  - `discount_price: optional number`

  - `expiry_date_time: optional string`

  - `forecast_array: optional array of number`

  - `forecast_keys: optional array of string`

  - `history_array: optional array of number`

  - `history_keys: optional array of string`

  - `is_promotion: optional boolean`

  - `is_replenishment: optional boolean`

  - `max: optional number`

  - `min: optional number`

  - `next_delivery_date: optional string`

  - `next_ordering_date: optional string`

  - `order_level: optional number`

  - `price: optional number`

  - `validate_expiry_date_time: 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/$STORE_NUMBER/storeproducts \
    -X PUT \
    -H "Authorization: $COLLEQTIVE_BEARER_TOKEN"
```