AffiliatesFindAll Endpoint

Overview

This end point allows you to find all of the affiliates that are in your store.  This allows you to list them and parse them for any number of reasons or purposes.

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 them.

AffiliatesFindAll

This REST API end point allows you to find all of the affiliates 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

HTTP Method

GET

Parameters

There are no parameters for this end point.

Returns

If successful, this end point will return a populated list of the 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);

// call the API to find all affiliates in the store
ApiResponse<List<AffiliateDTO>> response = proxy.AffiliatesFindAll();
// 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() {

    // call the API to find the all affiliates in the store
    $.ajax({
        dataType: "json",
        url: url + apiPath + endPoint + "?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(1397006816526)/",
            "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":[

         ]
      },
      {
         "Id":245,
         "StoreId":1,
         "LastUpdatedUtc":"/Date(1397031083033)/",
         "Enabled":false,
         "ReferralId":"XYZ-Company",
         "DisplayName":"XYZ Company",
         "Address":{
            "Bvin":null,
            "LastUpdatedUtc":"/Date(1397006816527)/",
            "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":"XYZ123456",
         "DriversLicenseNumber":"",
         "WebSiteUrl":"",
         "CustomThemeName":"",
         "Notes":"",
         "Contacts":[

         ]
      },
      {
         "Id":246,
         "StoreId":1,
         "LastUpdatedUtc":"/Date(1397031127270)/",
         "Enabled":false,
         "ReferralId":"Acme-Inc",
         "DisplayName":"Acme Incorporated",
         "Address":{
            "Bvin":null,
            "LastUpdatedUtc":"/Date(1397006816527)/",
            "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":"COFQ3898AAD",
         "DriversLicenseNumber":"",
         "WebSiteUrl":"",
         "CustomThemeName":"",
         "Notes":"",
         "Contacts":[

         ]
      }
   ]
}
Have more questions? Submit a request

Need More Help?

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