AffiliateContactDTO Object

Overview

The REST API makes extensive use of the AffiliateContactDTO object whenever working with an affiliate contact.  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. 

AffiliateContactDTO

The AffiliateContactDTO object will contain all of the details of an affiliate contact for your Hotcakes Commerce store.

Members

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

Member Default Description
AffiliateId (empty string) The unique ID or bvin of the affiliate that this contact is attached to.
Id 0 A unique ID for the affiliate contact used to manage the object in the data source.
StoreId 0 This is the ID of the Hotcakes store. Typically, this is 1, except in multi-tenant environments.
UserId (empty string) The unique ID to identify and work with the affiliate contact in the CMS.

 

Example of AffiliateContactDTO

{
   "Errors":[

   ],
   "Content":{
      "Id":43,
      "StoreId":1,
      "AffiliateId":"bf7389a2-9b21-4d33-b276-23c9c18ea0c0",
      "UserId":"728"
   }
}
Have more questions? Submit a request

Need More Help?

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