Anchor to section titled 'undefined'discount
discount
mutation
2024-07
Requires Apps must have write 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 section titled 'Arguments'
Arguments
The ID of the redeem code's discount.
The IDs of the discount redeem codes to delete.
- Anchor to savedSearchIdsavedSearchId
The ID of the saved search.
- Anchor to searchsearch
The search query for filtering discount redeem codes.
Was this section helpful?
Anchor to section titled 'DiscountCodeRedeemCodeBulkDeletePayload returns'
DiscountCodeRedeemCodeBulkDeletePayload returns
The asynchronous job that deletes the discount redeem codes.
The list of errors that occurred from executing the mutation.
Was this section helpful?
Code examples for MUTATION: discountCodeRedeemCodeBulkDelete
Query Reference for MUTATION: discountCodeRedeemCodeBulkDelete
"mutation discountCodeRedeemCodeBulkDelete($discountId: ID!) {\n discountCodeRedeemCodeBulkDelete(discountId: $discountId) {\n job {\n # Job fields\n }\n userErrors {\n field\n message\n }\n }\n}"Input Reference for MUTATION: discountCodeRedeemCodeBulkDelete
"{\n \"discountId\": \"gid://shopify/<objectName>/10079785100\",\n \"ids\": [\n \"gid://shopify/<objectName>/10079785100\"\n ],\n \"savedSearchId\": \"gid://shopify/<objectName>/10079785100\",\n \"search\": \"<your-search>\"\n}"Schema Reference for MUTATION: discountCodeRedeemCodeBulkDelete
""
Display Examples for MUTATION: discountCodeRedeemCodeBulkDelete
[
{
"example": {
"type_name": "discountcoderedeemcodebulkdelete",
"title": "Asynchronously delete discount redeem codes in bulk using a search filter",
"description": "Asynchronously delete all redeem codes that have never been used.",
"query_string": "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}",
"variables": {
"discountId": "gid://shopify/DiscountCodeNode/2429471",
"search": "times_used:0"
},
"response": {
"data": {
"discountCodeRedeemCodeBulkDelete": {
"job": {
"id": "gid://shopify/Job/f94b3a07-086d-4bfa-94b8-50172691a2e3"
},
"userErrors": []
}
}
},
"api_name": "admin",
"minimum_api_version": "2023-10",
"maximum_api_version": "unstable",
"location": "/components/pricing/test/unit/graph_api/admin/mutations/discount_code_redeem_code_bulk_delete_test.rb",
"curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-07/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",
"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",
"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",
"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",
"php_example": "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<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\n$variables = [\n \"discountId\" => \"gid://shopify/DiscountCodeNode/2429471\",\n \"search\" => \"times_used:0\",\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
},
"titleStringKey": "variables",
"inputVariableEntries": [
{
"arg": {
"name": "discountId",
"description": "The ID of the redeem code's discount.",
"type": {
"kind": "SCALAR",
"name": "ID",
"list": false,
"non_null": true
},
"defaultValue": null,
"typeSignature": "ID!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "discountId",
"argValue": " \"gid://shopify/DiscountCodeNode/2429471\"",
"typeKind": "MUTATION"
},
{
"arg": {
"name": "search",
"description": "The search query for filtering discount redeem codes.",
"type": {
"kind": "SCALAR",
"name": "String",
"list": false,
"non_null": false
},
"defaultValue": null,
"typeSignature": "String",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "search",
"argValue": " \"times_used:0\"",
"typeKind": "MUTATION"
}
]
},
{
"example": {
"type_name": "discountcoderedeemcodebulkdelete",
"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 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}",
"variables": {
"discountId": "gid://shopify/DiscountCodeNode/2429471",
"ids": [
"gid://shopify/DiscountRedeemCode/1"
],
"search": "discount_type:bxgy"
},
"response": {
"data": {
"discountCodeRedeemCodeBulkDelete": {
"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_redeem_code_bulk_delete_test.rb",
"curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-07/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",
"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",
"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",
"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",
"php_example": "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<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\n$variables = [\n \"discountId\" => \"gid://shopify/DiscountCodeNode/2429471\",\n \"ids\" => [\"gid://shopify/DiscountRedeemCode/1\"],\n \"search\" => \"discount_type:bxgy\",\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
},
"titleStringKey": "variables",
"inputVariableEntries": [
{
"arg": {
"name": "discountId",
"description": "The ID of the redeem code's discount.",
"type": {
"kind": "SCALAR",
"name": "ID",
"list": false,
"non_null": true
},
"defaultValue": null,
"typeSignature": "ID!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "discountId",
"argValue": " \"gid://shopify/DiscountCodeNode/2429471\"",
"typeKind": "MUTATION"
},
{
"arg": {
"name": "ids",
"description": "The IDs of the discount redeem codes 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/DiscountRedeemCode/1\"]",
"typeKind": "MUTATION"
},
{
"arg": {
"name": "search",
"description": "The search query for filtering discount redeem codes.",
"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"
}
]
}
]