CustomerAccountDTO Object

Overview

The REST API makes extensive use of the CustomerAccountDTO object whenever working with a single customer account.  This article will help you to know the various members of this object.

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

There are no tasks needed to get started with understanding this object. 

CustomerAccountDTO

The CustomerAccountDTO object will contain all of the details of a single customer account for your Hotcakes Commerce store.

Members

The following table gives you details on the various members of the CustomerAccountDTO object.  The descriptions are based upon default functionality and the default Viewset included with Hotcakes.

Member Default Description
Addresses (empty List of AddressDTO) Addresses from the customer's address book
BillingAddress (empty AddressDTO) Address details for billing the customer
Bvin (empty string) The unique ID of the customer account.
CreationDateUtc UtcNow The date/time stamp of when the customer was created.
Email (empty string) The primary email address for the customer and it is used to get their avatar from gravatar.
FailedLoginCount 0 The number of times that the customer failed to login.
FirstName (empty string) First name of the customer
LastLoginDateUtc UtcNow The date/time stamp of the last time the customer logged in.
LastName (empty string) Last or surname of the customer
LastUpdatedUtc UtcNow The date/time stamp of the last time the customer was updated.
Notes (empty string) Notes about the customer
Password (empty string) Encrypted password of the customer
PricingGroupId (empty string) The unique ID (bvin) of the price group that this customer belongs to.
Salt (empty string) Value used to help with encrypting the password
ShippingAddress (empty AddressDTO) Address details for the primary shipping address
TaxExempt False Defines whether the customer is exempt from paying taxes

 

Example of CustomerAccountDTO

{
   "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.