productVariantDelete
mutation
deprecated

Choose a version:

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

Deletes a product variant. Use productVariantsBulkDelete instead.

Anchor to section titled 'Arguments'

Arguments

Anchor to id id ID! required: The ID of the product variant to be deleted.

Was this section helpful?

Anchor to section titled 'ProductVariantDeletePayload returns'

ProductVariantDeletePayload returns

Anchor to ProductVariantDeletePayload.deletedProductVariantId deletedProductVariantId ID: The ID of the deleted product variant.
Anchor to ProductVariantDeletePayload.product product Product: The product associated with the deleted product variant.
Anchor to ProductVariantDeletePayload.userErrors userErrors [UserError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Code examples for MUTATION: productVariantDelete

Query Reference for MUTATION: productVariantDelete

"mutation productVariantDelete($id: ID!) {\n  productVariantDelete(id: $id) {\n    deletedProductVariantId\n    product {\n      # Product fields\n    }\n    userErrors {\n      field\n      message\n    }\n  }\n}"

Input Reference for MUTATION: productVariantDelete

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

Schema Reference for MUTATION: productVariantDelete

""

Display Examples for MUTATION: productVariantDelete

[
  {
    "example": {
      "type_name": "productvariantdelete",
      "title": "Delete a product variant",
      "query_string": "mutation productVariantDelete($id: ID!) {\n  productVariantDelete(id: $id) {\n    deletedProductVariantId\n    product {\n      id\n      title\n    }\n    userErrors {\n      field\n      message\n    }\n  }\n}",
      "variables": {
        "id": "gid://shopify/ProductVariant/43729076"
      },
      "response": {
        "data": {
          "productVariantDelete": {
            "deletedProductVariantId": "gid://shopify/ProductVariant/43729076",
            "product": {
              "id": "gid://shopify/Product/108828309",
              "title": "Draft"
            },
            "userErrors": []
          }
        }
      },
      "api_name": "admin",
      "minimum_api_version": "2023-10",
      "maximum_api_version": "2024-07",
      "location": "/components/merchandising/test/unit/graph_api/admin/mutations/product_variant_delete_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 productVariantDelete($id: ID!) { productVariantDelete(id: $id) { deletedProductVariantId product { id title } userErrors { field message } } }\",\n \"variables\": {\n    \"id\": \"gid://shopify/ProductVariant/43729076\"\n  }\n}'\n",
      "remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  mutation productVariantDelete($id: ID!) {\n    productVariantDelete(id: $id) {\n      deletedProductVariantId\n      product {\n        id\n        title\n      }\n      userErrors {\n        field\n        message\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"id\": \"gid://shopify/ProductVariant/43729076\"\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 productVariantDelete($id: ID!) {\n    productVariantDelete(id: $id) {\n      deletedProductVariantId\n      product {\n        id\n        title\n      }\n      userErrors {\n        field\n        message\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"id\": \"gid://shopify/ProductVariant/43729076\"\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 productVariantDelete($id: ID!) {\n      productVariantDelete(id: $id) {\n        deletedProductVariantId\n        product {\n          id\n          title\n        }\n        userErrors {\n          field\n          message\n        }\n      }\n    }`,\n    \"variables\": {\n      \"id\": \"gid://shopify/ProductVariant/43729076\"\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 productVariantDelete($id: ID!) {\n    productVariantDelete(id: $id) {\n      deletedProductVariantId\n      product {\n        id\n        title\n      }\n      userErrors {\n        field\n        message\n      }\n    }\n  }\nQUERY;\n\n$variables = [\n  \"id\" => \"gid://shopify/ProductVariant/43729076\",\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
    },
    "titleStringKey": "variables",
    "inputVariableEntries": [
      {
        "arg": {
          "name": "id",
          "description": "The ID of the product variant to be deleted.",
          "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/ProductVariant/43729076\"",
        "typeKind": "MUTATION"
      }
    ]
  },
  {
    "example": {
      "type_name": "productvariantdelete",
      "title": "Delete non-existing product variant",
      "description": "Trying to delete a product variant using an ID that doesn't exist returns `null`.\n",
      "query_string": "mutation productVariantDelete($id: ID!) {\n  productVariantDelete(id: $id) {\n    deletedProductVariantId\n    userErrors {\n      field\n      message\n    }\n  }\n}",
      "variables": {
        "id": "gid://shopify/ProductVariant/-1"
      },
      "response": {
        "data": {
          "productVariantDelete": {
            "deletedProductVariantId": null,
            "userErrors": [
              {
                "field": [
                  "id"
                ],
                "message": "Product variant does not exist"
              }
            ]
          }
        }
      },
      "api_name": "admin",
      "minimum_api_version": "2023-10",
      "maximum_api_version": "2024-07",
      "location": "/components/merchandising/test/unit/graph_api/admin/mutations/product_variant_delete_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 productVariantDelete($id: ID!) { productVariantDelete(id: $id) { deletedProductVariantId userErrors { field message } } }\",\n \"variables\": {\n    \"id\": \"gid://shopify/ProductVariant/-1\"\n  }\n}'\n",
      "remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  mutation productVariantDelete($id: ID!) {\n    productVariantDelete(id: $id) {\n      deletedProductVariantId\n      userErrors {\n        field\n        message\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"id\": \"gid://shopify/ProductVariant/-1\"\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 productVariantDelete($id: ID!) {\n    productVariantDelete(id: $id) {\n      deletedProductVariantId\n      userErrors {\n        field\n        message\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"id\": \"gid://shopify/ProductVariant/-1\"\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 productVariantDelete($id: ID!) {\n      productVariantDelete(id: $id) {\n        deletedProductVariantId\n        userErrors {\n          field\n          message\n        }\n      }\n    }`,\n    \"variables\": {\n      \"id\": \"gid://shopify/ProductVariant/-1\"\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 productVariantDelete($id: ID!) {\n    productVariantDelete(id: $id) {\n      deletedProductVariantId\n      userErrors {\n        field\n        message\n      }\n    }\n  }\nQUERY;\n\n$variables = [\n  \"id\" => \"gid://shopify/ProductVariant/-1\",\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
    },
    "titleStringKey": "variables",
    "inputVariableEntries": [
      {
        "arg": {
          "name": "id",
          "description": "The ID of the product variant to be deleted.",
          "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/ProductVariant/-1\"",
        "typeKind": "MUTATION"
      }
    ]
  }
]

productVariantDeletemutationdeprecated

Arguments

ProductVariantDeletePayload returns

productVariantDelete
mutation
deprecated