ManufacturerUpdate Endpoint

Overview

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

ManufacturerUpdate

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

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

BVIN is the manufacturer ID as described in the parameters below.

HTTP Method

POST

Parameters

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

Returns

If successful, this endpoint will return a populated VendorManufacturerDTO 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.Client
  • Hotcakes.CommerceDTO.v1.Contacts

 

string url = "http://example.com";
string key = "YOUR-API-KEY";

Api proxy = new Api(url, key);

// specify the manufacturer to find
var manufacturerId = "43c3e7ca-5ab6-4b26-b089-78d31b52326d";

// find the manufacturer to update
var manufacturer = proxy.ManufacturerFind(manufacturerId).Content;

// update one or more properties of the manufacturer
manufacturer.EmailAddress = "info@hotcakescommerce.com";

// call the API to update the manufacturer
ApiResponse response = proxy.ManufacturerUpdate(manufacturer);
// 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 = "manufacturers";  
// get this from the store admin
var apiKey = "YOUR-API-KEY";

$(document).ready(function() {

    // specify the manufacturer to find
    var manufacturerId = "43c3e7ca-5ab6-4b26-b089-78d31b52326d";

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

});

function UpdateManufacturer(manufacturer) {

    // update one or more properties of the manufacturer
    manufacturer.EmailAddress = "info@hotcakescommerce.com";

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

}
{
   "Errors":[

   ],
   "Content":{
      "Bvin":"43c3e7ca-5ab6-4b26-b089-78d31b52326d",
      "StoreId":1,
      "LastUpdated":"\/Date(1398493983810)\/",
      "DisplayName":"Hotcakes Commerce",
      "EmailAddress":"info@hotcakescommerce.com",
      "Address":{
         "Bvin":null,
         "LastUpdatedUtc":"\/Date(1398468783306)\/",
         "StoreId":0,
         "NickName":"",
         "FirstName":"",
         "MiddleInitial":"",
         "LastName":"",
         "Company":"",
         "Line1":"",
         "Line2":"",
         "Line3":"",
         "City":"",
         "RegionName":"",
         "RegionBvin":"",
         "PostalCode":"",
         "CountryName":"United States",
         "CountryBvin":"bf7389a2-9b21-4d33-b276-23c9c18ea0c0",
         "Phone":"",
         "Fax":"",
         "WebSiteUrl":"",
         "UserBvin":"",
         "AddressType":0
      },
      "DropShipEmailTemplateId":"",
      "Contacts":[

      ],
      "ContactType":1
   }
}
Have more questions? Submit a request

Need More Help?

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