ProductRelationshipsCreate Endpoint

Overview

Product relationships help to populate the related products view when a customer is looking at a product.  This endpoint allows you to create as many related products 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 products that you want to relate to each other before you create the relation.

ProductRelationshipsCreate

This REST API endpoint allows you to create a product relationship 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/productrelationships

HTTP Method

POST

Parameters

This method only requires that you pass a populated instance of the ProductRelationshipDTO object to the endpoint.

Returns

If successful, this endpoint will return a ProductRelationshipDTO 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 product relationship object
var relationship = new ProductRelationshipDTO
{
    ProductId = "fb975149-2c73-45ad-8082-68961e04915c",
    RelatedProductId = "964163db-e733-4cbd-ace5-32717d813f3e"
};

// call the API to create the new product relationship
ApiResponse<ProductRelationshipDTO> response = proxy.ProductRelationshipsCreate(relationship);
// 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 = "productrelationships";  
// get this from the store admin
var apiKey = "YOUR-API-KEY";

$(document).ready(function() {

    // create a new product relationship object
    var relationship = {
        "ProductId": "fb975149-2c73-45ad-8082-68961e04915c",
        "RelatedProductId": "964163db-e733-4cbd-ace5-32717d813f3e"
    };

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

});
{
   "Errors":[

   ],
   "Content":{
      "Id":1,
      "StoreId":1,
      "ProductId":"fb975149-2c73-45ad-8082-68961e04915c",
      "RelatedProductId":"964163db-e733-4cbd-ace5-32717d813f3e",
      "IsSubstitute":false,
      "SortOrder":1,
      "MarketingDescription":""
   }
}
Have more questions? Submit a request

Need More Help?

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