Address

What can you do with Address?


Properties

Property Details
id
"id": 903
Type: Number
This is the unique numeric identifier for the Address
address1
"address1": "Hello World"
Type: String
address2
"address2": "Hello World"
Type: String
cityId
"cityId": 930
Type: Number
Unique identifier for the associated City object.
stateId
"stateId": 688
Type: Number
Unique identifier for the associated State object.
countryId
"countryId": 850
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
verificationServiceId
"verificationServiceId": 406
Type: Number
verificationJson
"verificationJson": "Hello World"
Type: String
taxJurisdictionCode
"taxJurisdictionCode": "Hello World"
Type: String


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
  • cityId
  • stateId
  • countryId
  • zipCode
  • latitude
  • longitude
  • verificationServiceId
  • verificationJson
  • taxJurisdictionCode

DataFlow PATCH objects:


End Points

DELETEapi/v1/Address/{id:int}
Delete an instance of the Address object.
GETapi/v1/Address
Retrieve all of the Address objects.
GETapi/v1/Address/Metadata
Retrieve all of the meta data details of the Address object.
GETapi/v1/Address/Metadata/{option}
Retrieve all the meta data details of the Address object based on provided options.
{option}Metadata options for the Address object.
GETapi/v1/Address/Paged
Retreive all of the Address objects in a paged fashion.
GETapi/v1/Address/{id:int}
Retrieve an instance of the Address object by it's ID.
{id:int}Unique identifier for the Address object.
POSTapi/v1/Address
Create a new instance of the Address object.
PUTapi/v1/Address/{id:int}
Update an existing instance of the Address object.