VendorCreate Endpoint

Overview

Your store may or may not need vendors.  If you do, this endpoint allows you to create as many vendors as you need for 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 some kind of idea what attributes that you want your vendor to have before you create it.

VendorCreate

This REST API endpoint allows you to create a vendor for 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/vendors

HTTP Method

POST

Parameters

This method only requires that you pass an instance of the VendorManufacturerDTO object to the endpoint.

Returns

If successful, this endpoint will return a VendorManufacturerDTO object in JSON format.  Otherwise, you will 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);

// create a new instance of a vendor
var vendor = new VendorManufacturerDTO();

// populate the vendor object with minimal information
vendor.ContactType = VendorManufacturerTypeDTO.Vendor;
vendor.DisplayName = "Hotcakes Commerce";
vendor.EmailAddress = "info@hotcakescommerce.com";

// call the API to create the new vendor
ApiResponse<VendorManufacturerDTO> response = proxy.VendorCreate(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() {

    // create a new instance of a vendor
    var vendor = {
        "ContactType": 0,
        "DisplayName": "Hotcakes Commerce",
        "EmailAddress": "info@hotcakescommerce.com"
    };

    // call the API to create the new vendor
    $.ajax({
        dataType: "json",
        url: url + apiPath + endPoint + "?key=" + apiKey,
        data: JSON.stringify(vendor),
        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(1398165072697)\/",
      "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.