AffiliateReferralsFindForAffiliate Endpoint

Overview

You may come across a use case where you need to find all of the referrals a specific affiliate has.  This end point allows you to find list of referrals for any single affiliate in your store.

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
  • Visual Studio 2012 or newer

Getting Started

You should already have a project open and ready to accept code to allow you to use this REST API end point.  You should also have one or more affiliate referrals s created so that you can successfully find one.

AffiliateReferralsFindForAffiliate

This REST API end point allows you to find affiliate referrals in your store. 

Example URL

This is what the REST end point will look like if you are calling it using JavaScript.  See our REST API URL documentation for more information.

http://yourdomain.com/DesktopModules/Hotcakes/API/rest/v1/affiliates/[ID]/referrals

ID is the primary identifier of the affiliate as described in the parameters below.

HTTP Method

GET

Parameters

Parameter Description
ID This is the unique ID of the affiliate that you wish to find referrals for

Returns

If successful, this end point will return a populated AffiliateReferralDTO object in JSON format.  Otherwise, you should have one or more errors returned.  

Example Code

The following code will allow you to successfully call this end point, provided that you have enabled it.

Project References

  • Hotcakes.CommerceDTO

Import Namespaces

  • Hotcakes.CommerceDTO.v1
  • Hotcakes.CommerceDTO.v1.Client
  • Hotcakes.CommerceDTO.v1.Contacts

 

string url = "http://YOURDOMAIN.COM";
string key = "YOUR-API-KEY";

Api proxy = new Api(url, key);

// specify an affiliate ID to locate referrals for
var affiliateID = 246;

// call the API to get the referrals for the affiliate
ApiResponse<List<AffiliateReferralDTO>> response = proxy.AffiliateReferralsFindForAffiliate(affiliateID);
// your domain name
var url = "http://YOURDOMAIN.COM"; 
// the path where the API is
var apiPath = "/DesktopModules/Hotcakes/API/rest/v1/";  
// endpoint as shown in the documentation
var endPoint = "affiliates";  
// get this from the store admin
var apiKey = "YOUR-API-KEY";

$(document).ready(function() {

    // specify an affiliate ID to locate referrals for
var affiliateID = 246;

// call the API to get the affiliate referrals 
$.ajax({
    dataType: "json",
    url: url + apiPath + endPoint + "/" + affiliateID + "/referrals?key=" + apiKey,
    type: 'GET',
        success: function (data) {
            // do something
        },
        error: function (jqXHR, textStatus) {
           // do something else
        }
    });

});
{
   "Errors":[

   ],
   "Content":[
      {
         "Id":180,
         "StoreId":1,
         "TimeOfReferralUtc":"/Date(1397431348360)/",
         "AffiliateId":246,
         "ReferrerUrl":"http://domain.com/landingpage"
      },
      {
         "Id":181,
         "StoreId":1,
         "TimeOfReferralUtc":"/Date(1397442465517)/",
         "AffiliateId":246,
         "ReferrerUrl":"http://domain.com/landingpage"
      },
      {
         "Id":182,
         "StoreId":1,
         "TimeOfReferralUtc":"/Date(1397442468457)/",
         "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.