Get Wishlist Items
Retrieve the authenticated customer's wishlist items for the current channel.
Endpoint
GET /api/shop/wishlistsRequest Headers
| Header | Required | Description |
|---|---|---|
Content-Type | Yes | application/json |
X-STOREFRONT-KEY | Yes | Your storefront API key |
Authorization | Yes | Customer Bearer token (Bearer <accessToken>) |
Query Parameters
| Parameter | Required | Default | Description |
|---|---|---|---|
sort | No | id | Column to sort by — id or created_at. The compound form created_at-desc (<column>-<direction>) is also accepted. |
order | No | asc | Sort direction — asc 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). To show the newest item at the top, pass ?sort=created_at&order=desc (or the shorthand ?sort=created_at-desc).
Response Fields (200 OK)
| Field | Type | Description |
|---|---|---|
id | integer | Wishlist item ID |
product | object | Associated product (id, name, sku, type, price, baseImageUrl) |
customer | object | Customer who added the item (id, email) |
channel | object | Channel where the item was added (id, code) |
createdAt | string | Timestamp when the item was added |
updatedAt | string | Timestamp when the item was last updated |
TIP
The response is a plain JSON array of wishlist items. Pagination metadata is exposed via the X-Total-Count / X-Page / X-Per-Page / X-Total-Pages response headers.
Use Cases
- Display the customer's wishlist page
- Show a wishlist count in navigation
- Build saved-for-later product lists
Notes
- Wishlist items are scoped to the customer and the current channel.
- Guests cannot have wishlists — a valid customer token is required.