productVariantBulkDeletePreview

Requires permission products:product:delete.

Read-only blast radius (default-variant/last-variant checks, open-document/cart references) for a bulk variant delete.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

query ProductVariantBulkDeletePreview($input: ProductVariantBulkDeleteInput!) {
  productVariantBulkDeletePreview(input: $input) {
    buyingListLines
    cartLines
    defaultVariantCount
    missing
    openOrderLines
    openQuoteLines
    lastVariantViolations {
      productName
      productId
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query ProductVariantBulkDeletePreview($input: ProductVariantBulkDeleteInput!) {\n  productVariantBulkDeletePreview(input: $input) {\n    buyingListLines\n    cartLines\n    defaultVariantCount\n    missing\n    openOrderLines\n    openQuoteLines\n    lastVariantViolations {\n      productName\n      productId\n    }\n  }\n}",
  "variables": {
    "input": {
      "variantIds": [
        "id"
      ]
    }
  }
}
EOF

Variables:

{
  "input": {
    "variantIds": [
      "id"
    ]
  }
}

Response:

{
  "data": {
    "productVariantBulkDeletePreview": {
      "buyingListLines": 0,
      "cartLines": 0,
      "defaultVariantCount": 0,
      "missing": 0,
      "openOrderLines": 0,
      "openQuoteLines": 0,
      "lastVariantViolations": [
        {
          "productName": "string",
          "productId": "id"
        }
      ]
    }
  }
}

productVariantBulkDeletePreview(
  input: ProductVariantBulkDeleteInput!
): ProductBulkDeletePreview!

Arguments

productVariantBulkDeletePreview.input ● ProductVariantBulkDeleteInput! non-null input

The details of the product variant bulk delete request.

Type

ProductBulkDeletePreview object

What a bulk delete would affect, for the confirmation dialog. It writes nothing.