CustomPropertyDTO Object

Overview

The REST API occasionally uses the CustomPropertyDTO object when working with products and orders.  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. 

CustomPropertyDTO

The CustomPropertyDTO object will contain all of the details of a single custom property for products and orders in your Hotcakes Commerce store.

Members

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

Member Default Description
DeveloperId (empty string) This is a unique ID that you use to group your own properties together.  Use any value that you wish here as long as it is unique to your company and you use it consistently.
Key (empty string) This is the unique name that is used to store and retrieve the custom property.
Value (empty string) This is the information that you are saving to later retrieve.  You are not limited in the number of characters that you can use.

 

Example of CustomPropertyDTO

{
      "CustomProperties":[
         {
            "DeveloperId":"MYCOMPANY",
            "Key":"ERPID",
            "Value":"0123456789"
         }
}
Have more questions? Submit a request

Need More Help?

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