WishListItemsUpdate Endpoint

Overview

It wouldn't be unusual to need to update an existing wish list item.  This endpoint allows you to update any specific wish list item 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 one to update.

WishListItemsUpdate

This REST API endpoint allows you to update a wish list item in your store. This requires that you also have a wish list item to update, which would mean that you should also call the WishListItemsFind endpoint to get an existing wish list item.

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/[BVIN]

BVIN is the wish list item ID as described in the parameters below.

HTTP Method

POST

Parameters

Parameter Description
bvin This is the unique ID of the wish list item that you wish to update
data You will need to pass an updated JSON version of the WishListItemDTO object in your post request

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 wish list item to update
var wishListItemId = 3;

// call the API to get the wish list item
var wishListItem = proxy.WishListItemsFind(wishListItemId).Content;

// update one or more properties
wishListItem.Quantity = 2;

// call the API to save the updated wish list item
ApiResponse<WishListItemDTO> response = proxy.WishListItemsUpdate(wishListItem);
// 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 wish list item to look for
    var wishListItemId = 3;

    // call the API to find the wish list item
    $.ajax({
        dataType: "json",
        url: url + apiPath + endPoint + "/" + wishListItemId + "?key=" + apiKey,
        type: 'GET',
        success: function (data) {
            // update the wish list item  in another method
            UpdateWishListItem(data.Content);
        },
        error: function (jqXHR, textStatus) {
            // do something
        }
    });

});

function UpdateWishListItem(wishListItem) {

    // update one or more properties
    wishListItem.Quantity = 2;

    // parse the UTC date to save safely
    wishListItem.LastUpdatedUtc = ParseDateForSave(wishListItem.LastUpdatedUtc);
            
    // call the API to save the updated wish list item
    $.ajax({
        dataType: "json",
        url: url + apiPath + endPoint + "/" + wishListItem.Id + "?key=" + apiKey,
        data: JSON.stringify(wishListItem),
        type: 'POST',
        success: function (data) {
            // do something
        },
        error: function (jqXHR, textStatus) {
            // do something else
        }
    });

}

function ParseDateForSave(dateValue) {
    // create a new date object in UTC format
    var newDate = new Date(parseInt(dateValue.substr(6)));

    // return the UTC version of the date
    return newDate.toISOString();
}
{
   "Errors":[

   ],
   "Content":{
      "Id":3,
      "StoreId":1,
      "CustomerId":"3",
      "LastUpdatedUtc":"\/Date(1403259862553)\/",
      "ProductId":"5d520070-17e5-4587-bddb-9935bc584b6c",
      "Quantity":2,
      "SelectionData":[
         {
            "OptionBvin":"f5c6fbd865c6494291737f1c2c64b8c1",
            "SelectionData":"90c9ce3cad0e4b8daba93e825db2de93"
         }
      ]
   }
}
Have more questions? Submit a request

Need More Help?

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