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. You can run one bulk mutation operation at a time per shop, though a bulkOperationRunQuery operation can run simultaneously.

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 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.
Anchor to groupObjectsgroupObjects •Boolean DeprecatedDefault:true

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($mutation: String!, $stagedUploadPath: String!, $clientIdentifier: String) {

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

bulkOperation {

# BulkOperation fields

}

userErrors {

field

message

}

Input

{

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

"stagedUploadPath": "<your-stagedUploadPath>",

"clientIdentifier": "<your-clientIdentifier>"

}