Choose a version:

bulkOperationRunQuery

mutation

Creates and runs a bulk operation to fetch data asynchronously. The operation processes your GraphQL query in the background and returns results in a JSONL file when complete.

Apps can run one bulk query operation and one bulk mutation operation at a time per shop. The query must include at least one connection field and supports up to five connections with a maximum nesting depth of two levels.

Note

Results remain available for seven days after completion.

For more information, see the bulk operations guide.

Anchor to Arguments

Arguments

Anchor to groupObjectsgroupObjects •Boolean! requiredDefault:true: Whether to group objects under their corresponding parent objects in the JSONL output. Grouping is costly, causes bulk operations to take longer to complete, and increases the chances of failures such as timeouts.
Anchor to queryquery •String! required: The query to be executed in bulk.

Was this section helpful?

Anchor to BulkOperationRunQueryPayload returnsBulkOperationRunQueryPayload returns

Anchor to bulkOperationbulkOperation •BulkOperation: The newly created bulk operation.
Anchor to userErrorsuserErrors •[BulkOperationUserError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Examples

bulkOperationRunQuery reference

Mutation Reference

mutation bulkOperationRunQuery($query: String!, $groupObjects: Boolean!) {

bulkOperationRunQuery(query: $query, groupObjects: $groupObjects) {

bulkOperation {

# BulkOperation fields

}

userErrors {

field

message

}

Input

{

"query": "<your-query>",

"groupObjects": true

}