Choose a version:

InventoryScheduledChange

object

Requires read_inventory access scope.

Returns the scheduled changes to inventory states related to the ledger document.

Anchor to FieldsFields

Anchor to expectedAtexpectedAt •DateTime! non-null: The date and time that the scheduled change is expected to happen.
Anchor to fromNamefromName •String! non-null: The quantity name to transition from.
Anchor to inventoryLevelinventoryLevel •InventoryLevel! non-null: The quantities of an inventory item that are related to a specific location.
Anchor to ledgerDocumentUriledgerDocumentUri •URL! non-null: A freeform URI that represents what changed the inventory quantities.
Anchor to quantityquantity •Int! non-null: The quantity of the scheduled change associated with the ledger document in the fromName state.
Anchor to toNametoName •String! non-null: The quantity name to transition to.

Was this section helpful?

Anchor to MutationsMutations

Anchor to inventorySetScheduledChanges inventorySetScheduledChanges

•mutation

Set up scheduled changes of inventory items.

Caution

As of 2026-01, this mutation supports an optional idempotency key using the @idempotent directive. As of 2026-04, the idempotency key is required and must be provided using the @idempotent directive. For more information, see the idempotency documentation.

Arguments

Anchor to inputinput

•InventorySetScheduledChangesInput!

required

The input fields for setting up scheduled changes of inventory items.

Was this section helpful?