Wishlist

List the customer's wishlist items

Returns every wishlist item for the authenticated customer in the current channel. Each row embeds product, customer and channel as IRIs.

get/wishlists

Request

Query parameters

sort'id' | 'created_at' | 'id-asc' | 'id-desc' | 'created_at-asc' | 'created_at-desc'

Column to sort by: id (default) or created_at. Compound form also accepted, e.g. created_at-desc.

order'asc' | 'desc'

Sort direction: asc (default) or desc. Use desc to show the most recently added items first.

pageinteger

The collection page number

per_pageinteger

The number of items per page

Headers

X-STOREFRONT-KEYstring required

Storefront API Key for authentication. Required for all shop/storefront API requests.

X-Localestring
Example:en

Locale code for localized data (e.g. "en", "fr", "ar"). Defaults to channel's default locale.

X-Channelstring
Example:default

Channel code (e.g. "default"). Defaults to the current channel.

X-Currencystring
Example:USD

Currency code (e.g. "USD", "EUR", "INR"). Defaults to channel's base currency.

Response

List of wishlist items.

Changes

No recorded changes to this operation across all 13 revisions of this API.