Choose a version:

discountCodeRedeemCodeBulkDelete

mutation

Requires Apps must have write_discounts access scope.

Asynchronously delete discount codes in bulk that customers can use to redeem a discount.

Arguments

Anchor to discountIddiscountId • ID!required: The ID of the DiscountCodeNode object that the codes will be removed from. For example, gid://shopify/DiscountCodeNode/123. You can use the codeDiscountNodes query to retrieve the ID.
Anchor to idsids • [ID!]: The IDs of the DiscountRedeemCode objects to delete. For example, gid://shopify/DiscountRedeemCode/123. You can use the codeDiscountNodes query to retrieve the ID.
Anchor to savedSearchIdsavedSearchId • ID: The ID of a saved search.
Anchor to searchsearch • String: A filter made up of terms, connectives, modifiers, and comparators that you can use to search for code discounts. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

For a list of accepted values for the search field, refer to the query argument on the codeDiscountNodes query.

Was this section helpful?

Anchor to DiscountCodeRedeemCodeBulkDeletePayload returnsDiscountCodeRedeemCodeBulkDeletePayload returns

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

Was this section helpful?

Asynchronously delete discount redeem codes in bulk using a search filter
Deletes a discount code
Using more than one targeting argument returns an error
discountCodeRedeemCodeBulkDelete reference

Examples

Open in GraphiQL

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

const response = await admin.graphql(

`#graphql

mutation discountCodeRedeemCodeBulkDelete($discountId: ID!, $search: String) {

discountCodeRedeemCodeBulkDelete(discountId: $discountId, search: $search) {

job {

}

userErrors {

code

field

message

}

}`,

{

variables: {

"discountId": "gid://shopify/DiscountCodeNode/2429471",

"search": "times_used:0"

);

const data = await response.json();

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-07/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();

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"
    },
  },
});

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)

Input variables

JSON

{

"discountId": "gid://shopify/DiscountCodeNode/2429471",

"search": "times_used:0"

}

Response

JSON

{

"discountCodeRedeemCodeBulkDelete": {

"job": {

"id": "gid://shopify/Job/a2337b55-0b31-44d9-9027-f4fefc5317d5"

"userErrors": []

}