Choose a version:

InventoryChange

object

Requires read_inventory access scope.

A change in an inventory quantity of an inventory item at a location. Each change tracks how inventory moves between different states like available, committed, reserved, or damaged.

The change captures the amount changed, the resulting quantity, and links to the associated InventoryItem and Location.

The name field indicates which inventory state changed, such as available, reserved, or damaged. The ledgerDocumentUri field provides an audit trail by referencing the source document or system that triggered the change.

Anchor to FieldsFields

Anchor to deltadelta •Int! non-null: The amount by which the inventory quantity was changed.
Anchor to itemitem •InventoryItem: The inventory item associated with this inventory change.
Anchor to ledgerDocumentUriledgerDocumentUri •String: A URI that represents what the inventory quantity change was applied to.
Anchor to locationlocation •Location: The location associated with this inventory change.
Anchor to namename •String! non-null: The name of the inventory quantity that was changed.
Anchor to quantityAfterChangequantityAfterChange •Int: The quantity of named inventory after the change.

Was this section helpful?