priceRuleDelete
mutation
deprecated

Choose a version:

Requires write_price_rules access scope.

Delete a price rule. Use discountCodeDelete instead.

Anchor to section titled 'Arguments'

Arguments

Anchor to id id ID! required: The ID of the price rule object.

Was this section helpful?

Anchor to section titled 'PriceRuleDeletePayload returns'

PriceRuleDeletePayload returns

Anchor to PriceRuleDeletePayload.deletedPriceRuleId deletedPriceRuleId ID: The ID price of the deleted price rule.
Anchor to PriceRuleDeletePayload.priceRuleUserErrors priceRuleUserErrors [PriceRuleUserError!]! non-null: The list of errors that occurred from executing the mutation.
Anchor to PriceRuleDeletePayload.shop shop Shop! non-null: The shop of the deleted price rule.
Anchor to PriceRuleDeletePayload.userErrors userErrors [UserError!]! non-null deprecated: The list of errors that occurred from executing the mutation. Use priceRuleUserErrors instead.

Was this section helpful?

Code examples for MUTATION: priceRuleDelete

Query Reference for MUTATION: priceRuleDelete

"mutation priceRuleDelete($id: ID!) {\n  priceRuleDelete(id: $id) {\n    deletedPriceRuleId\n    priceRuleUserErrors {\n      # PriceRuleUserError fields\n    }\n    shop {\n      # Shop fields\n    }\n    userErrors {\n      field\n      message\n    }\n  }\n}"

Input Reference for MUTATION: priceRuleDelete

"{\n  \"id\": \"gid://shopify/<objectName>/10079785100\"\n}"

Schema Reference for MUTATION: priceRuleDelete

""

Display Examples for MUTATION: priceRuleDelete

[
  {
    "example": {
      "type_name": "priceruledelete",
      "title": "Delete a price rule",
      "query_string": "mutation priceRuleDelete($id: ID!) {\n  priceRuleDelete(id: $id) {\n    priceRuleUserErrors {\n      field\n      message\n      code\n    }\n    deletedPriceRuleId\n  }\n}",
      "query_arguments": {
        "id": "$id"
      },
      "variables": {
        "id": "gid://shopify/PriceRule/1057371200"
      },
      "response": {
        "data": {
          "priceRuleDelete": {
            "priceRuleUserErrors": [],
            "deletedPriceRuleId": "gid://shopify/PriceRule/1057371200"
          }
        }
      },
      "api_name": "admin",
      "minimum_api_version": "2023-10",
      "maximum_api_version": "2024-07",
      "location": "/components/pricing/test/unit/graph_api/admin/mutations/price_rule_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 priceRuleDelete($id: ID!) { priceRuleDelete(id: $id) { priceRuleUserErrors { field message code } deletedPriceRuleId } }\",\n \"variables\": {\n    \"id\": \"gid://shopify/PriceRule/1057371200\"\n  }\n}'\n",
      "remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  mutation priceRuleDelete($id: ID!) {\n    priceRuleDelete(id: $id) {\n      priceRuleUserErrors {\n        field\n        message\n        code\n      }\n      deletedPriceRuleId\n    }\n  }`,\n  {\n    variables: {\n      \"id\": \"gid://shopify/PriceRule/1057371200\"\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 priceRuleDelete($id: ID!) {\n    priceRuleDelete(id: $id) {\n      priceRuleUserErrors {\n        field\n        message\n        code\n      }\n      deletedPriceRuleId\n    }\n  }\nQUERY\n\nvariables = {\n  \"id\": \"gid://shopify/PriceRule/1057371200\"\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 priceRuleDelete($id: ID!) {\n      priceRuleDelete(id: $id) {\n        priceRuleUserErrors {\n          field\n          message\n          code\n        }\n        deletedPriceRuleId\n      }\n    }`,\n    \"variables\": {\n      \"id\": \"gid://shopify/PriceRule/1057371200\"\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 priceRuleDelete($id: ID!) {\n    priceRuleDelete(id: $id) {\n      priceRuleUserErrors {\n        field\n        message\n        code\n      }\n      deletedPriceRuleId\n    }\n  }\nQUERY;\n\n$variables = [\n  \"id\" => \"gid://shopify/PriceRule/1057371200\",\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
    },
    "titleStringKey": "variables",
    "inputVariableEntries": [
      {
        "arg": {
          "name": "id",
          "description": "The ID of the price rule object.",
          "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/PriceRule/1057371200\"",
        "typeKind": "MUTATION"
      }
    ]
  }
]

priceRuleDeletemutationdeprecated

Arguments

PriceRuleDeletePayload returns

priceRuleDelete
mutation
deprecated