orderDelete

mutation

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

Deletes an order. For more information on which orders can be deleted, refer to Delete an order.

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?

Delete an order
orderDelete reference

Examples

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 data = await response.json();

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

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2024-10/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"
  }
}'

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 data = await response.json();

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"
    },
  },
});

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)

Input variables

JSON

{

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

}

Response

JSON

{

"orderDelete": {

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

"userErrors": []

}