...
Website Option | Where does it display on the website | Field in Street | Website Option | Street 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 | public.address.data.line.1 | NA | ||
Address 1 | Used to output the address on the search results & property details pages | public.address.data.line.1 | NA | ||
Address 2 | Used to output the address on the search results & property details pages | public.address.data.line.2 | NA | ||
City | Used to output the address on the search results & property details pages | property.address.data.town | NA | ||
State | Used to output the address on the search results & property details pages | property_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 | property.address.data.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 | property.branch_uuid | NA | ||
Additional Features | |||||
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 | property.sales.listing?.Data?.new_home property.lettings.listing?.Data?.new_home | NA | ||
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 | NA | ||
Hidden | Field doesn't output on the website specifically, but when ticked it hides the property 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 | import.ImportId | 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 | property.created_at | 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 | Property.id | 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 | property.details.Data.full_description | NA | ||
Low Price* | Field outputs as the price on the search results and property details page | property.salesListing?.Data?.price property.lettingsListing?.Data?.price_pcm | NA | ||
Main Features | Outputs as the Main Features bullet points on the property details page | property.featuresForPortals (max 10) | NA | ||
Number Bathrooms | Outputs as a numeric symbol on the search results and property details page | property.bathrooms | NA | ||
Number Bedrooms | Outputs as a numeric symbol on the search results and property details page | property.bedrooms | NA | ||
Number Receptions | Outputs as a numeric symbol on the search results and property details page | property.receptions | NA | ||
Organisation ID | Doesn't output on the website. An ID associating it with the specific organisation | API Key credentials | NA | ||
Property Type | Outputs on the search results and property details page (house, flat, apartment etc) | property.property_type | The list is comprehensive and too long to insert here. For a full list of property type mappings please click here | ||
Service Charge | 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. | Not currently used | NA | ||
Short Description | Outputs on the list view of the search results page | property.details.Data.short_description | NA | ||
Status | Outputs as the status of the propery (for sale, under offer etc) | property.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 | property.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. | property.salesListing?.Data?.price_qualifier | 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 | Not currently used | 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) | Not currently used | 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 | webdadi_sub_type | NA | ||
...