Import specificatie aankoopopdrachten

Details of the JSON specification used by woonpleinlimburg.nl to import property details from other systems into woonpleinlimburg.nl.

This page details the specification of an JSON feed to send property information to woonpleinlimburg.nl

Your JSON feed will contain all the property information for one woonpleinlimburg.nl advertiser account. We match the feed URL you give us to an advertiser account once we validate and approve the feed.

Each feed URL can only contain property information for a single woonpleinlimburg account or estate agent. If you are creating feeds for multiple estate agents, each one will need to be available on a unique URL.

We cannot accept a feed URL that requires any manual intervention (such as clicking on a ‘confirm’ button) because our property feed process is completely automatic.

Your property feed must be an absolute feed of all your property information – not an incremental one. Each time we process a feed, we evaluate it against every property for that account in the woonpleinlimburg database. Your feed must contain ALL the properties that you want ADDED or UPDATED. It should not contain any properties that you want to DELETE.

When a property is ADDED to your database, there will be a new property record for it in your feed. It will be INSERTED to our database and we will process and store all associated images

If a property is UPDATED in your database, the "updated" tag in your feed should also change. When we see a change in the "updated" tag, the property will be UPDATED in our database and we will process all associated images. Please note, if the date does not change, we will not update the property, and if the date is invalid or does not conform to this specification, the JSON feed will be updated weekly rather than daily.

If a property is DELETED from your database, there will be no property record for it in your feed. We DELETE properties and any associated images from our database when there is no matching property record in your feed.

In order to correctly insert, update or delete, we must consistently identify each property as a unique entity in your feed. We do this using the "id" tag which must consistently and uniquely identify each one of your properties.

Table of Contents

Field name
Type
Values
Description

General fields

id
string
example: "ABC1234"

REQUIRED unique object id

created
date time
example: "2020-02-16 22:15:17"

REQUIRED created date

updated
date time
example: "2020-08-27 15:21:30"

REQUIRED updated date

purchase_order

boolean
"true" or "false"

REQUIRED indicates if object is a purchase order (Aankoopopdracht)

featured
boolean
"yes" or "no"

indicates if object is featured or not

archived
boolean
"true" or "false"

indicates if object is archived or not (active or not)

Commercial manager

commercial_manager
string
example: "John Smith"
name of responsible real estate agent
commercial_manager_email
string
example: "j.smith@mail.com"
email of responsible real estate agent
commercial_manager_avatar
string
example: "https://domain.com/img.jpg"
profile image of the responsible agent

Address & location

address

string

example: "Neringpassage 170, Lelystad Nederland"

REQUIRED full address of the object

street

string

example: "Neringpassage"

REQUIRED streetname of the object

house_number

string

example: "170"

REQUIRED house number of the object

house_number_addition

string

example: "b"

REQUIRED house number addition of the object

street_address

string

example: "Neringpassage 170"

REQUIRED street and house number of the object

zip

string

example: "8224 BS"

REQUIRED zipcode of the object

city

string

example: "Lelystad"

REQUIRED city where the object is located in

country

string

example: "Nederland"

REQUIRED country where the object is located

latitude

string

example: "52.5087125200"

REQUIRED latitude of the address

longitude

string

example: "54.764266700"

REQUIRED longitude of the address

neighborhood

string

example: "central park"

neighborhood name where the object is located

NeighborhoodWijk

Land registries

land_registries

array

example:

"land_registries": [
{
"municipality": "Vlissingen",
"municipality_code": "1033",
"section": "A",
"plot_number": "5032"
},
{
"municipality": "Vlissingen",
"municipality_code": "1033",
"section": "A",
"plot_number": "5298"
}
],

Land registries

Land registriesKadastrale gegevens
municipality

string

example: "Lelystad"

municipality of the land

MunicipalityGemeente
municipality_code

string

example: "LLS00"

municipality code of the land

Municipality codeGemeente code
section

string

example: "A1"

section of the land

SectionSectie
plot_number

string

example: "321E"

plot number of the land

Plot numberPerceelnummer

Financial

asking_price

integer

example: "350000"

OPTIONAL indicates the original asking price in euro of the object

PricePrijs

Object categories & types

category
string
"house", "apartment", "land", or "other"

REQUIRED indicates main category type of the object:

HouseWoonhuis
ApartmentAppartement
Building landBouwgrond
OtherOverig OG

type

* if category = "house"

string
"single-family-house", "mansion", "villa", "country-house", "bungalow", "farmhouse", "canal-house", "houseboat", "mobile-home", "caravan" or "estate"

REQUIRED if category is "house"

Single-family houseEengezinswoning
MansionHerenhuis
VillaVilla
Country houseLandhuis
BungalowBungalow
FarmhouseWoonboerderij
Canal houseGrachtenpand
HouseboatWoonboot
Mobile homeStacaravan
CaravanWoonwagen
EstateLandgoed

type

* if category = "apartment"

string
"top-floor", "ground-floor-apartment", "duplex", "gallery-flat", "porch-flat", "ground-floor-flat-top-floor", "penthouse", "gatehouse", "dorm-room", "double-ground-floor-apartment" or "mezzanine"

REQUIRED if category is "apartment"

Top floorBovenwoning
Ground floor apartmentBenedenwoning
DuplexMaisonnette
Gallery flatGalerijflat
Porch flatPortiekflat
Ground floor flat + top floorBeneden + bovenwoning
PenthousePenthouse
GatehousePortiekwoning
Dorm roomStudentenkamer
Double ground floor apartmentDubbel benedenhuis
MezzanineTussenverdieping

type

* if category = "other"

string
"indoor-garage", "garage", "parking-garage", "parking-place", "salvage", "trailer-park-location", "mobile-home-putch", "bert", "bottom-part" or "storage-space"

REQUIRED if category is "other"

Indoor garageInpandigeGarage
GarageGarage
Parking garageParkeer kelder
Parking placeParkeerplaats / Capaciteit
SalvageBerging
Trailer park locationWoonwagenstandplaats
Mobile home pitchStacaravanstandplaats
BerthLigplaats
Bottom partOnderstuk
Storage spaceOpslagruimte

subtype

* if category = "house"

string
"detached-house", "townhouse", "semi-detached-house", "terraced-house", "corner-house", "end-house", "hald-detached-house", "switched-semi-detached-house" or "staggered"

REQUIRED if category is "house"

Detached houseVrijstaande woning
TownhouseGeschakelde woning
Semi-detached house2-onder-1-kapwoning
Terraced houseTussenwoning
Corner houseHoekwoning
End houseEindwoning
Half detached houseHalfvrijstaande woning
Switched semi-detached houseGeschakelde 2-onder-1-kapwoning
StaggeredVerspringend

Construction

build_year

string

example: "1997"

indicates the build year of the object in YYYY

Build yearBouwjaar

living_space

integer
example: "145"

indicates the living space in m2 of the object

Living spaceWoonoppervlakte
volume
integer

example: "280"

indicates the volume of the living space in m3 of the object

VolumeVolume
plot_surface
integer
example: "550"

indicates the plot surface in m2 of the object

Plot surfacePerceeloppervlakte

other_indoor_space

integer

example: "12"

indicates the other indoor space in m2 of the object

Other indoor spaceOverige inpandige ruimte 

external_storage

integer

example: "20"

indicates external storage space in m2 of the object

External storageExterne bergruimte

rooms

integer

example: "3"

indicates the total number of rooms of the object

RoomsKamers

bedrooms

integer

example: "2"

indicates the total number of bedrooms of the object

BedroomsSlaapkamers

Descriptions

titles

array

example:
"titles": {
"en": "House for sale Aalbersestraat 16 4384 HL Vlissingen ",
"nl": "Woonhuis te koop Aalbersestraat 16 4384 HL Vlissingen "
},

Auto generated titles of the object (multilingual, in array: en, nl)

Could be used as a title or to generate a page url of the object and as title for SEO purposes.

meta_descriptions

array

example:
"meta_descriptions": {
"en": "Description here",
"nl": "Omschrijving hier"
},

Auto-generated meta description of the object (multilingual, in array: en, nl)

Could be used as description for SEO purposes.

meta_keywords

array

example:
"meta_keywords": {
"en": "keyword1, keyword2",
"nl": "zoekwoord1, zoekwoord2"
},

Auto-generated meta keywords of the object (multilingual, in array: en, nl)

Could be used as keywords for SEO purposes.

Media

image

string

example: "https://domain.com/object/main-image.jpg"

absolute url of the main image of the object

images

array

example:
"images": [
{
"id": 274928,
"sort": 1,
"url": "https://domain.com/object/392372598.jpg"
},
{
"id": 274929,
"sort": 2,
"url": "https://domain.com/object/2781512586.jpg"
},
{
"id": 274930,
"sort": 3,
"url": "https://domain.com/object/3412723251.jpg"
},
{
"id": 274931,
"sort": 4,
"url": "https://domain.com/object/3445401687.jpg"
}
]

images of the object in array with "id", "sort" sort order and "url" as the absolute image url

plans

array

example:
"plans": [
{
"id": 11038,
"sort": 200,
"url": "https://domain.com/object/3602172565.jpg",
"title": "Floor plan"
},
{
"id": 11039,
"sort": 201,
"url": "https://domain.com/object/215058354.jpg",
"title": "Floor plan"
},
{
"id": 11040,
"sort": 202,
"url": "https://domain.com/object/3841480935.jpg",
"title": "Floor plan"
}
]

floor plans of the object in array with "id", "sort" sort order "url" as the absolute floor plan (image; jpg / png) url and (optional) "title"

external_plans

string

example: "https://m2makelaars.floorplanner.com/aalbersestraat-16-te-vlissingen/embed/"

absolute url of the external floor plan of the object (this might be a tour or a interactive floor plan)

external_panoramas

string

example: "https://www.virtuelepioniers.nl/clients/m2makelaars/vlissingen_aalbersestraat_16/"

absolute url of the external panorama / virtual tour of the object (this might be a tour or a interactive floor plan)

videos

array

example:
"videos": [
{
"code": "kD51kbDZCjM",
"link": "https://www.youtube.com/watch?v=kD51kbDZCjM"
}
],

videos of the object in array with "code" (optional) and"link" as the absolute url of the video