inventorySetScheduledChanges

mutation

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

Set up scheduled changes of inventory items.

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?

Mutation Reference

1mutation inventorySetScheduledChanges($input: InventorySetScheduledChangesInput!) {
2  inventorySetScheduledChanges(input: $input) {
3    scheduledChanges {
4      # InventoryScheduledChange fields
5    }
6    userErrors {
7      field
8      message
9    }
10  }
11}

Input

1{
2  "input": {
3    "items": [
4      {
5        "inventoryItemId": "gid://shopify/<objectName>/10079785100",
6        "ledgerDocumentUri": "https://example.myshopify.com",
7        "locationId": "gid://shopify/<objectName>/10079785100",
8        "scheduledChanges": [
9          ""
10        ]
11      }
12    ],
13    "reason": "<your-reason>",
14    "referenceDocumentUri": "https://example.myshopify.com"
15  }
16}

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

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

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