AffiliateDTO Object

Overview

The REST API makes extensive use of the AffiliateDTO object whenever working with a single affiliate.  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. 

AffiliateDTO

The AffiliateDTO object will contain all of the details of a single affiliate for your Hotcakes Commerce store.

Members

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

Member Default Description
Address new AddressDTO The primary or business address for the affiliate.
CommissionAmount 0 The amount to be used to calculate commissions on referred store purchases.
CommissionType 1 Reflects how the CommissionAmount should be calculated when applying referred purchase commissions. The possible values are:
  • None = 0
  • PercentageCommission = 1
  • FlatRateCommission = 2
Contacts List of AffiliateContactDTO Contains a listing of the customers that currently assigned to the affiliate.
CustomThemeName (empty string) This property is not used anywhere in the application, but could be used to customize views in your store.
DisplayName (empty string) This is the name of the affiliate that is used to map back to the CMS username, and it maps to the Username property in the Affiliate object.
DriversLicenseNumber (empty string) An optional field that allows for more specific reporting on affiliates and also allows for compliance with law in some regions.
Enabled false If true, this affiliate is enabled for use on the store. This is not able to be set in the user interface.
Id 0 The unique ID for the affiliate.
LastUpdatedUtc UtcNow The last updated date is used for auditing purposes to know when the affiliate was last updated.
Notes (empty string) Contains private notes about the affiliate. Only store merchants will see them.
ReferralDays 30 Reflects the number of days that an affiliate will "own" the rights to commissions on purchases made by a referred customer.
ReferralId (empty string) A unique value used to refer customers to the store for affiliate credit.  This maps to the AffiliateId property in the Affiliate object and is used in URL's.
StoreId 0 This is the ID of the Hotcakes store. Typically, this is 1, except in multi-tenant environments.
TaxId (empty string) The ID that the affiliate uses to report taxes.
WebSiteUrl (empty string) The URL of the website of the affiliate.

 

Example of AffiliateDTO

{
   "Errors":[

   ],
   "Content":{
      "Id":244,
      "StoreId":1,
      "LastUpdatedUtc":"/Date(1397028431747)/",
      "Enabled":false,
      "ReferralId":"ABC-Company",
      "DisplayName":"ABC Company",
      "Address":{
         "Bvin":null,
         "LastUpdatedUtc":"/Date(1397003388210)/",
         "StoreId":0,
         "NickName":"",
         "FirstName":"",
         "MiddleInitial":"",
         "LastName":"",
         "Company":"",
         "Line1":"",
         "Line2":"",
         "Line3":"",
         "City":"",
         "RegionName":"",
         "RegionBvin":"",
         "PostalCode":"",
         "CountryName":"United States",
         "CountryBvin":"bf7389a2-9b21-4d33-b276-23c9c18ea0c0",
         "Phone":"",
         "Fax":"",
         "WebSiteUrl":"",
         "UserBvin":"",
         "AddressType":0
      },
      "CommissionAmount":0,
      "CommissionType":1,
      "ReferralDays":30,
      "TaxId":"",
      "DriversLicenseNumber":"",
      "WebSiteUrl":"",
      "CustomThemeName":"",
      "Notes":"Created through the REST API",
      "Contacts":[

      ]
   }
}
Have more questions? Submit a request

Need More Help?

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