Common Types
This page documents common data structures used throughout the API. These types appear in multiple endpoints and resources.
Address
Used for billing and shipping addresses throughout the API.
| Field | Type | Required | Description |
|---|---|---|---|
firstName | string | No | Contact's first name (for shipping addresses only). |
lastName | string | No | Contact's last name (for shipping addresses only). |
line1 | string | Yes | Street address (e.g., "Trieda Andreja Hlinku"). Max 255 characters. |
line2 | string | No | Additional address info (e.g., unit number). Max 255 characters. |
city | string | Yes | City name. Max 255 characters. |
postalCode | string | Yes | Postal code. Max 255 characters. |
country | string | Yes | ISO 3166-1 Alpha-2 country code (e.g., "SK", "CZ", "HU"). 2 chars. |
Address Types
- Billing Address: Contains core address fields only (no name fields)
- Shipping Address: Includes optional
firstNameandlastNamefields for delivery contact - Checkout Address: All fields have a maximum length of 255 characters
Example (Shipping Address):
json
{
"firstName": "Anton",
"lastName": "Čomáš",
"line1": "Trieda Andreja Hlinku",
"line2": "1/14A",
"city": "Nitra",
"postalCode": "949 01",
"country": "SK"
}Example (Billing Address):
json
{
"line1": "Trieda Andreja Hlinku",
"line2": "1/14A",
"city": "Nitra",
"postalCode": "949 01",
"country": "SK"
}Bank Account
Bank account information for expert payouts.
| Attribute | Description |
|---|---|
| iban string, nullable | Slovak IBAN (must start with SK, 24 characters). |
json
{
"iban": "SK3112000000198742637541"
}Company
Company information for business registrations and invoicing.
| Attribute | Description |
|---|---|
| businessId string | Business ID (e.g., IČO). |
| taxId string | Tax ID (e.g., DIČ). |
| vatId string, nullable | VAT ID (e.g., IČ DPH). |
json
{
"businessId": "10699595",
"taxId": "421769982",
"vatId": null
}Coords
Geographic coordinates for real estate locations.
| Attribute | Description |
|---|---|
| lat number | Latitude. |
| lng number | Longitude. |
json
{
"lat": 48.30734852531308,
"lng": 18.086583509280644
}Date of Birth
Date of birth structure for user registration.
| Field | Type | Description |
|---|---|---|
| day | integer | Day of month (1-31). |
| month | integer | Month (1-12). |
| year | integer | Year of birth (1920-2010). |
json
{
"day": 15,
"month": 6,
"year": 1985
}