ProductRelationshipsUpdate Endpoint

Overview

It wouldn't be unusual to need to update an existing product relationship.  This endpoint allows you to update any specific product relationship 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 find one to update.

ProductRelationshipsUpdate

This REST API endpoint allows you to update a product relationship in your store. This requires that you also have a product relationship to update, which would mean that you should also call the ProductRelationshipFind endpoint to get an existing product relationship.

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

HTTP Method

POST

Parameters

Parameter Description
id This is the unique ID of the product relationship that you wish to update
data You will need to pass an updated JSON version of the ProductRelationshipDTO object in your post request

Returns

If successful, this endpoint will return a populated 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 relationship to find
var relationshipId = 7;

// call the API to find the product relationship
var relationship = proxy.ProductRelationshipsFind(relationshipId).Content;

// update one or more properties
relationship.SortOrder = 2;

// call the API to update the product relationship
ApiResponse<ProductRelationshipDTO> response = proxy.ProductRelationshipsUpdate(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() {

    // specify the product relationship to find
    var relationshipId = 7;

    // call the API to find the product relationship
    $.ajax({
        dataType: "json",
        url: url + apiPath + endPoint + "/" + relationshipId + "?key=" + apiKey,
        type: 'GET',
        success: function (data) {
            // update the product relationship in another method
            UpdateProductRelationship(data.Content);
        },
        error: function (jqXHR, textStatus) {
            // do something
        }
    });

});

function UpdateProductRelationship(relationship) {
            
    // update one or more properties
    relationship.SortOrder = 2;

    // call the API to update the product relationship
    $.ajax({
        dataType: "json",
        url: url + apiPath + endPoint + "/" + relationship.Id + "?key=" + apiKey,
        data: JSON.stringify(relationship),
        type: 'POST',
        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":2,
      "MarketingDescription":""
   }
}
Have more questions? Submit a request

Need More Help?

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