list_inventory
Updated September 9, 20261 min read
List inventory rows with paging, sorting, search, merchant filters, location filters, stock-range filters, and update-date filters. This uses the same middleware inventory listing surface as the dashboard. Use select with json-mask syntax to trim the returned payload.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
tenantId | string | Yes | — |
available_from | number or string | No | — |
available_to | number or string | No | — |
barcode | array or string | No | — |
inventory_key | array or string | No | — |
location | array or string | No | — |
merchant | array or string | No | — |
on_hand_from | number or string | No | — |
on_hand_to | number or string | No | — |
page | number or string | No | — |
page_size | number or string | No | — |
product_id | array or string | No | — |
product_ref | array or string | No | — |
reserved_from | number or string | No | — |
reserved_to | number or string | No | — |
search_mode | string | No | Values: fuzzy, exact. |
search_string | string | No | — |
select | string | No | json-mask expression to filter response fields. |
sku | array or string | No | — |
sort_by | string | No | — |
sort_direction | string | No | Values: asc, desc. |
status | array or string | No | — |
tzoffset | number or string | No | Timezone offset in minutes. Defaults to 240 (Asia/Dubai). |
unavailable_from | number or string | No | — |
unavailable_to | number or string | No | — |
update_date_from | string | No | — |
update_date_to | string | No | — |
Example agent prompt
"Show me the recent inventory."
list_inventory(
tenantId="…"
)