ProductRelationshipsForProduct Endpoint

Overview

Sometimes you might need to find all relationships for a specific product to do something with them.  This endpoint allows you to find the relationships for a specific product 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 propduct relationships created so that you can successfully find one or more.

ProductRelationshipsForProduct

This REST API endpoint allows you to find a collection of product relationships for a 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/productrelationships/?key=[YOURKEY]&byproduct=[BVIN]

HTTP Method

GET

Parameters

Parameter Description
bvin This is the unique ID of the product that you wish to find relationships for

Returns

If successful, this endpoint will return a populated List of ProductRelationshipDTO 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 to find relationships for
var productId = "fb975149-2c73-45ad-8082-68961e04915c";

// call the API to find the product relationships
ApiResponse<List<ProductRelationshipDTO>> response = proxy.ProductRelationshipsForProduct(productId);
// 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() {

    // specify the product to find relationships for
    var productId = "fb975149-2c73-45ad-8082-68961e04915c";

    // call the API to find the product relationships
    $.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":7,
         "StoreId":1,
         "ProductId":"fb975149-2c73-45ad-8082-68961e04915c",
         "RelatedProductId":"964163db-e733-4cbd-ace5-32717d813f3e",
         "IsSubstitute":false,
         "SortOrder":1,
         "MarketingDescription":""
      },
      {
         "Id":8,
         "StoreId":1,
         "ProductId":"fb975149-2c73-45ad-8082-68961e04915c",
         "RelatedProductId":"f82bcaad-97e4-4e03-8683-998a09346009",
         "IsSubstitute":false,
         "SortOrder":2,
         "MarketingDescription":""
      }
   ]
}
Have more questions? Submit a request

Need More Help?

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