wishlist
wishlist is a Magento 2 GraphQL query in the Wishlist module. Return the contents of a customer's wish list. It returns WishlistOutput and requires an Authorization header (Bearer customer token).
Deprecated: Moved under `Customer.wishlist`.
Last verified: against Magento 2.4.9.
Returns
Resolver class
\Magento\WishlistGraphQl\Model\Resolver\WishlistResolver
Cache
cacheable: no
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
query {
wishlist {
items {
id
qty
description
added_at
product {
id
uid
name
sku
description { ... }
short_description { ... }
special_price
special_from_date
special_to_date
attribute_set_id
meta_title
meta_keyword
meta_description
image { ... }
small_image { ... }
thumbnail { ... }
new_from_date
new_to_date
tier_price
options_container
created_at
updated_at
country_of_manufacture
type_id
websites { ... }
product_links { ... }
media_gallery_entries { ... }
price { ... }
price_range { ... }
gift_message_available
manufacturer
categories { ... }
canonical_url
media_gallery { ... }
custom_attributesV2 { ... }
tier_prices { ... }
price_tiers { ... }
only_x_left_in_stock
stock_status
quantity
min_sale_qty
max_sale_qty
url_key
url_suffix
url_path
url_rewrites { ... }
related_products { ... }
upsell_products { ... }
crosssell_products { ... }
rating_summary
review_count
reviews { ... }
swatch_image
}
}
items_count
name
sharing_code
updated_at
}
}Variables
{}Related in WishlistGraphQl
Other fields shipped by the same module.
addProductsToWishlist
Add one or more products to the specified wish list. This mutation supports all product types.
Wishlist · returns AddProductsToWishlistOutput
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
Every Magento dev tool, in one hosted workspace.
Free to sign up. Nothing to install. Drafts, audits, and projects saved across every tool.