Choose a version:

bulkOperationRunMutation

mutation

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 import data asynchronously. This mutation executes a specified GraphQL mutation multiple times using input data from a JSONL file that you've uploaded to Shopify.

The operation processes each line in your JSONL file as a separate mutation execution. The operation delivers results in a JSONL file when it completes. Bulk mutation operations and bulkOperationRunQuery 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.

Learn more about bulk importing data.

Anchor to Arguments

Arguments

Anchor to clientIdentifierclientIdentifier •String: An optional identifier which may be used for querying.
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 mutationmutation •String! required: The mutation to be executed in bulk.
Anchor to stagedUploadPathstagedUploadPath •String! required: The staged upload path of the file containing mutation variables.

Was this section helpful?

Anchor to BulkOperationRunMutationPayload returnsBulkOperationRunMutationPayload returns

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

Was this section helpful?

Examples

bulkOperationRunMutation reference

Mutation Reference

mutation bulkOperationRunMutation($clientIdentifier: String, $groupObjects: Boolean!, $mutation: String!, $stagedUploadPath: String!) {

bulkOperationRunMutation(clientIdentifier: $clientIdentifier, groupObjects: $groupObjects, mutation: $mutation, stagedUploadPath: $stagedUploadPath) {

bulkOperation {

# BulkOperation fields

}

userErrors {

field

message

}

Input

{

"clientIdentifier": "<your-clientIdentifier>",

"groupObjects": true,

"mutation": "<your-mutation>",

"stagedUploadPath": "<your-stagedUploadPath>"

}