get_inventory
Updated September 9, 20261 min read
Get the stock by location of one inventory, addressed by inventory_key, product_id or product_ref + merchant (GET /inventory/inventory-key/{key}, /inventory/product-id/{id} or /inventory/product-ref/{ref}). Use select with json-mask syntax to return only required fields.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
tenantId | string | Yes | — |
inventory_key | string | No | — |
merchant | string | No | — |
product_id | string | No | Product whose inventory_key identifies the inventory. |
product_ref | string | No | Merchant product reference; requires merchant. |
select | string | No | json-mask expression to filter response fields. |
Example agent prompt
"Look up the inventory for me."
get_inventory(
tenantId="…",
product_id="PROD-1234"
)