# discountCodeBulkDelete - admin-graphql - MUTATION Version: 2024-10 ## Description Deletes multiple [code-based discounts](https://help.shopify.com/manual/discounts/discount-types#discount-codes) asynchronously using one of the following: - A search query - A saved search ID - A list of discount code IDs For example, you can delete discounts for all codes that match a search criteria, or delete a predefined set of discount codes. ### Access Scopes Apps must have `write_discounts` access scope. ## Arguments * [ids](/docs/api/admin-graphql/2024-10/scalars/ID): ID - The IDs of the discounts to delete. * [savedSearchId](/docs/api/admin-graphql/2024-10/scalars/ID): ID - The ID of the saved search for filtering discounts to delete. Saved searches represent [customer segments](https://help.shopify.com/manual/customers/customer-segments) that merchants have built in the Shopify admin. * [search](/docs/api/admin-graphql/2024-10/scalars/String): String - The search query for filtering discounts.

For more information on the list of supported fields and search syntax, refer to the [`codeDiscountNodes`](https://shopify.dev/docs/api/admin-graphql/latest/queries/codeDiscountNodes#query-arguments) query. ## Returns * [job](/docs/api/admin-graphql/2024-10/objects/Job): Job The asynchronous job that deletes the discounts. * [userErrors](/docs/api/admin-graphql/2024-10/objects/DiscountUserError): DiscountUserError! The list of errors that occurred from executing the mutation. ## Examples ### Asynchronously delete code discounts 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 discountCodeBulkDelete($search: String) { discountCodeBulkDelete(search: $search) { job { id } userErrors { code field message } } }\",\n \"variables\": {\n \"search\": \"discount_type:percentage ends_at:past_week status:expired\"\n }\n}'\n" Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n data: {\n \"query\": `mutation discountCodeBulkDelete($search: String) {\n discountCodeBulkDelete(search: $search) {\n job {\n id\n }\n userErrors {\n code\n field\n message\n }\n }\n }`,\n \"variables\": {\n \"search\": \"discount_type:percentage ends_at:past_week status:expired\"\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 discountCodeBulkDelete($search: String) {\n discountCodeBulkDelete(search: $search) {\n job {\n id\n }\n userErrors {\n code\n field\n message\n }\n }\n }\nQUERY\n\nvariables = {\n \"search\": \"discount_type:percentage ends_at:past_week status:expired\"\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 discountCodeBulkDelete($search: String) {\n discountCodeBulkDelete(search: $search) {\n job {\n id\n }\n userErrors {\n code\n field\n message\n }\n }\n }`,\n {\n variables: {\n \"search\": \"discount_type:percentage ends_at:past_week status:expired\"\n },\n },\n);\n\nconst data = await response.json();\n" Graphql query: "mutation discountCodeBulkDelete($search: String) {\n discountCodeBulkDelete(search: $search) {\n job {\n id\n }\n userErrors {\n code\n field\n message\n }\n }\n}" #### Graphql Input { "search": "discount_type:percentage ends_at:past_week status:expired" } #### Graphql Response { "data": { "discountCodeBulkDelete": { "job": { "id": "gid://shopify/Job/5c346b2e-979c-4449-ad4e-ac7a1090ecb4" }, "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 discountCodeBulkDelete($search: String, $ids: [ID!]) { discountCodeBulkDelete(search: $search, ids: $ids) { job { id } userErrors { code field message } } }\",\n \"variables\": {\n \"ids\": [\n \"gid://shopify/DiscountCodeNode/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 discountCodeBulkDelete($search: String, $ids: [ID!]) {\n discountCodeBulkDelete(search: $search, ids: $ids) {\n job {\n id\n }\n userErrors {\n code\n field\n message\n }\n }\n }`,\n \"variables\": {\n \"ids\": [\n \"gid://shopify/DiscountCodeNode/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 discountCodeBulkDelete($search: String, $ids: [ID!]) {\n discountCodeBulkDelete(search: $search, ids: $ids) {\n job {\n id\n }\n userErrors {\n code\n field\n message\n }\n }\n }\nQUERY\n\nvariables = {\n \"ids\": [\"gid://shopify/DiscountCodeNode/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 discountCodeBulkDelete($search: String, $ids: [ID!]) {\n discountCodeBulkDelete(search: $search, ids: $ids) {\n job {\n id\n }\n userErrors {\n code\n field\n message\n }\n }\n }`,\n {\n variables: {\n \"ids\": [\n \"gid://shopify/DiscountCodeNode/1\"\n ],\n \"search\": \"discount_type:bxgy\"\n },\n },\n);\n\nconst data = await response.json();\n" Graphql query: "mutation discountCodeBulkDelete($search: String, $ids: [ID!]) {\n discountCodeBulkDelete(search: $search, ids: $ids) {\n job {\n id\n }\n userErrors {\n code\n field\n message\n }\n }\n}" #### Graphql Input { "ids": [ "gid://shopify/DiscountCodeNode/1" ], "search": "discount_type:bxgy" } #### Graphql Response { "data": { "discountCodeBulkDelete": { "job": null, "userErrors": [ { "code": "TOO_MANY_ARGUMENTS", "field": null, "message": "Only one of 'ids', 'search' or 'saved_search_id' is allowed." } ] } } }