Create or update customer's or supplier's address.
If the created or updated address belongs to a customer (to a natural person), and your account country is subject to the General Data Protection Regulation (GDPR), Erply logs the change in the customer information processing log.
| Parameter name | Description | Possible value | Required |
|---|---|---|---|
| addressID | Address ID. If this parameter is present, then the specified address is updated. | integer | |
| ownerID | Customer's or supplier's unique ID. | integer | |
| typeID | Address type ID, see getAddressTypes. (Not required if updating an existing address.) | integer | yes |
| street | Street address. If address cannot be split into parts, put the whole address into this field. |
String (65536) | |
| address2 | Street address, line 2. This field is exposed via Erply user interface only for US, CA and MX accounts! | String (65536) | |
| city | City, region, or county | String (255) | |
| postalCode | Postal code or ZIP code. | String (16) | |
| state | State. This field is exposed via Erply user interface only for US, CA and MX accounts! | String (255) | |
| country | String (255) | ||
| ***** | Additional attributes associated with this item. Attributes must be supplied as a flat list, each attribute defined by the following set of three parameters. Replace # with set number (1, 2, 3, ...). When updating an existing entry, API will only update the attributes specified in input data and leave all other existing attributes unchanged. To delete an attribute, set its value to 'null' or 'undefined'. |
||
| attributeName# | Attribute name. Name can only contain the following symbols: A-Z, a-z, 0-9, dash and underscore. | string | |
| attributeType# | Attribute type, possible types are 'text', 'int' and 'double'. By default 'text'. | string | |
| attributeValue# | Value of the attribute. Set value to 'null' or 'undefined' to delete an attribute. 'text' attribute can be any string, maximum 255 characters. 'int' must be a signed 32-bit integer. 'double' must be a decimal number. |
string |
| Field name | Type | Description |
|---|---|---|
| addressID | integer | ID of the created/updated address item. |