get_inventory_history
Updated September 9, 20261 min read
Get inventory event history of one inventory, addressed by inventory_key or product_id (GET /inventory-events/inventory-key/{key} or /inventory-events/product-id/{id}), optionally for one location. Newest first, paged by page_num/rows_per_page over the latest 500 events. Use select with json-mask syntax to return only required fields.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
tenantId | string | Yes | — |
inventory_key | string | No | — |
location_id | string | No | Restrict the history to one location. |
page_num | number | No | 1-based page number. Backend defaults to 1. |
product_id | string | No | Product whose inventory_key identifies the inventory. |
rows_per_page | number | No | Events per page. Backend defaults to 10. |
select | string | No | json-mask expression to filter response fields. |
Example agent prompt
"Run get_inventory_history."
get_inventory_history(
tenantId="…",
product_id="PROD-1234"
)