AffiliateReferralsCreate 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 affiliate referrals 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 referral to have before you create it.

AffiliateReferralssCreate

This REST API end point allows you to create an affiliate referral 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/[ID]/referrals

ID is the unique ID for the affiliate as described below.

HTTP Method

POST

Parameters

Parameter Description
Id This is the unique ID of the affiliate that you wish to reward with the referral
data You will need to pass a JSON version of the AffiliateReferralDTO object in your post request

Returns

If successful, this end point will return a AffiliateReferralDTO 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 referral
var affiliateReferral = new AffiliateReferralDTO();

// populate the affiliate referral object with minimal information
affiliateReferral.AffiliateId = 246;
affiliateReferral.ReferrerUrl = "http://domain.com/landingpage";

// call the API to create the affiliate referral
ApiResponse<AffiliateReferralDTO> response = proxy.AffiliateReferralsCreate(affiliateReferral);
// 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 reward the referral to
    var affiliateID = 246;

    // create a new instance of affiliate referral
    var affiliateReferral = {
        "AffiliateId": affiliateID,
        "ReferrerUrl": "http://domain.com/landingpage"
    };

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

});
{
   "Errors":[

   ],
   "Content":{
      "Id":181,
      "StoreId":1,
      "TimeOfReferralUtc":"/Date(1397417265517)/",
      "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.