Get Stock On Hand
unleashed.get_stock_on_hand
ActionBusiness appsconnection required
Calls the Unleashed Software API with the connection's credentials.
Read one product's stock position, either as a single aggregate row or broken out per warehouse.
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
2 fields, 1 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 |
|---|---|---|---|---|---|
product_guid The product to read, as the Guid Unleashed assigned it. | string | Yes | — | — | 3d3a9b0f-8c3e-4a6a-9f7e-2b1c4d5e6f70 |
all_warehouses Return one row per warehouse instead of a single aggregate row. | boolean | No | false | — | — |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"all_warehouses": false,
"product_guid": "3d3a9b0f-8c3e-4a6a-9f7e-2b1c4d5e6f70"
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
Guid The stock-on-hand row's Guid. | string | — |
ProductGuid The product this row counts. | string | — |
ProductCode The product's code. | string | — |
ProductDescription The product's description. | string | — |
ProductGroupName The product group the product belongs to. | string | — |
ProductSourceId The product's id in the system it was imported from. | string | — |
QtyOnHand How many units are physically in the warehouse. | number | — |
AllocatedQty How many of those units are already committed to orders. | number | — |
AvailableQty How many units are free to sell. | number | — |
OnPurchase How many units are on order from suppliers. | number | — |
AvgCost Average unit cost of the stock held. | number | — |
TotalCost Value of the stock held, at average cost. | number | — |
DaysSinceLastSale How long since the product last sold. | number | — |
Warehouse Name of the warehouse the row counts. | string | — |
WarehouseCode Code of that warehouse. | string | — |
WarehouseId Guid of that warehouse. | string | — |
LastModifiedOn Timestamp of the last change to the row. | string | — |
{
"AllocatedQty": 0,
"AvailableQty": 0,
"AvgCost": 0,
"DaysSinceLastSale": 0,
"Guid": "",
"LastModifiedOn": "",
"OnPurchase": 0,
"ProductCode": "",
"ProductDescription": "",
"ProductGroupName": "",
"ProductGuid": "",
"ProductSourceId": "",
"QtyOnHand": 0,
"TotalCost": 0,
"Warehouse": "",
"WarehouseCode": "",
"WarehouseId": ""
}Notes
- With all_warehouses on, the output is the paged list shape (stock[], count, pagination) rather than a single row.
Related Unleashed Software nodes
See Get 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.