AffiliatesDelete Endpoint

Overview

If your store has affiliates, it may be necessary to manage them from time to time, including deleting them as necessary.  This end point allows you to delete any unnecessary affilaites from 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 delete one.

AffiliatesDelete

This REST API end point allows you to delete an affiliate from 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 affiliate ID as described in the parameters below.

HTTP Method

DELETE

Parameters

Parameter Description
id This is the unique ID of the affiliate that you wish to delete

Returns

If successful, this end point will return True in the ApiResponse.Content object.  Otherwise, you should have one or more errors returned.  If you receive a False response with no error, either the category ID doesn't exist, or the REST call was improperly formatted.

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 to delete
var affiliateID = 244;

// call the API to delete the affiliate
ApiResponse<bool> response = proxy.AffiliatesDelete(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 to delete
    var affiliateID = 244;

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

});
{
   "Errors":[

   ],
   "Content":true
}
Have more questions? Submit a request

Need More Help?

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