Bulk
An error in the input of a mutation. Mutations return objects to indicate validation failures, such as invalid field values or business logic violations, that prevent the operation from completing.
Anchor to FieldsFields
- code (BulkOperationUserErrorCode)
- field ([String!])
- message (String!)
- Anchor to codecode•Bulk
Operation User Error Code The error code.
- Anchor to fieldfield•[String!]
The path to the input field that caused the error.
- Anchor to messagemessage•String!non-null
The error message.
Anchor to MutationsMutations
- 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: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.
Arguments