Choose a version:

draftOrderDelete

mutation

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

Deletes a draft order.

Anchor to Arguments

Arguments

Anchor to inputinput

•DraftOrderDeleteInput!

required

Specify the draft order to delete by its ID.

Show input fields

Was this section helpful?

Anchor to DraftOrderDeletePayload returnsDraftOrderDeletePayload returns

Anchor to deletedIddeletedId •ID: The ID of the deleted draft order.
Anchor to userErrorsuserErrors •[UserError!]! non-null: The list of errors that occurred from executing the mutation.

Show fields

Was this section helpful?

Examples

Delete a draft order by ID and return the deleted ID

Query

mutation draftOrderDelete($input: DraftOrderDeleteInput!) {
  draftOrderDelete(input: $input) {
    deletedId
  }
}

Variables

{
  "input": {
    "id": "gid://shopify/DraftOrder/276395349"
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2026-04/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation draftOrderDelete($input: DraftOrderDeleteInput!) { draftOrderDelete(input: $input) { deletedId } }",
 "variables": {
    "input": {
      "id": "gid://shopify/DraftOrder/276395349"
    }
  }
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  mutation draftOrderDelete($input: DraftOrderDeleteInput!) {
    draftOrderDelete(input: $input) {
      deletedId
    }
  }`,
  {
    variables: {
        "input": {
            "id": "gid://shopify/DraftOrder/276395349"
        }
    },
  },
  );
  const json = await response.json();
  return json.data;
}

Ruby

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~QUERY
  mutation draftOrderDelete($input: DraftOrderDeleteInput!) {
    draftOrderDelete(input: $input) {
      deletedId
    }
  }
QUERY

variables = {
  "input": {
    "id": "gid://shopify/DraftOrder/276395349"
  }
}

response = client.query(query: query, variables: variables)

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation draftOrderDelete($input: DraftOrderDeleteInput!) {
      draftOrderDelete(input: $input) {
        deletedId
      }
    }`,
    "variables": {
        "input": {
            "id": "gid://shopify/DraftOrder/276395349"
        }
    },
  },
});

Shopify CLI

shopify app execute \
--query \
'mutation draftOrderDelete($input: DraftOrderDeleteInput!) {
  draftOrderDelete(input: $input) {
    deletedId
  }
}' \
--variables \
'{
  "input": {
    "id": "gid://shopify/DraftOrder/276395349"
  }
}'

Direct API Access

const response = await fetch('shopify:admin/api/2026-04/graphql.json', {
  method: 'POST',
  body: JSON.stringify({
    query: `
      mutation draftOrderDelete($input: DraftOrderDeleteInput!) {
        draftOrderDelete(input: $input) {
          deletedId
        }
      }
    `,
    variables: {
        "input": {
            "id": "gid://shopify/DraftOrder/276395349"
        }
    },
  }),
});

const { data } = await response.json();
console.log(data);

Response

{
  "draftOrderDelete": {
    "deletedId": "gid://shopify/DraftOrder/276395349"
  }
}

Deleting a draft order that doesn't exist returns an error

Query

mutation draftOrderDelete($input: DraftOrderDeleteInput!) {
  draftOrderDelete(input: $input) {
    deletedId
    userErrors {
      message
      field
    }
  }
}

Variables

{
  "input": {
    "id": "gid://shopify/DraftOrder/1"
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2026-04/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation draftOrderDelete($input: DraftOrderDeleteInput!) { draftOrderDelete(input: $input) { deletedId userErrors { message field } } }",
 "variables": {
    "input": {
      "id": "gid://shopify/DraftOrder/1"
    }
  }
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  mutation draftOrderDelete($input: DraftOrderDeleteInput!) {
    draftOrderDelete(input: $input) {
      deletedId
      userErrors {
        message
        field
      }
    }
  }`,
  {
    variables: {
        "input": {
            "id": "gid://shopify/DraftOrder/1"
        }
    },
  },
  );
  const json = await response.json();
  return json.data;
}

Ruby

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~QUERY
  mutation draftOrderDelete($input: DraftOrderDeleteInput!) {
    draftOrderDelete(input: $input) {
      deletedId
      userErrors {
        message
        field
      }
    }
  }
QUERY

variables = {
  "input": {
    "id": "gid://shopify/DraftOrder/1"
  }
}

response = client.query(query: query, variables: variables)

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation draftOrderDelete($input: DraftOrderDeleteInput!) {
      draftOrderDelete(input: $input) {
        deletedId
        userErrors {
          message
          field
        }
      }
    }`,
    "variables": {
        "input": {
            "id": "gid://shopify/DraftOrder/1"
        }
    },
  },
});

Shopify CLI

shopify app execute \
--query \
'mutation draftOrderDelete($input: DraftOrderDeleteInput!) {
  draftOrderDelete(input: $input) {
    deletedId
    userErrors {
      message
      field
    }
  }
}' \
--variables \
'{
  "input": {
    "id": "gid://shopify/DraftOrder/1"
  }
}'

Direct API Access

const response = await fetch('shopify:admin/api/2026-04/graphql.json', {
  method: 'POST',
  body: JSON.stringify({
    query: `
      mutation draftOrderDelete($input: DraftOrderDeleteInput!) {
        draftOrderDelete(input: $input) {
          deletedId
          userErrors {
            message
            field
          }
        }
      }
    `,
    variables: {
        "input": {
            "id": "gid://shopify/DraftOrder/1"
        }
    },
  }),
});

const { data } = await response.json();
console.log(data);

Response

{
  "draftOrderDelete": {
    "deletedId": null,
    "userErrors": [
      {
        "message": "Draft order not found",
        "field": null
      }
    ]
  }
}

Remove an existing DraftOrder

Query

mutation draftOrderDelete($input: DraftOrderDeleteInput!) {
  draftOrderDelete(input: $input) {
    deletedId
    userErrors {
      field
      message
    }
  }
}

Variables

{
  "input": {
    "id": "gid://shopify/DraftOrder/276395349"
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2026-04/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation draftOrderDelete($input: DraftOrderDeleteInput!) { draftOrderDelete(input: $input) { deletedId userErrors { field message } } }",
 "variables": {
    "input": {
      "id": "gid://shopify/DraftOrder/276395349"
    }
  }
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  mutation draftOrderDelete($input: DraftOrderDeleteInput!) {
    draftOrderDelete(input: $input) {
      deletedId
      userErrors {
        field
        message
      }
    }
  }`,
  {
    variables: {
        "input": {
            "id": "gid://shopify/DraftOrder/276395349"
        }
    },
  },
  );
  const json = await response.json();
  return json.data;
}

Ruby

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~QUERY
  mutation draftOrderDelete($input: DraftOrderDeleteInput!) {
    draftOrderDelete(input: $input) {
      deletedId
      userErrors {
        field
        message
      }
    }
  }
QUERY

variables = {
  "input": {
    "id": "gid://shopify/DraftOrder/276395349"
  }
}

response = client.query(query: query, variables: variables)

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation draftOrderDelete($input: DraftOrderDeleteInput!) {
      draftOrderDelete(input: $input) {
        deletedId
        userErrors {
          field
          message
        }
      }
    }`,
    "variables": {
        "input": {
            "id": "gid://shopify/DraftOrder/276395349"
        }
    },
  },
});

Shopify CLI

shopify app execute \
--query \
'mutation draftOrderDelete($input: DraftOrderDeleteInput!) {
  draftOrderDelete(input: $input) {
    deletedId
    userErrors {
      field
      message
    }
  }
}' \
--variables \
'{
  "input": {
    "id": "gid://shopify/DraftOrder/276395349"
  }
}'

Direct API Access

const response = await fetch('shopify:admin/api/2026-04/graphql.json', {
  method: 'POST',
  body: JSON.stringify({
    query: `
      mutation draftOrderDelete($input: DraftOrderDeleteInput!) {
        draftOrderDelete(input: $input) {
          deletedId
          userErrors {
            field
            message
          }
        }
      }
    `,
    variables: {
        "input": {
            "id": "gid://shopify/DraftOrder/276395349"
        }
    },
  }),
});

const { data } = await response.json();
console.log(data);

Response

{
  "draftOrderDelete": {
    "deletedId": "gid://shopify/DraftOrder/276395349",
    "userErrors": []
  }
}

draftOrderDelete reference

Examples

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(

`#graphql

mutation draftOrderDelete($input: DraftOrderDeleteInput!) {

draftOrderDelete(input: $input) {

deletedId

}

}`,

{

variables: {

"input": {

"id": "gid://shopify/DraftOrder/276395349"

}

);

const json = await response.json();

return json.data;

}

GQL

mutation draftOrderDelete($input: DraftOrderDeleteInput!) {
  draftOrderDelete(input: $input) {
    deletedId
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2026-04/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation draftOrderDelete($input: DraftOrderDeleteInput!) { draftOrderDelete(input: $input) { deletedId } }",
 "variables": {
    "input": {
      "id": "gid://shopify/DraftOrder/276395349"
    }
  }
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  mutation draftOrderDelete($input: DraftOrderDeleteInput!) {
    draftOrderDelete(input: $input) {
      deletedId
    }
  }`,
  {
    variables: {
        "input": {
            "id": "gid://shopify/DraftOrder/276395349"
        }
    },
  },
  );
  const json = await response.json();
  return json.data;
}

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation draftOrderDelete($input: DraftOrderDeleteInput!) {
      draftOrderDelete(input: $input) {
        deletedId
      }
    }`,
    "variables": {
        "input": {
            "id": "gid://shopify/DraftOrder/276395349"
        }
    },
  },
});

Ruby

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~QUERY
  mutation draftOrderDelete($input: DraftOrderDeleteInput!) {
    draftOrderDelete(input: $input) {
      deletedId
    }
  }
QUERY

variables = {
  "input": {
    "id": "gid://shopify/DraftOrder/276395349"
  }
}

response = client.query(query: query, variables: variables)

Shopify CLI

shopify app execute \
--query \
'mutation draftOrderDelete($input: DraftOrderDeleteInput!) {
  draftOrderDelete(input: $input) {
    deletedId
  }
}' \
--variables \
'{
  "input": {
    "id": "gid://shopify/DraftOrder/276395349"
  }
}'

Direct API Access

const response = await fetch('shopify:admin/api/2026-04/graphql.json', {
  method: 'POST',
  body: JSON.stringify({
    query: `
      mutation draftOrderDelete($input: DraftOrderDeleteInput!) {
        draftOrderDelete(input: $input) {
          deletedId
        }
      }
    `,
    variables: {
        "input": {
            "id": "gid://shopify/DraftOrder/276395349"
        }
    },
  }),
});

const { data } = await response.json();
console.log(data);

Input variables

JSON

{

"input": {

"id": "gid://shopify/DraftOrder/276395349"

}

Response

JSON

{

"draftOrderDelete": {

"deletedId": "gid://shopify/DraftOrder/276395349"

}