ProductTypesAddProperty Endpoint

Overview

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

ProductTypesAddProperty

This REST API endpoint allows you to update a product type in your store to have one or more product properties assigned to it. 

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

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

ID is the product property 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 with the property.
id This is the unique ID of the product property that you wish to add to the product type.

Returns

If successful, this endpoint will return True in the ApiResponse.Content object.  Otherwise, you should have one or more errors returned.  If you receive a False response with no error, either the product type or product property ID doesn't exist, or the REST call was improperly formatted.

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 update with a property
var typeId = "1d883a38-143f-4bfc-b0d9-6ff3b410a95b";

// specify the property ID to associate to this product type
var propertyId = 15;

// this parameter is currently not used (use any integer)
var sortOrder = 0;

// call the API to update the product type with the property 
ApiResponse<bool> response = proxy.ProductTypesAddProperty(typeId, propertyId, sortOrder);
// 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 update with a property
    var typeId = "1d883a38-143f-4bfc-b0d9-6ff3b410a95b";

    // specify the property ID to associate to this product type
    var propertyId = 15;

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

});
{
   "Errors":[

   ],
   "Content":true
}
Have more questions? Submit a request

Need More Help?

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