AffiliateReferralDTO Object

Overview

The REST API makes use of the AffiliateReferralDTO object whenever working with affiliate referrals.  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. 

AffiliateReferralDTO

The AffiliateReferralDTO 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 AffiliateReferralDTO object.  The descriptions are based upon default functionality and the default Viewset included with Hotcakes.

Member Default Description
AffiliateId 0 The unique ID of the affiliate to properly relate the referral to the right affiliate.
Id 0 The Unique ID of this affiliate referral instance used to find and update this item.
ReferrerUrl (empty string) This value should contain the referring URL that the affiliate referral came from. It can occasionally be an empty string.
StoreId 0 This is the ID of the Hotcakes store. Typically, this is 1, except in multi-tenant environments.
TimeOfReferralUtc UtcNow The date/time stamp that the referral was made, used for auditing purposes only.

 

Example of AffiliateReferralDTO

{
   "Errors":[

   ],
   "Content":{
      "Id":180,
      "StoreId":1,
      "TimeOfReferralUtc":"\/Date(1397406148359)\/",
      "AffiliateId":246,
      "ReferrerUrl":"http://domain.com/landingpage"
   }
}
Have more questions? Submit a request

Need More Help?

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