bulkOperationRunQuery

Start an async bulk export — runs a query against every matching object and writes the results to a downloadable JSONL file.

Use it in a workflow

Query

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

mutation BulkOperationRunQuery($query: String!, $groupObjects: Boolean!) {
  bulkOperationRunQuery(query: $query, groupObjects: $groupObjects) {
    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.

{
  "query": "string",
  "groupObjects": false
}

Response

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

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