bulkOperationCancel
mutation

Choose a version:

Starts the cancelation process of a running bulk operation.

There may be a short delay from when a cancelation starts until the operation is actually canceled.

Anchor to section titled 'Arguments'

Arguments

Anchor to id id ID! required: The ID of the bulk operation to cancel.

Was this section helpful?

Anchor to section titled 'BulkOperationCancelPayload returns'

BulkOperationCancelPayload returns

Anchor to BulkOperationCancelPayload.bulkOperation bulkOperation BulkOperation: The bulk operation to be canceled.
Anchor to BulkOperationCancelPayload.userErrors userErrors [UserError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Code examples for MUTATION: bulkOperationCancel

Query Reference for MUTATION: bulkOperationCancel

"mutation bulkOperationCancel($id: ID!) {\n  bulkOperationCancel(id: $id) {\n    bulkOperation {\n      # BulkOperation fields\n    }\n    userErrors {\n      field\n      message\n    }\n  }\n}"

Input Reference for MUTATION: bulkOperationCancel

"{\n  \"id\": \"gid://shopify/<objectName>/10079785100\"\n}"

Schema Reference for MUTATION: bulkOperationCancel

""

Display Examples for MUTATION: bulkOperationCancel

[]

bulkOperationCancelmutation

Arguments

BulkOperationCancelPayload returns

bulkOperationCancel
mutation