Choose a version:

discountCodeBulkDeactivate

mutation

Requires Apps must have write_discounts access scope.

Deactivates multiple code-based discounts asynchronously using one of the following:

A search query
A saved search ID
A list of discount code IDs

For example, you can deactivate discounts for all codes that match a search criteria, or deactivate a predefined set of discount codes.

Anchor to Arguments

Arguments

Anchor to idsids •[ID!]: The IDs of the discounts to deactivate.
Anchor to savedSearchIdsavedSearchId •ID: The ID of the saved search for filtering discounts to deactivate. Saved searches represent customer segments that merchants have built in the Shopify admin.
Anchor to searchsearch •String: The search query for filtering discounts.

For more information on the list of supported fields and search syntax, refer to the codeDiscountNodes query.

Was this section helpful?

Anchor to DiscountCodeBulkDeactivatePayload returnsDiscountCodeBulkDeactivatePayload returns

Anchor to jobjob •Job: The asynchronous job that deactivates the discounts.
Anchor to userErrorsuserErrors •[DiscountUserError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Examples

Asynchronously deactivate code discounts in bulk using a search filter

Description

Asynchronously deactivate all [code discounts](https://help.shopify.com/manual/discounts/discount-types#discount-codes) that expired in the past week and provide a percentage off the products in an order.

Query

mutation discountCodeBulkDeactivate($search: String) {
  discountCodeBulkDeactivate(search: $search) {
    job {
      id
    }
    userErrors {
      code
      field
      message
    }
  }
}

Variables

{
  "search": "discount_type:percentage ends_at:past_week"
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-10/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation discountCodeBulkDeactivate($search: String) { discountCodeBulkDeactivate(search: $search) { job { id } userErrors { code field message } } }",
 "variables": {
    "search": "discount_type:percentage ends_at:past_week"
  }
}'

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 discountCodeBulkDeactivate($search: String) {
    discountCodeBulkDeactivate(search: $search) {
      job {
        id
      }
      userErrors {
        code
        field
        message
      }
    }
  }`,
  {
    variables: {
        "search": "discount_type:percentage ends_at:past_week"
    },
  },
  );
  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 discountCodeBulkDeactivate($search: String) {
    discountCodeBulkDeactivate(search: $search) {
      job {
        id
      }
      userErrors {
        code
        field
        message
      }
    }
  }
QUERY

variables = {
  "search": "discount_type:percentage ends_at:past_week"
}

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

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation discountCodeBulkDeactivate($search: String) {
      discountCodeBulkDeactivate(search: $search) {
        job {
          id
        }
        userErrors {
          code
          field
          message
        }
      }
    }`,
    "variables": {
        "search": "discount_type:percentage ends_at:past_week"
    },
  },
});

Response

{
  "discountCodeBulkDeactivate": {
    "job": {
      "id": "gid://shopify/Job/54e3ab26-1701-4c10-b582-875adb274811"
    },
    "userErrors": []
  }
}

Using more than one argument returns an error

Description

If you use both `search` and `ids` arguments in the same request, then the mutation returns an error.

Query

mutation discountCodeBulkDeactivate($search: String, $ids: [ID!]) {
  discountCodeBulkDeactivate(search: $search, ids: $ids) {
    job {
      id
    }
    userErrors {
      code
      field
      message
    }
  }
}

Variables

{
  "ids": [
    "gid://shopify/DiscountCodeNode/1"
  ],
  "search": "discount_type:bxgy"
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-10/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation discountCodeBulkDeactivate($search: String, $ids: [ID!]) { discountCodeBulkDeactivate(search: $search, ids: $ids) { job { id } userErrors { code field message } } }",
 "variables": {
    "ids": [
      "gid://shopify/DiscountCodeNode/1"
    ],
    "search": "discount_type:bxgy"
  }
}'

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 discountCodeBulkDeactivate($search: String, $ids: [ID!]) {
    discountCodeBulkDeactivate(search: $search, ids: $ids) {
      job {
        id
      }
      userErrors {
        code
        field
        message
      }
    }
  }`,
  {
    variables: {
        "ids": [
            "gid://shopify/DiscountCodeNode/1"
        ],
        "search": "discount_type:bxgy"
    },
  },
  );
  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 discountCodeBulkDeactivate($search: String, $ids: [ID!]) {
    discountCodeBulkDeactivate(search: $search, ids: $ids) {
      job {
        id
      }
      userErrors {
        code
        field
        message
      }
    }
  }
QUERY

variables = {
  "ids": [
    "gid://shopify/DiscountCodeNode/1"
  ],
  "search": "discount_type:bxgy"
}

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

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation discountCodeBulkDeactivate($search: String, $ids: [ID!]) {
      discountCodeBulkDeactivate(search: $search, ids: $ids) {
        job {
          id
        }
        userErrors {
          code
          field
          message
        }
      }
    }`,
    "variables": {
        "ids": [
            "gid://shopify/DiscountCodeNode/1"
        ],
        "search": "discount_type:bxgy"
    },
  },
});

Response

{
  "discountCodeBulkDeactivate": {
    "job": null,
    "userErrors": [
      {
        "code": "TOO_MANY_ARGUMENTS",
        "field": null,
        "message": "Only one of 'ids', 'search' or 'saved_search_id' is allowed."
      }
    ]
  }
}

discountCodeBulkDeactivate 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 discountCodeBulkDeactivate($search: String) {

discountCodeBulkDeactivate(search: $search) {

job {

}

userErrors {

code

field

message

}

}`,

{

variables: {

"search": "discount_type:percentage ends_at:past_week"

);

const json = await response.json();

return json.data;

}

mutation discountCodeBulkDeactivate($search: String) {
  discountCodeBulkDeactivate(search: $search) {
    job {
      id
    }
    userErrors {
      code
      field
      message
    }
  }
}

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-10/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation discountCodeBulkDeactivate($search: String) { discountCodeBulkDeactivate(search: $search) { job { id } userErrors { code field message } } }",
 "variables": {
    "search": "discount_type:percentage ends_at:past_week"
  }
}'

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

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  mutation discountCodeBulkDeactivate($search: String) {
    discountCodeBulkDeactivate(search: $search) {
      job {
        id
      }
      userErrors {
        code
        field
        message
      }
    }
  }`,
  {
    variables: {
        "search": "discount_type:percentage ends_at:past_week"
    },
  },
  );
  const json = await response.json();
  return json.data;
}

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation discountCodeBulkDeactivate($search: String) {
      discountCodeBulkDeactivate(search: $search) {
        job {
          id
        }
        userErrors {
          code
          field
          message
        }
      }
    }`,
    "variables": {
        "search": "discount_type:percentage ends_at:past_week"
    },
  },
});

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 discountCodeBulkDeactivate($search: String) {
    discountCodeBulkDeactivate(search: $search) {
      job {
        id
      }
      userErrors {
        code
        field
        message
      }
    }
  }
QUERY

variables = {
  "search": "discount_type:percentage ends_at:past_week"
}

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

Input variables

JSON

{

"search": "discount_type:percentage ends_at:past_week"

}

Response

JSON

{

"discountCodeBulkDeactivate": {

"job": {

"id": "gid://shopify/Job/54e3ab26-1701-4c10-b582-875adb274811"

"userErrors": []

}