ProductPropertyChoiceDTO Object

Overview

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

ProductPropertyChoiceDTO

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

Members

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

Member Default Description
ChoiceName (empty string) This is the system or localization-safe name of the choice.
DisplayName (empty string) When localization is enabled, this is the language-friendly name that is used over the ChoiceName.
Id 0 This is the unique ID or primary key of the choice.
LastUpdated UtcNow The last updated date is used for auditing purposes to know when the product property was last updated.
PropertyId 0 The unique ID of the product property that this choice is assigned to.
SortOrder 0 This is the numeric representation of the order that this choice will appear when listed with the other product property choices.
StoreId 0 This is the ID of the Hotcakes store. Typically, this is 1, except in multi-tenant environments.

 

Example of ProductPropertyChoiceDTO

{
      "Id":9,
      "StoreId":1,
      "PropertyId":6,
      "ChoiceName":"Orange",
      "DisplayName":"Orange",
      "SortOrder":1,
      "LastUpdated":"/Date(1395782131104)/"
}
Have more questions? Submit a request

Need More Help?

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