VendorUpdate Endpoint

Overview

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

VendorUpdate

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

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

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

HTTP Method

POST

Parameters

Parameter Description
bvin This is the unique ID of the vendor 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 vendor to find
var vendorId = "5e742f08-42e8-41ad-9d16-7f9eb7a0992f";

// find the vendor to update
var vendor = proxy.VendorFind(vendorId).Content;

// update one or more properties of the vendor
vendor.ContactType = VendorManufacturerTypeDTO.Vendor;

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

$(document).ready(function() {

    // specify the vendor to find
    var vendorId = "5e742f08-42e8-41ad-9d16-7f9eb7a0992f";

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

});

function UpdateVendor(vendor) {

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

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

}
{
   "Errors":[

   ],
   "Content":{
      "Bvin":"5e742f08-42e8-41ad-9d16-7f9eb7a0992f",
      "StoreId":1,
      "LastUpdated":"/Date(1398405427653)/",
      "DisplayName":"Hotcakes Commerce",
      "EmailAddress":"info@hotcakescommerce.com",
      "Address":{
         "Bvin":null,
         "LastUpdatedUtc":"/Date(1398139859233)/",
         "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":0
   }
}
Have more questions? Submit a request

Need More Help?

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