discountCodeBulkActivate

mutation

Requires Apps must have write_discounts access scope.

Activates multiple code discounts asynchronously using one of the following:

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

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

Arguments

Anchor to idsids • [ID!]: The IDs of the discounts to activate.
Anchor to savedSearchIdsavedSearchId • ID: The ID of the saved search for filtering discounts to activate. 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 DiscountCodeBulkActivatePayload returnsDiscountCodeBulkActivatePayload returns

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

Was this section helpful?

Asynchronously activate code discounts in bulk using a search filter
Using more than one targeting argument returns an error
discountCodeBulkActivate reference

Examples

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

const response = await admin.graphql(

`#graphql

mutation discountCodeBulkActivate($search: String) {

discountCodeBulkActivate(search: $search) {

job {

}

userErrors {

code

field

message

}

}`,

{

variables: {

"search": "discount_type:percentage starts_at:past_week"

);

const data = await response.json();

mutation discountCodeBulkActivate($search: String) {
  discountCodeBulkActivate(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 discountCodeBulkActivate($search: String) { discountCodeBulkActivate(search: $search) { job { id } userErrors { code field message } } }",
 "variables": {
    "search": "discount_type:percentage starts_at:past_week"
  }
}'

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

const response = await admin.graphql(
  `#graphql
  mutation discountCodeBulkActivate($search: String) {
    discountCodeBulkActivate(search: $search) {
      job {
        id
      }
      userErrors {
        code
        field
        message
      }
    }
  }`,
  {
    variables: {
      "search": "discount_type:percentage starts_at:past_week"
    },
  },
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation discountCodeBulkActivate($search: String) {
      discountCodeBulkActivate(search: $search) {
        job {
          id
        }
        userErrors {
          code
          field
          message
        }
      }
    }`,
    "variables": {
      "search": "discount_type:percentage starts_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 discountCodeBulkActivate($search: String) {
    discountCodeBulkActivate(search: $search) {
      job {
        id
      }
      userErrors {
        code
        field
        message
      }
    }
  }
QUERY

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

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

Input variables

JSON

{

"search": "discount_type:percentage starts_at:past_week"

}

Response

JSON

{

"discountCodeBulkActivate": {

"job": {

"id": "gid://shopify/Job/2c09b7e9-e9b3-435a-8ab4-2c35f3eeb6b1"

"userErrors": []

}