VariantOptionDataDTO Object

Overview

The REST API makes exclusive use of the VariantOptionDataDTO object whenever specifying matching criteria for locating a product variant.  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. 

VariantOptionDataDTO

The VariantOptionDataDTO object will contain all of the details needed to find a specific product variant in your Hotcakes Commerce store.  This object doesn't do it on its own, but is used by the ProductVariantSkuUpdateDTO object.

Members

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

Member Default Description
ChoiceId (empty string) The unique ID or Bvin of this option.
ChoiceItemId (empty string) The unique ID of the selected choice in this option.

Example of VariantOptionDataDTO

{
   "MatchingOptions":[
      {
         "ChoiceId":"696252e1-ef08-4eef-b83a-1e9d237db51d",
         "ChoiceItemId":"5A5C3C93-4CE6-46CB-A460-06FD6F8E03BE"
      },
      {
         "ChoiceId":"f5c6fbd8-65c6-4942-9173-7f1c2c64b8c1",
         "ChoiceItemId":"90C9CE3C-AD0E-4B8D-ABA9-3E825DB2DE93"
      }
   ]
}
Have more questions? Submit a request

Need More Help?

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