ProductPropertyDTO Object

Overview

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

ProductPropertyDTO

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

Members

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

Member Default Description
Choices Empty list of ProductPropertyChoiceDTO A collection of choices that belong to this product property.  This property only applies when the TypeCode property is MultipleChoiceField (2).
CultureCode en-US This property reflects the language that this product property has been saved for.
DefaultValue (empty string) This is the default value that will first be used in products, until the product has been updated to have another value.
DisplayName (empty string) The name used on localized sites to recognize the product property in the native or chosen language.
DisplayOnSite true A setting used to determine whether or not this product property is displayed on the site to customers.
DisplayToDropShipper true A setting used to determine whether or not this product property is displayed to drop shippers.
Id 0 The unique ID or identifier/primary key of the product property.
LastUpdatedUtc UtcNow The last updated date is used for auditing purposes to know when the product property was last updated.
PropertyName (empty string) The globally used system name for the product property.
StoreId 0 This is the ID of the Hotcakes store. Typically, this is 1, except in multi-tenant environments.
TypeCode None or 0 The type of property that this product property is, which helps determine how it's displayed to merchants and customers.  The possible values are:
  • None = 0
  • TextField = 1
  • MultipleChoiceField = 2
  • CurrencyField = 3
  • DataField = 4
  • HyperLink = 7

 

Example of ProductPropertyDTO

{
   "Errors":[

   ],
   "Content":{
      "Id":6,
      "StoreId":1,
      "PropertyName":"ERP ID Number",
      "DisplayName":"ABC ERP ID Number",
      "DisplayOnSite":false,
      "DisplayToDropShipper":true,
      "TypeCode":0,
      "DefaultValue":"replace me",
      "CultureCode":"en-US",
      "Choices":[

      ],
      "LastUpdatedUtc":"\/Date(1398729020223)\/"
   }
}
Have more questions? Submit a request

Need More Help?

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