discountAutomaticDeactivate

mutation

Requires Apps must have write_discounts access scope.

Deactivates an automatic discount.

Arguments

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

Was this section helpful?

Anchor to DiscountAutomaticDeactivatePayload returnsDiscountAutomaticDeactivatePayload returns

Anchor to automaticDiscountNodeautomaticDiscountNode • DiscountAutomaticNode: The deactivated automatic discount.
Anchor to userErrorsuserErrors • [DiscountUserError!]!non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Deactivate an active automatic discount
Deactivate an automatic discount set to start in the future
discountAutomaticDeactivate reference

Examples

1const { admin } = await authenticate.admin(request);
2
3const response = await admin.graphql(
4  `#graphql
5  mutation discountAutomaticDeactivate($id: ID!) {
6    discountAutomaticDeactivate(id: $id) {
7      automaticDiscountNode {
8        automaticDiscount {
9          ... on DiscountAutomaticBxgy {
10            status
11            startsAt
12            endsAt
13          }
14        }
15      }
16      userErrors {
17        field
18        message
19      }
20    }
21  }`,
22  {
23    variables: {
24      "id": "gid://shopify/DiscountAutomaticNode/198286294"
25    },
26  },
27);
28
29const data = await response.json();
30

mutation discountAutomaticDeactivate($id: ID!) {
  discountAutomaticDeactivate(id: $id) {
    automaticDiscountNode {
      automaticDiscount {
        ... on DiscountAutomaticBxgy {
          status
          startsAt
          endsAt
        }
      }
    }
    userErrors {
      field
      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 discountAutomaticDeactivate($id: ID!) { discountAutomaticDeactivate(id: $id) { automaticDiscountNode { automaticDiscount { ... on DiscountAutomaticBxgy { status startsAt endsAt } } } userErrors { field message } } }",
 "variables": {
    "id": "gid://shopify/DiscountAutomaticNode/198286294"
  }
}'

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

const response = await admin.graphql(
  `#graphql
  mutation discountAutomaticDeactivate($id: ID!) {
    discountAutomaticDeactivate(id: $id) {
      automaticDiscountNode {
        automaticDiscount {
          ... on DiscountAutomaticBxgy {
            status
            startsAt
            endsAt
          }
        }
      }
      userErrors {
        field
        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 discountAutomaticDeactivate($id: ID!) {
      discountAutomaticDeactivate(id: $id) {
        automaticDiscountNode {
          automaticDiscount {
            ... on DiscountAutomaticBxgy {
              status
              startsAt
              endsAt
            }
          }
        }
        userErrors {
          field
          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 discountAutomaticDeactivate($id: ID!) {
    discountAutomaticDeactivate(id: $id) {
      automaticDiscountNode {
        automaticDiscount {
          ... on DiscountAutomaticBxgy {
            status
            startsAt
            endsAt
          }
        }
      }
      userErrors {
        field
        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  "discountAutomaticDeactivate": {
3    "automaticDiscountNode": {
4      "automaticDiscount": {
5        "status": "EXPIRED",
6        "startsAt": "2024-09-12T01:08:08Z",
7        "endsAt": "2024-09-12T01:08:08Z"
8      }
9    },
10    "userErrors": []
11  }
12}