productDelete
mutation

Choose a version:

Requires write_products access scope. Also: The user must have a permission to delete products.

Deletes a product, including all associated variants and media.

As of API version 2023-01, if you need to delete a large product, such as one that has many variants that are active at several locations, you may encounter timeout errors. To avoid these timeout errors, you can instead use the asynchronous ProductDeleteAsync mutation.

Anchor to section titled 'Arguments'

Arguments

Anchor to input input ProductDeleteInput! required: Specifies the product to delete by its ID.

Was this section helpful?

Anchor to section titled 'ProductDeletePayload returns'

ProductDeletePayload returns

Anchor to ProductDeletePayload.deletedProductId deletedProductId ID: The ID of the deleted product.
Anchor to ProductDeletePayload.shop shop Shop! non-null: The shop associated with the product.
Anchor to ProductDeletePayload.userErrors userErrors [UserError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Code examples for MUTATION: productDelete

Query Reference for MUTATION: productDelete

"mutation productDelete($input: ProductDeleteInput!) {\n  productDelete(input: $input) {\n    deletedProductId\n    shop {\n      # Shop fields\n    }\n    userErrors {\n      field\n      message\n    }\n  }\n}"

Input Reference for MUTATION: productDelete

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

Schema Reference for MUTATION: productDelete

"input ProductDeleteInput {\n  id: ID!\n}\n"

Display Examples for MUTATION: productDelete

[
  {
    "example": {
      "type_name": "productdelete",
      "title": "Delete a non-existent product",
      "description": "Trying to delete a non-existent product returns `null`.\n",
      "query_string": "mutation {\n  productDelete(input: {id: \"gid://shopify/Product/-1\"}) {\n    deletedProductId\n    userErrors {\n      field\n      message\n    }\n  }\n}",
      "query_arguments": {
        "id": "gid://shopify/Product/-1"
      },
      "response": {
        "data": {
          "productDelete": {
            "deletedProductId": null,
            "userErrors": [
              {
                "field": [
                  "id"
                ],
                "message": "Product does not exist"
              }
            ]
          }
        }
      },
      "api_name": "admin",
      "minimum_api_version": "2023-10",
      "maximum_api_version": "unstable",
      "location": "/components/merchandising/test/unit/graph_api/admin/mutations/product_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 { productDelete(input: {id: \\\"gid://shopify/Product/-1\\\"}) { deletedProductId userErrors { field message } } }\"\n}'\n",
      "remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  mutation {\n    productDelete(input: {id: \"gid://shopify/Product/-1\"}) {\n      deletedProductId\n      userErrors {\n        field\n        message\n      }\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 {\n    productDelete(input: {id: \"gid://shopify/Product/-1\"}) {\n      deletedProductId\n      userErrors {\n        field\n        message\n      }\n    }\n  }\nQUERY\n\nresponse = client.query(query: query)\n",
      "node_example": "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: `mutation {\n    productDelete(input: {id: \"gid://shopify/Product/-1\"}) {\n      deletedProductId\n      userErrors {\n        field\n        message\n      }\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 {\n    productDelete(input: {id: \"gid://shopify/Product/-1\"}) {\n      deletedProductId\n      userErrors {\n        field\n        message\n      }\n    }\n  }\nQUERY;\n\n$response = $client->query([\"query\" => $query]);\n"
    },
    "titleStringKey": "variables",
    "inputVariableEntries": []
  },
  {
    "example": {
      "type_name": "productdelete",
      "title": "Delete a product and return its ID",
      "query_string": "mutation {\n  productDelete(input: {id: \"gid://shopify/Product/108828309\"}) {\n    deletedProductId\n  }\n}",
      "query_arguments": {
        "id": "gid://shopify/Product/108828309"
      },
      "response": {
        "data": {
          "productDelete": {
            "deletedProductId": "gid://shopify/Product/108828309"
          }
        }
      },
      "api_name": "admin",
      "minimum_api_version": "2023-10",
      "maximum_api_version": "unstable",
      "location": "/components/merchandising/test/unit/graph_api/admin/mutations/product_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 { productDelete(input: {id: \\\"gid://shopify/Product/108828309\\\"}) { deletedProductId } }\"\n}'\n",
      "remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  mutation {\n    productDelete(input: {id: \"gid://shopify/Product/108828309\"}) {\n      deletedProductId\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 {\n    productDelete(input: {id: \"gid://shopify/Product/108828309\"}) {\n      deletedProductId\n    }\n  }\nQUERY\n\nresponse = client.query(query: query)\n",
      "node_example": "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: `mutation {\n    productDelete(input: {id: \"gid://shopify/Product/108828309\"}) {\n      deletedProductId\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 {\n    productDelete(input: {id: \"gid://shopify/Product/108828309\"}) {\n      deletedProductId\n    }\n  }\nQUERY;\n\n$response = $client->query([\"query\" => $query]);\n"
    },
    "titleStringKey": "variables",
    "inputVariableEntries": []
  }
]

productDeletemutation

Arguments

ProductDeletePayload returns

productDelete
mutation