Base URL
https://{tenant}.logzi.com/api/stock_pile/
Every request returns a JSON response. On success result.code == 1, on error result.code == 0. The stock API is used for real-time queries of product stock recorded in the warehouses — in item-level, grouped, and analytical views. This is a read-only API.
/api/stock_pile/get
Retrieve a single product stock record by ID or part number.
Query parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
id | int | Stock record ID | |
partnumber | string | Product part number |
Example request
GET /api/stock_pile/get?partnumber=PROD-001
X-API-KEY: {your_api_key}/api/stock_pile/get_analytics
Retrieve stock analytics summary data.
No parameters required — the summary includes all stock data.
Example request
GET /api/stock_pile/get_analytics
X-API-KEY: {your_api_key}/api/stock_pile/get_group_all
Retrieve grouped product stock with filter conditions.
Query parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
partnumber | string | Product part number | |
quantity_phy_higher | float | Minimum physical quantity filter | |
store_id_in | array | List of warehouse IDs to filter by | |
product_id | int | Product ID | |
synchronizable | int | Filter synchronizable products (0/1) |
Example request
GET /api/stock_pile/get_group_all?partnumber=PROD-001
X-API-KEY: {your_api_key}/api/stock_pile/list
Paginated list of stock records.
Query parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
list_count | int | Maximum number of records returned | |
list_offset | int | Pagination offset (default: 0) | |
list_condition | object | Filter condition object | |
list_params | object | Other query parameters |
Example request
GET /api/stock_pile/list?list_offset=0&list_count=100
X-API-KEY: {your_api_key}/api/stock_pile/list_extended
Extended stock list including product data.
Query parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
list_count | int | Maximum number of records returned | |
list_offset | int | Pagination offset (default: 0) | |
list_condition | object | Filter condition object | |
list_params | object | Other query parameters |
Example request
GET /api/stock_pile/list_extended?list_offset=0&list_count=100
X-API-KEY: {your_api_key}/api/stock_pile/list_close
Retrieve the list of closed stock items.
Query parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
list_count | int | Maximum number of records returned | |
list_offset | int | Pagination offset (default: 0) | |
list_condition | object | Filter condition object | |
list_params | object | Other query parameters |
Example request
GET /api/stock_pile/list_close?list_offset=0&list_count=100
X-API-KEY: {your_api_key}/api/stock_pile/list_group_all
Stock summary list grouped by warehouse and part number.
No parameters required.
Example request
GET /api/stock_pile/list_group_all
X-API-KEY: {your_api_key}Create your account now,
pay later!
