Skip to content

Get Wishlist Item ​

About ​

The wishlist query retrieves a single wishlist item by its IRI identifier. Use this query to:

  • Fetch detailed information about a specific wishlist item
  • Display wishlist item details on a detail page
  • Verify a product exists in the customer's wishlist

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
idID!The IRI of the wishlist item (e.g. /api/shop/wishlists/69).

Possible Returns ​

FieldTypeDescription
idID!IRI identifier (e.g. /api/shop/wishlists/69).
_idInt!Numeric identifier.
productProduct!Associated product with id, name, price, etc.
customerCustomer!Associated customer with id, email.
channelChannel!Associated channel with id, code.
createdAtStringTimestamp when the item was added.
updatedAtStringTimestamp when the item was last updated.

Released under the MIT License.