productDelete - admin-graphql - MUTATION

Version: 2024-10

Description:

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](https://shopify.dev/api/admin-graphql/latest/input-objects/ProductVariantInput) that are active at several [locations](https://shopify.dev/api/admin-graphql/latest/input-objects/InventoryLevelInput), you may encounter timeout errors. To avoid these timeout errors, you can instead use the asynchronous [ProductDeleteAsync](https://shopify.dev/api/admin-graphql/latest/mutations/productDeleteAsync) mutation.

Access Scopes

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

Arguments

• input: ProductDeleteInput! - Specifies the product to delete by its ID.
• synchronous: Boolean - Specifies whether or not to run the mutation synchronously.

Returns

• deletedProductId: ID The ID of the deleted product.
• productDeleteOperation: ProductDeleteOperation The product delete operation, returned when run in asynchronous mode.
• shop: Shop! The shop associated with the product.
• userErrors: UserError! The list of errors that occurred from executing the mutation.

Examples

• Delete a non-existent product

          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 { productDelete(input: {id: \\\"gid://shopify/Product/-1\\\"}) { deletedProductId userErrors { field message } } }\"\n}'\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"
          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"
          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"
          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"
          Graphql query: "mutation {\n  productDelete(input: {id: \"gid://shopify/Product/-1\"}) {\n    deletedProductId\n    userErrors {\n      field\n      message\n    }\n  }\n}"
        

  input: null

  response: {
    "data": {
      "productDelete": {
        "deletedProductId": null,
        "userErrors": [
          {
            "field": [
              "id"
            ],
            "message": "Product does not exist"
          }
        ]
      }
    }
  }

  Delete a product

          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 { productDelete(input: {id: \\\"gid://shopify/Product/108828309\\\"}) { deletedProductId } }\"\n}'\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"
          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"
          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"
          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"
          Graphql query: "mutation {\n  productDelete(input: {id: \"gid://shopify/Product/108828309\"}) {\n    deletedProductId\n  }\n}"
        

  input: null

  response: {
    "data": {
      "productDelete": {
        "deletedProductId": "gid://shopify/Product/108828309"
      }
    }
  }

  Delete a product asynchronously and return a product delete operation

          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 productDelete($input: ProductDeleteInput!, $synchronous: Boolean!) { productDelete(synchronous: $synchronous, input: $input) { deletedProductId productDeleteOperation { id status deletedProductId } } }\",\n \"variables\": {\n    \"synchronous\": false,\n    \"input\": {\n      \"id\": \"gid://shopify/Product/108828309\"\n    }\n  }\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `mutation productDelete($input: ProductDeleteInput!, $synchronous: Boolean!) {\n      productDelete(synchronous: $synchronous, input: $input) {\n        deletedProductId\n        productDeleteOperation {\n          id\n          status\n          deletedProductId\n        }\n      }\n    }`,\n    \"variables\": {\n      \"synchronous\": false,\n      \"input\": {\n        \"id\": \"gid://shopify/Product/108828309\"\n      }\n    },\n  },\n});\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 productDelete($input: ProductDeleteInput!, $synchronous: Boolean!) {\n    productDelete(synchronous: $synchronous, input: $input) {\n      deletedProductId\n      productDeleteOperation {\n        id\n        status\n        deletedProductId\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"synchronous\": false,\n  \"input\": {\n    \"id\": \"gid://shopify/Product/108828309\"\n  }\n}\n\nresponse = client.query(query: query, variables: variables)\n"
          PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n  mutation productDelete($input: ProductDeleteInput!, $synchronous: Boolean!) {\n    productDelete(synchronous: $synchronous, input: $input) {\n      deletedProductId\n      productDeleteOperation {\n        id\n        status\n        deletedProductId\n      }\n    }\n  }\nQUERY;\n\n$variables = [\n  \"synchronous\" => false,\n  \"input\" => [\n    \"id\" => \"gid://shopify/Product/108828309\",\n  ],\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
          Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  mutation productDelete($input: ProductDeleteInput!, $synchronous: Boolean!) {\n    productDelete(synchronous: $synchronous, input: $input) {\n      deletedProductId\n      productDeleteOperation {\n        id\n        status\n        deletedProductId\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"synchronous\": false,\n      \"input\": {\n        \"id\": \"gid://shopify/Product/108828309\"\n      }\n    },\n  },\n);\n\nconst data = await response.json();\n"
          Graphql query: "mutation productDelete($input: ProductDeleteInput!, $synchronous: Boolean!) {\n  productDelete(synchronous: $synchronous, input: $input) {\n    deletedProductId\n    productDeleteOperation {\n      id\n      status\n      deletedProductId\n    }\n  }\n}"
        

  input: {
    "synchronous": false,
    "input": {
      "id": "gid://shopify/Product/108828309"
    }
  }

  response: {
    "data": {
      "productDelete": {
        "deletedProductId": null,
        "productDeleteOperation": {
          "id": "gid://shopify/ProductDeleteOperation/1010603706",
          "status": "CREATED",
          "deletedProductId": null
        }
      }
    }
  }