Anchor to section titled 'undefined'discount
discount
mutation
Unstable
Requires Apps must have write access scope.
Asynchronously delete code discounts in bulk using a search query, a saved search ID, or a list of code discount IDs.
Anchor to section titled 'Arguments'
Arguments
The IDs of the code discounts to delete.
- Anchor to savedSearchIdsavedSearchId
The ID of the saved search to use for filtering code discounts to delete.
- Anchor to searchsearch
The search query for filtering code discounts to delete.
For more information on the list of supported fields and search syntax, refer to the CodeDiscountNodes query section.
Was this section helpful?
Anchor to section titled 'DiscountCodeBulkDeletePayload returns'
DiscountCodeBulkDeletePayload returns
The asynchronous job that deletes the code discounts.
The list of errors that occurred from executing the mutation.
Was this section helpful?
Code examples for MUTATION: discountCodeBulkDelete
Query Reference for MUTATION: discountCodeBulkDelete
"mutation discountCodeBulkDelete {\n discountCodeBulkDelete {\n job {\n # Job fields\n }\n userErrors {\n field\n message\n }\n }\n}"Input Reference for MUTATION: discountCodeBulkDelete
"{\n \"ids\": [\n \"gid://shopify/<objectName>/10079785100\"\n ],\n \"savedSearchId\": \"gid://shopify/<objectName>/10079785100\",\n \"search\": \"<your-search>\"\n}"Schema Reference for MUTATION: discountCodeBulkDelete
""
Display Examples for MUTATION: discountCodeBulkDelete
[
{
"example": {
"type_name": "discountcodebulkdelete",
"title": "Asynchronously delete code discounts in bulk using a search filter",
"description": "Asynchronously delete all expired code discounts that ended within the past week and are type `percentage`.",
"query_string": "mutation discountCodeBulkDelete($search: String) {\n discountCodeBulkDelete(search: $search) {\n job {\n id\n }\n userErrors {\n code\n field\n message\n }\n }\n}",
"variables": {
"search": "discount_type:percentage ends_at:past_week status:expired"
},
"response": {
"data": {
"discountCodeBulkDelete": {
"job": {
"id": "gid://shopify/Job/5c346b2e-979c-4449-ad4e-ac7a1090ecb4"
},
"userErrors": []
}
}
},
"api_name": "admin",
"minimum_api_version": "2023-10",
"maximum_api_version": "unstable",
"location": "/components/pricing/test/unit/graph_api/admin/mutations/discount_code_bulk_delete_test.rb",
"curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/unstable/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",
"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",
"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",
"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",
"php_example": "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<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\n$variables = [\n \"search\" => \"discount_type:percentage ends_at:past_week status:expired\",\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
},
"titleStringKey": "variables",
"inputVariableEntries": [
{
"arg": {
"name": "search",
"description": "The search query for filtering code discounts to delete.\n\nFor more information on the list of supported fields and search syntax, refer to the [CodeDiscountNodes query section](https://shopify.dev/api/admin-graphql/latest/queries/codeDiscountNodes#argument-codediscountnodes-query).",
"type": {
"kind": "SCALAR",
"name": "String",
"list": false,
"non_null": false
},
"defaultValue": null,
"typeSignature": "String",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "search",
"argValue": " \"discount_type:percentage ends_at:past_week status:expired\"",
"typeKind": "MUTATION"
}
]
},
{
"example": {
"type_name": "discountcodebulkdelete",
"title": "Using more than one targeting argument returns an error",
"description": "Trying to use both `search` and `ids` arguments returns an error",
"query_string": "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}",
"variables": {
"ids": [
"gid://shopify/DiscountCodeNode/1"
],
"search": "discount_type:bxgy"
},
"response": {
"data": {
"discountCodeBulkDelete": {
"job": null,
"userErrors": [
{
"code": "TOO_MANY_ARGUMENTS",
"field": null,
"message": "Only one of 'ids', 'search' or 'saved_search_id' is allowed."
}
]
}
}
},
"api_name": "admin",
"minimum_api_version": "2023-10",
"maximum_api_version": "unstable",
"location": "/components/pricing/test/unit/graph_api/admin/mutations/discount_code_bulk_delete_test.rb",
"curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/unstable/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",
"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",
"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",
"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",
"php_example": "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<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\n$variables = [\n \"ids\" => [\"gid://shopify/DiscountCodeNode/1\"],\n \"search\" => \"discount_type:bxgy\",\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
},
"titleStringKey": "variables",
"inputVariableEntries": [
{
"arg": {
"name": "ids",
"description": "The IDs of the code discounts to delete.",
"type": {
"kind": "SCALAR",
"name": "ID",
"list": true,
"non_null": false
},
"defaultValue": null,
"typeSignature": "[ID!]",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "ids",
"argValue": " [\"gid://shopify/DiscountCodeNode/1\"]",
"typeKind": "MUTATION"
},
{
"arg": {
"name": "search",
"description": "The search query for filtering code discounts to delete.\n\nFor more information on the list of supported fields and search syntax, refer to the [CodeDiscountNodes query section](https://shopify.dev/api/admin-graphql/latest/queries/codeDiscountNodes#argument-codediscountnodes-query).",
"type": {
"kind": "SCALAR",
"name": "String",
"list": false,
"non_null": false
},
"defaultValue": null,
"typeSignature": "String",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "search",
"argValue": " \"discount_type:bxgy\"",
"typeKind": "MUTATION"
}
]
}
]