Vebra API import user guide; getting your properties onto your website from Vebra

Article - 840040464

08:05, 19 April 2023

The following document explains how you can get the property data from your Vebra software onto your website. It explains exactly how an import of your property data from Vebra 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 Vebra 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 Vebra who has access to the API, typically those using the Vebra Alto software.

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 Vebra, please contact your Account Manager.

We will contact Vebra 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 Vebra it gets that information.

Please note - although the Vebra 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 Vebra. 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 Vebra Alto

Website Option

Vebra 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

property_address_name

NA

Address 1

Used to output the address on the search results & property details pages

property_address_street

NA

Address 3 

Used to output the address on the search results & property details pages

property_address_locality

NA

City

Used to output the address on the search results & property details pages

property_town_address

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_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_branchid

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

property_description or mainfeatures (property_bullets_bullet 1 - 18) contain the word “Auction” or “auction”

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

property_newbuild is marked as true

NA

Mark the property as a Student Property (262144)

Doesn't output specifically, but allows the property to appear in student property filter searches if required

property_rm_type marked as "Student - House", "Student - Flat " or "Student Property"

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

hideprice

Field doesn't output on the website specifically, but when ticked it hides the price from appearing on the website

hideprice

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_importType

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

""

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

long_description

NA

Low Price*

Field outputs as the price on the search results and property details page

price

NA

Main Features

Outputs as the Main Features bullet points on the property details page

mainfeatures (property_bullets_bullet 1 - 18)

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

Import_clientID

NA

Property Type

Outputs on the search results and property details page (house, flat, apartment etc)

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.

service_charge

NA

Short Description

Outputs on the list view of the search results page

property_description

NA

Status

Outputs as the status of the propery (for sale, under offer etc)

property_web_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.

property_price_at_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 

property_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)

property_video (multiple videos can be supported if the organisation is set to use the WD.TechSpecs (Multi) field)

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

1.4 Media

Ensure you use the recommended file formats as specified by your Vebra software to ensure your photographs, floor plans, Brochures and EPCs display correctly on the website. You should consult with Vebra 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 Vebra and those changes will automatically appear on your website within 15 minutes (providing you have addeded/edited the information into the correct field of Vebra)

I’ve made a change to a property listing but not displaying on my website even though it has updated on the property portals?

How often does the Vebra 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 Vebra 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 Vebra as listed in section 1.3.

Having a standard Import setup for all Vebra 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. Vebra 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:

Vebra API import, Vebra import, Vebra Alto import, website upload from Vebra, import


Article ID: 840040464
Link: https://webdadi.atlassian.net/wiki/spaces/PKB/pages/840040464