bulk
Requires Only accessible by supported access tokens: https://shopify.dev/docs/api/usage/bulk-operations/queries#access-token-considerations.
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.
Results remain available for seven days after completion.
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.
Arguments
- groupObjects (Boolean!)
- query (String!)
- 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.
- Anchor to queryquery•String!required
The query to be executed in bulk.
- 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.