# discountCodeRedeemCodeBulkDelete - admin-graphql - MUTATION Version: 2024-10 ## Description 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. ### Access Scopes Apps must have `write_discounts` access scope. ## Arguments * [discountId](/docs/api/admin-graphql/2024-10/scalars/ID): ID! - The ID of the redeem code's discount. * [ids](/docs/api/admin-graphql/2024-10/scalars/ID): ID - The IDs of the discount redeem codes to delete. * [savedSearchId](/docs/api/admin-graphql/2024-10/scalars/ID): ID - The ID of the saved search. * [search](/docs/api/admin-graphql/2024-10/scalars/String): String - The search query for filtering discount redeem codes. ## Returns * [job](/docs/api/admin-graphql/2024-10/objects/Job): Job The asynchronous job that deletes the discount redeem codes. * [userErrors](/docs/api/admin-graphql/2024-10/objects/DiscountUserError): DiscountUserError! The list of errors that occurred from executing the mutation. ## Examples ### Asynchronously delete discount redeem codes in bulk using a search filter Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation discountCodeRedeemCodeBulkDelete($discountId: ID!, $search: String) { discountCodeRedeemCodeBulkDelete(discountId: $discountId, search: $search) { job { id } userErrors { code field message } } }\",\n \"variables\": {\n \"discountId\": \"gid://shopify/DiscountCodeNode/2429471\",\n \"search\": \"times_used:0\"\n }\n}'\n" Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n data: {\n \"query\": `mutation discountCodeRedeemCodeBulkDelete($discountId: ID!, $search: String) {\n discountCodeRedeemCodeBulkDelete(discountId: $discountId, search: $search) {\n job {\n id\n }\n userErrors {\n code\n field\n message\n }\n }\n }`,\n \"variables\": {\n \"discountId\": \"gid://shopify/DiscountCodeNode/2429471\",\n \"search\": \"times_used:0\"\n },\n },\n});\n" Ruby example: "session = ShopifyAPI::Auth::Session.new(\n shop: \"your-development-store.myshopify.com\",\n access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n session: session\n)\n\nquery = <<~QUERY\n mutation discountCodeRedeemCodeBulkDelete($discountId: ID!, $search: String) {\n discountCodeRedeemCodeBulkDelete(discountId: $discountId, search: $search) {\n job {\n id\n }\n userErrors {\n code\n field\n message\n }\n }\n }\nQUERY\n\nvariables = {\n \"discountId\": \"gid://shopify/DiscountCodeNode/2429471\",\n \"search\": \"times_used:0\"\n}\n\nresponse = client.query(query: query, variables: variables)\n" Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation discountCodeRedeemCodeBulkDelete($discountId: ID!, $search: String) {\n discountCodeRedeemCodeBulkDelete(discountId: $discountId, search: $search) {\n job {\n id\n }\n userErrors {\n code\n field\n message\n }\n }\n }`,\n {\n variables: {\n \"discountId\": \"gid://shopify/DiscountCodeNode/2429471\",\n \"search\": \"times_used:0\"\n },\n },\n);\n\nconst data = await response.json();\n" Graphql query: "mutation discountCodeRedeemCodeBulkDelete($discountId: ID!, $search: String) {\n discountCodeRedeemCodeBulkDelete(discountId: $discountId, search: $search) {\n job {\n id\n }\n userErrors {\n code\n field\n message\n }\n }\n}" #### Graphql Input { "discountId": "gid://shopify/DiscountCodeNode/2429471", "search": "times_used:0" } #### Graphql Response { "data": { "discountCodeRedeemCodeBulkDelete": { "job": { "id": "gid://shopify/Job/a2337b55-0b31-44d9-9027-f4fefc5317d5" }, "userErrors": [] } } } ### Deletes a discount code Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation DiscountRedeemCodeBulkDelete($discountId: ID!, $ids: [ID!]) { discountCodeRedeemCodeBulkDelete(discountId: $discountId, ids: $ids) { job { id } userErrors { code field message } } }\",\n \"variables\": {\n \"discountId\": \"gid://shopify/DiscountCodeNode/2429471\",\n \"ids\": [\n \"gid://shopify/DiscountRedeemCode/1\"\n ]\n }\n}'\n" Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n data: {\n \"query\": `mutation DiscountRedeemCodeBulkDelete($discountId: ID!, $ids: [ID!]) {\n discountCodeRedeemCodeBulkDelete(discountId: $discountId, ids: $ids) {\n job {\n id\n }\n userErrors {\n code\n field\n message\n }\n }\n }`,\n \"variables\": {\n \"discountId\": \"gid://shopify/DiscountCodeNode/2429471\",\n \"ids\": [\n \"gid://shopify/DiscountRedeemCode/1\"\n ]\n },\n },\n});\n" Ruby example: "session = ShopifyAPI::Auth::Session.new(\n shop: \"your-development-store.myshopify.com\",\n access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n session: session\n)\n\nquery = <<~QUERY\n mutation DiscountRedeemCodeBulkDelete($discountId: ID!, $ids: [ID!]) {\n discountCodeRedeemCodeBulkDelete(discountId: $discountId, ids: $ids) {\n job {\n id\n }\n userErrors {\n code\n field\n message\n }\n }\n }\nQUERY\n\nvariables = {\n \"discountId\": \"gid://shopify/DiscountCodeNode/2429471\",\n \"ids\": [\"gid://shopify/DiscountRedeemCode/1\"]\n}\n\nresponse = client.query(query: query, variables: variables)\n" Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation DiscountRedeemCodeBulkDelete($discountId: ID!, $ids: [ID!]) {\n discountCodeRedeemCodeBulkDelete(discountId: $discountId, ids: $ids) {\n job {\n id\n }\n userErrors {\n code\n field\n message\n }\n }\n }`,\n {\n variables: {\n \"discountId\": \"gid://shopify/DiscountCodeNode/2429471\",\n \"ids\": [\n \"gid://shopify/DiscountRedeemCode/1\"\n ]\n },\n },\n);\n\nconst data = await response.json();\n" Graphql query: "mutation DiscountRedeemCodeBulkDelete($discountId: ID!, $ids: [ID!]) {\n discountCodeRedeemCodeBulkDelete(discountId: $discountId, ids: $ids) {\n job {\n id\n }\n userErrors {\n code\n field\n message\n }\n }\n}" #### Graphql Input { "discountId": "gid://shopify/DiscountCodeNode/2429471", "ids": [ "gid://shopify/DiscountRedeemCode/1" ] } #### Graphql Response { "data": { "discountCodeRedeemCodeBulkDelete": { "job": { "id": "gid://shopify/Job/33cb59e4-a258-4b33-af81-09b196ad4385" }, "userErrors": [] } } } ### Using more than one targeting argument returns an error Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation discountCodeRedeemCodeBulkDelete($discountId: ID!, $search: String, $ids: [ID!]) { discountCodeRedeemCodeBulkDelete(discountId: $discountId, search: $search, ids: $ids) { job { id } userErrors { code field message } } }\",\n \"variables\": {\n \"discountId\": \"gid://shopify/DiscountCodeNode/2429471\",\n \"ids\": [\n \"gid://shopify/DiscountRedeemCode/1\"\n ],\n \"search\": \"discount_type:bxgy\"\n }\n}'\n" Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n data: {\n \"query\": `mutation discountCodeRedeemCodeBulkDelete($discountId: ID!, $search: String, $ids: [ID!]) {\n discountCodeRedeemCodeBulkDelete(discountId: $discountId, search: $search, ids: $ids) {\n job {\n id\n }\n userErrors {\n code\n field\n message\n }\n }\n }`,\n \"variables\": {\n \"discountId\": \"gid://shopify/DiscountCodeNode/2429471\",\n \"ids\": [\n \"gid://shopify/DiscountRedeemCode/1\"\n ],\n \"search\": \"discount_type:bxgy\"\n },\n },\n});\n" Ruby example: "session = ShopifyAPI::Auth::Session.new(\n shop: \"your-development-store.myshopify.com\",\n access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n session: session\n)\n\nquery = <<~QUERY\n mutation discountCodeRedeemCodeBulkDelete($discountId: ID!, $search: String, $ids: [ID!]) {\n discountCodeRedeemCodeBulkDelete(discountId: $discountId, search: $search, ids: $ids) {\n job {\n id\n }\n userErrors {\n code\n field\n message\n }\n }\n }\nQUERY\n\nvariables = {\n \"discountId\": \"gid://shopify/DiscountCodeNode/2429471\",\n \"ids\": [\"gid://shopify/DiscountRedeemCode/1\"],\n \"search\": \"discount_type:bxgy\"\n}\n\nresponse = client.query(query: query, variables: variables)\n" Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation discountCodeRedeemCodeBulkDelete($discountId: ID!, $search: String, $ids: [ID!]) {\n discountCodeRedeemCodeBulkDelete(discountId: $discountId, search: $search, ids: $ids) {\n job {\n id\n }\n userErrors {\n code\n field\n message\n }\n }\n }`,\n {\n variables: {\n \"discountId\": \"gid://shopify/DiscountCodeNode/2429471\",\n \"ids\": [\n \"gid://shopify/DiscountRedeemCode/1\"\n ],\n \"search\": \"discount_type:bxgy\"\n },\n },\n);\n\nconst data = await response.json();\n" Graphql query: "mutation discountCodeRedeemCodeBulkDelete($discountId: ID!, $search: String, $ids: [ID!]) {\n discountCodeRedeemCodeBulkDelete(discountId: $discountId, search: $search, ids: $ids) {\n job {\n id\n }\n userErrors {\n code\n field\n message\n }\n }\n}" #### Graphql Input { "discountId": "gid://shopify/DiscountCodeNode/2429471", "ids": [ "gid://shopify/DiscountRedeemCode/1" ], "search": "discount_type:bxgy" } #### Graphql Response { "data": { "discountCodeRedeemCodeBulkDelete": { "job": null, "userErrors": [ { "code": "TOO_MANY_ARGUMENTS", "field": null, "message": "Only one of 'ids', 'search' or 'saved_search_id' is allowed." } ] } } }