TAG LINE
SMALL TITLE

Address

(API Version v3)


What can you do with Address?


Properties

Property Details
id
"id": 20
Type: Number
This is the unique numeric identifier for the Address
address1
"address1": "Hello World"
Type: String
address2
"address2": "Hello World"
Type: String
stateId
"stateId": 26
Type: Number
Unique identifier for the associated State object.
countryId
"countryId": 0
Type: Number
Unique identifier for the associated Country object.
zipCode
"zipCode": "Hello World"
Type: String
latitude
"latitude": "Hello World"
Type: String
longitude
"longitude": "Hello World"
Type: String
taxJurisdictionCode
"taxJurisdictionCode": "Hello World"
Type: String
cityName
"cityName": "Hello World"
Type: String
taxJurisdictionCodeUpdated
"taxJurisdictionCodeUpdated": "2005-04-11T14:56:24"
Type: Date


Update Request Filters

When updating an object you use the update request header with the list of properties to update. Then you need only supply the new values in the body of your request. Please note, this header can only be used with PUT or PATCH requests.

Field List:

  • identity
  • address1
  • address2
  • stateId
  • countryId
  • zipCode
  • latitude
  • longitude
  • cityName
  • stateCode
  • countryCode

DataFlow PATCH objects:


End Points

GETapi/v3/Address
Retrieve all of the Address objects.
GETapi/v3/Address/Paged
Retreive all of the Address objects in a paged fashion.
GETapi/v3/Address/{id:int}
Retrieve an instance of the Address object by it's ID.
{id:int}Unique identifier for the Address object.