Bulk operations group objects default changed to `false`

We have optimized the output of bulk operations in the GraphQL Admin API to enhance speed and reliability.

What's Changed

Bulk Queries (`bulkOperationRunQuery`)

The groupObjects argument now defaults to false. Grouping objects can slow down operations and increase failure rates, especially with large datasets.

Bulk Mutations (`bulkOperationRunMutation`)

The groupObjects argument is now deprecated. It does not affect the order of output files because mutation outputs do not have parent objects.

What You Need to Do

If You're Running Bulk Queries

To maintain grouped output: Set groupObjects: true.

mutation {
  bulkOperationRunQuery(
    query: """
    {
      products {
        edges {
          node {
            id
            title
          }
        }
      }
    }
    """
    groupObjects: true  // Add this to maintain grouped output
  ) {
    bulkOperation {
      id
      status
    }
    userErrors {
      field
      message
    }
  }
}

If You're Running Bulk Mutations

Remove the groupObjects argument from your queries. This will not impact the output files.

Why We Made This Change

Most applications do not require grouped output and the associated overhead negatively impacts performance. These changes deliver faster, more predictable results that are easier to process at scale. Enable groupObjects only if your application specifically depends on the grouped output format. As this was the default behavior previously, you can verify on any version after 2025-07 by setting groupObjects to false and testing your application.

For optimal performance, omit groupObjects on or after 2026-01, and disable this option if you are on 2025-07 or 2025-10.

Learn More

Was this section helpful?

Bulk operations group objects default changed to false