discountAutomaticDelete

mutation

Requires Apps must have write_discounts access scope.

Deletes an automatic discount.

Arguments

Anchor to idid • ID!required: The ID of the automatic discount to delete.

Was this section helpful?

Anchor to DiscountAutomaticDeletePayload returnsDiscountAutomaticDeletePayload returns

Anchor to deletedAutomaticDiscountIddeletedAutomaticDiscountId • ID: The ID of the automatic discount that was deleted.
Anchor to userErrorsuserErrors • [DiscountUserError!]!non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Delete an automatic discount
Remove an existing PriceRule
discountAutomaticDelete reference

Examples

1const { admin } = await authenticate.admin(request);
2
3const response = await admin.graphql(
4  `#graphql
5  mutation discountAutomaticDelete($id: ID!) {
6    discountAutomaticDelete(id: $id) {
7      deletedAutomaticDiscountId
8      userErrors {
9        field
10        code
11        message
12      }
13    }
14  }`,
15  {
16    variables: {
17      "id": "gid://shopify/DiscountAutomaticNode/198286294"
18    },
19  },
20);
21
22const data = await response.json();
23

mutation discountAutomaticDelete($id: ID!) {
  discountAutomaticDelete(id: $id) {
    deletedAutomaticDiscountId
    userErrors {
      field
      code
      message
    }
  }
}

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-04/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation discountAutomaticDelete($id: ID!) { discountAutomaticDelete(id: $id) { deletedAutomaticDiscountId userErrors { field code message } } }",
 "variables": {
    "id": "gid://shopify/DiscountAutomaticNode/198286294"
  }
}'

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

const response = await admin.graphql(
  `#graphql
  mutation discountAutomaticDelete($id: ID!) {
    discountAutomaticDelete(id: $id) {
      deletedAutomaticDiscountId
      userErrors {
        field
        code
        message
      }
    }
  }`,
  {
    variables: {
      "id": "gid://shopify/DiscountAutomaticNode/198286294"
    },
  },
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation discountAutomaticDelete($id: ID!) {
      discountAutomaticDelete(id: $id) {
        deletedAutomaticDiscountId
        userErrors {
          field
          code
          message
        }
      }
    }`,
    "variables": {
      "id": "gid://shopify/DiscountAutomaticNode/198286294"
    },
  },
});

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 discountAutomaticDelete($id: ID!) {
    discountAutomaticDelete(id: $id) {
      deletedAutomaticDiscountId
      userErrors {
        field
        code
        message
      }
    }
  }
QUERY

variables = {
  "id": "gid://shopify/DiscountAutomaticNode/198286294"
}

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

Input variables

JSON

1{
2  "id": "gid://shopify/DiscountAutomaticNode/198286294"
3}

Response

JSON

1{
2  "discountAutomaticDelete": {
3    "deletedAutomaticDiscountId": "gid://shopify/DiscountAutomaticNode/198286294",
4    "userErrors": []
5  }
6}