draftOrderBulkDelete
mutation

Choose a version:

Requires write_draft_orders access scope. Also: The user must have access to delete multiple draft orders.

Deletes multiple draft orders.

Anchor to section titled 'Arguments'

Arguments

Anchor to ids ids [ID!]: The IDs of the draft orders to delete.
Anchor to savedSearchId savedSearchId ID: The ID of the draft order saved search for filtering draft orders on.
Anchor to search search String: The conditions for filtering draft orders on. See the detailed search syntax.

Was this section helpful?

Anchor to section titled 'DraftOrderBulkDeletePayload returns'

DraftOrderBulkDeletePayload returns

Anchor to DraftOrderBulkDeletePayload.job job Job: The asynchronous job for deleting the draft orders.
Anchor to DraftOrderBulkDeletePayload.userErrors userErrors [UserError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Code examples for MUTATION: draftOrderBulkDelete

Query Reference for MUTATION: draftOrderBulkDelete

"mutation draftOrderBulkDelete {\n  draftOrderBulkDelete {\n    job {\n      # Job fields\n    }\n    userErrors {\n      field\n      message\n    }\n  }\n}"

Input Reference for MUTATION: draftOrderBulkDelete

"{\n  \"ids\": [\n    \"gid://shopify/<objectName>/10079785100\"\n  ],\n  \"savedSearchId\": \"gid://shopify/<objectName>/10079785100\",\n  \"search\": \"<your-search>\"\n}"

Schema Reference for MUTATION: draftOrderBulkDelete

""

Display Examples for MUTATION: draftOrderBulkDelete

[]

draftOrderBulkDeletemutation

Arguments

DraftOrderBulkDeletePayload returns

draftOrderBulkDelete
mutation