REST API Endpoints for Affiliates

Overview

Hotcakes Commerce offers a comprehensive way to manage affiliates to help your store get referral business.  This area of the API allows you to manage how that is done.

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

Getting Started

If you haven’t already done so, you should probably have a development environment ready to development against, complete with Hotcakes installed and configured.

REST API End Points for Affiliates

There are a handful of REST API endpoints that allow you to display or manage various aspects of affiliates.  Those endpoints are detailed below.

End Point Return Type Description
AffiliatesCreate AffilateDTO Creates a new affiliate in your store and returns the object back to you.
AffiliatesDelete AffilateDTO Deletes the specified affiliate from the store that matches the given ID.
AffiliatesFind List of AffilateDTO Returns a specific affiliate in the store matching the given ID.
AffiliatesFindAll List of AffilateDTO Allows you to find all affiliates in the store.
AffiliateReferralsCreate AffiliateReferralDTO Creates a new referral for the specified affiliate.
AffiliateReferralsFindForAffiliate List of AffiliateReferralDTO Use this end point to find all referrals for a specific affiliate in the store.
AffiliatesUpdate AffilateDTO Updates the affiliate record with the information provided

 

Have more questions? Submit a request

Need More Help?

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