OptionSettingDTO Object

Overview

The REST API makes extensive use of the OptionSettingDTO object whenever working with a product that has one or more choices for a customer.  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. 

OptionSettingDTO

The OptionSettingDTO object will allow you to save meta data for any product choice/option in your Hotcakes Commerce store.  You can have an unlimited number of settings for your product option.

Members

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

Member Default Description
Key (empty string) This is the unique key or name of the setting to save.
Value (empty string) This is the value to returned with this setting is retrieved using the key.

 

Example of OptionSettingDTO

{
   "Errors":[

   ],
   "Content":
         {
            "Key":"ERPID",
            "Value":"1234567890"
         }
}
Have more questions? Submit a request

Need More Help?

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