Choose a version:

orderDelete

mutation

Requires write_orders access scope. Also: The user must have delete_orders permission.

Permanently deletes an Order from the store.

You can only delete specific order types. Other orders you can cancel using the orderCancel mutation instead.

Caution

This action is irreversible. You can't recover deleted orders.

Anchor to Arguments

Arguments

Anchor to orderIdorderId •ID! required: The ID of the order to be deleted.

Was this section helpful?

Anchor to OrderDeletePayload returnsOrderDeletePayload returns

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

Was this section helpful?

Examples

Delete an order

Query

mutation OrderDelete($orderId: ID!) {
  orderDelete(orderId: $orderId) {
    deletedId
    userErrors {
      field
      message
      code
    }
  }
}

Variables

{
  "orderId": "gid://shopify/Order/776341364"
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2026-01/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation OrderDelete($orderId: ID!) { orderDelete(orderId: $orderId) { deletedId userErrors { field message code } } }",
 "variables": {
    "orderId": "gid://shopify/Order/776341364"
  }
}'

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 OrderDelete($orderId: ID!) {
    orderDelete(orderId: $orderId) {
      deletedId
      userErrors {
        field
        message
        code
      }
    }
  }`,
  {
    variables: {
        "orderId": "gid://shopify/Order/776341364"
    },
  },
  );
  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 OrderDelete($orderId: ID!) {
    orderDelete(orderId: $orderId) {
      deletedId
      userErrors {
        field
        message
        code
      }
    }
  }
QUERY

variables = {
  "orderId": "gid://shopify/Order/776341364"
}

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

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation OrderDelete($orderId: ID!) {
      orderDelete(orderId: $orderId) {
        deletedId
        userErrors {
          field
          message
          code
        }
      }
    }`,
    "variables": {
        "orderId": "gid://shopify/Order/776341364"
    },
  },
});

Shopify CLI

shopify app execute \
--query \
'mutation OrderDelete($orderId: ID!) {
  orderDelete(orderId: $orderId) {
    deletedId
    userErrors {
      field
      message
      code
    }
  }
}' \
--variables \
'{
  "orderId": "gid://shopify/Order/776341364"
}'

Response

{
  "orderDelete": {
    "deletedId": "gid://shopify/Order/776341364",
    "userErrors": []
  }
}

orderDelete reference

Examples

Open in GraphiQL

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

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

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

const response = await admin.graphql(

`#graphql

mutation OrderDelete($orderId: ID!) {

orderDelete(orderId: $orderId) {

deletedId

userErrors {

field

message

code

}

}`,

{

variables: {

"orderId": "gid://shopify/Order/776341364"

);

const json = await response.json();

return json.data;

}

GQL

mutation OrderDelete($orderId: ID!) {
  orderDelete(orderId: $orderId) {
    deletedId
    userErrors {
      field
      message
      code
    }
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2026-01/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation OrderDelete($orderId: ID!) { orderDelete(orderId: $orderId) { deletedId userErrors { field message code } } }",
 "variables": {
    "orderId": "gid://shopify/Order/776341364"
  }
}'

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 OrderDelete($orderId: ID!) {
    orderDelete(orderId: $orderId) {
      deletedId
      userErrors {
        field
        message
        code
      }
    }
  }`,
  {
    variables: {
        "orderId": "gid://shopify/Order/776341364"
    },
  },
  );
  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 OrderDelete($orderId: ID!) {
      orderDelete(orderId: $orderId) {
        deletedId
        userErrors {
          field
          message
          code
        }
      }
    }`,
    "variables": {
        "orderId": "gid://shopify/Order/776341364"
    },
  },
});

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 OrderDelete($orderId: ID!) {
    orderDelete(orderId: $orderId) {
      deletedId
      userErrors {
        field
        message
        code
      }
    }
  }
QUERY

variables = {
  "orderId": "gid://shopify/Order/776341364"
}

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

Shopify CLI

shopify app execute \
--query \
'mutation OrderDelete($orderId: ID!) {
  orderDelete(orderId: $orderId) {
    deletedId
    userErrors {
      field
      message
      code
    }
  }
}' \
--variables \
'{
  "orderId": "gid://shopify/Order/776341364"
}'

Input variables

JSON

{

"orderId": "gid://shopify/Order/776341364"

}

Response

JSON

{

"orderDelete": {

"deletedId": "gid://shopify/Order/776341364",

"userErrors": []

}