CategoryProductAssociationsUpdate Endpoint

Overview

It wouldn't be unusual to need to update an existing product/category association.  This endpoint allows you to update any specific 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/category associations created so that you can successfully find one to update.

CategoryProductAssociationsUpdate

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

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/categoryproductassociations/[BVIN]

BVIN is the product/category association ID as described in the parameters below.

HTTP Method

POST

Parameters

Parameter Description
bvin This is the unique ID of the product/category association that you wish to update
data You will need to pass an updated JSON version of the CategoryProductAssociationDTO object in your post request

Returns

If successful, this endpoint will return a populated CategoryProductAssociationDTO 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/category association to update
var associationId = 63;

// get an instance of the product/category association
var association = proxy.CategoryProductAssociationsFind(associationId).Content;

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

// call the API to update the product/category association
ApiResponse<CategoryProductAssociationDTO> response = proxy.CategoryProductAssociationsUpdate(association);
// 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 = "categoryproductassociations";  
// get this from the store admin
var apiKey = "YOUR-API-KEY";

$(document).ready(function() {

    // specify the product/category association to update
    var associationId = 63;

    // get an instance of the product/category associatio
    $.ajax({
        dataType: "json",
        url: url + apiPath + endPoint + "/" + associationId + "?key=" + apiKey,
        type: 'GET',
        success: function (data) {
            // update the product/category association in another method
            UpdateProductCategoryAssociation(data.Content);
        },
        error: function (jqXHR, textStatus) {
            // do something
        }
    });

});

function UpdateProductCategoryAssociation(association) {

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

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

}
{
   "Errors":[

   ],
   "Content":{
      "Id":63,
      "CategoryId":"fe186c61-1997-4ad9-ba27-f7962d29261d",
      "ProductId":"fb975149-2c73-45ad-8082-68961e04915c",
      "SortOrder":2,
      "StoreId":1
   }
}
Have more questions? Submit a request

Need More Help?

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