ProductPropertiesUpdate Endpoint

Overview

It wouldn't be unusual to need to update an existing product property.  This endpoint allows you to update any specific product property 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 product properties created so that you can successfully find one to update.

ProductPropertiesUpdate

This REST API endpoint allows you to update a product property in your store. This requires that you also have a product property to update, which would mean that you should also call the ProductPropertiesFind endpoint to get an existing product property.

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/productproperties/[ID]

ID is the product property ID as described in the parameters below.

HTTP Method

POST

Parameters

Parameter Description
id This is the unique ID of the product property that you wish to update
data You will need to pass an updated JSON version of the ProductPropertyDTO object in your post request

Returns

If successful, this endpoint will return a populated ProductPropertyDTO 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 product property to look for
var propertyId = 5;

// call the API to find the product property
var property = proxy.ProductPropertiesFind(propertyId).Content;

// update one or more properties of the object
property.DisplayToDropShipper = false;
            
// call the API to update the property
ApiResponse<ProductPropertyDTO> response = proxy.ProductPropertiesUpdate(property);
// 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 = "productproperties";  
// get this from the store admin
var apiKey = "YOUR-API-KEY";

$(document).ready(function() {

    // specify the product property to look for
    var propertyId = 5;

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

});

function UpdateProductProperty(property) {
            
    // update one or more properties of the object
    property.DisplayToDropShipper = false;

    // call the API to update the property
    $.ajax({
        dataType: "json",
        url: url + apiPath + endPoint + "/" +property.Id + "?key=" + apiKey,
        data: JSON.stringify(property),
        type: 'POST',
        success: function (data) {
            // do something
        },
        error: function (jqXHR, textStatus) {
            // do something else
        }
    });

}
{
   "Errors":[

   ],
   "Content":{
      "Id":14,
      "StoreId":1,
      "PropertyName":"",
      "DisplayName":"",
      "DisplayOnSite":true,
      "DisplayToDropShipper":false,
      "TypeCode":0,
      "DefaultValue":"",
      "CultureCode":"en-US",
      "Choices":[

      ],
      "LastUpdatedUtc":"/Date(1398810774721)/"
   }
}
Have more questions? Submit a request

Need More Help?

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