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.

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?

Asynchronously deactivate code discounts in bulk using a search filter
Using more than one argument returns an error
discountCodeBulkDeactivate reference

Examples

1const { admin } = await authenticate.admin(request);
2
3const response = await admin.graphql(
4  `#graphql
5  mutation discountCodeBulkDeactivate($search: String) {
6    discountCodeBulkDeactivate(search: $search) {
7      job {
8        id
9      }
10      userErrors {
11        code
12        field
13        message
14      }
15    }
16  }`,
17  {
18    variables: {
19      "search": "discount_type:percentage ends_at:past_week"
20    },
21  },
22);
23
24const data = await response.json();
25

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-01/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"
  }
}'

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

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

1{
2  "search": "discount_type:percentage ends_at:past_week"
3}

Response

JSON

1{
2  "discountCodeBulkDeactivate": {
3    "job": {
4      "id": "gid://shopify/Job/54e3ab26-1701-4c10-b582-875adb274811"
5    },
6    "userErrors": []
7  }
8}