REST API Endpoints for Wish List Items

Overview

Wish lists allow customers to save a listing of products that they want but don't want to buy right away.  This allows them to buy them later or have others buy the products for them.  This area of the API allows you to manage how that is done.

Requirements

The following pre-requisites will be necessary to accomplish the goals of this article:

  • General understanding of REST and API’s
  • Understanding of C# and/or JavaScript

Getting Started

If you haven’t already done so, you should probably have a development environment ready to development against, complete with Hotcakes installed and configured.

REST API Endpoints for Wish List Items

There are a handful of REST API endpoints that allow you to display or manage various aspects of wish list items.  Those endpoints are detailed below.

Endpoint Return Type Description
WishListItemsCreate WishListItemDTO Creates a new wish list item.
WishListItemsDelete Boolean Permanently deletes the specified wish list item.
WishListItemsFind WishListItemDTO Allows you to find a specific wish list item using its ID.
WishListItemsFindAll List of WishListItemDTO Look for and return all wish list items in the store.
WishListItemsFindForCustomer List of WishListItemDTO Look for and return all wish list items matching the given customer ID.
WishListItemsUpdate WishListItemDTO Updates the wish list item with the given wish list object.

 

Have more questions? Submit a request

Need More Help?

Do you need more assistance with this article? Please review your support options.