update_inventory
Updated September 30, 20261 min read
Set absolute inventory values by submitting snapshot inventory events. If both on_hand and unavailable are provided, this creates a SNAPSHOT event. If only one field is provided, it creates SNAPSHOT_ONHAND or SNAPSHOT_UNAVAILABLE. Stock is identified by inventory_key only; to start from a product, read its inventory_key with get_product or get_inventory first.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
event_timestamp | string | Yes | ISO 8601 event timestamp. Backend rejects future timestamps and timestamps older than the tolerance window. |
inventory_key | string | Yes | Inventory to write to. |
location_id | string | Yes | — |
tenantId | string | Yes | — |
on_hand | number | No | Absolute on-hand quantity to set. |
reason | string | No | — |
unavailable | number | No | Absolute unavailable quantity to set. |
Example agent prompt
"Update the inventory."
update_inventory(
tenantId="…",
inventory_key="INV-1234",
location_id="DXB-WH-01",
event_timestamp=…
)