AffiliatesCreate Endpoint

Overview

Affiliates make it easier for most stores to grow new and repeat business through referrals.  This end point allows you to create as many affiliates as you need for 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 some kind of idea what attributes that you want your affiliate to have before you create it.

AffiliatesCreate

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

POST

Parameters

This method only requires that you pass an instance of the AffiliateDTO object to the end point.

Returns

If successful, this end point will return a AffiliateDTO object in JSON format.  Otherwise, you will 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);

// create a new instance of affiliate
var affiliate = new AffiliateDTO();

// populate the affiliate with minimal information
affiliate.ReferralId = "ABC-Company";
affiliate.DisplayName = "ABC Company";
affiliate.TaxId = "ABC123456";
affiliate.Notes = "Created through the REST API";

// call the API to create the customer account
ApiResponse<AffiliateDTO> response = proxy.AffiliatesCreate(affiliate);
// 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() {

    // create an affiliate object to save
    var affiliate = {
        "ReferralId": "ABC-Company",
        "DisplayName": "ABC Company",
        "TaxId": "ABC123456",
        "Notes": "Added through the REST API."
    };

    // create the new affiliate
    $.ajax({
        dataType: "json",
        url: url + apiPath + endPoint + "?key=" + apiKey,
        data: JSON.stringify(affiliate),
        type: 'POST',
        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(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.