addProductsToWishlist
addProductsToWishlist is a Magento 2 GraphQL mutation in the Wishlist module. Add one or more products to the specified wish list. This mutation supports all product types. It returns AddProductsToWishlistOutput and requires an Authorization header (Bearer customer token).
Last verified: against Magento 2.4.9.
Returns
Resolver class
\Magento\WishlistGraphQl\Model\Resolver\AddProductsToWishlist
Arguments
The ID of a wish list.
An array of products to add to the 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
Query
mutation ($wishlistId: ID!, $wishlistItems: [WishlistItemInput!]!) {
addProductsToWishlist(wishlistId: $wishlistId, wishlistItems: $wishlistItems) {
wishlist {
id
items {
id
qty
description
added_at
product { ... }
}
items_v2 {
items { ... }
page_info { ... }
}
items_count
sharing_code
updated_at
}
user_errors {
message
code
}
}
}Variables
{
"wishlistId": "",
"wishlistItems": [
{
"quantity": 0,
"sku": ""
}
]
}Related in WishlistGraphQl
Other fields shipped by the same module.
addWishlistItemsToCart
Add items in the specified wishlist to the customer's cart.
Wishlist · returns AddWishlistItemsToCartOutput
clearWishlist
Remove all the products from the specified wish list.
Wishlist · returns RemoveProductsFromWishlistOutput
removeProductsFromWishlist
Remove one or more products from the specified wish list.
Wishlist · returns RemoveProductsFromWishlistOutput
updateProductsInWishlist
Update one or more products in the specified wish list.
Wishlist · returns UpdateProductsInWishlistOutput
wishlist
DeprecatedReturn the contents of a customer's wish list.
Wishlist · returns WishlistOutput
Every Magento dev tool, in one hosted workspace.
Free to sign up. Nothing to install. Drafts, audits, and projects saved across every tool.