AffiliatesFind Endpoint

Overview

Sometimes you just need to find an affiliate to do something unique with it.  This end point allows you to find a specific 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 affiliates created so that you can successfully find one.

AffiliatesFind

This REST API end point allows you to find an affiliate 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]

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

Returns

If successful, this end point will return a populated AffiliateDTO 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 the ID for an affiliate to find
var affiliateID = 244;

// call the API to find the affiliate
ApiResponse<AffiliateDTO> response = proxy.AffiliatesFind(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 the ID for an affiliate to find
    var affiliateID = 244;

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

});
{
   "Errors":[

   ],
   "Content":{
      "Id":244,
      "StoreId":1,
      "LastUpdatedUtc":"/Date(1397028431747)/",
      "Enabled":false,
      "ReferralId":"ABC-Company",
      "DisplayName":"ABC Company",
      "Address":{
         "Bvin":null,
         "LastUpdatedUtc":"/Date(1397006235405)/",
         "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.