Skip to content

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

ArgumentTypeDescription
firstIntNumber of items to return per page.
afterStringCursor for pagination. Use endCursor from previous response.

Possible Returns

FieldTypeDescription
edges[WishlistEdge!]Array of wishlist edges with cursor and node.
edges.cursorString!Cursor for this edge, used in pagination.
edges.nodeWishlist!The wishlist item object.
edges.node.idID!IRI identifier (e.g. /api/shop/wishlists/69).
edges.node._idInt!Numeric identifier.
edges.node.productProduct!Associated product with id, name, sku, price, type, description, baseImageUrl.
edges.node.customerCustomer!Associated customer with id, email.
edges.node.channelChannel!Associated channel with id, code, translation.
edges.node.createdAtStringTimestamp when the item was added.
edges.node.updatedAtStringTimestamp when the item was last updated.
pageInfoPageInfo!Pagination metadata.
totalCountInt!Total number of wishlist items.

Released under the MIT License.