ProductTypesUpdate Endpoint

Overview

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

ProductTypesUpdate

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

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

BVIN is the product type ID as described in the parameters below.

HTTP Method

POST

Parameters

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

Returns

If successful, this endpoint will return a populated ProductTypeDTO 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 type to look for
var typeId = "1d883a38-143f-4bfc-b0d9-6ff3b410a95b";

// call the API to find the specified product type
var type = proxy.ProductTypesFind(typeId).Content;

// update one or more properties of the product type
type.TemplateName = "HighEndLaptop";

// call the API to update the product type
ApiResponse<ProductTypeDTO> response = proxy.ProductTypesUpdate(type);
// 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 = "producttypes";  
// get this from the store admin
var apiKey = "YOUR-API-KEY";

$(document).ready(function() {

    // specify the product type to look for
    var typeId = "1d883a38-143f-4bfc-b0d9-6ff3b410a95b";

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

});

function UpdatePropertyType(category) {

    // update one or more properties of the product type
    type.TemplateName = "HighEndLaptop";

    // clearing out the last udpated date to prevent errors
    // the API will update this for you anyway
    type.LastUpdated = ""; 
            
    // call the API to update the product type
    $.ajax({
        dataType: "json",
        url: url + apiPath + endPoint + "/" + type.Bvin + "?key=" + apiKey,
        data: JSON.stringify(type),
        type: 'POST',
        success: function (data) {
            // do something
        },
        error: function (jqXHR, textStatus) {
            // do something else
        }
    });

}
{
   "Errors":[

   ],
   "Content":{
      "Bvin":"1d883a38-143f-4bfc-b0d9-6ff3b410a95b",
      "StoreId":1,
      "LastUpdated":"/Date(1398987799035)/",
      "IsPermanent":false,
      "ProductTypeName":"Laptops",
      "TemplateName":"HighEndLaptop"
   }
}
Have more questions? Submit a request

Need More Help?

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