CustomerAccountsUpdate Endpoint

Overview

It wouldn't be unusual to need to update an existing customer account.  This endpoint allows you to update any specific customer account in 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 one or more customer accounts created so that you can successfully find one to update.

CustomerAccountsUpdate

This REST API endpoint allows you to update a customer account in your store. This requires that you also have a customer account to update, which would mean that you should also call the CustomerAccountsFind endpoint (or similar) to get an existing customer account.

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/[BVIN]

BVIN is the customer account ID as described in the parameters below.

HTTP Method

POST

Parameters

Parameter Description
bvin This is the unique ID of the customer account that you wish to update, which is also the same as the CMS UserID
data You will need to pass an updated JSON version of the CustomerAccountDTO object in your post request

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 the customer account ID (UserID/bvin) to find
var customerID = "5";

// call the API to find the customer account
ApiResponse<CustomerAccountDTO> customerResponse = proxy.CustomerAccountsFind(customerID);

// update the customer information as desired
customerResponse.Content.Email = "newemail@domain.com";

// save the updated customer record
ApiResponse<CustomerAccountDTO> response = proxy.CustomerAccountsUpdate(customerResponse.Content);
// 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 the customer account ID (UserID/bvin) to find
    var customerID = "5";

    // call the API to find the customer account
    $.ajax({
        dataType: "json",
        url: url + apiPath + endPoint + "/" + customerID + "?key=" + apiKey,
        type: 'GET',
        success: function (data) {
            UpdateCustomer(data.Content);
        },
        error: function (jqXHR, textStatus) {
            // do something
        }
    });

});

function UpdateCustomer(customer) {

    // update the customer record
    customer.Email = "newemail@domain.com";

    // replace date properties with UTC-friendly dates to prevent errors
    customer.LastUpdatedUtc = ParseDateForSave(customer.LastUpdatedUtc);
    customer.CreationDateUtc = ParseDateForSave(customer.CreationDateUtc);
    customer.LastLoginDateUtc = ParseDateForSave(customer.LastLoginDateUtc);
    customer.BillingAddress.LastUpdatedUtc = ParseDateForSave(customer.BillingAddress.LastUpdatedUtc);
    customer.ShippingAddress.LastUpdatedUtc = ParseDateForSave(customer.ShippingAddress.LastUpdatedUtc);

    // save the updated customer record
    $.ajax({
        dataType: "json",
        url: url + apiPath + endPoint + "/" + customer.Bvin + "?key=" + apiKey,
        data: JSON.stringify(customer),
        type: 'POST',
        success: function (data) {
            // do something
        },
        error: function (jqXHR, textStatus) {
            // do something else
        }
    });

}

function ParseDateForSave(dateValue) {
    // create a new date object in UTC format
    var newDate = new Date(parseInt(dateValue.substr(6)));

    // return the UTC version of the date
    return newDate.toISOString();
}
{
   "Errors":[

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

      ],
      "TaxExempt":false,
      "Notes":"",
      "PricingGroupId":"",
      "FailedLoginCount":0,
      "LastUpdatedUtc":"/Date(1396979518810)/",
      "CreationDateUtc":"/Date(1396404842413)/",
      "LastLoginDateUtc":"/Date(1396979518822)/",
      "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.