Anchor to section titled 'undefined'discount
discount
mutation
2024-10latest
Requires Apps must have write access scope.
Deletes an automatic discount.
Anchor to section titled 'Arguments'
Arguments
The ID of the automatic discount to delete.
Was this section helpful?
Anchor to section titled 'DiscountAutomaticDeletePayload returns'
DiscountAutomaticDeletePayload returns
- Anchor to DiscountAutomaticDeletePayload.deletedAutomaticDiscountIddeleted
Automatic Discount Id The deleted automatic discount ID.
The list of errors that occurred from executing the mutation.
Was this section helpful?
Code examples for MUTATION: discountAutomaticDelete
Query Reference for MUTATION: discountAutomaticDelete
"mutation discountAutomaticDelete($id: ID!) {\n discountAutomaticDelete(id: $id) {\n deletedAutomaticDiscountId\n userErrors {\n field\n message\n }\n }\n}"Input Reference for MUTATION: discountAutomaticDelete
"{\n \"id\": \"gid://shopify/<objectName>/10079785100\"\n}"Schema Reference for MUTATION: discountAutomaticDelete
""
Display Examples for MUTATION: discountAutomaticDelete
[
{
"example": {
"type_name": "discountautomaticdelete",
"title": "Delete an automatic discount",
"description": "Deleting an automatic discount returns the ID of the deleted automatic discount",
"query_string": "mutation discountAutomaticDelete($id: ID!) {\n discountAutomaticDelete(id: $id) {\n deletedAutomaticDiscountId\n userErrors {\n field\n code\n message\n }\n }\n}",
"variables": {
"id": "gid://shopify/DiscountAutomaticNode/198286294"
},
"response": {
"data": {
"discountAutomaticDelete": {
"deletedAutomaticDiscountId": "gid://shopify/DiscountAutomaticNode/198286294",
"userErrors": []
}
}
},
"api_name": "admin",
"minimum_api_version": "2023-10",
"maximum_api_version": "unstable",
"location": "/components/pricing/test/unit/graph_api/admin/mutations/discount_automatic_delete_test.rb",
"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 discountAutomaticDelete($id: ID!) { discountAutomaticDelete(id: $id) { deletedAutomaticDiscountId userErrors { field code message } } }\",\n \"variables\": {\n \"id\": \"gid://shopify/DiscountAutomaticNode/198286294\"\n }\n}'\n",
"remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation discountAutomaticDelete($id: ID!) {\n discountAutomaticDelete(id: $id) {\n deletedAutomaticDiscountId\n userErrors {\n field\n code\n message\n }\n }\n }`,\n {\n variables: {\n \"id\": \"gid://shopify/DiscountAutomaticNode/198286294\"\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 discountAutomaticDelete($id: ID!) {\n discountAutomaticDelete(id: $id) {\n deletedAutomaticDiscountId\n userErrors {\n field\n code\n message\n }\n }\n }\nQUERY\n\nvariables = {\n \"id\": \"gid://shopify/DiscountAutomaticNode/198286294\"\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 discountAutomaticDelete($id: ID!) {\n discountAutomaticDelete(id: $id) {\n deletedAutomaticDiscountId\n userErrors {\n field\n code\n message\n }\n }\n }`,\n \"variables\": {\n \"id\": \"gid://shopify/DiscountAutomaticNode/198286294\"\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 discountAutomaticDelete($id: ID!) {\n discountAutomaticDelete(id: $id) {\n deletedAutomaticDiscountId\n userErrors {\n field\n code\n message\n }\n }\n }\nQUERY;\n\n$variables = [\n \"id\" => \"gid://shopify/DiscountAutomaticNode/198286294\",\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
},
"titleStringKey": "variables",
"inputVariableEntries": [
{
"arg": {
"name": "id",
"description": "The ID of the automatic discount to delete.",
"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/DiscountAutomaticNode/198286294\"",
"typeKind": "MUTATION"
}
]
}
]