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.
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.
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 queryquery•String!required
The query to be executed in bulk.
- Anchor to groupObjectsgroup•Boolean!
Objects requiredDefault:false Enables grouping objects directly under their corresponding parent objects in the JSONL output. Enabling grouping slows down bulk operations and increases the likelihood of timeouts. Only enable grouping if you depend on the grouped format.
Arguments