Anchor to section titled 'undefined'

discountCodeBulkDeactivate
mutation

Requires Apps must have write_discounts access scope.

Asynchronously deactivate code discounts in bulk using a search query, a saved search ID, or a list of code discount IDs.


The IDs of the code discounts to deactivate.

The ID of the saved search.

The search query for filtering code discounts.

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


Was this section helpful?

The asynchronous job that deactivates the code discounts.

The list of errors that occurred from executing the mutation.


Was this section helpful?

Examples

Hide code
DescriptionCopy
mutation discountCodeBulkDeactivate($search: String) {
  discountCodeBulkDeactivate(search: $search) {
    job {
      id
    }
    userErrors {
      code
      field
      message
    }
  }
}
curl -X POST \
https://your-development-store.myshopify.com/admin/api/2024-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();
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)
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"
    },
  },
});
use Shopify\Clients\Graphql;

$client = new Graphql("your-development-store.myshopify.com", $accessToken);
$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]);
Hide code
Input variables
Copy
{
  "search": "discount_type:percentage ends_at:past_week"
}
Hide code
Response
JSON
{
  "discountCodeBulkDeactivate": {
    "job": {
      "id": "gid://shopify/Job/18cd2ec6-34b1-4c8c-a156-9b467a6a4c3d"
    },
    "userErrors": []
  }
}