deleteWishlist mutation

The deleteWishlist mutation deletes the specified wish list. In Adobe Commerce, you cannot delete the customer’s default (first) wish list. This mutation is not available in Magento Open Source.

This mutation requires a valid customer authentication token.

Syntax

1
2
3
mutation {
  deleteWishlist(wishlistId: ID!): DeleteWishlistOutput
}

Example usage

The following example deletes a wish list.

Request:

1
2
3
4
5
6
7
8
9
10
mutation{
  deleteWishlist(wishlistId: 3){
    status
    wishlists {
      id
      name
      items_count
    }
  }
}

Response:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
{
  "data": {
    "deleteWishlist": {
      "status": true,
      "wishlists": [
        {
          "id": "1",
          "name": "Vacation Wants",
          "items_count": 7
        },
        {
          "id": "2",
          "name": "Lose the Muffintop",
          "items_count": 6
        }
      ]
    }
  }
}

Input attributes

The deleteWishlist mutation requires the following input.

Output attributes

The DeleteWishlistOutput object can contain the following attributes:

Wishlist attributes

The Wishlist object contains all the items in the customer’s wish list.

WishlistItem attributes

The WishlistItem object can contain the following attributes.