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

1
2
3
4
5
6
7
mutation {
    deleteCompareList(
        uid: ID!
    ) {
        DeleteCompareListOutput
    }
}

Example usage

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

Request:

1
2
3
4
5
6
7
mutation {
    deleteCompareList(
        uid: "sssXyGZkTFksdPnxNoK1ut6OiV4bbchD"
    ) {
        result
    }
}

Response:

1
2
3
4
5
6
7
{
  "data": {
    "deleteCompareList": {
      "result": true
    }
  }
}

Input attributes

The deleteCompareList mutation requires the following input.

Attribute Data Type Description
uid ID! The unique ID of the compare list to delete

Output attributes

The DeleteCompareListOutput object returns a Boolean value that indicates whether the operation was successful.

Attribute Data Type Description
result Boolean! A value of true indicates the compare list has been deleted successfully. Otherwise, the value is false