Anchor to section titled 'undefined'discount
discount
mutation
2024-04
Requires Apps must have write access scope.
Deactivates a code discount.
Anchor to section titled 'Arguments'
Arguments
The ID of the code discount to deactivate.
Was this section helpful?
Anchor to section titled 'DiscountCodeDeactivatePayload returns'
DiscountCodeDeactivatePayload returns
The deactivated code discount.
The list of errors that occurred from executing the mutation.
Was this section helpful?
Code examples for MUTATION: discountCodeDeactivate
Query Reference for MUTATION: discountCodeDeactivate
"mutation discountCodeDeactivate($id: ID!) {\n discountCodeDeactivate(id: $id) {\n codeDiscountNode {\n # DiscountCodeNode fields\n }\n userErrors {\n field\n message\n }\n }\n}"Input Reference for MUTATION: discountCodeDeactivate
"{\n \"id\": \"gid://shopify/<objectName>/10079785100\"\n}"Schema Reference for MUTATION: discountCodeDeactivate
""
Display Examples for MUTATION: discountCodeDeactivate
[
{
"example": {
"type_name": "discountcodedeactivate",
"title": "Deactivate a code discount set to start in the future",
"description": "Deactivating a code discount set in the future sets its `startsAt` and `endsAt` to now. In this example, the `startsAt` and `endsAt` were originally set in the year 2049.",
"query_string": "mutation discountCodeDeactivate($id: ID!) {\n discountCodeDeactivate(id: $id) {\n codeDiscountNode {\n codeDiscount {\n ... on DiscountCodeBasic {\n title\n status\n startsAt\n endsAt\n }\n }\n }\n userErrors {\n field\n code\n message\n }\n }\n}",
"variables": {
"id": "gid://shopify/DiscountCodeNode/206265824"
},
"response": {
"data": {
"discountCodeDeactivate": {
"codeDiscountNode": {
"codeDiscount": {
"title": "percentage_off_code",
"status": "EXPIRED",
"startsAt": "2024-09-12T01:06:40Z",
"endsAt": "2024-09-12T01:06:40Z"
}
},
"userErrors": []
}
}
},
"api_name": "admin",
"minimum_api_version": "2023-10",
"maximum_api_version": "unstable",
"location": "/components/pricing/test/unit/graph_api/admin/mutations/discount_code_deactivate_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 discountCodeDeactivate($id: ID!) { discountCodeDeactivate(id: $id) { codeDiscountNode { codeDiscount { ... on DiscountCodeBasic { title status startsAt endsAt } } } userErrors { field code message } } }\",\n \"variables\": {\n \"id\": \"gid://shopify/DiscountCodeNode/206265824\"\n }\n}'\n",
"remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation discountCodeDeactivate($id: ID!) {\n discountCodeDeactivate(id: $id) {\n codeDiscountNode {\n codeDiscount {\n ... on DiscountCodeBasic {\n title\n status\n startsAt\n endsAt\n }\n }\n }\n userErrors {\n field\n code\n message\n }\n }\n }`,\n {\n variables: {\n \"id\": \"gid://shopify/DiscountCodeNode/206265824\"\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 discountCodeDeactivate($id: ID!) {\n discountCodeDeactivate(id: $id) {\n codeDiscountNode {\n codeDiscount {\n ... on DiscountCodeBasic {\n title\n status\n startsAt\n endsAt\n }\n }\n }\n userErrors {\n field\n code\n message\n }\n }\n }\nQUERY\n\nvariables = {\n \"id\": \"gid://shopify/DiscountCodeNode/206265824\"\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 discountCodeDeactivate($id: ID!) {\n discountCodeDeactivate(id: $id) {\n codeDiscountNode {\n codeDiscount {\n ... on DiscountCodeBasic {\n title\n status\n startsAt\n endsAt\n }\n }\n }\n userErrors {\n field\n code\n message\n }\n }\n }`,\n \"variables\": {\n \"id\": \"gid://shopify/DiscountCodeNode/206265824\"\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 discountCodeDeactivate($id: ID!) {\n discountCodeDeactivate(id: $id) {\n codeDiscountNode {\n codeDiscount {\n ... on DiscountCodeBasic {\n title\n status\n startsAt\n endsAt\n }\n }\n }\n userErrors {\n field\n code\n message\n }\n }\n }\nQUERY;\n\n$variables = [\n \"id\" => \"gid://shopify/DiscountCodeNode/206265824\",\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
},
"titleStringKey": "variables",
"inputVariableEntries": [
{
"arg": {
"name": "id",
"description": "The ID of the code discount to deactivate.",
"type": {
"kind": "SCALAR",
"name": "ID",
"list": false,
"non_null": true
},
"defaultValue": null,
"typeSignature": "ID!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "id",
"argValue": " \"gid://shopify/DiscountCodeNode/206265824\"",
"typeKind": "MUTATION"
}
]
},
{
"example": {
"type_name": "discountcodedeactivate",
"title": "Deactivate an active code discount",
"description": "Deactivating an active code discount sets the `endsAt` to now. In this example, the `endsAt` was originally set to January 1, 2049.",
"query_string": "mutation discountCodeDeactivate($id: ID!) {\n discountCodeDeactivate(id: $id) {\n codeDiscountNode {\n codeDiscount {\n ... on DiscountCodeBasic {\n title\n status\n startsAt\n endsAt\n }\n }\n }\n userErrors {\n field\n code\n message\n }\n }\n}",
"variables": {
"id": "gid://shopify/DiscountCodeNode/206265824"
},
"response": {
"data": {
"discountCodeDeactivate": {
"codeDiscountNode": {
"codeDiscount": {
"title": "percentage_off_code",
"status": "EXPIRED",
"startsAt": "2024-09-03T01:05:24Z",
"endsAt": "2024-09-12T01:06:40Z"
}
},
"userErrors": []
}
}
},
"api_name": "admin",
"minimum_api_version": "2023-10",
"maximum_api_version": "unstable",
"location": "/components/pricing/test/unit/graph_api/admin/mutations/discount_code_deactivate_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 discountCodeDeactivate($id: ID!) { discountCodeDeactivate(id: $id) { codeDiscountNode { codeDiscount { ... on DiscountCodeBasic { title status startsAt endsAt } } } userErrors { field code message } } }\",\n \"variables\": {\n \"id\": \"gid://shopify/DiscountCodeNode/206265824\"\n }\n}'\n",
"remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation discountCodeDeactivate($id: ID!) {\n discountCodeDeactivate(id: $id) {\n codeDiscountNode {\n codeDiscount {\n ... on DiscountCodeBasic {\n title\n status\n startsAt\n endsAt\n }\n }\n }\n userErrors {\n field\n code\n message\n }\n }\n }`,\n {\n variables: {\n \"id\": \"gid://shopify/DiscountCodeNode/206265824\"\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 discountCodeDeactivate($id: ID!) {\n discountCodeDeactivate(id: $id) {\n codeDiscountNode {\n codeDiscount {\n ... on DiscountCodeBasic {\n title\n status\n startsAt\n endsAt\n }\n }\n }\n userErrors {\n field\n code\n message\n }\n }\n }\nQUERY\n\nvariables = {\n \"id\": \"gid://shopify/DiscountCodeNode/206265824\"\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 discountCodeDeactivate($id: ID!) {\n discountCodeDeactivate(id: $id) {\n codeDiscountNode {\n codeDiscount {\n ... on DiscountCodeBasic {\n title\n status\n startsAt\n endsAt\n }\n }\n }\n userErrors {\n field\n code\n message\n }\n }\n }`,\n \"variables\": {\n \"id\": \"gid://shopify/DiscountCodeNode/206265824\"\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 discountCodeDeactivate($id: ID!) {\n discountCodeDeactivate(id: $id) {\n codeDiscountNode {\n codeDiscount {\n ... on DiscountCodeBasic {\n title\n status\n startsAt\n endsAt\n }\n }\n }\n userErrors {\n field\n code\n message\n }\n }\n }\nQUERY;\n\n$variables = [\n \"id\" => \"gid://shopify/DiscountCodeNode/206265824\",\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
},
"titleStringKey": "variables",
"inputVariableEntries": [
{
"arg": {
"name": "id",
"description": "The ID of the code discount to deactivate.",
"type": {
"kind": "SCALAR",
"name": "ID",
"list": false,
"non_null": true
},
"defaultValue": null,
"typeSignature": "ID!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "id",
"argValue": " \"gid://shopify/DiscountCodeNode/206265824\"",
"typeKind": "MUTATION"
}
]
}
]