Get Wishlists

About

The wishlists query retrieves a paginated list of the authenticated customer's wishlist items. Use this query to:

• Display the customer's wishlist page
• Show wishlist item counts in navigation
• Build wishlist displays with product details
• Implement pagination for large wishlists
• Show channel-specific wishlist data

This query uses cursor-based pagination and returns wishlist items with their associated product, customer, and channel data.

Authentication

This query requires customer authentication:

• Authenticated customers: Provide a valid customer authentication token in the Authorization header. Obtain this token via the Customer Login API.

Authorization: Bearer <accessToken>

Arguments

Argument	Type	Description
first	Int	Number of items to return per page.
after	String	Cursor for pagination. Use endCursor from previous response.
sort	String	Column to sort by — id (default) or created_at. The compound form created_at-desc (<column>-<direction>) is also accepted.
order	String	Sort direction — asc (default) or desc. Use desc to return the most recently added items first.

By default the wishlist is returned oldest-first (the order items were added). Pass sort: "created_at", order: "desc" to show the newest item at the top.

Possible Returns

Field	Type	Description
edges	[WishlistEdge!]	Array of wishlist edges with cursor and node.
edges.cursor	String!	Cursor for this edge, used in pagination.
edges.node	Wishlist!	The wishlist item object.
edges.node.id	ID!	IRI identifier (e.g. /api/shop/wishlists/69).
edges.node._id	Int!	Numeric identifier.
edges.node.product	Product!	Associated product with id, name, sku, price, type, description, baseImageUrl.
edges.node.customer	Customer!	Associated customer with id, email.
edges.node.channel	Channel!	Associated channel with id, code, translation.
edges.node.createdAt	String	Timestamp when the item was added.
edges.node.updatedAt	String	Timestamp when the item was last updated.
pageInfo	PageInfo!	Pagination metadata.
totalCount	Int!	Total number of wishlist items.