ProductPropertiesForProduct Endpoint

Overview

This endpoint allows you to find all of the product properties for a specific product in your store.  This allows you to list them and parse them for any number of reasons or purposes.

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 and associated to a known product so that you can successfully find them.

ProductPropertiesForProduct

This REST API endpoint allows you to find all of the product properties for a specific product in 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?key=[YOURKEY]&byproduct=[BVIN]

BVIN is the primary key or ID of the product as described in the parameters below.

HTTP Method

GET

Parameters

Parameter Description
byproduct This value should be a valid product ID for the product you are looking for. This is the same property/field that is called "bvin" in the database or product object.

Returns

If successful, this endpoint will return a populated list of the 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);

// the product ID (bvin) to find properties for
var productID = "8a981b5a-0fc2-4afd-9d7f-234c47fdc152";

// call the API to get all of the product properties in the store
ApiResponse<List<ProductPropertyDTO>> response = proxy.ProductPropertiesForProduct();
// 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() {

    // the product ID (bvin) to find properties for
    var productID = "8a981b5a-0fc2-4afd-9d7f-234c47fdc152";

    // call the API to get all of the product properties in the store
    $.ajax({
        dataType: "json",
        url: url + apiPath + endPoint + "/?key=" + apiKey + "&byproduct=" + productID,
        type: 'GET',
        success: function (data) {
            // do something
        },
        error: function (jqXHR, textStatus) {
           // do something else
        }
    });

});
{
   "Errors":[

   ],
   "Content":[
      {
         "Id":5,
         "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(1398754189713)/"
      },
      {
         "Id":8,
         "StoreId":1,
         "PropertyName":"ISBN",
         "DisplayName":"Book ISBN",
         "DisplayOnSite":true,
         "DisplayToDropShipper":true,
         "TypeCode":0,
         "DefaultValue":"replace me",
         "CultureCode":"en-US",
         "Choices":[

         ],
         "LastUpdatedUtc":"/Date(1398831469697)/"
      },
      {
         "Id":12,
         "StoreId":1,
         "PropertyName":"Platform",
         "DisplayName":"Compatible Platforms",
         "DisplayOnSite":true,
         "DisplayToDropShipper":true,
         "TypeCode":0,
         "DefaultValue":"replace me",
         "CultureCode":"en-US",
         "Choices":[

         ],
         "LastUpdatedUtc":"/Date(1398831576673)/"
      },
      {
         "Id":11,
         "StoreId":1,
         "PropertyName":"Publisher",
         "DisplayName":"Book Publisher",
         "DisplayOnSite":true,
         "DisplayToDropShipper":true,
         "TypeCode":0,
         "DefaultValue":"replace me",
         "CultureCode":"en-US",
         "Choices":[

         ],
         "LastUpdatedUtc":"/Date(1398831516950)/"
      },
      {
         "Id":10,
         "StoreId":1,
         "PropertyName":"ReleaseDate",
         "DisplayName":"Software Release Date",
         "DisplayOnSite":true,
         "DisplayToDropShipper":true,
         "TypeCode":0,
         "DefaultValue":"replace me",
         "CultureCode":"en-US",
         "Choices":[

         ],
         "LastUpdatedUtc":"/Date(1398831499710)/"
      },
      {
         "Id":9,
         "StoreId":1,
         "PropertyName":"Version",
         "DisplayName":"Software Version Number",
         "DisplayOnSite":true,
         "DisplayToDropShipper":true,
         "TypeCode":0,
         "DefaultValue":"replace me",
         "CultureCode":"en-US",
         "Choices":[

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

Need More Help?

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