Specificatie aankoopopdrachten
Details of the JSON specification used by Pyber to export purchase order object details to other systems or websites.
This page details the specification of an JSON feed to export property information
The JSON feed will contain all the property information for one account.
Each feed URL can only contain property information for a single account or estate agent. If there are multiple estate agents, each one will have their own unique URL.
The property feed is an absolute feed of all the property information – not an incremental one. The feed contains ALL the properties that are ADDED or UPDATED by the agency. The feed does not contain any properties that are DELETED.
When a property is ADDED, there will be a new property record for it in the feed. You need to process and store all associated images.
If a property is UPDATED in the feed, the "updated" tag in our feed will also change. When you see a change in the "updated" tag, the property will need to be UPDATED in your database and processed with all associated images. Please note, if the date does not change, there is no need to update the property. Our JSON feed is updated automatically. However we strongly recommand to import the feed not more than 1 time per hour.
If a property is DELETED, there will be no property record for it in our feed. In this case you need to DELETE properties and any associated images from your database when there is no matching property record in our feed.
In order to correctly insert, update or delete, we identify each property as a unique entity in the feed. We do this using the "id" tag which must consistently and uniquely identify each one of the properties.
Table of Contents
Field name
Type
Values
Description
General fields
string example: "A1234"
REQUIRED unique object id
date time "2020-02-16 22:15:17" REQUIRED created date
date time "2020-08-27 15:21:30" REQUIRED updated date
purchase_order
boolean "true" or "false" REQUIRED indicates if object is a purchase order (Aankoopopdracht)
boolean "yes" or "no" indicates if object is featured or not
boolean "true" or "false" indicates if object is archived or not (active or not)
Commercial manager
string "John Smith" string "j.smith@mail.com" string "https://domain.com/img.jpg" 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
| Neighborhood | Wijk |
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 registries | Kadastrale gegevens |
string
example: "Lelystad"
municipality of the land
| Municipality | Gemeente |
string
"LLS00" municipality code of the land
| Municipality code | Gemeente code |
string
example: "A1"
section of the land
| Section | Sectie |
string
example: "321E"
plot number of the land
| Plot number | Perceelnummer |
Financial
asking_price
integer example: "350000"
OPTIONAL indicates the original asking price in euro of the object
| Price | Prijs |
Object categories & types
string "house",
"apartment",
"land", or
"other" REQUIRED indicates main category type of the object:
| House | Woonhuis |
| Apartment | Appartement |
| Building land | Bouwgrond |
| Other | Overig 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 house | Eengezinswoning |
| Mansion | Herenhuis |
| Villa | Villa |
| Country house | Landhuis |
| Bungalow | Bungalow |
| Farmhouse | Woonboerderij |
| Canal house | Grachtenpand |
| Houseboat | Woonboot |
| Mobile home | Stacaravan |
| Caravan | Woonwagen |
| Estate | Landgoed |
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 floor | Bovenwoning |
| Ground floor apartment | Benedenwoning |
| Duplex | Maisonnette |
| Gallery flat | Galerijflat |
| Porch flat | Portiekflat |
| Ground floor flat + top floor | Beneden + bovenwoning |
| Penthouse | Penthouse |
| Gatehouse | Portiekwoning |
| Dorm room | Studentenkamer |
| Double ground floor apartment | Dubbel benedenhuis |
| Mezzanine | Tussenverdieping |
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 garage | InpandigeGarage |
| Garage | Garage |
| Parking garage | Parkeer kelder |
| Parking place | Parkeerplaats / Capaciteit |
| Salvage | Berging |
| Trailer park location | Woonwagenstandplaats |
| Mobile home pitch | Stacaravanstandplaats |
| Berth | Ligplaats |
| Bottom part | Onderstuk |
| Storage space | Opslagruimte |
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 house | Vrijstaande woning |
| Townhouse | Geschakelde woning |
| Semi-detached house | 2-onder-1-kapwoning |
| Terraced house | Tussenwoning |
| Corner house | Hoekwoning |
| End house | Eindwoning |
| Half detached house | Halfvrijstaande woning |
| Switched semi-detached house | Geschakelde 2-onder-1-kapwoning |
| Staggered | Verspringend |
Construction
string
"1997" indicates the build year of the object in YYYY
| Build year | Bouwjaar |
living_space
integer "145" indicates the living space in m2 of the object
| Living space | Woonoppervlakte |
integer example: "280"
indicates the volume of the living space in m3 of the object
| Volume | Volume |
integer "550" indicates the plot surface in m2 of the object
| Plot surface | Perceeloppervlakte |
other_indoor_space
integer example: "12"
indicates the other indoor space in m2 of the object
| Other indoor space | Overige inpandige ruimte |
external_storage
integer example: "20"
indicates external storage space in m2 of the object
| External storage | Externe bergruimte |
rooms
integer example: "3"
indicates the total number of rooms of the object
| Rooms | Kamers |
bedrooms
integer example: "2"
indicates the total number of bedrooms of the object
| Bedrooms | Slaapkamers |
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
"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"
}
]
"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
"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
"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
