bulkOperationRunMutation

Start an async bulk import — runs a mutation once per line of an uploaded JSONL file.

Use it in a workflow

Add a step and choose the Shopify connector.
Pick the bulkOperationRunMutation action (under Bulk).
Fill in the fields below, then reference the result from later steps as {{bulkoperationrunmutation.response.data}}.

Query

This is the mutation the action sends by default. Edit it in the step's Query field to change which fields come back.

graphql

mutation BulkOperationRunMutation($mutation: String!, $stagedUploadPath: String!, $groupObjects: Boolean, $clientIdentifier: String) {
  bulkOperationRunMutation(
    mutation: $mutation
    stagedUploadPath: $stagedUploadPath
    groupObjects: $groupObjects
    clientIdentifier: $clientIdentifier
  ) {
    bulkOperation {
      completedAt
      createdAt
      errorCode
      fileSize
      id
      objectCount
      partialDataUrl
      query
      rootObjectCount
      status
      type
      url
    }
    userErrors {
      code
      field
      message
    }
  }
}

Variables

Pass these as a JSON object in the step's Variables field.

mutationstringrequired

The mutation to be executed in bulk.

stagedUploadPathstringrequired

The staged upload path of the file containing mutation variables.

groupObjectsboolean

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.

clientIdentifierstring

An optional identifier which may be used for querying.

json

{
  "mutation": "string",
  "stagedUploadPath": "string",
  "groupObjects": false,
  "clientIdentifier": "string"
}

Response

Read the result with {{bulkoperationrunmutation.response.data.data.bulkOperationRunMutation}}. If the API returns errors, the step fails and they are at {{bulkoperationrunmutation.response.data.errors}}.

bulkOperationobject

completedAtstring

createdAtstring

errorCodestring

One ofACCESS_DENIEDINTERNAL_SERVER_ERRORTIMEOUT

fileSizestring

idstring

objectCountstring

partialDataUrlstring

querystring

rootObjectCountstring

statusstring

One ofCANCELEDCANCELINGCOMPLETEDCREATEDEXPIREDFAILEDRUNNING

typestring

One ofQUERYMUTATION

urlstring

userErrorsarray<object>

codeobject

fieldobject

messageobject

Need more? See the Shopify guide for connection setup and behaviour shared by every action.

Was this page helpful?