ProductPropertiesCreate Endpoint

Overview

Any store with different kinds of products or numerous products with the same properties probably needs product properties.  This endpoint allows you to create as many product properties as you need for 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 some kind of idea what attributes that you want your product property to have before you create it.

ProductPropertiesCreate

This REST API endpoint allows you to create a product property for your store. 

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

HTTP Method

POST

Parameters

This method only requires that you pass an instance of the ProductPropertyDTO object to the endpoint.

Returns

If successful, this endpoint will return a ProductPropertyDTO object in JSON format.  Otherwise, you will 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);

// create a new instance of a product property
var property = new ProductPropertyDTO();

// populate the product property object with minimal information
property.PropertyName = "ERP ID Number";
property.DisplayName = "ABC ERP ID Number";
property.DefaultValue = "replace me";
property.DisplayOnSite = false;

// call the API to create the new product property
ApiResponse<ProductPropertyDTO> response = proxy.ProductPropertiesCreate(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() {

    // create a new instance of a product property
    var property = {
        "PropertyName": "ERP ID Number",
        "DisplayName": "ABC ERP ID Number",
        "DefaultValue": "replace me",
        "DisplayOnSite": false
    };

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

});
{
   "Errors":[

   ],
   "Content":{
      "Id":6,
      "StoreId":1,
      "PropertyName":"ERP ID Number",
      "DisplayName":"ABC ERP ID Number",
      "DisplayOnSite":false,
      "DisplayToDropShipper":true,
      "TypeCode":0,
      "DefaultValue":"replace me",
      "CultureCode":"en-US",
      "Choices":[

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

Need More Help?

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