CustomerAccountsFindByEmail Endpoint

Overview

Sometimes you just need to find a customer account to do something unique with it.  This endpoint allows you to find a specific customer account in your store using an email address.

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 endpoint.  You should also have one or more customer accounts created so that you can successfully find one.

CustomerAccountsFindByEmail

This REST API endpoint allows you to find a customer account in your store using an email address.   

Example URL

This is what the REST endpoint will look like if you are calling it using JavaScript.  See our REST API URL documentation for more information.

http://example.com/DesktopModules/Hotcakes/API/rest/v1/customeraccounts/ANY?key=[YOURKEY]&email=[EMAIL]

EMAIL is the email address of the user or customer account as described below.

HTTP Method

GET

Parameters

Parameter Description
email This is the email address of the customer account you are looking for. In the event that more than one customer account is found matching the email address, the first one is returned. For this reason, you should either have your site require a unique email address, or use another method to find a customer account.

Returns

If successful, this endpoint will return a populated CustomerAccountDTO 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 endpoint, provided that you have enabled it.

Project References

  • Hotcakes.CommerceDTO

Import Namespaces

  • Hotcakes.CommerceDTO.v1
  • Hotcakes.CommerceDTO.v1.Client
  • Hotcakes.CommerceDTO.v1.Membership

 

string url = "http://example.com";
string key = "YOUR-API-KEY";

Api proxy = new Api(url, key);

// specify an email address to use to find an account
var emailAddress = "superman@gmail.com";

ApiResponse<CustomerAccountDTO> response = proxy.CustomerAccountsFindByEmail(emailAddress);
// your domain name
var url = "http://example.com"; 
// the path where the API is
var apiPath = "/DesktopModules/Hotcakes/API/rest/v1/";  
// endpoint as shown in the documentation
var endPoint = "customeraccounts";  
// get this from the store admin
var apiKey = "YOUR-API-KEY";

$(document).ready(function() {

    // specify an email address to use to find an account
    var emailAddress = "superman@domain.com";

    // find the user account
    $.ajax({
        dataType: "json",
        url: url + apiPath + endPoint + "?key=" + apiKey + "&email=" + emailAddress,
        type: 'GET',
        success: function (data) {
            // do something
        },
        error: function (jqXHR, textStatus) {
           // do something else
        }
    });

});
{
   "Errors":[

   ],
   "Content":{
      "Bvin":"2",
      "Email":"superman@domain.com",
      "FirstName":"Clark",
      "LastName":"Kent",
      "Password":"",
      "Salt":"",
      "Addresses":[

      ],
      "TaxExempt":false,
      "Notes":"",
      "PricingGroupId":"",
      "FailedLoginCount":0,
      "LastUpdatedUtc":"/Date(1396397871480)/",
      "CreationDateUtc":"/Date(1396397871270)/",
      "LastLoginDateUtc":"/Date(1396398475303)/",
      "ShippingAddress":{
         "Bvin":null,
         "LastUpdatedUtc":"/Date(1396397870906)/",
         "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":"",
         "CountyName":"",
         "CountyBvin":"",
         "UserBvin":"",
         "AddressType":0
      },
      "BillingAddress":{
         "Bvin":null,
         "LastUpdatedUtc":"/Date(1396397870906)/",
         "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":"",
         "CountyName":"",
         "CountyBvin":"",
         "UserBvin":"",
         "AddressType":0
      }
   }
}
Have more questions? Submit a request

Need More Help?

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