Choose a version:

inventorySetScheduledChanges

mutation

Requires write_inventory access scope. Also: The user must have permission to update an inventory.

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.

Anchor to Arguments

Arguments

Anchor to inputinput

•InventorySetScheduledChangesInput!

required

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

Was this section helpful?

Anchor to InventorySetScheduledChangesPayload returnsInventorySetScheduledChangesPayload returns

Anchor to scheduledChangesscheduledChanges •[InventoryScheduledChange!]: The scheduled changes that were created.
Anchor to userErrorsuserErrors •[InventorySetScheduledChangesUserError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Examples

inventorySetScheduledChanges reference

Mutation Reference

mutation inventorySetScheduledChanges($input: InventorySetScheduledChangesInput!) {

inventorySetScheduledChanges(input: $input) {

scheduledChanges {

# InventoryScheduledChange fields

}

userErrors {

field

message

}

Input

{

"input": {

"reason": "<your-reason>",

"items": [

{

"inventoryItemId": "gid://shopify/<objectName>/10079785100",

"locationId": "gid://shopify/<objectName>/10079785100",

"ledgerDocumentUri": "https://example.myshopify.com",

"scheduledChanges": [

{}

]

}

"referenceDocumentUri": "https://example.myshopify.com"

}

Variables

{
  "input": {
    "reason": "<your-reason>",
    "items": [
      {
        "inventoryItemId": "gid://shopify/<objectName>/10079785100",
        "locationId": "gid://shopify/<objectName>/10079785100",
        "ledgerDocumentUri": "https://example.myshopify.com",
        "scheduledChanges": [
          {}
        ]
      }
    ],
    "referenceDocumentUri": "https://example.myshopify.com"
  }
}

Schema

input InventorySetScheduledChangesInput {
  reason: String!
  items: [InventoryScheduledChangeItemInput!]!
  referenceDocumentUri: URL!
}

input InventoryScheduledChangeItemInput {
  inventoryItemId: ID!
  locationId: ID!
  ledgerDocumentUri: URL!
  scheduledChanges: [InventoryScheduledChangeInput!]!
}