ProductRelationshipDTO Object

Overview

The REST API makes extensive use of the ProductRelationshipDTO object whenever relating products to each other.  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. 

ProductRelationshipDTO

The ProductRelationshipDTO object will contain all of the details of a single product relationship for your Hotcakes Commerce store catalog.

Members

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

Member Default Description
Id 0 The unique ID or primary key of the product relationship.
IsSubstitute False Allows the related product to replace the primary product. This property is not used in the application, but False should be saved for all products.
MarketingDescription (empty string) This property is not currently used in the application.
ProductId (empty string) The unique ID or Bvin of the primary product.
RelatedProductId (empty string) The unique ID or Bvin of the related product.
SortOrder 0 Used to sort the related products for display to customers.
StoreId 0 This is the ID of the Hotcakes store. Typically, this is 1, except in multi-tenant environments.

 

Example of ProductRelationshipDTO

{
   "Errors":[

   ],
   "Content":{
      "Id":1,
      "StoreId":1,
      "ProductId":"fb975149-2c73-45ad-8082-68961e04915c",
      "RelatedProductId":"964163db-e733-4cbd-ace5-32717d813f3e",
      "IsSubstitute":false,
      "SortOrder":1,
      "MarketingDescription":""
   }
}
Have more questions? Submit a request

Need More Help?

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