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

mutation inventorySetScheduledChanges($input: InventorySetScheduledChangesInput!) {

inventorySetScheduledChanges(input: $input) {

scheduledChanges {

# InventoryScheduledChange fields

}

userErrors {

field

message

}

Input

{

"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": {
    "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!]!
}