Search
K
[dev] 🇩🇪 Listings Management Germany

program

object
* Additional properties are NOT allowed.
projectStatusstring

The current status of the project.

Allowed values:CONSTRUCTION_STARTPROJECT_ENDED

Example:CONSTRUCTION_START

Example

unit

object
* Additional properties are NOT allowed.
numberOfUnitsnumber

The total number of units available in the project.

>= 0<= 999999

Example:10

priceFromnumber

The starting price for the units in the project.

>= 0< 9999999999999

Example:950

priceTonumber

The maximum price for the units in the project.

>= 0< 9999999999999

Example:1500

livingSpaceFromnumber

The minimum living space for the units in the project, measured in square meters.

>= 0< 999999

Example:50

livingSpaceTonumber

The maximum living space for the units in the project, measured in square meters.

>= 0< 999999

Example:150

numberOfRoomsFromnumber

The minimum number of rooms for the units in the project.

>= 0< 999999

Example:2

numberOfRoomsTonumber

The maximum number of rooms for the units in the project.

>= 0< 999999

Example:5

furnishingLevelstring

The furnishing level of the units in the project. Not provided (Keine Angabe) Standard (Standard) Upscale (Gehoben) Full (Vollständig)

Allowed values:NOT_PROVIDEDSTANDARDUPSCALEFULL

Example:UPSCALE

provisionTypestring

The type of provision for the units in the project. Provisionsfrei (w/o provision) Provision für Käufer (provision for buyer) Keine Angabe (not provided)

Allowed values:PROVISIONSFREIPROVISION_FÜR_KÄUFERKEINE_ANGABE

Example:PROVISION_FÜR_KÄUFER

provisionPercentnumber

The percentage of provision for the units in the project.

>= 0< 100

Example:3.57

soldOutPercentagenumber

The percentage of units in the project that have already been sold or rented.

>= 0< 100

Example:50

Example

projectData

object
* Additional properties are NOT allowed.
estateTypestring

The type of the estate being offered.

Allowed values:NEW_BUILD_PROJECTNEW_HOME_PROJECT

>= 1 characters<= 50 characters

Example:NEW_HOME_PROJECT

estateSubTypestring

The sub-type of the estate being offered. The sub-type provides more
specific information about the estate and can be used to further classify
the property within the broader category defined by the estateType.

Allowed values:NEW_BUILD_PROGRAM_APARTMENTNEW_BUILD_PROGRAM_HOUSENEW_BUILD_COMMERCIALNEW_BUILD_OTHER_RESIDENTIALHOUSE_TO_BUILDNEW_HOME_CATALOG

>= 1 characters<= 50 characters

Example:NEW_HOME_CATALOG

distributionTypestring

The distribution type of the project. It indicates whether the property
is available for purchase (BUY) or for rent (RENT) or both (BUY_RENT).

Allowed values:BUYRENTBUY_RENT

>= 1 characters<= 50 characters

Example:BUY_RENT

unitsarray[object]
* Additional properties are NOT allowed.
Show Child Parameters
locationobject

geographical information of the real estate property

* Additional properties are NOT allowed.
Show Child Parameters
programobject
* Additional properties are NOT allowed.
Show Child Parameters
deliveryDatestring

The expected delivery date of the project.

Example:2025-12-31

structureobject

structure of the property

* Additional properties are NOT allowed.
Show Child Parameters
textsobject

the texts can be transmitted in several languages. The corresponding data element therefore is an object and contains data elements which contain the language abbreviation in ISO 639-1 as a name.

* Additional properties are NOT allowed.
Show Child Parameters
linksobject
Show Child Parameters
contactobject
* Additional properties are NOT allowed.
Show Child Parameters
Example

projectMetadata

object

metadata associated with the project in Immowelt system.

* Additional properties are NOT allowed.
sourceobjectrequired

metadata related to the source / sender system

* Additional properties are NOT allowed.
Show Child Parameters
portalWebKeystring

short id of the real estate classified on a public website. generated by the portal/receiver.

Example:2rqww3y

Example

projectRequest

object

Request wrapper for Data

* Additional properties are NOT allowed.
dataobjectrequired
* Additional properties are NOT allowed.
Show Child Parameters
mediaarray[object]

Array of media items to attach to the listing.

* Additional properties are NOT allowed.
Show Child Parameters
metadataobjectrequired

metadata associated with the project in Immowelt system.

* Additional properties are NOT allowed.
Show Child Parameters
Example