Customer Address Object
Customer Address is a Child object of Customer and Lead.
End Point
/customeraddress
GET, POST, PUT, DELETE
GET and DELETE requests expect parameters customerId AND id of type Int32.
Merging two Addresses via API
POST: E.g /customeraddress/Merge?customerId=10&addressIdToMerge=2&addressIdToMergeInto=1
- The paramater customerId is the Id of the Customer (Int32).
- addressIdToMerge is the Id of the Address (Int32) that you want to delete.
- addressIdToMergeInto is the Id of the Address (Int32) that you want to keep.
Properties
| Property | Caption | Data Type | Required |
| Id | Id | Int32 | Put only |
| CustomerRef | Customer | EntityRef | True (either Customer or Lead Ref) |
| Name | Name | String (50) | True |
| Addr1 | Name/Company | String (50) | False |
| Addr2 | Street | String (50) | False |
| Addr3 | Floor/Suite | String (50) | False |
| Addr4 | Care of | String (50) | False |
| AltContact | Alt. Contact | String (50) | False |
| AltPhone | Alt. Phone | String (50) | False |
| City | City | String (50) | False |
| Contact | Contact | String (50) | False |
| Country | Country | String (50) | False |
| Fax | Fax | String (50) | False |
| Phone | Phone | String (50) | False |
| State | State/Prov./Reg. | String (50) | False |
| Website | Website | String (50) | False |
| Zip | Zip/Postal code | String (50) | False |
| String (1023) | False | ||
| ItemSalesTaxRef | Tax Item | EntityRef | False |
| LocationRef | Location | EntityRef | False |
| SalesTaxCodeRef | Tax Code | EntityRef | False |
| IsActive | Active | Boolean | False |
| IsPrimary | Is Primary | Boolean | False |
Json Sample
{
"Id": 1,
"CustomerRef": {
"Id": 298,
"Name": "Sky Rockets Inc."
},
"Website": "https://www.skyrocketsinc.com",
"LocationRef": null,
"ItemSalesTaxRef": null,
"SalesTaxCodeRef": null,
"Name": "Primary",
"Addr1": "Sky Rockets Inc.",
"Addr2": "140 Hauge Street",
"Addr3": "Suite 404",
"Addr4": "Accounting",
"City": "Miami",
"State": "FL",
"Zip": "33303",
"Country": "US",
"Contact": "John Doe",
"AltContact": "Jane Smith",
"Phone": "972-544-3160",
"AltPhone": "305-869-8942",
"Fax": "305-869-8944",
"Email": "jane.doe.@gmail.com",
"IsPrimary": true,
"IsActive": true,
"CustomFields": [
{
"Name": "AddCust1",
"Value": null,
"Caption": "FFL"
},
{
"Name": "AddCust2",
"Value": null,
"Caption": "Ship Time"
}
]
}
