Dezrez API import user guide; getting your properties onto your website from Dezrez
- Elliott
The following document explains how you can get the property data from your Dezrez software onto your website. It explains exactly how an import of your property data from Dezrez works and outlines what you need to do to ensure the information on your website is correct. It also contains important information to ensure your property alert emails link correctly to your website (in the FAQs section).
Contents
1.1 - Overview
1.2 - Setting up an import to your website
1.3 - What information does the website use to display my property listings?
1.4 - Media
1.5 - FAQs - including how to setup your property alert emails
1.1 Overview
The Dezrez API Import is one of the fastest methods of transferring property data. Once setup, it will look for changes to your property listings every 15 mins and immediately makes these changes to your website.
It is available to any client on Dezrez who has access to the API, typically those using the Pro, Premium or Enterprise packages.
It runs 7 days a week, 8am - 8pm. It does not run overnight when estate agent offices are closed and no changes are taking place.
1.2 Setting up an import to your website
If you’re having a new website built by Webdadi, your Project Manager will be in touch to setup your import. If you already have a Webdadi website and want to setup a new import from Dezrez, please contact your Account Manager.
We will contact Dezrez on your behalf to obtain the relevant API credentials to setup your import.
1.3 What information does the website use to display my property listings?
The following table outlines what information is used on the website, where it is output, and from where in Dezrez it gets that information.
Please note - although the Dezrez software itself is customisable and allows you to create new fields and have a bespoke configurations, the website import only downloads the default/core fields of Dezrez.
Website Option | Where does it display on the website | Field in Dezrez | Website Option | Dezrez Drop Down Option |
House Number | Doesn't output on the website specifically. This field is imported purely to help us identify the property in our database for troubleshooting | Address.BuildingName or Address.Number | NA |
|
Address 1 | Used to output the address on the search results & property details pages | Address.Street | NA |
|
Address 3 | Used to output the address on the search results & property details pages | None | NA |
|
City | Used to output the address on the search results & property details pages | Address.Town | NA |
|
State | Used to output the address on the search results & property details pages | thisProperty.address.county | NA |
|
Country | Used to output the address on the search results & property details pages | UK | NA |
|
Postcode | Used to output the address on the search results & property details pages. Only the first part of the postcode will show | Address.Postcode | NA |
|
Branchcode | Determines what branch the property is allocated to. This should match an office setup on the website. This branches details will apear on the property details page (editable in VIA) and is where any arrange a viewing email requests are sent for that property. Properties allocated to a branch not setup on the website will not display | BranchDetails.Id | NA |
|
Additional Features |
|
|
|
|
Mark the Property as For Sale by Auction (64) | Doesn’t output specifically, but allows the property to appear in a For Sale by Auction filter searches if required | The tags field should contain the tag (AUC) or (auc) | NA |
|
Mark the property as a New Build (1) | Doesn't output specifically, but allows the property to appear in new homes filter searches if required | The tags field should contain the tag (NH) or (nh) | NA |
|
Mark the property as a Development Opportunity (268435456) | Doesn't output specifically, but allows the property to appear in development opportunity filter searches if required | The tags field should contain the tag (DEV) or (dev) | NA |
|
Mark the property as being in a Village/Rural location (1073741824) | Doesn't output specifically, but allows the property to appear in rural location filter searches if required | The tag field should contain the tag (VR) or (vr) |
|
|
Council Tax Band | Outputs on the property details page in the left hand side section below the bullet pointed main features | counciltax | NA |
|
Hidden | Field doesn't output on the website specifically, but when ticked it hides the property from appearing on the website | hidden or portalexclude | NA |
|
hideprice | Field doesn't output on the website specifically, but when ticked it hides the price from appearing on the website |
| NA |
|
importtype | Determines whether the price of the property is per annum, per month or per week. Doesn't ouput on the site specifically per property as the website is set to display a default, but will use this price to convert to the correct amount according to the website default | RoleType.SystemName | NA |
|
Instructed Date | Field doesn't output on the website specifically, but ensures the newest/oldest filter on the website searches functions correctly. It uses this date to define a property's age. If this is blank, it cannot filter properties by those values | DateInstructed | NA |
|
Internal Code | Field doesn't output on the website specifically, but ensure the property can always be viewed by using the clients website URL followed by /property/propertyid eg: estateagent.com/property/12345 | roleid | NA |
|
Long Description | Field outputs as the description on the property details page | Descriptions Main Marketing Text | NA |
|
Low Price* | Field outputs as the price on the search results and property details page | lowprice | NA |
|
Main Features | Outputs as the Main Features bullet points on the property details page | mainfeatures | NA |
|
Number Bathrooms | Outputs as a numeric symbol on the search results and property details page | RoomCountsDescription.Bathrooms | NA |
|
Number Bedrooms | Outputs as a numeric symbol on the search results and property details page | RoomCountsDescription.Bedrooms | NA |
|
Number Receptions | Outputs as a numeric symbol on the search results and property details page | RoomCountsDescription.Receptions | NA |
|
Organisation ID | Doesn't output on the website. An ID associating it with the specific organisation | ThisImport.ClientId | NA |
|
Property Type | Outputs on the search results and property details page (house, flat, apartment etc) | PropertyType | The list is comprehensive and too long to insert here. For a full list of property type mappings please click here | |
Short Description | Outputs on the list view of the search results page | Descriptions SummaryText | NA |
|
Status | Outputs as the status of the propery (for sale, under offer etc) | status | For Sale | For Sale |
Under Offer | Under Offer | |||
Sold STC | Sold Subject to Contract (SSTC) | |||
Sold | Sold | |||
To Let | To Let | |||
Let Agreed | Let or Let Agreed | |||
Tenure | Outputs the tenure underneath the main description on the property listings page | tenure | Commonhold | Commonhold |
Freehold | Freehold | |||
Leasehold | Leasehold | |||
Leasehold + Share of freehold | Leasehold + Share of freehold | |||
Share of freehold | Share of freehold | |||
Terms | Outputs near the price of the property (offers in excess, guide price etc). In Vebra, customers can add additional drop down options with customised wording for price qualifier wording. The website can’t support limitless custom options the customer may have added to Vebra Alto, but it supports the default options within Vebra Alto. The options which are supported are to the right. The customer must use the default options in order for it to display correctly on the website. | terms | Guide | Guide Price |
Fixed Price | Fixed Price | |||
Offers in the region of | Offers in Region Of | |||
Offers in excess | Offers in Excess of | |||
Offers over | Prices From | |||
Null | Null | |||
Vacant From | Doesn't output on the website | thisProperty.available | NA |
|
Video Tour (multi or single) | Outputs as a video symbol on the search results and property details page. When clicked it displays the video(s) | videotour | NA |
|
Webdadi Sub Type | Field doesn't output on the website specifically, but essentially markes the property as a sales or lettings property so it appears in the relevant search | webdadisubtype | NA |
|
1.4 Media
Ensure you use the recommended file formats as specified by your Dezrez software to ensure your photographs, floor plans, Brochures and EPCs display correctly on the website. You should consult with Dezrez to ascertain exactly how to upload the relevant media.
1.5 FAQs
How do I make changes to the property listings on my website?
Simply update your property information within Dezrez and those changes will automatically appear on your website within 15 minutes (providing you have addeded/edited the information into the correct field)
I’ve made a change to a property listing but not displaying on my website even though it has updated on the property portals?
Firstly, ensure you have added/edited the information in the correct field within Dezrez. Section 1.3 above outlines what fields you should use to correctly display on your website. If you’re adding information to other fields not listed above, they won’t display on the website.
The website will update every 15 minutes. Unlike the property portals, the changes are not quite made instantly in real time. Changes can take up to 15 minutes, so please check when you added/edited the property. You may just have to wait for the import to run again if it’s been less time then that since you made your edit. However, the maximise time you should ever wait for an update is 15 minutes
Ensure you have allocated the property to an office that is setup on your website. Properties added to Dezrez that aren’t allocated to an office, or allocated to an office not setup on the website, will not display.
How often does the Dezrez API Import run & how quickly will any changes be on my website?
The tool runs every 15 mins to look for changes to your property listings data. When it picks up any edits, additions or deletions of properties, these changes are then directly added to the website and there is no additional processing time. You should never be waiting more than 15 minutes for an update to show on your website.
It runs every day between 8am - 8pm. It does not run overnight, as estate agent offices are closed so no changes will be taking place.
Can I customise my import to use different fields?
In short, no. The website uses a specific set of data from Dezrez that can’t be customised. However, most of the information on the website is factual data such as the address, price, tenure etc which shouldn’t need to be customised.
You need to add the data you want to display online to the relevant fields in Dezrez as listed in section 1.3.
Having a standard Import setup for all Dezrez customers allows us to support and maintain your import. It also means your import is constantly updated in line with any legal requirements such as the requirement to display council tax and tenure information published in May 2022.
Do I need to do anything to ensure my property alert emails work correctly once my import is setup?
Yes. Dezrez should ensure your property alert emails are set up to link to your property listings on the website correctly. They will need to generate a URL to the property online in their email templates. Please contact them directly to ensure they have the following setup:
To link to any property on the website, simply enter your website address followed by:
/property/Property_id
eg: www.estateagentwebsite/property/1245091
Keywords:
Dezrez API import, Dezrez import, Rezi import, website upload from Dezrez, import