Skip to main content
Anchor to InventoryChangeInput

InventoryChangeInput

input_object

The input fields for the change to be made to an inventory item at a location.

Anchor to FieldsFields

Anchor to deltadelta
•Int!
non-null

The amount by which the inventory quantity will be changed.

Anchor to inventoryItemIdinventoryItemId
•ID!
non-null

Specifies the inventory item to which the change will be applied.

Anchor to ledgerDocumentUriledgerDocumentUri
•String

A non-Shopify URI that identifies what specific inventory transaction or ledger entry was changed. Represents the exact inventory movement being referenced, distinct from the business reason for the change.

Preferred format - Global ID (GID): gid://[your-app-name]/[transaction-type]/[id]

Examples:

  • gid://warehouse-app/InventoryTransaction/TXN-2024-001 (specific transaction)
  • gid://3pl-system/StockMovement/SM-2024-0125 (stock movement record)
  • gid://pos-app/InventoryUpdate/UPD-98765 (POS inventory update)
  • gid://erp-connector/LedgerEntry/LE-2024-11-21-001 (ledger entry)

Requirements: Valid non-Shopify URI with scheme and content. Required for all quantity names except available. Cannot use gid://shopify/* format.

Anchor to locationIdlocationId
•ID!
non-null

Specifies the location at which the change will be applied.

Was this section helpful?

Anchor to Input objects using this inputInput objects using this input

Anchor to InventoryAdjustQuantitiesInput.changesInventoryAdjustQuantitiesInput.changes
•INPUT OBJECT

The input fields required to adjust inventory quantities.

Was this section helpful?