MageSmith
MutationCompareList · Magento 2.4.9

deleteCompareList

deleteCompareList is a Magento 2 GraphQL mutation in the CompareList module. Delete the specified compare list. It returns DeleteCompareListOutput and requires an Authorization header (Bearer customer token).

Last verified: against Magento 2.4.9.

Returns

DeleteCompareListOutput

Resolver class

\Magento\CompareListGraphQl\Model\Resolver\DeleteCompareList

Arguments

uid ID! Required

The unique ID of the compare list to be deleted.

Example request

Auto-generated from the SDL — paste-ready against your store's /graphql endpoint. Replace the host, store code, and any required values before running.

Headers

Content-Type
application/json
Store
default store view code; use 'default' for the single-store baseline
Authorization
Bearer <CUSTOMER_TOKEN> obtain from generateCustomerToken mutation

Query

mutation ($uid: ID!) {
  deleteCompareList(uid: $uid) {
    result
  }
}

Variables

{
  "uid": ""
}

Related in CompareListGraphQl

Other fields shipped by the same module.

Mutation

addProductsToCompareList

Add products to the specified compare list.

CompareList · returns CompareList

→
Mutation

assignCompareListToCustomer

Assign the specified compare list to the logged in customer.

CompareList · returns AssignCompareListToCustomerOutput

→
Query

compareList

Return products that have been added to the specified compare list.

CompareList · returns CompareList

→
Mutation

createCompareList

Create a new compare list. The compare list is saved for logged in customers.

CompareList · returns CompareList

→
Mutation

removeProductsFromCompareList

Remove products from the specified compare list.

CompareList · returns CompareList

→

Every Magento dev tool, in one hosted workspace.

Free to sign up. Nothing to install. Drafts, audits, and projects saved across every tool.

Open app →