Anchor to draftOrderBulkDeletedraft
draftOrderBulkDelete
mutation
Requires access scope. Also: The user must have access to delete multiple draft orders.
Deletes multiple draft orders.
Anchor to Arguments
Arguments
- •
The IDs of the draft orders to delete.
- Anchor to savedSearchIdsaved•
Search Id The ID of the draft order saved search for filtering draft orders on.
- Anchor to searchsearch•
The conditions for filtering draft orders on. See the detailed search syntax.
Was this section helpful?
Anchor to DraftOrderBulkDeletePayload returnsDraftOrderBulkDeletePayload returns
- •
The asynchronous job for deleting the draft orders.
- Anchor to userErrorsuser•
Errors [UserError!]! non-null The list of errors that occurred from executing the mutation.
Was this section helpful?
Mutation Reference
mutation draftOrderBulkDelete($ids: [ID!], $savedSearchId: ID, $search: String) {
draftOrderBulkDelete(ids: $ids, savedSearchId: $savedSearchId, search: $search) {
job {
# Job fields
}
userErrors {
field
message
}
}
}
Input
{
"ids": [
"gid://shopify/<objectName>/10079785100"
],
"savedSearchId": "gid://shopify/<objectName>/10079785100",
"search": "<your-search>"
}
{
"ids": [
"gid://shopify/<objectName>/10079785100"
],
"savedSearchId": "gid://shopify/<objectName>/10079785100",
"search": "<your-search>"
}