WishListItemsFindForCustomer Endpoint

Overview

Sometimes you just need to find a a listing of the wish list items a customer has to do something unique with it.  This endpoint allows you to find all wish list items for a customer in your store.

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
  • Visual Studio 2012 or newer

Getting Started

You should already have a project open and ready to accept code to allow you to use this REST API endpoint.  You should also have one or more wish list items created so that you can successfully find some.

WishListItemsFindForCustomer

This REST API endpoint allows you to find all of the wish list items that a specific customer has added. 

Example URL

This is what the REST endpoint will look like if you are calling it using JavaScript.  See our REST API URL documentation for more information.

http://example.com/DesktopModules/Hotcakes/API/rest/v1/wishlistitems/?key=[YOURKEY]&id=[CUSTOMERID]

CUSTOMERID is the slug portion of the URL as described in the parameters below.

HTTP Method

GET

Parameters

Parameter Description
id This is the unique ID of the customer, which is also the ID of the customer in the CMS.

Returns

If successful, this endpoint will return a populated WishListItemDTO object in JSON format.  Otherwise, you should have one or more errors returned.  

Example Code

The following code will allow you to successfully call this endpoint, provided that you have enabled it.

Project References

  • Hotcakes.CommerceDTO

Import Namespaces

  • Hotcakes.CommerceDTO.v1
  • Hotcakes.CommerceDTO.v1.Catalog
  • Hotcakes.CommerceDTO.v1.Client

 

string url = "http://example.com";
string key = "YOUR-API-KEY";

Api proxy = new Api(url, key);

// specify the customer to find wish list items for
var customerId = "3";

// call the API to find the wish list items for the customer
ApiResponse<List<WishListItemDTO>> response = proxy.WishListItemsFindForCustomer(customerId);
// your domain name
var url = "http://example.com"; 
// the path where the API is
var apiPath = "/DesktopModules/Hotcakes/API/rest/v1/";  
// endpoint as shown in the documentation
var endPoint = "wishlistitems";  
// get this from the store admin
var apiKey = "YOUR-API-KEY";

$(document).ready(function() {

    // specify the customer to find wish list items for
    var customerId = "3";

    // call the API to find the wish list items for the customer
    $.ajax({
        dataType: "json",
        url: url + apiPath + endPoint + "?key=" + apiKey + "&id=" + customerId,
        type: 'GET',
        success: function (data) {
            // do something
        },
        error: function (jqXHR, textStatus) {
           // do something else
        }
    });

});
{
   "Errors":[

   ],
   "Content":[
      {
         "Id":6,
         "StoreId":1,
         "CustomerId":"3",
         "LastUpdatedUtc":"/Date(1403318445917)/",
         "ProductId":"dfcae0ee-8bcf-4321-8b31-7883b5434285",
         "Quantity":2,
         "SelectionData":[

         ]
      },
      {
         "Id":4,
         "StoreId":1,
         "CustomerId":"3",
         "LastUpdatedUtc":"/Date(1403262038847)/",
         "ProductId":"dfcae0ee-8bcf-4321-8b31-7883b5434285",
         "Quantity":1,
         "SelectionData":[

         ]
      },
      {
         "Id":3,
         "StoreId":1,
         "CustomerId":"3",
         "LastUpdatedUtc":"/Date(1403259862553)/",
         "ProductId":"5d520070-17e5-4587-bddb-9935bc584b6c",
         "Quantity":2,
         "SelectionData":[
            {
               "OptionBvin":"f5c6fbd865c6494291737f1c2c64b8c1",
               "SelectionData":"90c9ce3cad0e4b8daba93e825db2de93"
            }
         ]
      },
      {
         "Id":2,
         "StoreId":1,
         "CustomerId":"3",
         "LastUpdatedUtc":"/Date(1403257711740)/",
         "ProductId":"dfcae0ee-8bcf-4321-8b31-7883b5434285",
         "Quantity":1,
         "SelectionData":[

         ]
      }
   ]
}
Have more questions? Submit a request

Need More Help?

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