VendorManufacturerDTO Object

Overview

The REST API makes extensive use of the VendorManufacturerDTO object whenever working with a vendor or manufacturer.  This article will help you to know the various members of this object.

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

Getting Started

There are no tasks needed to get started with understanding this object. 

VendorManufacturerDTO

The VendorManufacturerDTO object will contain all of the details of a single vendor or manufacturer for your Hotcakes Commerce store.

Members

The following table gives you details on the various members of the VendorManufacturerDTO object.  The descriptions are based upon default functionality and the default Viewset included with Hotcakes.

Member Default Description
Address AddressDTO An address object matching the vendor/manufacturer.
Bvin (empty string) This is the ID of the vendor/manufacturer.
Contacts List of VendorManufacturerContactDTO Contains a listing of user accounts that belong to the current vendor/manufacturer.
ContactType 0 Specifies whether this instance of the object contains contacts for a vendor or a manufacturer. The possible values include:
  • Unknown = -1
  • Vendor = 0
  • Manufacturer = 1
DisplayName (empty string) The value used in all administrative and customer views to identify the vendor/manufacturer.
DropShipEmailTemplateId (empty string) The email template ID used when workflow sends a notification email about a drop shipment.
EmailAddress (empty string) The primary email address used to contact the vendor/manufacturer. This is used for system emails for actions such as drop-shipping.
LastUpdated UtcNow An auditing value to track the last time the vendor/manufacturer record was updated.
StoreId 0 This is the ID of the Hotcakes store. Typically, this is 1, except in multi-tenant environments.

 

Example of VendorManufacturerDTO

{
   "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.