Anchor to section titled 'undefined'discount
discount
mutation
2024-04
Requires Apps must have write access scope.
Asynchronously activate 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 activate.
- Anchor to savedSearchIdsavedSearchId
The ID of the saved search.
- Anchor to searchsearch
The search query for filtering code discounts.
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 'DiscountCodeBulkActivatePayload returns'
DiscountCodeBulkActivatePayload returns
The asynchronous job that activates the code discounts.
The list of errors that occurred from executing the mutation.
Was this section helpful?
Code examples for MUTATION: discountCodeBulkActivate
Query Reference for MUTATION: discountCodeBulkActivate
"mutation discountCodeBulkActivate {\n discountCodeBulkActivate {\n job {\n # Job fields\n }\n userErrors {\n field\n message\n }\n }\n}"Input Reference for MUTATION: discountCodeBulkActivate
"{\n \"ids\": [\n \"gid://shopify/<objectName>/10079785100\"\n ],\n \"savedSearchId\": \"gid://shopify/<objectName>/10079785100\",\n \"search\": \"<your-search>\"\n}"Schema Reference for MUTATION: discountCodeBulkActivate
""
Display Examples for MUTATION: discountCodeBulkActivate
[
{
"example": {
"type_name": "discountcodebulkactivate",
"title": "Asynchronously activate code discounts in bulk using a search filter",
"description": "Asynchronously activate all code discounts that start within the past week and are type `percentage`.",
"query_string": "mutation discountCodeBulkActivate($search: String) {\n discountCodeBulkActivate(search: $search) {\n job {\n id\n }\n userErrors {\n code\n field\n message\n }\n }\n}",
"variables": {
"search": "discount_type:percentage starts_at:past_week"
},
"response": {
"data": {
"discountCodeBulkActivate": {
"job": {
"id": "gid://shopify/Job/2c09b7e9-e9b3-435a-8ab4-2c35f3eeb6b1"
},
"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_activate_test.rb",
"curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-04/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation discountCodeBulkActivate($search: String) { discountCodeBulkActivate(search: $search) { job { id } userErrors { code field message } } }\",\n \"variables\": {\n \"search\": \"discount_type:percentage starts_at:past_week\"\n }\n}'\n",
"remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation discountCodeBulkActivate($search: String) {\n discountCodeBulkActivate(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 starts_at:past_week\"\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 discountCodeBulkActivate($search: String) {\n discountCodeBulkActivate(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 starts_at:past_week\"\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 discountCodeBulkActivate($search: String) {\n discountCodeBulkActivate(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 starts_at:past_week\"\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 discountCodeBulkActivate($search: String) {\n discountCodeBulkActivate(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 starts_at:past_week\",\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.\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 starts_at:past_week\"",
"typeKind": "MUTATION"
}
]
},
{
"example": {
"type_name": "discountcodebulkactivate",
"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 discountCodeBulkActivate($search: String, $ids: [ID!]) {\n discountCodeBulkActivate(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": {
"discountCodeBulkActivate": {
"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_activate_test.rb",
"curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-04/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation discountCodeBulkActivate($search: String, $ids: [ID!]) { discountCodeBulkActivate(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 discountCodeBulkActivate($search: String, $ids: [ID!]) {\n discountCodeBulkActivate(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 discountCodeBulkActivate($search: String, $ids: [ID!]) {\n discountCodeBulkActivate(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 discountCodeBulkActivate($search: String, $ids: [ID!]) {\n discountCodeBulkActivate(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 discountCodeBulkActivate($search: String, $ids: [ID!]) {\n discountCodeBulkActivate(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 activate.",
"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.\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"
}
]
}
]