AddressDTO Object

Overview

The REST API makes extensive use of the AddressDTO object whenever working with an address.  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. 

AddressDTO

The AddressDTO object will contain all of the details of an address for your Hotcakes Commerce store.

Members

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

Member Default Description
AddressType General Specifies if the address belongs to the merchant or not. The possible values are:
  • General = 0
  • Billing = 1
  • Shipping = 2
  • BillingAndShipping = 3
  • StoreContact = 99
Bvin (empty string) This is the unique ID of the Address.
City (empty string) The name of the city.
Company (empty string) If this is not a residential address, a company name should be specified.
CountryBvin (empty string) This is the unique ID or bvin of the country related to this address.
CountryName (empty string) This property will contain the SystemName of the country.
Fax (empty string) A fax or facsimile number for the address.
FirstName (empty string) The first name of the recipient at this address.
LastName (empty string) The last name or surname of the recipient at this address.
LastUpdatedUtc UtcNow The last updated date is used for auditing purposes to know when the address was last updated.
Line1 (empty string) The first line of the street address, such as 123 Main Street.
Line2 (empty string) The second line of the street address, such as Suite 100.
Line3 (empty string) The third line of the street address. Usually used for non-US or military addresses.
MiddleInitial (empty string) The middle initial of the recipient at this address.
Nickname (empty string) A user-defined value to name this address for easy identification in the user interface.
Phone (empty string) A telephone number for the address.
PostalCode (empty string) Contains the zip or postal code of the address, as necessary.
RegionBvin (empty string) This should contain a valid ID of the Region, if applicable.
RegionName (empty string) This property will contain the SystemName of the region.
StoreId 0 This is the ID of the Hotcakes store. Typically, this is 1, except in multi-tenant environments.
UserBvin (empty string) Addresses are mapped back to a CMS user record, even for vendors and manufacturers. This field is the user ID.
WebSiteUrl (empty string) A website URL for the address. Primarily used for vendors and manufacturers.

 

Example of AddressDTO

{
   "Errors":[

   ],
   "Content":{
      "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.