CustomerAccountsCreate Endpoint

Overview

Nearly every single store needs customers.  That's the whole point, right?  This endpoint allows you to create as many customer accounts as you want 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 endpoint.  You should also have some kind of idea what attributes that you want your customer account to have before you create it.

CustomerAccountsCreate

This REST API endpoint allows you to create a customer account for your store. 

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

HTTP Method

POST

Parameters

This method only requires that you pass an instance of the CustomerAccountDTO object to the endpoint.

Returns

If successful, this endpoint will return a CustomerAccountDTO 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 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);

// create a new instance of customer account
var customerAccount = new CustomerAccountDTO();

// populate the customer account with minimum details
customerAccount.FirstName = "Bruce";
customerAccount.LastName = "Wayne";
customerAccount.Email = "batman@domain.com";

// call the API to create the account
ApiResponse<CustomerAccountDTO> response = proxy.CustomerAccountsCreate(customerAccount);
// 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() {

    // create a new instance of customer account
    // populate the customer account with minimum details
    var customerAccount = {
        "FirstName": "Bruce",
        "LastName": "Wayne",
        "Email": "batman@domain.com"
    };

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

});
{
   "Errors":[

   ],
   "Content":{
      "Bvin":"5",
      "Email":"batman@domain.com",
      "FirstName":"Bruce",
      "LastName":"Wayne",
      "Password":"",
      "Salt":"",
      "Addresses":[

      ],
      "TaxExempt":false,
      "Notes":"",
      "PricingGroupId":"",
      "FailedLoginCount":0,
      "LastUpdatedUtc":"/Date(1396404842507)/",
      "CreationDateUtc":"/Date(1396404842413)/",
      "LastLoginDateUtc":"/Date(1396405100934)/",
      "ShippingAddress":{
         "Bvin":null,
         "LastUpdatedUtc":"/Date(1396404841712)/",
         "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(1396404841713)/",
         "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.