Anchor to section titled 'undefined'

discountCodeRedeemCodeBulkDelete
mutation

Requires Apps must have write_discounts access scope.

Asynchronously delete discount redeem codes in bulk. Specify the redeem codes to delete by providing a search query, a saved search ID, or a list of redeem code IDs.


Anchor to discountId
discountId
required

The ID of the redeem code's discount.

The IDs of the discount redeem codes to delete.

The ID of the saved search.

The search query for filtering discount redeem codes.


Was this section helpful?

The asynchronous job that deletes the discount redeem codes.

The list of errors that occurred from executing the mutation.


Was this section helpful?

Examples

Hide code
DescriptionCopy
mutation discountCodeRedeemCodeBulkDelete($discountId: ID!, $search: String) {
  discountCodeRedeemCodeBulkDelete(discountId: $discountId, 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 discountCodeRedeemCodeBulkDelete($discountId: ID!, $search: String) { discountCodeRedeemCodeBulkDelete(discountId: $discountId, search: $search) { job { id } userErrors { code field message } } }",
 "variables": {
    "discountId": "gid://shopify/DiscountCodeNode/2429471",
    "search": "times_used:0"
  }
}'
const { admin } = await authenticate.admin(request);

const response = await admin.graphql(
  `#graphql
  mutation discountCodeRedeemCodeBulkDelete($discountId: ID!, $search: String) {
    discountCodeRedeemCodeBulkDelete(discountId: $discountId, search: $search) {
      job {
        id
      }
      userErrors {
        code
        field
        message
      }
    }
  }`,
  {
    variables: {
      "discountId": "gid://shopify/DiscountCodeNode/2429471",
      "search": "times_used:0"
    },
  },
);

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 discountCodeRedeemCodeBulkDelete($discountId: ID!, $search: String) {
    discountCodeRedeemCodeBulkDelete(discountId: $discountId, search: $search) {
      job {
        id
      }
      userErrors {
        code
        field
        message
      }
    }
  }
QUERY

variables = {
  "discountId": "gid://shopify/DiscountCodeNode/2429471",
  "search": "times_used:0"
}

response = client.query(query: query, variables: variables)
const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation discountCodeRedeemCodeBulkDelete($discountId: ID!, $search: String) {
      discountCodeRedeemCodeBulkDelete(discountId: $discountId, search: $search) {
        job {
          id
        }
        userErrors {
          code
          field
          message
        }
      }
    }`,
    "variables": {
      "discountId": "gid://shopify/DiscountCodeNode/2429471",
      "search": "times_used:0"
    },
  },
});
use Shopify\Clients\Graphql;

$client = new Graphql("your-development-store.myshopify.com", $accessToken);
$query = <<<QUERY
  mutation discountCodeRedeemCodeBulkDelete($discountId: ID!, $search: String) {
    discountCodeRedeemCodeBulkDelete(discountId: $discountId, search: $search) {
      job {
        id
      }
      userErrors {
        code
        field
        message
      }
    }
  }
QUERY;

$variables = [
  "discountId" => "gid://shopify/DiscountCodeNode/2429471",
  "search" => "times_used:0",
];

$response = $client->query(["query" => $query, "variables" => $variables]);
Hide code
Input variables
Copy
{
  "discountId": "gid://shopify/DiscountCodeNode/2429471",
  "search": "times_used:0"
}
Hide code
Response
JSON
{
  "discountCodeRedeemCodeBulkDelete": {
    "job": {
      "id": "gid://shopify/Job/f94b3a07-086d-4bfa-94b8-50172691a2e3"
    },
    "userErrors": []
  }
}