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).
...
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. This guide is also only relevant to the Atom website platform. It is not entirely compatible with older website templates.
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) |
property_rm_type marked as "Student - House", "Student - Flat " or "Student Property"
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 |
council_tax.band
NA
Deposit
Outputs on the property details page. Only relevant to Lettings properties
let_bond.Deposit
NA
Ground Rent
Outputs on the property details page. Relevant only for Leasehold or Commonhold properties. Will only display if there is a value in this field. If there is no value added, this field simply won’t display on the website.
groundrent
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 |
Lease Expiry
Outputs on the property details page. Relevant only for Leasehold or Commonhold properties. Will only display if there is a value in this field. If there is no value added, this field simply won’t display on the website.
leasend
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 | |
Outputs on the property details page. Relevant only for Leasehold or Commonhold properties. Will only display if there is a value in this field. If there is no value added, this field simply won’t display on the website.
service_charge
NA
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.
...