Skip to content
You are reading the pinned copy of v1.0, which is also the latest release. Read the latest.

Wishlist (storefront API)

Storefront and customer routes of the wishlist module. Send Accept-Language (or X-Locale from a browser) on every call; a customer route needs the session cookie.

Get wishlist

Parameters:

  • page in query (number, min 1, optional).
  • pageSize in query (number, min 1, max 100, optional).
  • sortBy in query ("createdAt", "price", "productName", optional).
  • sortOrder in query ("asc", "desc", optional).

Responses:

  • 200: Wishlist retrieved.
  • 401: Unauthorized.

Remove item from wishlist

Parameters:

  • productId in path (string, required).

Responses:

  • 204: Item removed.
  • 401: Unauthorized.
  • 404: Item not found.

Add item to wishlist

Parameters:

  • productId in path (string, required).

Responses:

  • 201: Item added.
  • 401: Unauthorized.
  • 404: Product not found.
  • 409: Item already in wishlist.

Get wishlisted product ids

Responses:

  • 200: Product ids retrieved.
  • 401: Unauthorized.
As seen on Open Source Alternatives The Merchant Engine badge