deleteCompareList mutation

The deleteCompareList mutation deletes the specified comparison list. Run this mutation in the following circumstances:

• When the guest or customer clears all entries from the comparison list.
• After a guest's session expires.

Syntax

mutation {
    deleteCompareList(
        uid: ID!
    ) {
        DeleteCompareListOutput
    }
}

Reference

The deleteCompareList reference provides detailed information about the types and fields defined in this mutation.

• Adobe Commerce as a Cloud Service

• On-Premises/Cloud

Example usage

The following example deletes the comparison list with a uid value of sssXyGZkTFksdPnxNoK1ut6OiV4bbchD.

Request:

mutation {
    deleteCompareList(
        uid: "sssXyGZkTFksdPnxNoK1ut6OiV4bbchD"
    ) {
        result
    }
}

Response:

{
  "data": {
    "deleteCompareList": {
      "result": true
    }
  }
}

Related topics

• compareList query
• addProductsToCompareList mutation
• assignCompareListToCustomer mutation
• createCompareList mutation
• removeProductsFromCompareList mutation

data-slots=text

data-backgroundcolor=blue