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 changeFromQuantitychangeFromQuantity
•Int

The quantity currently expected at this location, before the delta is applied.

This field enables a compare-and-swap (CAS) safety check. If the location’s current quantity doesn't match the value you provide, then the mutation fails with a CHANGE_FROM_QUANTITY_STALE error. This prevents unintended overwrites when the request is based on stale inventory data.

To skip the CAS check, pass null. Use this only when your system is the source of truth for this inventory and you don’t need to protect against concurrent updates. This field is mandatory: you must explicitly pass in a value, even if that value is null, or the mutation returns an error.

For more information, refer to the compare and swap documentation.

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?