ProductRelationshipsUnrelate Endpoint

Overview

Sometimes you have related products that don't need to be related any longer.  This endpoint allows you to delete or unrelate any unnecessary product relationships 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 relationships created so that you can successfully delete one.

ProductRelationshipsUnrelate

This REST API endpoint allows you to delete a product relationship from 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/[PRIMARYID]/[RELATEDID]

HTTP Method

DELETE

Parameters

Parameter Description
primaryid This is the unique ID of the primary product that other products are related to.
relatedid This is the unique ID of the related product

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 one or both of the product ID's doesn't exist, the product relationship 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 primary product ID or Bvin
var productId = "fb975149-2c73-45ad-8082-68961e04915c";
// specify the related product ID or Bvin
var relatedProductId = "964163db-e733-4cbd-ace5-32717d813f3e";

// call the API to delete the product relationship
ApiResponse<bool> response = proxy.ProductRelationshipsUnrelate(productId, relatedProductId);
// 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 primary product ID or Bvin
    var productId = "fb975149-2c73-45ad-8082-68961e04915c";
    // specify the related product ID or Bvin
    var relatedProductId = "964163db-e733-4cbd-ace5-32717d813f3e";

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

});
{
   "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.