bulkOperationRunQuery mutation

Creates and runs a bulk operation query.

See the bulk operations guide for more details.

On this page

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.

mutation bulkOperationRunQuery($query: String!) { bulkOperationRunQuery(query: $query) { 
  1. <font style="color:#1F61A0;">bulkOperation</font> <font style="color:#555555;">{</font>
  3.   <font style="color:#1F61A0;">id</font>
  5. <font style="color:#555555;">}</font>
  7. <font style="color:#1F61A0;">userErrors</font> <font style="color:#555555;">{</font>
  9.   <font style="color:#1F61A0;">field</font>
  11.   <font style="color:#1F61A0;">message</font>
  13. <font style="color:#555555;">}</font>
} } { “query”: “placeholder” }

Arguments

Argument Description
query
(
[String!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)

) REQUIRED		 The query to be executed in bulk.

Return fields

  • bulkOperation ([BulkOperation](https://shopify.dev/docs/admin-api/graphql/reference/bulk-operations/bulkoperation))
    The newly created bulk operation.
  • userErrors ([[UserError!]!](https://shopify.dev/docs/admin-api/graphql/reference/usererror))
    List of errors that occurred executing the mutation.