Address Structure
This structure is the basic object used to transmit address data. It is used, for instance, to transfer the shipping address and delivery address in the createShipments method.
Structure Fields
| Field Name | Type | Required? | Description |
|---|---|---|---|
| name | string(60) | Yes | Company name or first name and surname. |
| postalCode | string(10) | Yes | Postal code, without dash |
| city | string(17) | Yes | City name |
| street | string(35) | Yes | Street |
| houseNumber | string(10) | Yes | House number The sum of characters in the "apartmentNumber" and "houseNumber" fields shall not exceed 15 characters. |
| apartmentNumber | string(10) | No | Apartment number The sum of characters in the "apartmentNumber" and "houseNumber" fields shall not exceed 15 characters. |
| contactPerson | string(60) | No | Name and surname of the contact person |
| contactPhone | string(20) | No | Contact phone number |
| contactEmail | string(60) | No | Contact e-mail |
Example:
<addressData> <name>Testan Testington</name> <postalCode>02796</postalCode> <city>Warsaw</city> <street>Wąwozowa</street> <houseNumber>2</houseNumber> <contactPerson>Testan Testington</contactPerson> <contactEmail>testan@anydomain.eu</contactEmail> </addressData>