Bulk
Return type for mutation.
Anchor to FieldsFields
- bulkOperation (BulkOperation)
- userErrors ([BulkOperationUserError!]!)
- Anchor to bulkOperationbulk•Bulk
Operation Operation The newly created bulk operation.
- Anchor to userErrorsuser•[Bulk
Errors Operation User Error!]! non-null The list of errors that occurred from executing the mutation.
Anchor to Mutations with this payloadMutations with this payload
- bulkOperationRunQuery (BulkOperationRunQueryPayload)
- •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.
Bulk query and bulk mutation operations can run at the same time per shop. The number of concurrent operations that an app can run depends on the API version. For the applicable concurrency limits, refer to the bulk operations guide. The query must include at least one connection field and supports up to five connections with a maximum nesting depth of two levels.
NoteResults remain available for seven days after completion.
Note:Results remain available for seven days after completion.
Note: Results remain available for seven days after completion.
For more information, see the bulk operations guide.
- Anchor to groupObjectsgroup•Boolean!
Objects 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.
Arguments