List Stock On Hand
unleashed.list_stock_on_hand
ActionBusiness appsconnection required
Calls the Unleashed Software API with the connection's credentials.
Fetch a page of stock levels, optionally narrowed to a warehouse, a set of products or a date — the read behind a reorder alert or a stock sync.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- Custom
- Providers
- Unleashed Software
- Secret shape
- {"api_id": "…", "api_key": "…"} — the API ID and API Key from Unleashed
- Resolved by
- config.connection_id, else node.connection_id
Configuration
9 fields, none required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.
| Field | Type | Required | Default | Constraints | Example |
|---|---|---|---|---|---|
page Which page of results to fetch; Unleashed pages from 1. | number | No | 1 | ≥ 1 | — |
page_size How many rows one page holds. Unleashed defaults to 200 and refuses more than 1000. | number | No | 200 | 1–1000 | — |
product_id Only return stock for these product Guids; separate several with commas. | string | No | — | — | 3d3a9b0f-8c3e-4a6a-9f7e-2b1c4d5e6f70 |
warehouse_code Only return records for this warehouse code. | string | No | — | — | MAIN |
warehouse_name Only return stock for the warehouse with this name. | string | No | — | — | Main Warehouse |
as_at_date Return the stock position as it stood on this date, as YYYY-MM-DD. | string | No | — | matches \d{4}-\d{2}-\d{2} | 2026-01-31 |
modified_since Only return records created or edited since this UTC timestamp, which is how an incremental sync avoids re-reading the whole account. | string | No | — | — | 2026-01-01T00:00:00 |
order_by Column to sort the rows by; Unleashed sorts by product code otherwise. | string | No | — | — | productCode |
is_assembled Include the quantities that could be produced by auto-assembly bills of materials, not only what is physically on the shelf. | boolean | No | false | — | — |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"as_at_date": "2026-01-31",
"is_assembled": false,
"modified_since": "2026-01-01T00:00:00",
"order_by": "productCode",
"page": 1,
"page_size": 200,
"product_id": "3d3a9b0f-8c3e-4a6a-9f7e-2b1c4d5e6f70",
"warehouse_code": "MAIN",
"warehouse_name": "Main Warehouse"
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
count How many rows this page carried. | number | — |
pagination Unleashed's Pagination block, as returned. | object | — |
page_number The page number this response is. | number | — |
number_of_pages How many pages the filtered set spans. | number | — |
number_of_items How many rows the filtered set holds in total. | number | — |
stock[].Guid The stock-on-hand row's Guid. | string | — |
stock[].ProductGuid The product this row counts. | string | — |
stock[].ProductCode The product's code. | string | — |
stock[].ProductDescription The product's description. | string | — |
stock[].ProductGroupName The product group the product belongs to. | string | — |
stock[].ProductSourceId The product's id in the system it was imported from. | string | — |
stock[].QtyOnHand How many units are physically in the warehouse. | number | — |
stock[].AllocatedQty How many of those units are already committed to orders. | number | — |
stock[].AvailableQty How many units are free to sell. | number | — |
stock[].OnPurchase How many units are on order from suppliers. | number | — |
stock[].AvgCost Average unit cost of the stock held. | number | — |
stock[].TotalCost Value of the stock held, at average cost. | number | — |
stock[].DaysSinceLastSale How long since the product last sold. | number | — |
stock[].Warehouse Name of the warehouse the row counts. | string | — |
stock[].WarehouseCode Code of that warehouse. | string | — |
stock[].WarehouseId Guid of that warehouse. | string | — |
stock[].LastModifiedOn Timestamp of the last change to the row. | string | — |
{
"count": 0,
"number_of_items": 0,
"number_of_pages": 0,
"page_number": 0,
"pagination": {},
"stock": [
{
"AllocatedQty": 0,
"AvailableQty": 0,
"AvgCost": 0,
"DaysSinceLastSale": 0,
"Guid": "",
"LastModifiedOn": "",
"OnPurchase": 0,
"ProductCode": "",
"ProductDescription": "",
"ProductGroupName": "",
"ProductGuid": "",
"ProductSourceId": "",
"QtyOnHand": 0,
"TotalCost": 0,
"Warehouse": "",
"WarehouseCode": "",
"WarehouseId": ""
}
]
}Related Unleashed Software nodes
See List Stock On Hand run in a workflow.
In a technical demo we add the Unleashed Software connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.