ProductTypeDTO Object

Overview

The REST API makes extensive use of the ProductTypeDTO object whenever working with a single product type.  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. 

ProductTypeDTO

The ProductTypeDTO object will contain all of the details of a single type of product for your Hotcakes Commerce store.

Members

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

Member Default Description
Bvin (empty string) The unique ID or primary key of the product type.
IsPermanent False This property is used to tell the main application when a product type is a core feature.
LastUpdated UtcNow The last updated date is used for auditing purposes to know when the product property was last updated.
ProductTypeName (empty string) The name used in the merchant application to label the products that will be using this product type.
StoreId 0 This is the ID of the Hotcakes store. Typically, this is 1, except in multi-tenant environments.
TemplateName (empty string) When used, this property allows you to set a high-level default template for products of this type to use.

 

Example of ProductTypeDTO

{
   "Errors":[

   ],
   "Content":{
      "Bvin":"1d883a38-143f-4bfc-b0d9-6ff3b410a95b",
      "StoreId":1,
      "LastUpdated":"\/Date(1398905984776)\/",
      "IsPermanent":false,
      "ProductTypeName":"Laptops",
      "TemplateName":""
   }
}
Have more questions? Submit a request

Need More Help?

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