What arguments does clearWishlist accept?

The clearWishlist mutation accepts 1 argument: wishlistId (ID!), required.

Does clearWishlist require authentication?

clearWishlist requires an Authorization header with a Bearer customer token. Obtain the token by calling the generateCustomerToken mutation with the customer's email and password.

MageSmith

MutationWishlist · Magento 2.4.9

clearWishlist

Q: What does the clearWishlist mutation do in Magento 2 GraphQL?

clearWishlist is a Magento 2 GraphQL mutation in the Wishlist module. Remove all the products from the specified wish list. It returns RemoveProductsFromWishlistOutput and requires an Authorization header (Bearer customer token).

Q: What does clearWishlist return?

clearWishlist returns RemoveProductsFromWishlistOutput.

clearWishlist is a Magento 2 GraphQL mutation in the Wishlist module. Remove all the products from the specified wish list. It returns RemoveProductsFromWishlistOutput and requires an Authorization header (Bearer customer token).

Last verified: 2026-05-23 against Magento 2.4.9.

Returns

RemoveProductsFromWishlistOutput

Resolver class

\Magento\WishlistGraphQl\Model\Resolver\ClearWishlist

Arguments

wishlistId ID! Required

The ID of a wish list.

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 ($wishlistId: ID!) {
  clearWishlist(wishlistId: $wishlistId) {
    wishlist {
      id
      items {
        id
        qty
        description
        added_at
        product { ... }
      }
      items_v2 {
        items { ... }
        page_info { ... }
      }
      items_count
      sharing_code
      updated_at
    }
    user_errors {
      message
      code
    }
  }
}