removeProductsFromCompareList mutation | Adobe Commerce Developer Guide

The removeProductsFromCompareList mutation removes products from a comparison list.

You must specify the unique ID of a comparison list along with the list of product IDs to be removed.

Syntax

mutation {
    removeProductsFromCompareList(
        input: RemoveProductsFromCompareListInput
    ) {
        CompareList
    }
}

Example usage

The following example removes two products from the comparison list with the unique ID “sssXyGZkTFksdPnxNoK1ut6OiV4bbchD”.

Request:

mutation {
  removeProductsFromCompareList(
    input: {
      uid: "sssXyGZkTFksdPnxNoK1ut6OiV4bbchD",
      products: ["1", "2"]
    }
  ) {
    uid
    item_count
    attributes {
      code
      label
    }
    items {
      uid
      product {
        sku
        name
        description {
          html
        }
      }
    }
  }
}

Response:

{
  "data": {
    "removeProductsFromCompareList": {
      "uid": "sssXyGZkTFksdPnxNoK1ut6OiV4bbchD",
      "item_count": 2,
      "attributes": [
        {
          "code": "sku",
          "label": "SKU"
        },
        {
          "code": "description",
          "label": "Description"
        },
        {
          "code": "short_description",
          "label": "Short Description"
        },
        {
          "code": "activity",
          "label": "Activity"
        }
      ],
      "items": [
        {
          "uid": "3",
          "product": {
            "sku": "24-MB03",
            "name": "Crown Summit Backpack",
            "description": {
              "html": "<p>The Crown Summit Backpack is equally at home in a gym locker, study cube or a pup tent, so be sure yours is packed with books, a bag lunch, water bottles, yoga block, laptop, or whatever else you want in hand. Rugged enough for day hikes and camping trips, it has two large zippered compartments and padded, adjustable shoulder straps.</p>\n<ul>\n<li>Top handle.</li>\n<li>Grommet holes.</li>\n<li>Two-way zippers.</li>\n<li>H 20\" x W 14\" x D 12\".</li>\n<li>Weight: 2 lbs, 8 oz. Volume: 29 L.</li>\n<ul>"
            }
          }
        },
        {
          "uid": "4",
          "product": {
            "sku": "24-MB05",
            "name": "Wayfarer Messenger Bag",
            "description": {
              "html": "<p>Perfect for class, work or the gym, the Wayfarer Messenger Bag is packed with pockets. The dual-buckle flap closure reveals an organizational panel, and the roomy main compartment has spaces for your laptop and a change of clothes. An adjustable shoulder strap and easy-grip handle promise easy carrying.</p>\n<ul>\n<li>Multiple internal zip pockets.</li>\n<li>Made of durable nylon.</li>\n</ul>"
            }
          }
        }
      ]
    }
  }
}

Input attributes

The RemoveProductsFromCompareListInput input object defines the comparison list to be modified.

RemoveProductsFromCompareListInput attributes

The RemoveProductsFromCompareListInput object contains the following attributes:

Attribute	Data Type	Description
`products`	[ID!]!	An array of product IDs to remove from the comparison list
`uid`	ID!	The unique identifier of the comparison list to modify

Output attributes

The CompareList output object contains the following attributes:

Attribute	Data Type	Description
`attributes`	[ComparableAttribute]	An array of attributes that can be used for comparing products
`item_count`	Int!	The number of items in the comparison lists
`items`	[ComparableItem]	An array of products to compare
`uid`	ID!	The unique ID of a `CompareList` object

ComparableAttribute attributes

The ComparableAttribute object lists the attributes that are available for comparisons:

Attribute	Data Type	Description
`code`	String!	An attribute code that is enabled for product comparisons
`label`	String!	The label of the attribute code

ComparableItem attributes

The ComparableItem object lists items that have been added to the comparison list:

Attribute	Data Type	Description
`attributes`	[ProductAttribute]!	An array of product attributes that can be used to compare products
`product`	ProductInterface!	Contains details about a product in a comparison list
`uid`	ID!	The unique ID of a `ComparableItem` object

ProductAttribute object

The ProductAttribute object outputs item data from the corresponding attribute:

Attribute	Data Type	Description
`code`	String!	The unique identifier for a product attribute code
`label`	String!	The display value of the attribute